Difference between revisions of "Manual:General Features"

From Mudlet
Jump to navigation Jump to search
(test edit - see if #mudlet-pulse notifications are working)
 
(7 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
=Multi Session Gaming=
+
==Command Line==
  
−
Mudlet lets you play several simultaneous game sessions. However, currently we have the restriction that you cannot use the same profile twice. Consequently, if you want to play three characters on the same game at the same time, you need to make 3 profiles with 3 different names e.g. [email protected], [email protected] etc.
+
Mudlets command line is especially designed for playing MUD and MUSH games. It aims at reducing the amount of typing by using autocompletion and tab completion schemes that are optimized for typical game playing situations. The command line offers tab completion (TAB key with or without shift) and autocompletion (cursor up and cursor down keys).
  
−
Each profile will be shown in a new tab as a session of its own. That means, your old session will not be stopped, when you start a second one. When you have more than one active session, try clicking the menu button "MultiView" to see them all together.
+
''Tab completion'' searches the last 100 lines in the game output buffer for words matching the word that you are currently typing. This is useful if you have to type complicated long names. You only have to type the first letters and then press the tab key until the proposal is what you want.
  
−
You can switch between profiles (characters) by pressing <code>Ctrl+Tab</code> or select a particular one with <code>Ctrl+<number of tab></code>.
+
''Autocompletion'' tries to match your current typing with your command history. Example: If you typed the same command a while ago, you only have to start typing the first couple of letters and then press the cursor up key until the proposal matches the command that you want to use.
  
−
Want to be able to control all your profiles at once for games that allow multiplaying? Check out [https://forums.mudlet.org/viewtopic.php?f=6&t=23023 a package just for this]. On Mudlet 4.10 and earlier, a pre-installed <code>send-to-all-profiles</code> package provided control through the :<command> alias.
+
''Command history'' - if you haven’t started to type anything yet, you can browse through your command history with the cursor up and cursor down keys. However, if you have started typing pressing cursor up will result in a shot at autocompletion.
  
−
=Split Screen=
+
''Escape key'' - to get out of autocompletion you can press the ESC key any time. After pressing ESC the entire text gets selected and you can overwrite it or get back into command history mode.
  
−
Mudlet has a split screen: if you scroll up in the game text screen (or any other mini console window), the screen will split in two parts. The lower part will follow the game output while the upper part will stay focused on your scrolling: this way you can read easier through old passages without missing what is going on at the moment. Split screen can be activated via the scroll bar, page up / page down keys or the mouse wheel.
+
=== Command-line Shortcuts ===
  
−
Scrolling back to the end will close the split screen automatically. A click on the middle mouse button will close the split screen immediately as well as pressing <code>Ctrl+Enter</code> on the keyboard (<code>command+return</code> for mac). The size of the 2 parts of the split screen can be modified by dragging the separator bar in the middle with the mouse. Split screen can be helpful when selecting text in order to copy it to trigger editor e.g. when making triggers. If you don’t use split screen when selecting text, new arriving text will upset your selection.
+
The command line has some built in keyboard shortcuts.
  
−
To scroll quicker, hold <code>Ctrl</code> while scrolling. Conversely, to scroll just one line at a time hold <code>Shift</code> (available in Mudlet 4.11+).
+
{| class="wikitable"
 +
|-
 +
| Tab || Tab completion, see [[Manual:Technical Manual#Command_Line_Auto-Completion.2C_Tab-Completion_and_Command_History|this technical manual section]].
 +
|-
 +
| Up or Down || Command line history, see [[Manual:Technical Manual#Command_Line_Auto-Completion.2C_Tab-Completion_and_Command_History|this technical manual section]].
 +
|-
 +
| Home || Move cursor to beginning of line.
 +
|-
 +
| End || Move cursor to end of line.
 +
|-
 +
| CTRL+A || Select all.
 +
|-
 +
| CTRL+F || Move cursor to search bar.
 +
|-
 +
| SHIFT+Enter || Create an additional input line.
 +
|-
 +
| SHIFT+Left || Highlight one character left of the cursor (or unhighlight if already highlighted).
 +
|-
 +
| SHIFT+Right || Highlight one character right of the cursor (or unhighlight if already highlighted).
 +
|-
 +
| CTRL+Left || Move cursor one word to the left.
 +
|-
 +
| CTRL+Right || Move cursor one word to the right.
 +
|-
 +
| Backspace || Deletes the character to the left of the cursor.
 +
|-
 +
| CTRL+Backspace || Remove one word left of the cursor.
 +
|-
 +
| Delete || Deletes the character to the right of the cursor.
 +
|-
 +
| CTRL+Delete || Remove one word right of the cursor.
 +
|-
 +
| SHIFT+CTRL+Left || Highlight one word left of cursor.
 +
|-
 +
| SHIFT+CTRL+Right || Highlight one word right of cursor.
 +
|-
 +
| CTRL+C || Copies the selected text to the clipboard.
 +
|-
 +
| CTRL+Insert || Copies the selected text to the clipboard.
 +
|-
 +
| CTRL+K || Deletes to the end of the line.
 +
|-
 +
| CTRL+V || Pastes the clipboard text into line edit.
 +
|-
 +
| SHIFT+Insert || Pastes the clipboard text into line edit.
 +
|-
 +
| CTRL+X || Deletes the selected text and copies it to the clipboard.
 +
|-
 +
| SHIFT+Delete || Deletes the selected text and copies it to the clipboard.
 +
|-
 +
| Ctrl+Z || Undoes the last operation.
 +
|-
 +
| Ctrl+Y || Redoes the last undone operation.
 +
|-
 +
| PgUp || Scroll up one page in the main window buffer
 +
|-
 +
| PgDn || Scroll down one page in the main window buffer
 +
|-
 +
| Ctrl+Enter || Return to the bottom of the main window buffer
 +
|-
 +
|}
  
−
= Automatic login =
+
See also: [https://doc.qt.io/qt-6/qlineedit.html#details QT manual]
  
−
[[File:Character autologin.png|frame|left|Enter character name and password for automatic login]]
+
==Logging Output to text or HTML Log Files==
−
[[File:Toggle password storage in profile or computer.png|thumb|left|Toggle password storage in profile or computer]]
 
  
−
[[File:Passwords stored securely in Windows.png|thumb|left|Passwords stored securely in Windows]]
+
Press on the little button with the blue folder with the green arrow icon on the lower right side of the command line to turn on plain text logging. Click again to stop logging.  
−
[[File:Passwords stored securely in Linux.png|thumb|left|Passwords stored securely in Linux]]
 
−
[[File:Passwords stored securely in macOS.png|thumb|left|Passwords stored securely in macOS]]
 
  
−
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.
+
[[File:Folder-downloads.png|50px]]
  
−
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.
+
This will inform you about the file name and path of the log file. If you want to log in color you can choose to log to files in HTML format, but note that due to the nature of HTML, these log files tend to get very large quickly.  This, along with other options, can be set in the '''Preferences''' window (Alt+P).
  
−
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.
+
Log files can be found at the Mudlet home directory in your profile directory. To get the path to your Mudlet home directory you can type on the command line:
 +
<syntaxhighlight lang="lua">
 +
lua getMudletHomeDir()
 +
</syntaxhighlight>
 +
Log files are stored in "<mudletHomeDir>/logs". Each profile has its own <mudletHomeDir> path. Log files have a similar naming convention to the autosaved profiles: date#time.txt or date#time.html
  
−
=Command Line Auto-Completion, Tab-Completion and Command History=
+
==Split Screen==
  
−
Mudlets command line is especially designed for playing MUD and MUSH games. It aims at reducing the amount of typing by using autocompletion and tab completion schemes that are optimized for typical game playing situations. The command line offers tab completion (TAB key with or without shift) and autocompletion (cursor up and cursor down keys).
+
Mudlet has a split screen: if you scroll up in the game text screen (or any other mini console window), the screen will split in two parts. The lower part will follow the game output while the upper part will stay focused on your scrolling: this way you can read easier through old passages without missing what is going on at the moment. Split screen can be activated via the scroll bar, page up / page down keys or the mouse wheel.
  
−
'''Tab completion''' searches the last 100 lines in the game output buffer for words matching the word that you are currently typing. This is useful if you have to type complicated long names. You only have to type the first letters and then press the tab key until the proposal is what you want.
+
Scrolling back to the end will close the split screen automatically. A click on the middle mouse button will close the split screen immediately as well as pressing <code>Ctrl+Enter</code> on the keyboard (<code>command+return</code> for mac). The size of the 2 parts of the split screen can be modified by dragging the separator bar in the middle with the mouse. Split screen can be helpful when selecting text in order to copy it to trigger editor e.g. when making triggers. If you don’t use split screen when selecting text, new arriving text will upset your selection.
  
−
'''Autocompletion''' tries to match your current typing with your command history. Example: If you typed the same command a while ago, you only have to start typing the first couple of letters and then press the cursor up key until the proposal matches the command that you want to use.
+
To scroll quicker, hold <code>Ctrl</code> while scrolling. Conversely, to scroll just one line at a time hold <code>Shift</code> (available in Mudlet 4.11+).
  
−
'''Command history''' - if you haven’t started to type anything yet, you can browse through your command history with the cursor up and cursor down keys. However, if you have started typing pressing cursor up will result in a shot at autocompletion.
+
==Multi Session Gaming==
  
−
'''Escape key''' - to get out of autocompletion you can press the ESC key any time. After pressing ESC the entire text gets selected and you can overwrite it or get back into command history mode.
+
Mudlet lets you play several simultaneous game sessions. However, currently we have the restriction that you cannot use the same profile twice. Consequently, if you want to play three characters on the same game at the same time, you need to make 3 profiles with 3 different names e.g. [email protected], [email protected] etc.
  
 +
Each profile will be shown in a new tab as a session of its own. That means, your old session will not be stopped, when you start a second one. When you have more than one active session, try clicking the menu button "MultiView" to see them all together.
  
−
=Logging Output to text or HTML Log Files=
+
You can switch between profiles (characters) by pressing <code>Ctrl+Tab</code> or select a particular one with <code>Ctrl+<number of tab></code>.
  
−
Press on the little button with the blue folder with the green arrow icon on the lower right side of the command line to turn on plain text logging. Click again to stop logging. This will inform you about the file name and path of the log file. If you want to log in color you can chose to log to files in html format, but note that due to the nature of HTML, these log files tend to get very large quickly.
+
Want to be able to control all your profiles at once for games that allow multiplaying? Check out [https://forums.mudlet.org/viewtopic.php?f=6&t=23023 a package just for this]. On Mudlet 4.10 and earlier, a pre-installed <code>send-to-all-profiles</code> package provided control through the :<command> alias.
  
−
Log files can be found at the Mudlet home directory in your profile directory. To get the path to your Mudlet home directory you can type in your main window:
 
−
<syntaxhighlight lang="lua">
 
−
lua getMudletHomeDir()
 
−
</syntaxhighlight>
 
−
Log files are stored in "<mudletHomeDir>/logs". Each profile has its own <mudletHomeDir> path. Log files have a similar naming convention to the autosaved profiles: date#time.txt or date#time.html
 
  
 
[[Category:Mudlet Manual]]
 
[[Category:Mudlet Manual]]

Latest revision as of 11:57, 29 July 2024

Command Line

Mudlets command line is especially designed for playing MUD and MUSH games. It aims at reducing the amount of typing by using autocompletion and tab completion schemes that are optimized for typical game playing situations. The command line offers tab completion (TAB key with or without shift) and autocompletion (cursor up and cursor down keys).

Tab completion searches the last 100 lines in the game output buffer for words matching the word that you are currently typing. This is useful if you have to type complicated long names. You only have to type the first letters and then press the tab key until the proposal is what you want.

Autocompletion tries to match your current typing with your command history. Example: If you typed the same command a while ago, you only have to start typing the first couple of letters and then press the cursor up key until the proposal matches the command that you want to use.

Command history - if you haven’t started to type anything yet, you can browse through your command history with the cursor up and cursor down keys. However, if you have started typing pressing cursor up will result in a shot at autocompletion.

Escape key - to get out of autocompletion you can press the ESC key any time. After pressing ESC the entire text gets selected and you can overwrite it or get back into command history mode.

Command-line Shortcuts

The command line has some built in keyboard shortcuts.

Tab Tab completion, see this technical manual section.
Up or Down Command line history, see this technical manual section.
Home Move cursor to beginning of line.
End Move cursor to end of line.
CTRL+A Select all.
CTRL+F Move cursor to search bar.
SHIFT+Enter Create an additional input line.
SHIFT+Left Highlight one character left of the cursor (or unhighlight if already highlighted).
SHIFT+Right Highlight one character right of the cursor (or unhighlight if already highlighted).
CTRL+Left Move cursor one word to the left.
CTRL+Right Move cursor one word to the right.
Backspace Deletes the character to the left of the cursor.
CTRL+Backspace Remove one word left of the cursor.
Delete Deletes the character to the right of the cursor.
CTRL+Delete Remove one word right of the cursor.
SHIFT+CTRL+Left Highlight one word left of cursor.
SHIFT+CTRL+Right Highlight one word right of cursor.
CTRL+C Copies the selected text to the clipboard.
CTRL+Insert Copies the selected text to the clipboard.
CTRL+K Deletes to the end of the line.
CTRL+V Pastes the clipboard text into line edit.
SHIFT+Insert Pastes the clipboard text into line edit.
CTRL+X Deletes the selected text and copies it to the clipboard.
SHIFT+Delete Deletes the selected text and copies it to the clipboard.
Ctrl+Z Undoes the last operation.
Ctrl+Y Redoes the last undone operation.
PgUp Scroll up one page in the main window buffer
PgDn Scroll down one page in the main window buffer
Ctrl+Enter Return to the bottom of the main window buffer

See also: QT manual

Logging Output to text or HTML Log Files

Press on the little button with the blue folder with the green arrow icon on the lower right side of the command line to turn on plain text logging. Click again to stop logging.

Folder-downloads.png

This will inform you about the file name and path of the log file. If you want to log in color you can choose to log to files in HTML format, but note that due to the nature of HTML, these log files tend to get very large quickly. This, along with other options, can be set in the Preferences window (Alt+P).

Log files can be found at the Mudlet home directory in your profile directory. To get the path to your Mudlet home directory you can type on the command line: 

lua getMudletHomeDir()

Log files are stored in "<mudletHomeDir>/logs". Each profile has its own <mudletHomeDir> path. Log files have a similar naming convention to the autosaved profiles: date#time.txt or date#time.html

Split Screen

Mudlet has a split screen: if you scroll up in the game text screen (or any other mini console window), the screen will split in two parts. The lower part will follow the game output while the upper part will stay focused on your scrolling: this way you can read easier through old passages without missing what is going on at the moment. Split screen can be activated via the scroll bar, page up / page down keys or the mouse wheel.

Scrolling back to the end will close the split screen automatically. A click on the middle mouse button will close the split screen immediately as well as pressing Ctrl+Enter on the keyboard (command+return for mac). The size of the 2 parts of the split screen can be modified by dragging the separator bar in the middle with the mouse. Split screen can be helpful when selecting text in order to copy it to trigger editor e.g. when making triggers. If you don’t use split screen when selecting text, new arriving text will upset your selection.

To scroll quicker, hold Ctrl while scrolling. Conversely, to scroll just one line at a time hold Shift (available in Mudlet 4.11+).

Multi Session Gaming

Mudlet lets you play several simultaneous game sessions. However, currently we have the restriction that you cannot use the same profile twice. Consequently, if you want to play three characters on the same game at the same time, you need to make 3 profiles with 3 different names e.g. [email protected], [email protected] etc.

Each profile will be shown in a new tab as a session of its own. That means, your old session will not be stopped, when you start a second one. When you have more than one active session, try clicking the menu button "MultiView" to see them all together.

You can switch between profiles (characters) by pressing Ctrl+Tab or select a particular one with Ctrl+<number of tab>.

Want to be able to control all your profiles at once for games that allow multiplaying? Check out a package just for this. On Mudlet 4.10 and earlier, a pre-installed send-to-all-profiles package provided control through the :<command> alias.

Retrieved from "https://wiki.mudlet.org/index.php?title=Manual:General_Features&oldid=21920"