Page 1 of 1

zMUD Tutorials

Posted: Thu Dec 14, 2017 4:25 pm
by Taziar
zMUD Tutorials

Table of Contents
Tutorial #1: Install zMUD
Tutorial #2: Setup Characters in zMUD
Tutorial #3: Configure zMUD for WoTMUD
Tutorial #4: Install and Configure WoTwiki zMap
Tutorial #5: Install House of Medakan Scripts

Re: zMUD Tutorials

Posted: Thu Dec 14, 2017 4:26 pm
by Taziar
Tutorial 1: Install zMUD

Download and run zMUD 7.21 from zuggsoft.com (link provided here)

Image
Click Next.

Image
Read the license terms and click accept.

Image
Click on any of the 4 options to deselect it from the install process.
The eLicense Upgrade files are only necessary if upgrading from an old version (pre 7.21) of zMUD.
If this is a fresh install you can deselect eLicense files.

Image
It is not suggested to save zMUD in the program Files folder in modern windows as this can cause issues.
Change the file location to another location of your choice.
zMUD can be run from a thumb drive, but you will still need admin rights on any computer that runs zMUD as it saves information for plugins and copy protection in the Windows Registry.

Image
I generally save to my desktop in a folder called zMUD for easy access.
You will need to access this folder in the next steps of the tutorial.

Image
Deselect the option to run zMUD and then click finish, we will want to make some adjustments to zMUD.exe properties before we run zMUD for the first time.

Image
Navigate to the folder that you saved zMUD in.
To clean somethings up I delete the 4 folders at the top, Nodeka, Retomud, Sample, and ShatteredKingdoms since I do not use them.
Now, right click on zMUD.exe (Zmud application) and click properties.

Image
Click the tab at the top titled Compatibility.

Image
Select "Run this program in compatibility mode for" and select Windows Service pack 2.
Select "Run this program as an administrator"
Click apply, and then click OK.
You can now right click on zMUD.exe (Zmud application) and select send to desktop as shortcut, or just double click on zMUD.exe to run the program for the first time.
zMUD comes with a free 30 day evaluation and you can purchase the program from the Zuggsoft Store at anytime.

Re: zMUD Tutorials

Posted: Thu Dec 14, 2017 8:53 pm
by Taziar
Tutorial 2: Setup zMUD for WoTMUD

Image
This is the opening character screen.
The first thing I do with a new install is delete all of the icons in the character screen.

Image
Once all deleted click New to begin.

Image
Type game.wotmud.org into the Host text box and set Port to 2224.
Click Save.

Image
Select game.wotmud.org and click Edit, or right click on the game.wotmud icon and select properties.

Image
Select the MUD tab in the current character window.

Image
In the Title box type WoTMUD.
In the Icon Caption box type your character's name. Also place the name of your character in the Session ID field.
Click the lock next to the Icon Caption box or zMUD will change the caption icon name. (so the lock looks closed, it is a toggle)
Click save. (after changing anything, before changing tabs)
Open the character properties again and navigate back to the MUD tab.
Next to the port number on the right there is a square box, click it.

Image
Chose an icon from the list, download zMUD Icons, or create your own.
Icons should be 32x32 pixels and in bitmap format for zMUD to recognize them.
The zMUD Icons linked here are used in the following example.
Click import.

Image
Select the icon you wish to import.

Image
Once imported the icon will be placed at the end of the list and remain in the icon list for any character to choose.
Select the icon and click OK.

Image
Now your character icon will have its own name and selected icon.
Select the character icon and click connect, or double click the icon to connect.

Image
Once connected type in character and password.

Image
Once logged in to WoTMUD the auto-login wizard will verify your character's name and password.
Note: creating a new character can confuse the auto-login wizard, you may have to improvise to get it to work with brand new characters.

Image
The saved name and password can be found under the Character tab in the icon properties.


To add more characters right click the character icon in the Character window and click copy.
Right click in a blank spot in the character screen and select paste.
Change the Icon name under the MUD tab like you did originally for your first character. Copies create a session ID and fill the session ID box automatically, once the name is changed to the new character name this box can be set back to blank.
Select the Character tab and change the Name and Password to match the new character's information.
Double check that both character's information is correct.

Each character should have their own icon to connect to the mud with.

Image
Once you have connected for the first time zMUD will save a folder for mud files in the same directory as your zMUD.exe file.

Image
zMUD will use whatever name you placed in the Title box to create that folder and the settings file inside of it.

The next tutorial will show how to configure your zMUD preferences.

Re: zMUD Tutorials

Posted: Fri Dec 15, 2017 12:42 am
by Taziar
Tutorial 3: Configure zMUD for WoTMUD

Link to ZMUD help files regarding preferences: https://www.zuggsoft.com/zmud/help6/Preferen.htm

The following tutorial is how I setup my preferences for zMUD for use on WoTMUD.
Any options that I do not change I have omitted from including a screen shot of that preference settings window.
Place mouse over settings to receive a brief summary of the setting at the bottom of the Preferences window.

Click the large Prefs button on the main toolbar to open the preferences window.

Image
Click User Interface on the folder tree to the left of the window.
Changes: Refresh Amount, prompt for save, help balloons. (refresh amount I use is 0)
Refresh amount 0 is choppy but fastest, 1 is smoothest but slowest, and 5 being a decent inbetween.

Image
Changes: Save scrollback buffer to log when opened.

Image
This is the default Color Schemes window.
To change color schemes select the Scheme selector on the right side of the window.
Scheme options: VT100, ANSI, Windows, and User-defined.

Image
My User-defined scheme looks like this.
To change a color click the color boxes to the right of the Sample MUD Output box.

Image
This is the default Foreground Mapping setting.
The top row are the normal colors, while the bottom row are the highlight colors.
Note: Changing the zMUD info messages color in the previous window will change #11.

Image
The above Foreground Mapping is how I set my colors for playing WoTMUD.
Click a color box to change colors, select from standard zMUD list of available colors.
For scripting with color names they remain the same regardless of foreground mapping changes.

The following number map is how zMUD matches to WoTMUD's native color mapping.
#0 Basic text color (room descriptions, ect...)
#1 not used.
#2 Object on ground color when using look command or entering a room, and your melee hit opponent color.
#3 Room names, Immortal messages, and Lightside cross race color
#4 Received tells color, received melee hit color, and Darkside cross race color.
#5 Seanchan cross race color
#6 Mob color when entering a room or using the look and scan commands.
#7 not used.

Image
Deselect Check for updates as zMUD is no longer being developed or updated.
It is important to turn off (deselect) auto reconnect when playing WoTMUD.
Repeated connection attempts could receive a firewall ban for too many connections withing a certain time period.

Image
Here you select the font type and size that fits you and your screen best.
I change both Output and Command line windows fonts.
Vertical space adjust greater than -2 will cutoff parts of the text.

Image
Memory defaults at 1000 lines and can be set at a maximum of 65000.

Image
Tick Timer message interval default is 5 seconds, I prefer 3 seconds.
Deselect Display tick message to turn this feature off.

Image
Windows options set to my preferences.

Re: zMUD Tutorials

Posted: Fri Dec 15, 2017 3:37 pm
by Taziar
Tutorial 4: Install and Configure WoTwiki zMap

While this tutorial uses the WoTwiki zMap specifically, this tutorial will work for any .mdb zMap file.
Direct Download Link: WoTwiki zMap 1.1


Take your map file and place it into the settings folder that zMUD created inside of the directory containing zMUD.exe
In Tutorial #2 it was created as WoTMUD because of the name placed inside of the Title box.
After placing the map file in it's correct location connect to the mud with any character.


Image
Find the Map button on the main toolbar above and click it to open the map utility.

Image
Since zMUD has never opened a map before it will create a default map file named after the settings folder created in Tutorial #2.
Click the file toolbar at the top left of the map window, then click open.

Image
Select the map file you wish to load from the list provided, windows should automatically open the settings folder.
In the example above we see 2 .mdb files, the new file titled WoTMUD and WoTwiki zMap 1.0

Image
After successfully loading the map you need to configure it to WoTMUD.
Select Config on the toolbar and click on New Configuration.

Image
Follow the instructions.
Narrates, chats, or combat can interrupt the process.
If this happens just begin the configuration process over.

Image
Leave all three options selected.

Image
Double check the colored text in the MUD Output window.
Click finish if colors correctly match the legend.
Once finished click the Config toolbar once again and select Configure Settings.

Image
Deselect Match Room Name at Start of line and select match end of line.
Select Room Name uses Proper-case.
Now on the folder tree to the left select Room Exits.

Image
Set Exits Start Line to 1 (helps brief mode)
Deselect Multiline exits.
Select Exit line contains key.
Enter obvious exits: into the Exit line keyword text box.
Now on the folder tree to the left select MUD Prompt.

Image
Remove the * from Prompt char.
Copy and paste ^{o|*} * > into the Prompt trigger pattern.
Deselect PERL Regular Expression.
Deselect Allow blank line to trigger speedwalking as prompt.
Now on the folder tree to the left select Speedwalking.

Image
Select Match Room Name in the Automatic step confirmation box.
Select Center Map after every movement.
Close the map properties window.

Image
Type the command #FIND into the command line and press enter.

Image
The blue location dot should be moved to your current room.

The map is now installed and configured.
You will need to download and install mapping scripts to have the map follow you around the map with minimum errors.
The next tutorial will show how to find and download scripts for zMUD.

Re: zMUD Tutorials

Posted: Sat Dec 16, 2017 12:44 am
by Taziar
Tutorial 5: Install House of Medakan Scripts

Find a script to install from the House of Medakan Script post located here in the zMUD section of the Archives forums. For the purpose of this tutorial we will use the Characters scripts.

House of Medakan Characters Script

Their are two ways provided to access HoM scripts either:

Image
Download the CharactersHoM.txt file from the direct download link, open the file in your favorite text editor, select all, then copy it to your clipboard.

-OR-

Image
Highlight the script text provided in the code box, right click and select copy.

Now either in offline mode or while connected to the mud select the command line, and press ctrl-v to paste the script into the command line.

Image
If the cursor flashes at the end of the last line of the script it is ready to install, press enter.

If the cursor is located a few spaces to the left of the end of the line an error has occurred. Sometimes turning off wordwrap in the command line will fix this error. To do this: delete the script from the command line, open the preferences via the Prefs button on the main toolbar like shown in Tutorial 3. Select the command line option in the folder tree on the left. Deselect Wordwrap command line. Return to the command line and paste the script again. With wordwrap off only the last line of the script will be shown in the command line. If the cursor is now in the correct position at the end of the script press enter. If the script is still failing to load into the command line properly further troubleshooting will be necessary.

If you are connected to the mud, after installing immediately select file in the top left corner, and then select reconnect. Most HoM scripts need to have a fresh connection to the mud after installation to initialize properly.

Once the script is installed you can open the settings window to view the installed script folder.

Image
Double click the Character folder to see the contents inside.

Image
Inside the Characters folder you will need to change the default #KEYS to suit your game play style. Each alias and macro located in this folder will be enabled for all characters. A folder will be created for each character each time you connect to the mud with a new character.

Image
Each character folder is where you place character specific macros and alias.
These character folders automatically enable and disable on connection to the mud.
Alias and macros placed in individual character folders will only be enabled for that character.