Difference between revisions of "Manual:Connection Window"
(→Connection Window: images for connection window) |
|||
(2 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
+ | Thank you for choosing Mudlet. This page will help you get started with Mudlet and introduce you to some of the basics. | ||
+ | |||
+ | {{note}} Many elements of Mudlet have tool-tips displayed when you hover over a button or other element to show more help. | ||
+ | |||
= Connection Window = | = 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 | + | 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. |
− | + | ||
+ | [[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. | ||
− | |||
− | |||
== Pre-Configured Games == | == Pre-Configured Games == | ||
− | In the left of the window, you will notice a list of several MUD games. To play | + | 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. |
== New Connections == | == New Connections == | ||
Line 18: | Line 21: | ||
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. | ||
− | 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 | + | 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 enter those credentials now. |
[[File:New-connection.png|thumb|center|Creating a new game connection]] | [[File:New-connection.png|thumb|center|Creating a new game connection]] | ||
Line 31: | Line 34: | ||
[[File:Secure-connection.png|center]] | [[File:Secure-connection.png|center]] | ||
− | The game server | + | The your game server supports secure ([https://en.wikipedia.org/wiki/Transport_Layer_Security TLS], previously known as SSL) connections this can be enabled here. |
− | + | {{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. | |
== Automatic Login == | == Automatic Login == |
Revision as of 14:43, 15 July 2024
Thank you for choosing Mudlet. This page will help you get started with Mudlet and introduce you to some of the basics.
Note: Many elements of Mudlet have tool-tips displayed when you hover over a button or other element to show more help.
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.
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.
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.
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 enter those credentials now.
Note: Connection parameters cannot be edited while a connection is in progress for a selected profile.
Secure Connection (TLS)
To connect to a game securely, tick the 'Secure' box in the profile connection settings:
The your game server supports secure (TLS, previously known as SSL) connections this can be enabled here.
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 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.
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.
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.
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
Game admin: adding your game to Mudlet
If you're a game admin who'd like to add your game to Mudlet by default, see here on how can you list your MUD.