Welcome to Lich - A New Users Guide to GS 4.Lich
After having messed around with lich for several weeks, and having beat my head into the wall a few times wondering what I was doing wrong, I decided to start working on a guide to help new Lich users get familiar with the incredible capabilities that Lich brings to Gemstone IV. If you are reading this guide and are thinking 'Egads! This guy is a newb! He forgot about X!', PM me and I will add it to the appropriate section.
What Is Lich?
By now, if you have Lich, you should have been to the main Lich site. If you have not yet, please go there now and take a quick look around. In short, Lich is a scripting engine that runs alongside your game front end (Wizard FE or Stormfront) and allows for the intercommunication between and execution of complex scripts.
Key Functions of Lich
Lich's incredible script library, known as the Repository, has the capability to extend or automate nearly any task in Gemstone. Some of the most used and useful gameplay enhancing elements are:
- Map Based, Visual, Point-and-Click Movement
- Semi-Automated / Fully Automated Hunting
- Semi-Automated / Fully Automated Guild Skills
- Fully Automated Spell Ups, Resses and Healing
Where to Begin?
First off, download Lich. Follow the download and installation instructions on the Lich download page. You will need: 1) the latest Lich.zip file, 2) the Simutronics Game Entry tool, and 3) a version of the Ruby Interpreter.
The download file is a .zip containing all of the files necessary for running Lich. Extract the Lich zip file and create a shortcute to Lich.rbw if so desired.
Run Lich.rbw to start the Lich Game Entry.
And we're off.
Your First Few Minutes With Lich
When Lich starts for the first time, you will get a text dump. There is a note at the end of the Lich welcome screen noting that Updater is paused. Unpause the updater by entering:
The default prefix for any Lich command is the semi-colon ( ; ), and is used to execute commands.
Use the Help command.
Common Basic Commands
Execute a Script
The ;<scriptname> syntax will start the named script. For example, ;narost will start Narost, the map script. Many scripts will have flags, conditions that can be added to a command. These conditions will change how the script performs. An example of this would be
This runs the script Sloot2 in 'Sell' mode, selling off whatever goods have been specified during a
setup.
Set Up a Complex Script
Code:
;<scriptname> setup
Many scripts on the Repository have a SETUP command that can be run. This will often open a Graphical User Interface window that lets you input information to change how the script functions: specify targets for a hunting script, change what loot gets picked up or what bag it is put in etc.
Stop a Script that is Running
Sometimes, you are in the middle of a script and need to stop it in order to man the controls yourself. To stop any script, use the ;kill <scriptname> command.
Trust a Complex Script to Allow it to Function
Code:
;trust <scriptname>
Many of the more complex (read: useful) scripts do not work without being TRUSTED. A TRUSTED script is allowed to execute any function called for in the script - anything from requesting character information to interacting with game objects (withdrawing money from the bank for you!) to even more arcane functions that run under the hood. If your script is not running, you may need to TRUST it first.
Automatically Run a Script at Startup
Code:
;favs add [global] <scriptname> [variables]
Some scripts, such as the Uberbar that displays most of the relevant character information in one window, are good to run on all characters. Some scripts, such as the Autowar script that automates Warrior Guild tasks, are quite specific. The FAVS command allows you to set scripts that will run whenever Lich starts. Adding the [global] modifier will make the script run across all Lich users started from your Lich files. Finally, [variables] may be set, allowing you to set certain flags within the scripts.
Create Macros and Shortcut Commands
Code:
;alias add [global] <trigger>=<alias>
An Alias is a short-hand command that executes the verbose, or full, command. The TRIGGER is the input command and the ALIAS is the verbose, executed command.
For example, using
Code:
;alias add ll=;sloot2
will execute the script 'Sloot2' (note the ; before the script name necessary to execute a lich script!) whenever the command 'll' is entered on the front end. This is, for all intents and purposes, the same as the MACROS command familiar to StormFront users.
Getting Your First Scripts
Lich can take away most of the tedium and memorization that comes along with playing an archaic, text based game, leaving you only as much work as you find enjoyable. Scripts are found in the REPOSITORY and you may DOWNLOAD them as per your needs.
How to Use the Repository
The repository has four basic commands:
Code:
;repository
;repository download <scriptname>
;repository info <scriptname>
;repository list
The first shows a Help screen and is the root command for all others.
The second, often shortened to ';repo down', lets you download a specified script.
Third, INFO provides information about whatever script is specified. If the author has been kind and thorough, this will tell you how to use the script and if it has any interdependencies.
Fourth, LIST will list all scripts in the repository. The output is daunting.
What to Get
The following are a list of scripts that enhance or extend basic functions of Gemstone IV and can improve or streamline your gaming experience to a point where you can't think of ever going back.
The Must Haves
- Narost - Narost is an active map library that can display your location and allows Point-And-Click travel. Simply right click and choose a map, pick a room on it and click on it. You will begin traveling there post-haste.
- Go2 - Go2 is an intelligent travel script that is synchronized to many of the more complex scripts. Go2 uses a Room Number system and can intelligently plot routes between most any two rooms in all of Elanthia. Use can be as simple as ';go2 town' or ';go2 bank' to head to the nearest town square or bank. Use ';go2 targets' to see a list of pre-programmed locations broken down by towns. Or, use ;go2 save <new location name>=<new location room number> to create your own locations.
- Wander - The last of the Trifector of Travel, ;wander will move from room to room until it runs into a Boundary - a specified room number - or finds a room with a monster AND empty of players. Wander can be used to create a walled in hunting ground, letting you automatically move from room to room without having to use keystrokes. Use the ';wander add' command to add the room you are currently standing in to the Wander List. Note: Wander will NOT enter your boundary rooms. For example, adding Town Square East to the list and then executing ;wander from within the confines of Moot Hall will send your character exploring every room in Moot, but unable to leave as TSE is a Boundary.
- Uberbar - UberBar consolidates wound status, hitpoints, stamina, mana, spirit, exp, mind, stance and encumbrance into one window. It then adds in a handy room number tracker and Exp tracker. A must have.
- Uberspells - Like UberBar, UberSpells is an improvement on the basic StormFront windows. UberSpells itemizes your spells and provides a time remaining on your current Buffs, including some status effects such as Popped Muscles.
- Useherbs - Takes the mystery out of using your herbs. Usage syntax is ';useherbs <container>', where <container> can be any worn container or even the bench in Town Square Central. When it is finished, it will display the herbs needed to fix whatever wounds and scars were unable to be healed. Finally, as if it needed to be more useful, ';useherbs list' will provide a list of herbs itemized by condition.
- Sorter - Sorter cleans up your bags and breaks down the the output of a LOOK command, sorting the results by type. Makes looking in your locker or backpack, and especially your gem pouch, infinitely easier.
- Infomon - While Infomon does not directly improve on any particualr function, many other scripts are dependent upon it, and will not function without Infomon.