Lich:Software

;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 StormFront 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 StormFront to display additional information about the character's experience level that updates itself when experience is gained.

Quick Start & Installation Guides

• Windows
  • Download the Installer. See the guide below.
• Mac
  • Mac OS X
• Linux
  • Chromebook & Debian Variants
  • Fedora Installation - Lich (software)

What is "The 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.

Lich was originally created by Shaelun, who brought it up from an idea to version 3.57. Starting with version 3.58, Lich is maintained by Tillmen. Tillmen's versions focus 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.

The Lich is written to be compatible with other third-party software, such as PsiNet and Black Lightning.

What can Lich do for me?

The Lich program, absent of any scripts, doesn't appear to do much of anything (besides allow you to alias commands in the game). What Lich is doing behind the scenes allows you to use pretty powerful scripts, such as:

• go2: This script makes long and short journeys easy. It is powered by a database of 18,677 rooms with 42,695 known movements connecting those rooms (as of 10-2-2010, for Gemstone IV). Some of those movements include tasks such as navigating mazes, dealing with slippery ice, or waiting in line to use a rope bridge. It includes a large list of common locations in each town, and takes you to the closest one. For example typing ";go2 bank" will take you to whatever bank is closest to you.
• narost: This script pops up a window to show you which room you are in on a map. The script originally used only Tsoran's maps, but since those are becoming increasingly outdated, new maps are being created and added to narost. The script continues to show you what room you are in as you move around, changing maps as needed. It allows you to click on a room to make the go2 script take you there, and some other things.
• infomon: This script is responsible for tracking any useful information that the main Lich program doesn't. The most useful thing it tracks is the spells that are on you, and their remaining time. It also keeps track of other peoples spell ranks that use Lich, to give more accurate spell tracking.
• lnet: This script is a simple chat script that allows you to chat with other people using Lich. It is a great source of help for those new to Lich. It also allows scripts to transfer information to other characters (disabled by default) to allow, for example, a spellup script (waggle) to know exactly how many casts of what spells another character needs.
• repository: This script allows you to upload and download scripts from the Lich server. There are many, many more scripts available for tasks big and small.

In addition to the powerful Ruby scripts, Lich can run most WizardFE/Stormfront scripts unaltered. This allows you to use the scripts you already have, but since Lich is running them, you can have any number of them going at once. However, learning a little Ruby goes a long way. Scripts that take a hundred lines in WizardFE/Stormfront can usually be rewritten as a dozen or so lines in Ruby, and work much better.

What operating systems does it work with?

Starting in version 3.58, Lich is written completely in Ruby. This means it should it should run on any platform that can run the Ruby interpreter. Lich is developed on Linux, but the majority of the user base uses Windows (XP, Vista, Win7, Win8).

NOTICE The Lich Installation page can be found at Lich_(software)/Installation - And the information here will be removed NOTICE

Installation

Please review the Lich_(software)/Installation page. Information below this will be removed in time.

Windows

For Windows 10 / 8 / 7 users on 64-bit systems: you can download the Installer and install everything you need automatically. Always remember to back up existing Lich / Simutronics files.

Install Guide for Lich Version 4.6.58 (as of August 2nd, 2020)

1) Uninstall ALL existing Ruby installations. This includes deleting all existing Ruby folders (they should be located in the root C:\ drive folder).

2) Run the installer. Do NOT restart the computer if prompted (just cancel that message). The install will seem like it isn't doing anything when there's a black box on the screen, but just give it some time. When the installer window itself goes away it's done.

3) Log in and do -> ;repo download-lich <- and then exit the game.

4) Log in and do -> ;repo download repository <- and wait the few seconds for it to finish.

5) Do -> ;repo download-mapdb <- and wait the few seconds for it to finish.

6) In the Lich scripts folder replace your autostart.lic with Athias's autostart.lic (see link just below). This fixes an issue with the repository not checking for updates at startup. This may also introduce an unknown result with go2 and narost on a fresh install so just be aware.

7) Welcome to GemStone IV!

Athias's autostart.lic

Mac OS X

With Mac Catalina, Ruby 2.7 and changes to various gems used to support the game, the old script does not work. For instructions on installing on a Mac, please email doug@play.net .

Chromebook & Debian variants

The following steps should install Lich and Profanity for users of Debian/Chromebooks. Profanity is a terminal-based Front-End that will let you play the game (in lieu of The Wizard or Stormfront).

Update the list of available software and make sure some requirements are installed:

sudo apt-get -y update
sudo apt-get -y install autoconf bison build-essential libssl-dev libyaml-dev libreadline6-dev zlib1g-dev libncurses5-dev libffi-dev libgdbm6 libgdbm-dev libsqlite3-dev unzip

Install rbenv, a Ruby version manager. Add it to the PATH so that it will work outside of its own directory, and set it up to work when you launch the shell (terminal):

git clone https://github.com/rbenv/rbenv.git ~/.rbenv
echo 'export PATH="$HOME/.rbenv/bin:$PATH"' >> ~/.bashrc
echo 'eval "$(rbenv init -)"' >> ~/.bashrc

Run the shell's launch script now to enable those two changes and get rbenv working:

source ~/.bashrc

Download the tools to let rbenv install Ruby on its own, then install Ruby 2.5.1 and set it to be our default version of Ruby system-wide:

git clone https://github.com/rbenv/ruby-build.git ~/.rbenv/plugins/ruby-build
rbenv install 2.5.1 -v
rbenv global 2.5.1

Tell Ruby not to create documentation for its gems (plugins/packages) unless asked, because it takes a long time and they are available online. Then install the dependencies for Lich and Profanity:

echo "gem: --no-document" > ~/.gemrc
gem install sqlite3 gtk2 curses

Install Lich and Profanity:

curl --remote-name https://lichproject.org/download/lich-4.6.49.zip
unzip lich-*.zip
git clone https://github.com/matt-lowe/ProfanityFE.git

Fedora

The following steps have been tested and verified on Fedora 31 Workstation. These instructions assume that you are a user with sudo (wheel group) access.

1. Update The Base Installation:

$ rpm --import /etc/pki/rpm-gpg/RPM-GPG-KEY-fedora-31-x86_64
$ sudo dnf -y update
$ sudo dnf -y install vim git

2. Install required Ruby and Development packages:

$ sudo dnf install -y autoconf bison gcc gdbm gdbm-devel libyaml-devel \
libffi-devel make ncurses-devel openssl-devel readline-devel redhat-rpm-config \
ruby ruby-devel sqlite-devel unzip zlib-devel

3. Perform Ruby Gem Installations:

$ gem install rake
$ gem update
$ gem install sqlite3 gtk2 curses

4. Download Lich:

$ cd ~
$ curl --remote-name https://lichproject.org/download/lich-4.6.52.zip
$ unzip lich-4.6.52.zip

5. Clone Profanity:

$ cd ~

---> For Ondreian's Updated Version (Recommended)
$ git clone https://github.com/ondreian/ProfanityFE.git

---> For Tillmen's Version
$ git clone https://github.com/matt-lowe/ProfanityFE.git

Please refer to the Profanity FE page for initial configuration and additional instructions.

Jinx (;repository alternative)

Jinx is a project that is an alternative form of script installation from the default ;repository. It can serve up scripts for download similar to the ;repo however it is not dependent on a single server that may be prone to outages. Any one can set up their own script library, and then users can add it as a source for the ;jinx script to search and download from.

Jinx can be downloaded and installed into your scripts folder from the Elanthia Online github:

https://raw.githubusercontent.com/elanthia-online/scripts/master/scripts/jinx.lic

Right-click the above link and save it into the scripts folder in your lich directory.

Alternatively, the following command can be issued in game via lich to attempt to download the script to the proper directory for you:

;e require 'open-uri';begin;jinx_remote = open("https://raw.githubusercontent.com/elanthia-online/scripts/master/scripts/jinx.lic"); jinx_local = File.open(File.join(SCRIPT_DIR, 'jinx.lic'), "wb"); jinx_local.write(jinx_remote.read);ensure; jinx_remote.close(); jinx_local.close();end

once installed you can issue:

;jinx help

for basic usage information.

F.A.Q.

Q: Where did my inventory windows go?

A: If you use inventory windows in Stormfront, 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 Stormfront’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 Stormfront. It seems to be caused by Stormfront downloading a characters settings from the Simu server. To fix it, change Stormfront to store scripts/highlights/macros/etc locally, or log in once on Stormfront 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.

GTK3 Beta Test

The GTK3 Beta Test period is over, and has been released to the public for general use. Please see the Lich_(software)/Installation page.

Resources

• Lich scripting reference
• Mac Installation - Lich (software)
• Tillmen's Lich Update (v4.6.37): https://lichproject.org/
• Playershops by Lich: https://ps.lichproject.org/
• Unofficial Support for Lich: http://forum.gsplayers.com/forumdisplay.php?f=104
• Popular Lich script thread: http://forum.gsplayers.com/showthread.php?81229-What-Lich-Scripts-Do-You-Regularly-Use
• Fix F2P login: http://forum.gsplayers.com/showthread.php?94776-Getting-Lich-to-work-with-F2P-accounts