Lich:Software/Mac Installation

Installing the Lich script engine on your Mac OS X Computer

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.

Background

Mac OS X systems for Mavericks (10.9), Yosemite (10.10) and El Capitan (10.11) have some of the elements you need to run Lich already installed. Some elements are missing, and will require you to install components on your system. While most software distributed for Mac OS X comes in the form of an automated install file, Lich is different. Lich will require that you install some components via a Terminal window command prompt. You will also start Lich from the Terminal window.

Note for versions prior to Mavericks (10.9)

Installation instructions for Mac OS X versions prior to 10.9 is more complicated. The best option is to update your OS X version to current.

Steps to Install

There are six steps to getting Lich up and running on your new Mac.

1)  Installing the Avalon client.
2)  Installing the xQuartz windowing system.
3)  Installing the software compiling tools from Apple.
4)  Installing the core software Ruby will use to support gems required for Lich.
5)  Installing the Ruby gems used by Lich.
6)  Testing the game and finalizing the installation.

Depending on the capabilities of your Mac and your network, you should anticipate that this installation process will take between 10 minutes and 30 minutes.

Detailed Installation Instructions

Let's get you set up to use Lich on your Mac system.

First, if you haven't already, download Avalon 4.3.3 (beta) from http://www.play.net/playdotnet/play/avalon-info.asp You'll want to scroll down to the bottom to find the right one. After you've downloaded it, double click on the download to unzip it. Then, I would recommend you drag the application onto your desktop where it can be handy!

Second, let's install xQuartz from http://www.xquartz.org This is the standard DMG style installation, so just open it up and follow along the installation prompts. Don't forget to eject the DMG when finished. You'll be asked to log out and log back in - please do that before continuing (bookmark this post!)

Now we get serious.

Below, you'll find a list of commands that you'll need to enter in Terminal. Terminal is an application on every Mac system that allows you to enter Unix-style commands. If you've never used Terminal before, it is simply a console that you type information (commands) into and the system responds. It is in the Applications / Utilities folder, or you can simply use Spotlight (magnifying glass upper right corner on most Macs) to search for Terminal, and open it.

In Terminal, we're going to type the commands below. It is absolutely ok to copy and paste these commands into Terminal rather than type them in. You only need to copy the bold part. Anything in comment column is to help inform what's going on. Don't copy that portion. Be sure to copy the complete command, though.

Command	Comment
cd	just making sure we're in our home directory
gcc -v	force an install of the Apple Command Line Tools. Follow promots
/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"	copy and paste this whole command - don't just click on the link
brew doctor	this command is just checking the installation of Homebrew - should say 'Ready to Brew'
brew install --build-from-source --with-x11 cairo	this command should take a few minutes to complete
brew install https://raw.githubusercontent.com/Homebrew/homebrew/bb3fe5f2de87f76bc0a3f3480635c8fd0d68cec3/Library/Formula/gtk+.rb	copy and paste this whole command - don't just click on the link
sudo gem install gtk2	when using 'sudo' you'll be prompted for your password to continue
cd	just making sure we're in our home directory
curl -OL http://lichproject.org/download/lich-4.6.33.zip	download the current Lich software
unzip lich-4.6.33.zip	unzip the lich software for use

That is everything we should need to worry about to get into the game with Lich operating.

Running Lich for the First Time

In order to start the game with Lich, from Terminal we'll have to run the following command:

sudo ruby lich/lich.rbw --gemstone --avalon

You will be prompted for your password. Then, you should see in Terminal that Lich is waiting for the game client to connect. Just fire up Avalon, log in and enjoy!

Quick pro tip: The next time you want to play, just open up Terminal and hit your 'up arrow' one time. You should see the sudo ruby line above in your Terminal window. You can just press enter, fire up Avalon and enjoy again!

Final Steps

After confirming everything is working the way you want, don't forget! Open up Terminal and type the following three commands:

brew pin gtk+
brew pin cairo
brew pin pango

Enjoy!

Resources

• Lich scripting reference
• Tillmen's Lich Update (v4.6.33): 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