Lich:Software

The official GemStone IV encyclopedia.
Jump to: navigation, search

Lich:Software is a third party script and is not maintained by Simutronics. Simutronics is not responsible for the accuracy of the information presented on this page, nor is it liable for issues stemming from the use of the application on players' personal devices.

;TUNE TOWNCRIER to join the TownCrier channel and get GS news and tips every five minutes. There is no chat on this channel.

About

The Lich is third-party software that expands scripting capabilities on Simutronics front end clients (The Wizard and Wrayth for Windows users, and Avalon for Mac OS X users), allowing players to script using the Ruby Programming Language, a high-level programming language with almost limitless capability. The program comes bundled with several scripts, such as scripts that calculate a character's redux, move from any location to another within a database, walk through an area until a creature is found, and spell up a character using all available spells. Also, there is a repository that allows for the quick, easy downloading of user-made scripts through The Lich, itself. Scripts can range from being very simple to quite advanced; for example, there is a script, titled xpSF, that modifies the experience window in Wrayth to display additional information about the character's experience level that updates itself when experience is gained.

Installation Guides

What is "Lich"?

Lich is an open source scripting engine for text-based MUDs. It is not a complete front-end in and of itself: it operates much like a proxy server and communicates with the user through their chosen front-end (effectively giving the appearance of expanding the front-end's features with its own). It allows you to write and run scripts for a text-based MUD in the Ruby language.

How Does Lich Function

Lich defaults on Windows to a Lich 5 folder on your desktop. Lich launches by double clicking on the lich.rbw file. Folders are created inside the Lich 5 directory, the primary ones of user interest are the /scripts directory and the /data directory. Scripts contains user downloaded scripts and the Data directory contains information used by lich. The most notable items here are alias.db3 entry.dat lich.db3 which contains all your user information. This file should be backed up often, preferable with something like ;Lich Script:

Lich was originally created by Shaelun, who brought it up from an idea to version 3.57. Starting with version 3.58 through 4.6.56, Lich was maintained by Tillmen. Tillmen's versions focused more heavily on Simutronics games, specifically Gemstone IV. If you are interested in non-Simutronics games, you might be better served with Shaelun's version. Starting with Lich v5, Lich has been forked over by the team at Elanthia-Online to update and continue development in a collaborative format with contributions from both GemstoneIV and DragonRealms contributors. Current installation instructions now use Lich v5.


How do I use it

Lich itself doesn't do much. At it's core, it parses incoming XML from the game and runs it through an engine. Scripts that a user downloads perform a varity of functions with that information.

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. It's not all inclusive but contains a good starter set or some of the most popular scripts in use.

Core Lich components installed with lich

  • 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. Go2 is distributed as part of a default Lich installation.
  • Xnarost - 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. Xnarost is distributed as part of a default Lich installation.
  • Alias - A default script used to create shortcuts in lich. See wiki page for details.
  • Vars - A default script to create and view variables for both users and scripts. See wiki page for details.
  • Autostart - A default script to handle which scripts run on startup. See wiki page for details.
  • Repository - A default script to view and dowload other scripts. See wiki page for details.
  • Version - A default script to output your current lich version and other information. See wiki page for details.

Scripts maintained by Elanthia-online

  • Bigshot - A script for attacking and hunting routines. See wiki page for details.
  • Ewaggle - A script for spelling yourself and others up. See wiki page for details.
  • Ebounty - A script to get and perform bounties. See wiki page for details.
  • Eloot - A looting and loot management script. See wiki page for details.
  • Ecleanse - A script for dealing with status conditions. See wiki page for details.
  • Eherbs - A herb heaing and stocking script. See wiki page for details.
  • Ecure - A script for healing for empaths. Usage syntax is ;ecure setup for first usage.
  • Elogin - A script for command line login for your characters. . Usage syntax is ;elogin <charname>
  • Echild - A child bounty script that monitors for and returns a child during bounty sessions. Add to autostart or your hunting script when performing a bounty.
  • Ledger - A scripting for tracking your silver and bounty incoming across sessios and over time per character and account with a nice ascii discplay. Requires ascii_charts gem (installed by default with Lich 2.7.0+ full installer)

Other scripts that are popular

  • invdb - An inventory management database. See wiki page for details
  • multi - A script to peform repetitive set of commands. Usage syntax is ;multi; <number> <action> such as ;multi 10, get my diamond, drop my diamond
  • ego2 - A script for bounty escorts. Usage syntax is ;ego2 help for relevant commands.
  • spellcaster - Allows user to type just the spell number and have lich cast that spell. Usage syntax is ;Spellcaster setup for configuration. Set to autostart.
  • 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.
  • 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. *Note* Sorter can mess up some other scripts that deal with inventory, so be cautious in usage. Elanthia-Online scripts like eloot disable sorter when performing relevant functions
  • linktothefast - A complex script that provides highliting for Wryath links when links are disabled. This script can cause issues with STOW settings, so disable prior to adjusting those settings.
  • Uberbarv_D - The most current Uberbar variant. This will provide a paperdoll with room number, resource information, etc inside wrayth. Set to autostart. Note- there is a small performance impact when using Uberbars.
  • Jbackup - A excellent backup and recovery tool that allows lich database and any additional file backup a user prefers. Set to autostart.
  • dirty-deeds - A script for getting deeds in IMT and WL. ;dirty-deeds setup for configuration


F.A.Q and Common commands.

Q: Where did my inventory windows go?

A: If you use inventory windows in Wrayth, you’ll find they have disappeared the first time you run Lich on each character. Lich hijacks the setting to provide container contents to scripts. In doing so, it’s unable to tell what the setting was to start with, so it turns it off (from Wrayth’s point of view). Just type “set inv on” to turn it back on.

Q: Why do I keep disconnecting immediately after login?

A: This generally happens on only one character, and affects only Wrayth. It seems to be caused by Wrayth downloading a characters settings from the Simu server. To fix it, change Wrayth to store scripts/highlights/macros/etc locally, or log in once on Wrayth without Lich to allow it to do whatever it’s trying to do.

Q: How come when I cast spells on people it doesn't tell the correct duration for the spell?

A: This is due to not setting permissions correctly with LNet once logged in. In general, most people should be fine with typing: ;LNET ALLOW ALL ALL. This should allow anyone with Lich installed to detect your spell durations. It also allows other things, to see exactly what you can do type ;LNET HELP ingame and read over the output it provides.

Q: How do I enable or disable the various LichID or RealID in room description title?

A: To enable/disable the LichID or RealID you would use one of the following commands in-game:
# LichID
;e Lich.display_lichid = <true|false>

# RealID
;e Lich.display_uid = <true|false>


Resources

Third-Party Software - edit
Lich Installation: Lich
Downloadable Lich Scripts: Go2 | Xnarost | Repository | Popular Scripts