MUDLET_TIPS

This is a very brief explanation of starting up Mudlet. A more complete
help can be found on http://www.medievia.com/clients.html and through
https://mudlet.org/


Setting it up:

1. Download the Medievia Mudlet installer from the Medievia website and run
it, this will install the client on your system and give you the option
to run it automatically.
2. Running the client will automatically connect you to Medievia, login with
an existing character or begin a new adventure by starting a new character!

Now you are ready to play!

Here are some useful triggers. Triggers allow your game client to respond to
happenings in the game by looking for specific text and sending a command to
the game in response. Make sure you read Help RULES to see what rules we have
for using triggers. When you make these triggers or alias, you MUST type
exactly what you will see, so if you see You collapse, making an action with
you collapse will not work.

Triggers:
By clicking the Triggers tab at the top of the Medievia Mudlet window, the
trigger edit dialog opens. You should see some basic triggers provided by the
default client install. You may look at these for ideas or create your own!

Much more detailed information can be found on triggers on the Mudlet Trigger
Engine wiki: https://wiki.mudlet.org/w/Manual:Trigger_Engine

The simplest type of triggers use the substring or start of line option
in the dropdown for each line in the patterns list. These will either look for
a string that you specify (substring) on the numbered list, or a string at the
beginning of a line (start of line).

Here are some example triggers that should use the start of line trigger type:

Text to find: You are thirsty.
Command: drink water

Text to find: You are hungry.
Command: eat food

Text to find: You collapse, totally out of breath!
You fall down.
Command: stand

You may have noticed that the last example has two lines of text to find. Each
trigger will match those lines using an OR condition which means if it finds ANY
of those lines it will send the command, stand in that example.
More advanced options for triggers can be found on the Mudlet wiki link above.


Aliases:
Aliases let you define shortcuts that you can type that send more complicated
commands to the game.

Much more detailed information about aliases can be found on the Mudlet Alias
Engine wiki: https://wiki.mudlet.org/w/Manual:Alias_Engine

All aliases in Mudlet use something called Regular Expressions (RegEx) to match
what you type on the command line. RegEx can be very complicated to understand
and is considered a quite advanced topic. There is plenty of information regarding
RegEx available online but you can check out HELP MUDLET_REGEX for a quick primer
on using RegEx in Mudlet!
For these examples a simple RegEx symbol is used, they are prefixed by the ^ caret
symbol which means the command typed needs to be the first thing that is typed.

Alias Pattern: ^cure
Command: get potion bag;;q potion

Aliases can directly send a command to the game that is specified in the Command:
box in the Aliases editor. Aliases can also execute Lua code! Lua is a scripting
language used by many online games. There is extensive documentation on Lua
available online. For a quick primer on using Lua in Mudlet, check out HELP MUDLET_LUA.

More than one command can be done on any line and separated by two semi-colons.
(;;) Say, if you wanted to walk west then east very very quickly, you could type:
w;;e and hit enter, both W and E commands will be send to the game immediately.

The following alias uses both RegEx and Lua, and is included in the MedUI package
provided by the Medievia Mudlet install. Its purpose is to allow the player to repeat
commands by typing a slash followed by a number, for example /5 c ref me will cast
the refresh spell 5 times. It will also accept a wildcard for example /4 l in #.corpse
will look in 1.corpse, 2.corpse, etc by replacing the # sign with the incrementing
number each time the command is send to the game.

Alias Pattern: ^/(\d+) (.*)
Command: <leave blank>
Code:
for i = 1, matches[2] do
local cmd = string.gsub(matches[3], #, i)
send(cmd)
end

The Alias Pattern uses RegEx to capture both the number of iterations, the (/d+), as well
as the following command, the (.*). The script then loops through the number of iterations
while replacing the # symbols with the index variable i. It then sends the modified
command to the game using the send() Lua function.

Much more information can be found on the Mudlet Wiki page:
https://wiki.mudlet.org/w/Main_Page

As well as their online forums:
https://forums.mudlet.org/index.php

The Mudlet developers maintain a Discord server where you can ask questions in their
help channel and get responses by the many active players and developers!
Google Mudlet Discord to get yourself an invite to the server!

See also:  MUDLET_LUA MUDLET_REGEX