Lich:Software/Installation/macOS: Difference between revisions

The official GemStone IV encyclopedia.
< Lich:Software‎ | Installation
Jump to navigation Jump to search
(Restructure Mac guide as numbered steps; front ends moved to Lich:Software/Front ends; add Parallels)
 
(45 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{3rd-party}}
==Installing the Lich script engine on your Mac OS X Computer==
{{Lich install nav}}
There are two ways to play GemStone IV with Lich on a Mac:
* '''Native''' (this guide): Lich runs directly on macOS with [[Saga]], the official front end (in beta), or [[Avalon]]. You will need to use the Terminal app a little; no prior experience is required.
* '''Windows in Parallels''': run Windows in a virtual machine and use the Windows front ends ([[Wrayth]] or [[Wizard (front end)|The Wizard]]). See [[#Windows_in_Parallels|Windows in Parallels]] below.


The native install takes 60 to 90 minutes, depending on how many prerequisites you already have. If you get stuck or see errors, contact Doug (doug@play.net or Doug#6198 on Discord), or ask in the [https://discord.gg/KF9Wr8u GemStone IV Discord].
{{equation box|'''No longer viable due to change in GTK with Homebrew''' - '''FIXED (sort of)'''
User Jahadeem left a note about GTK failing. Our friends at Homebrew strike again. I have a workaround in place both in the instructions below and in the installer. I'll address this more permanently in the coming months, but for now OSX-Lich is BACK IN BUSINESS! [[User:DOUG|DOUG]] ([[User talk:DOUG|talk]]) 22:57, 10 June 2018 (CDT)}}


This guide changes settings for the tools it installs (Homebrew, rbenv and Ruby). Decide whether that is safe for your Mac before you start. If you have never heard of these tools, you are probably not using them for anything else, but proceed at your own risk.


{{blue|These instructions are for GemStone IV. DragonRealms players: see the [https://elanthipedia.play.net/Lich_script_repository#Setup_and_Installation DragonRealms Lich setup guide] on Elanthipedia.}}
{{equation box|'''An important note to users who updated to High Sierra (Mac OS X 10.13)''' - Apple has changed the default version of Ruby in its core software release. The version of Ruby distributed with Mac OS X 10.13 (High Sierra) is version 2.3.x, which does not work with the current Lich implementation. If you have had Lich installed in a prior version of Mac OS X (10.12 or earlier) and it was working, but you are now getting errors about SAFE variables, you are affected by this change. More detail will be provided when available as we work through these issues. If you have not installed Lich yet, the instructions below will work for you.


* '''Already have Lich?''' See [[Lich:Software/Installation/Upgrading|Upgrading Lich]] instead.
For those who desire immediate assistance, email doug@play.net for current information. When the entire solution is in place and known to be working, instructions will be provided below and this note will be removed.
<span id="Before_You_Start"></span><span id="The_Process"></span>


==Step 1: Install Homebrew==
[[User:DOUG|DOUG]] ([[User talk:DOUG|talk]]) 19:44, 9 October 2017 (CDT)}}
[https://brew.sh Homebrew] installs the software Lich needs. (You will install your front end, such as Saga, at the end of this guide.)
# Install Homebrew by following the instructions on the [https://brew.sh Homebrew site]. You will be asked for your password at least once.
# Homebrew also installs Apple's Command Line Tools. Accept the Apple license when asked.
# When Homebrew has finished, run this command in the Terminal app: <code>brew doctor</code>


It should reply <code>Your system is ready to brew.</code> If you get any other result, ask for help before you continue.
{{#lst:Lich_(software)|About}}


==Step 2: Install the required packages==
==Background==
Apple's own Ruby does not work well with Lich, so we install a newer one with '''rbenv''', a Ruby version manager, plus the graphics libraries Lich's login window uses. Enter these commands in Terminal one at a time, pressing Enter after each. Let each one finish before you enter the next.
# <code>brew install gtk+3</code>
# <code>brew install gobject-introspection</code>
# <code>brew install rbenv</code>
# <code>brew install adwaita-icon-theme</code>
# <code>brew install openssl@3</code>
# <code>brew upgrade ca-certificates</code>


==Step 3: Set up your shell==
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_(software)|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.
Now set up your Terminal so it can use these packages. First check which shell you have:


<code>echo $SHELL</code>
==Note for versions prior to Mavericks (10.9)==


* If Terminal shows <code>/bin/zsh</code> (the default on current macOS), run:<p><code>echo 'eval "$(rbenv init -)"' >> ~/.zshrc</code></p><p><code>echo 'if [ -z $DISPLAY ]; then export DISPLAY=:0.0; fi' >> ~/.zshrc</code></p><p><code>source ~/.zshrc</code></p>
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.
* If Terminal shows <code>/bin/bash</code>, run:<p><code>echo 'eval "$(rbenv init -)"' >> ~/.bash_profile</code></p><p><code>echo 'if [ -z $DISPLAY ]; then export DISPLAY=:0.0; fi' >> ~/.bash_profile</code></p><p><code>source ~/.bash_profile</code></p>


Check that rbenv works:
==Steps to Install==


<code>rbenv versions</code>
Before you begin, it may be a good idea to download and run the 3rd party provided lich diagnostics script. This script is written to run on your Mac no matter how much, or how little of the required components you have installed. It can be useful to create a reference snapshot before you begin installing, and again after. Just run the script again, it will simply add on to your existing diagnostics file, so you have a before and after picture.


It should print one line that looks like <code>* system</code>. If it does, continue. If not, ask for help.
To run this script, download the [http://bit.ly/GSLichDiag file] and then:


==Step 4: Install Ruby {{Lich version|ruby}}==
1) Open up your Terminal window (you can use Spotlight to search for Terminal, then open the application)
Enter these commands one at a time. The first one takes several minutes.
2) In your terminal window enter the following commands:
# <code>rbenv install {{Lich version|ruby}}</code>
cd
# <code>rbenv global {{Lich version|ruby}}</code>
chmod 744 ./Downloads/lichdiag.sh
# <code>ruby -v</code>
./Downloads/lichdiag.sh
3) The output in Terminal will tell you what you have and don't have.


The last command shows which Ruby is active. It should start with '''<code>ruby {{Lich version|ruby}}</code>''', for example <code>ruby {{Lich version|ruby}} (…) +PRISM [arm64-darwin25]</code>.
There are six steps to getting Lich up and running on your new Mac.


If it shows anything else, for example <code>ruby 2.6.10p210 (2022-04-12 revision 67958) [universal.arm64e-darwin22]</code>, close Terminal, open it again and run <code>ruby -v</code> once more. If it still does not start with <code>ruby {{Lich version|ruby}}</code>, ask for help.
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.


==Step 5: Download Lich==
# Download the [https://github.com/elanthia-online/lich-5/releases/latest/download/lich-5.zip Lich5 files]. (Windows, Mac and Linux all use the same files.)
# Unzip the file in your Downloads folder. This creates a folder called '''Lich5'''.
# Drag the '''Lich5''' folder (the folder, not the zip file) to your Desktop.


==Step 6: Install the gems Lich needs==
Depending on the capabilities of your Mac and your network, you should anticipate that this installation process will take between 15 minutes and 45 minutes for most Macbook Pros and MacPros.
Lich lists the gems (Ruby add-on libraries) it needs in a file named <code>Gemfile</code>, and '''Bundler''' installs exactly that set. The Gemfile also lists some gems only Lich's developers need (the <code>development</code> and <code>vscode</code> groups), so we tell Bundler to skip them. Enter these commands one at a time:
# <code>cd ~/Desktop/Lich5</code>
# <code>bundle config set --local without 'development vscode'</code>
# <code>bundle install</code>


<code>bundle install</code> can take several minutes; building the GTK gems is the slow part. When it finishes you should see a line beginning with <code>Bundle complete!</code>. If you see an error instead, ask for help.
==Detailed Installation Instructions==


:<small>Older guides use <code>bundle install --without development vscode</code>. That option was removed from the Bundler that comes with Ruby {{Lich version|ruby-series}}, so use the <code>bundle config set</code> command above instead.</small>
Let's get you set up to use Lich on your Mac system. You have two choices in how you can install Lich on your Mac OS X system. You can download a 3rd party installer file and let it do most of the work for you, or you can manually install the necessary components. The 3rd party installer file is not supported by Simutronics. '''NOTE:''' when running the installer file, you will be asked for your password twice - once to install Homebrew, and once to install xQuartz. This should happen within the first 5 to 10 minutes of the install. Thereafter the script should run without any further interaction required.


'''Quick test:'''
''Note: For most current Mac systems, the install script will take about 20 to 30 minutes to complete if it has to install everything.''
# Start the Ruby shell (the prompt will change): <code>irb</code>
# Check the first gem: <code>require 'sqlite3'</code> &mdash; it should reply <code>true</code>.
# Check the second gem: <code>require 'gtk3'</code> &mdash; this should also reply <code>true</code>. It might take a second or two.
# Return to the normal prompt: <code>exit</code>


If both replied <code>true</code>, the hard part is done.
'''To install via the 3rd party script osxlich.sh''':


==Step 7: Start Lich==
{|{{prettytable}}
To start Lich on its own, run this command in Terminal:
|'''Command''' || '''Comment'''
|-
|'''[http://bit.ly/GSLichDiag Download the diagnostic file]''' || You should run this before and after the installation to get a snapshot of your system to troubleshoot from.
|-
|'''[http://bit.ly/GSLichInstall Download the installer file]''' || After you've run the diagnostics, you'll run this program to install what you need.
|-
|'''Open the Terminal Application''' || You can find Terminal by using Spotlight.
|-
|'''cd''' || type (or copy / paste this and the following commands into your Terminal window.
|-
|'''chmod 744 ./Downloads/lichdiag.sh''' || make the diagnostic file executable only by you.
|-
|'''chmod 744 ./Downloads/osxlich.sh''' || make the installer program executable only by you.
|-
|'''./Downloads/lichdiag.sh''' || run the diagnostics program. It will create a text file on your desktop for reference.
|-
|'''./Downloads/osxlich.sh''' || run the installer program. You will be asked for your password twice during the install.
|-
|'''./Downloads/lichdiag.sh''' || after the installer completes, run the diagnostics again.
|-
|'''You are now ready to play''' || scroll down to the section on Running Lich for the First Time.
|}


<code>ruby ~/Desktop/Lich5/lich.rbw</code>
'''If you would rather manually install the required components:'''


After a few seconds the Lich login window opens. The first time Lich connects to the game, it downloads its map database and images, and you will see some Lich text in the game window, including a repository error. The error is normal.
First, if you haven't already, download Avalon 4.3.3 (beta) from http://www.play.net/playdotnet/play/avalon-info.asp
<span id="Starting_Lich"></span>
''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!


==Step 8: Set up a front end==
Now we get serious.
Follow the setup for your front end on the [[Lich:Software/Front ends|Front ends]] page:
* [[Lich:Software/Front ends#Saga|Saga]] (recommended): the official front end. Saga can start Lich for you. When Saga asks for your Lich folder, use <code>~/Desktop/Lich5</code>.
* [[Lich:Software/Front ends#Avalon|Avalon]]: the older official Mac front end.
* [[Lich:Software/Front ends#Warlock|Warlock]] or [[Lich:Software/Front ends#Profanity|Profanity]]: third-party front ends.
<span id="Front_Ends"></span><span id="Saga_(recommended)"></span><span id="Saga_.28recommended.29"></span><span id="Avalon"></span><span id="Other_Front_Ends"></span>


==Windows in Parallels==
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.
<span id="Parallels_Windows"></span>
The Ruby4Lich5 installer works in Windows running under [https://www.parallels.com/ Parallels] on both Intel and Apple Silicon Macs. That lets you use the Windows-only front ends, [[Wrayth]] and [[Wizard (front end)|The Wizard]].
# Inside Windows, install Wrayth or The Wizard and check that you can log in '''without''' Lich.
# Follow the [[Lich:Software/Installation/Windows|Windows installation]] guide inside Windows, keeping the default installer options.
# Start Lich by double-clicking '''lich.rbw''' in the Lich5 folder, then log in and play as usual.


'''If Wrayth scripts do not run''' on an Apple Silicon Mac: the <code>rubyw</code> file in <code>C:\Ruby4Lich5\X.X.X\bin</code> may be set to run in compatibility mode for Windows 7. Right-click it, choose '''Properties &rarr; Compatibility''', and turn compatibility mode off.
In Terminal, you're going to type (or copy / paste) 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.

{|{{prettytable}}
|'''Command''' || '''Comment'''
|-
|'''cd''' || just making sure we're in our home directory
|-
|'''/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. You'll be asked for your password here.
|-
|'''brew install Caskroom/cask/xquartz''' || Install xQuartz. This might ask you for your password again.
|-
|'''brew install rbenv''' || this command will install the rbenv manager to manage ruby versions
|-
|'''rbenv init''' || Initialize the environment
|-
|-'''echo 'export PATH="$HOME/.rbenv/bin:$PATH"' >> ~/.bash_profile''' || set up the environment to 'see' rbenv
|-
|'''echo 'eval "$(rbenv init -)"' >> ~/.bash_profile''' || make sure this works every time we open terminal
|-
|'''exit''' || log out of the terminal window
|-
|'''From the Terminal > Shell menu, open a new window''' || If you need to, you can use Spotlight to search for Terminal
|-
|'''brew install sethrfore/r-srf/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
|-
|'''rbenv install 2.2.5''' || Install Ruby version 2.2.5
|-
|'''rbenv global 2.2.5''' || Set 2.2.5 as the Ruby the system will use
|-
|'''rbenv rehash''' || Setting up to install the gems needed
|-
|'''gem install sqlite3''' || Install the database Lich uses This command may fail on some systems complaining that it is already installed. That's ok.
|-
|'''gem install gtk2 -v 3.1.8''' || Install the graphics interface Lich uses for advanced scripts like narost
|-
|'''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==

As of Lich v4.6.49 you can now run without sudo and without specifying Avalon:

ruby lich/lich.rbw

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!

==A Few Quick Pro Tips==

If you've read this far, you're going to benefit!

'''caffeinate -di [command]'''

Sometimes your Mac will want to go to sleep, and will disrupt your processes - even sometimes causing the dread 'SEGFAULT' that reboots your Mac with cryptic information that no one really can use (despite claims to the contrary). If you use the 'caffeinate' command in Terminal, your Mac will not sleep ( [d]isplay or computer [i]dle ) until the command completes. Suggested usage might be 'caffeinate -di ./osxinstall.sh' as one (very pertinent) example.

'''Install Wine'''

Took the plunge from a Windows PC to Mac OS X, but not quite ready to give up on your Stormfront or Wizard (my personal fav) yet? Great news! You don't have to. While Avalon is a tried and tested Mac front end, let's face it - the PC crowd presently has the better collection of front ends. So, how do you make this magic all happen? Just follow these instructions (wine installs are as long or longer than the core OS X Lich installs, so make sure you have time!) And now might just be a good time to test 'caffeinate' on that first command - it takes a while and might abort if the machine tries to sleep.

{|{{prettytable}}
|'''Command''' || '''Explanation'''
|-
|'''Open Terminal''' || Yes, we love this application to do heavy work!
|-
|'''cd''' || Always a good idea anytime you're not sure exactly where you are (which folder) on your Mac
|-
|'''caffeinate -di brew install wine''' || This will take a bit of time to complete, so we'll pour in some caffeine.
|-
|'''curl -OL http://www.play.net/software/lnchInst.exe''' || Don't just click the link, copy (or type) the entire command.
|-
|'''wine lnchInst.exe''' || You might see a few errors / warnings, but it'll work as of 8/2016
|-
|'''ruby ./lich/lich.rbw''' || Note! No SUDO (yay!) and no specifying --gemstone --avalon. Simple.
|}

''Troubleshooting - you may get this strange error message: "concat': no implicit conversion of Errno::EACCES into String (TypeError)" . If you've used Avalon and Lich previously (in particular, using 'sudo ruby' as the instructions say), then we have one step we need to take to remove this error. Don't worry, it is an expected outcome of using sudo with lich, and can be fixed with one line.''

{|{{prettytable}}
|'''Command''' || '''Explanation'''
|-
|'''cd''' || Absolutely ensure we're in the right directory
|-
|'''sudo chown -R $(whoami):staff ./lich''' || change ownership of all content in the lich directory to your username
|-
|'''ruby ./lich/lich.rbw''' || continue on with the login
|}

At this point, you'll see the Lich login window - just type in your account information, select your character, and then '''look at the two radio buttons'''. One of them is Wizard, and the other Stormfront. Select your preference, and click PLAY. Your front end will be downloaded and you'll be guided to install (please just select the default locations - wine knows what it's doing).

''Caution - sometimes wine takes a bit of time 'searching' for a previous installation of a file, especially the Wizard. No panic, let the process complete. Then you may not connect, especially the Wizard, the first time. No worries - wait it out and close up Terminal, then start Terminal again, and re-enter the command. You'll get in the second time.''

''Note: Stormfront is a very nice looking front end, but it has a memory leak in it. This situation is really exacerbated on a Mac / wine installation. You'll notice the front end start to get sluggish. When it does - simply move someplace safe, log out, and log back in. Voilà!''

'''Use those config files!'''

If you've been playing for a while, you'll have a couple of challenges to overcome - migrating any non-lich scripts you may have, and migrating your existing highlights, macros and other settings. The process is slightly different for each front end, but in general:

Wine installs all Windows programs under the user directory at the following path:

~/.wine/drive_c/Program\ Files

So our Simutronics front ends are stored at

~/.wine/drive_c/Program\ Files/SIMU/STORM

~/.wine/drive_c/Program\ Files/SIMU/WIZARD

To move your existing Stormfront configuration, take these steps:

1) Check to see if your scripts and such are saved on the server. If they are - confirm they're available to you
2) If they're not, on your old system with Stormfront - click on the Options button, then select SETTINGS and EXPORT
3) This will create an XML file. Copy this file over to your Mac (desktop is fine if you wish)
4) Start the game on your Mac with Lich and Stormfront, and then on that system, click Options > SETTINGS and IMPORT
5) Confirm your settings / highlights / scripts are available to you.

To move over your existing Wizard configuration (it's a bit harder), take these steps:

1) On your old system, copy the directory under Wizard called Gemstone
2) On your new Mac you'll need to use Terminal to put them in the right place
3) On your new Mac, you need to have the Wizard front end (via wine) already installed
4) Put the Gemstone folder on your desktop
5) In Terminal, type in
cd
cp -R ./Desktop/Gemstone ./.wine/drive_c/Program\ Files/SIMU/WIZARD/
6) Log into the game and see if your files made the transfer


'''Don't forget, Terminal remembers your command history'''

Just like in the game front ends, if you want to repeat a command that you've already typed in, you can simply hit the UP ARROW on your keyboard, and scroll backwards to find the command. If you go too far, DOWN ARROW will scroll you forwards. Admittedly, this is most advantageous when you're getting ready to play, and you hit UP ARROW to get your 'ruby ./lich/lich.rbw' command back.

From time to time, contributors may make changes / modifications to these tips (and the article in general), so bookmark this page, and check it periodically to see what's new and exciting!

'''If you're lazy, like a good Unix admin, use AUTOCOMPLETE in your Terminal window'''

Your Terminal window in Mac OS X will allow you to zip through long filenames and directory paths, if you use the TAB key (autocomplete). For example, in the Wizard instructions above, you can simply type in the following (and hit the TAB key where the field has [T]ab

5) cp -R ./Desk[T]ab/Gem[T]ab ./.wine/driv[T]ab/Prog[T]ab/SIMU/WIZ[T]ab

Autocomplete makes things much easier, and much less error prone! This will work if the file or directory already exists. If you hit TAB and it doesn't autocomplete, the capitalization is off - Unix is case sensitive!


==Resources==
==Resources==
* [[Lich:Software]]: what Lich is, FAQ and common commands
* [http://bit.ly/GSLichDiag OS X Lich Diagnostics] 3rd party, not supported by Simutronics
* [[Lich:Software/Scripting reference|Lich scripting reference]]
* [http://bit.ly/GSLichInstall OS X Lich Installation Script] 3rd party, not supported by Simutronics
* [[Lich:Script Repository#Popular_Lich_Scripts|Popular Lich scripts]]
* [[Lich scripting reference]]
* [https://discord.gg/KF9Wr8u GemStone IV Discord]: #scripting channel for Lich help
* 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


{{Third-Party Software}}
{{Third-Party Software}}
[[Category:Third-Party Software]]
[[Category:New Player]]

Latest revision as of 11:39, 14 November 2026

Lich:Software/Installation/macOS 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.

Lich installation guides — current release: Lich 5.24.2 (Ruby 4.0.9)
Start here · Windows · macOS · Linux · Upgrading · Front ends · Changelog · About Lich

There are two ways to play GemStone IV with Lich on a Mac:

  • Native (this guide): Lich runs directly on macOS with Saga, the official front end (in beta), or Avalon. You will need to use the Terminal app a little; no prior experience is required.
  • Windows in Parallels: run Windows in a virtual machine and use the Windows front ends (Wrayth or The Wizard). See Windows in Parallels below.

The native install takes 60 to 90 minutes, depending on how many prerequisites you already have. If you get stuck or see errors, contact Doug (doug@play.net or Doug#6198 on Discord), or ask in the GemStone IV Discord.

This guide changes settings for the tools it installs (Homebrew, rbenv and Ruby). Decide whether that is safe for your Mac before you start. If you have never heard of these tools, you are probably not using them for anything else, but proceed at your own risk.

These instructions are for GemStone IV. DragonRealms players: see the DragonRealms Lich setup guide on Elanthipedia.

Step 1: Install Homebrew

Homebrew installs the software Lich needs. (You will install your front end, such as Saga, at the end of this guide.)

  1. Install Homebrew by following the instructions on the Homebrew site. You will be asked for your password at least once.
  2. Homebrew also installs Apple's Command Line Tools. Accept the Apple license when asked.
  3. When Homebrew has finished, run this command in the Terminal app: brew doctor

It should reply Your system is ready to brew. If you get any other result, ask for help before you continue.

Step 2: Install the required packages

Apple's own Ruby does not work well with Lich, so we install a newer one with rbenv, a Ruby version manager, plus the graphics libraries Lich's login window uses. Enter these commands in Terminal one at a time, pressing Enter after each. Let each one finish before you enter the next.

  1. brew install gtk+3
  2. brew install gobject-introspection
  3. brew install rbenv
  4. brew install adwaita-icon-theme
  5. brew install openssl@3
  6. brew upgrade ca-certificates

Step 3: Set up your shell

Now set up your Terminal so it can use these packages. First check which shell you have:

echo $SHELL

  • If Terminal shows /bin/zsh (the default on current macOS), run:

    echo 'eval "$(rbenv init -)"' >> ~/.zshrc

    echo 'if [ -z $DISPLAY ]; then export DISPLAY=:0.0; fi' >> ~/.zshrc

    source ~/.zshrc

  • If Terminal shows /bin/bash, run:

    echo 'eval "$(rbenv init -)"' >> ~/.bash_profile

    echo 'if [ -z $DISPLAY ]; then export DISPLAY=:0.0; fi' >> ~/.bash_profile

    source ~/.bash_profile

Check that rbenv works:

rbenv versions

It should print one line that looks like * system. If it does, continue. If not, ask for help.

Step 4: Install Ruby 4.0.9

Enter these commands one at a time. The first one takes several minutes.

  1. rbenv install 4.0.9
  2. rbenv global 4.0.9
  3. ruby -v

The last command shows which Ruby is active. It should start with ruby 4.0.9, for example ruby 4.0.9 (…) +PRISM [arm64-darwin25].

If it shows anything else, for example ruby 2.6.10p210 (2022-04-12 revision 67958) [universal.arm64e-darwin22], close Terminal, open it again and run ruby -v once more. If it still does not start with ruby 4.0.9, ask for help.

Step 5: Download Lich

  1. Download the Lich5 files. (Windows, Mac and Linux all use the same files.)
  2. Unzip the file in your Downloads folder. This creates a folder called Lich5.
  3. Drag the Lich5 folder (the folder, not the zip file) to your Desktop.

Step 6: Install the gems Lich needs

Lich lists the gems (Ruby add-on libraries) it needs in a file named Gemfile, and Bundler installs exactly that set. The Gemfile also lists some gems only Lich's developers need (the development and vscode groups), so we tell Bundler to skip them. Enter these commands one at a time:

  1. cd ~/Desktop/Lich5
  2. bundle config set --local without 'development vscode'
  3. bundle install

bundle install can take several minutes; building the GTK gems is the slow part. When it finishes you should see a line beginning with Bundle complete!. If you see an error instead, ask for help.

Older guides use bundle install --without development vscode. That option was removed from the Bundler that comes with Ruby 4.0, so use the bundle config set command above instead.

Quick test:

  1. Start the Ruby shell (the prompt will change): irb
  2. Check the first gem: require 'sqlite3' — it should reply true.
  3. Check the second gem: require 'gtk3' — this should also reply true. It might take a second or two.
  4. Return to the normal prompt: exit

If both replied true, the hard part is done.

Step 7: Start Lich

To start Lich on its own, run this command in Terminal:

ruby ~/Desktop/Lich5/lich.rbw

After a few seconds the Lich login window opens. The first time Lich connects to the game, it downloads its map database and images, and you will see some Lich text in the game window, including a repository error. The error is normal.

Step 8: Set up a front end

Follow the setup for your front end on the Front ends page:

  • Saga (recommended): the official front end. Saga can start Lich for you. When Saga asks for your Lich folder, use ~/Desktop/Lich5.
  • Avalon: the older official Mac front end.
  • Warlock or Profanity: third-party front ends.

Windows in Parallels

The Ruby4Lich5 installer works in Windows running under Parallels on both Intel and Apple Silicon Macs. That lets you use the Windows-only front ends, Wrayth and The Wizard.

  1. Inside Windows, install Wrayth or The Wizard and check that you can log in without Lich.
  2. Follow the Windows installation guide inside Windows, keeping the default installer options.
  3. Start Lich by double-clicking lich.rbw in the Lich5 folder, then log in and play as usual.

If Wrayth scripts do not run on an Apple Silicon Mac: the rubyw file in C:\Ruby4Lich5\X.X.X\bin may be set to run in compatibility mode for Windows 7. Right-click it, choose Properties → Compatibility, and turn compatibility mode off.

Resources

Third-Party Software - edit
Lich: About Lich · Installation guides · Front ends
Downloadable Lich Scripts: Go2 | Map | Repository | Popular Scripts
Retrieved from "https://gswiki.play.net/index.php?title=Lich:Software/Installation/macOS&oldid=267893"