Difference between revisions of "Manual:Connection Window"

From Mudlet
Jump to navigation Jump to search
 
(17 intermediate revisions by the same user not shown)
Line 1: Line 1:
 +
= Connection Window =
 +
 
{{TOC right}}
 
{{TOC right}}
  
The connection dialog is the first screen you will be greeted with when starting Mudlet.  This window is how you set up your initial connection parameters and begin your connection.  
+
The connection dialog is the first screen you will be greeted with when starting Mudlet.  This window is how you set up your initial connection parameters and begin connecting to your game.  
Many elements of this window have Tool-Tip text displayed on-hover with more information related to each element or control.
+
 
 +
[[File:Main-connection-screen.png|thumb|center|Connection window showing pre-configured games]]
  
 
{{note}} The first time Mudlet is run, some options cannot be edited until you create your first new profile or after you start your first game.
 
{{note}} The first time Mudlet is run, some options cannot be edited until you create your first new profile or after you start your first game.
Line 8: Line 11:
 
== Pre-Configured Games ==
 
== Pre-Configured Games ==
  
In the left of the window, you will notice a list of several MUD games. To play them, select one from the list and click the "Connect" button.  
+
In the left of the window, you will notice a list of several MUD games. To play, select one from the list and click the "Connect" button.
 +
 
 +
{{note}} Game admins: like to see your game added to Mudlet? Visit [[Listing Your MUD]].
  
 
== New Connections ==
 
== New Connections ==
  
If you're using Mudlet with an unlisted game or for other telnet services, you'll want to click on the "New" button.  
+
If you're using Mudlet with an unlisted game or for other telnet services, you'll want to click on the '''New''' button then enter a name for the profile (perhaps your character or game name) in the '''Profile name''' section.  Next enter your '''Server address''' and '''port''', these are typically listed on the game website.
  
To set up your new connection profile, enter a Name for the profile.  Next enter your connection address and port.  If your game supports authentication you can either enter those credentials or do authentication another way via scripting.
+
[[File:New-connection.png|thumb|center|Creating a new game connection]]
  
 
{{note}} Connection parameters cannot be edited while a connection is in progress for a selected profile.
 
{{note}} Connection parameters cannot be edited while a connection is in progress for a selected profile.
  
 
+
To connect to a game securely (via [https://en.wikipedia.org/wiki/Transport_Layer_Security TLS] or SSL) tick the 'Secure' box in the profile connection settings:
== Secure Connection (TLS) ==
 
 
 
To connect to a game securely, tick the 'Secure' box in the profile connection settings:
 
  
 
[[File:Secure-connection.png|center]]
 
[[File:Secure-connection.png|center]]
  
The game server must support a secure ([https://en.wikipedia.org/wiki/Transport_Layer_Security TLS], previously known as SSL) connection in order for this to work, and this feature is only available from Mudlet 3.17 forward.
+
{{note}} Game admins/developers: check out [[Sample_TLS_Configuration|our sample configuration]] page or this [https://blog.oestrich.org/2018/11/nginx-tls-socket example of a TLS proxy using nginx] for some examples on how to setup a secure connection for your game.
  
If you are a game admin/developer, check out [[Sample_TLS_Configuration|our sample configuration]] page or this [https://blog.oestrich.org/2018/11/nginx-tls-socket example of a TLS proxy using nginx] for some examples on how to setup a secure connection for your game.
+
== Automatic Login ==
  
== Automatic Login ==
+
If your game takes in the characters name first and password next, Mudlet can automatically login for you. To make use of this feature in the Options tab type your name and password into the relevant sections as seen below.
  
[[File:Character autologin.png|thumb|right|Enter character name and password for automatic login]]
+
[[File:Character autologin.png|thumb|center|Enter character name and password for automatic login]]
[[File:Toggle password storage in profile or computer.png|thumb|right|Toggle password storage in profile or computer]]
 
  
[[File:Passwords stored securely in Windows.png|thumb|right|Passwords stored securely in Windows]]
+
All passwords by default are stored securely in the computers credential store - which means you can't just open up the file with the password and look at it.
[[File:Passwords stored securely in Linux.png|thumb|right|Passwords stored securely in Linux]]
 
[[File:Passwords stored securely in macOS.png|thumb|right|Passwords stored securely in macOS]]
 
  
 +
[[File:Toggle password storage in profile or computer.png|thumb|center|Toggle password storage in profile or computer]]
  
If your game takes in the characters name first and the characters password afterward, Mudlet can automatically login for you. To make use of this, put the name and password into the Connection information for your profile.
+
When the password is stored securely on the computer, you can find it in the credential manager.
  
By since Mudlet 4.2, all passwords by default are stored securely in the computers credential store - which means you can't just open up the file with the password and look at it. When the password is stored securely on the computer, you can find it in the credential manager - see screenshots on the left for Windows/Linux/macOS.
+
<gallery mode="packed">
 +
File:Passwords stored securely in Windows.png|Passwords stored securely in Windows
 +
File:Passwords stored securely in Linux.png|Passwords stored securely in Linux
 +
File:Passwords stored securely in macOS.png|Passwords stored securely in macOS
 +
</gallery>
  
The drawback of storing the password on the computer itself, however, is that if you use cloud sync for your profiles - the password won't the syncronised. You can go to Special Options in settings and change the password to be stored within the profile to make that work, if you'd like the password to be portable but visible in plaintext.
 
  
 +
{{note}} The drawback of storing the password on the computer itself, however, is that if you use cloud sync for your profiles - the password won't the synchronised.  You can go to Special Options in Mudlet's Preferences and change the password to be stored within the profile to make that work, if you'd like the password to be portable but visible in plaintext.
  
 
== Discord Rich Presence ==
 
== Discord Rich Presence ==
Line 52: Line 56:
 
This feature can only be enabled on the pre-configured games which currently also support the feature.  For more information, read about [[Standards:Discord_GMCP|Discord GMCP]]
 
This feature can only be enabled on the pre-configured games which currently also support the feature.  For more information, read about [[Standards:Discord_GMCP|Discord GMCP]]
  
== Game admin: adding your game to Mudlet ==
+
[[Category:Mudlet Manual]]
 
 
If you're a game admin who'd like to add your game to Mudlet by default, see here on how can you [[Listing Your MUD|list your MUD]].
 

Latest revision as of 12:58, 29 July 2024

Connection Window

The connection dialog is the first screen you will be greeted with when starting Mudlet. This window is how you set up your initial connection parameters and begin connecting to your game.

Connection window showing pre-configured games

Note Note: The first time Mudlet is run, some options cannot be edited until you create your first new profile or after you start your first game.

Pre-Configured Games

In the left of the window, you will notice a list of several MUD games. To play, select one from the list and click the "Connect" button.

Note Note: Game admins: like to see your game added to Mudlet? Visit Listing Your MUD.

New Connections

If you're using Mudlet with an unlisted game or for other telnet services, you'll want to click on the New button then enter a name for the profile (perhaps your character or game name) in the Profile name section. Next enter your Server address and port, these are typically listed on the game website.

Creating a new game connection

Note Note: Connection parameters cannot be edited while a connection is in progress for a selected profile.

To connect to a game securely (via TLS or SSL) tick the 'Secure' box in the profile connection settings:

Secure-connection.png

Note Note: Game admins/developers: check out our sample configuration page or this example of a TLS proxy using nginx for some examples on how to setup a secure connection for your game.

Automatic Login

If your game takes in the characters name first and password next, Mudlet can automatically login for you. To make use of this feature in the Options tab type your name and password into the relevant sections as seen below.

Enter character name and password for automatic login

All passwords by default are stored securely in the computers credential store - which means you can't just open up the file with the password and look at it.

Toggle password storage in profile or computer

When the password is stored securely on the computer, you can find it in the credential manager.


Note Note: The drawback of storing the password on the computer itself, however, is that if you use cloud sync for your profiles - the password won't the synchronised. You can go to Special Options in Mudlet's Preferences and change the password to be stored within the profile to make that work, if you'd like the password to be portable but visible in plaintext.

Discord Rich Presence

Since version 3.14 forward, Mudlet supports Discord Rich Presence integration for games using GMCP.

This feature can only be enabled on the pre-configured games which currently also support the feature. For more information, read about Discord GMCP