Lich:Software/Mac Installation: Difference between revisions

The official GemStone IV encyclopedia.
< Lich:Software
Jump to navigation Jump to search
m (Formatting)
(change to use Saga as the primary FE choice)
 
(35 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{3rd-party}}
With Mac Mojave and Catalina, Ruby 2.6 and 2.7, and changes to various gems used to support the game, the old script does not work.
To install Lich on newer versions of Mac OS, you will need a bit of familiarity with the Mac Terminal application. Some familiarity with Homebrew will help, although you should be able to follow the steps below without any prior knowledge of Homebrew.


This guide installs Lich for use with [[Saga]], the official Simutronics front end for Mac, Windows and Linux (currently in beta). Saga is now the recommended front end on Mac. [[Avalon]] and other front ends also work, and are covered in [[#Front Ends|Front Ends]] below. The entire process will take 60-90 minutes to complete, but the time required will depend on how many prerequisites you need to install and how many errors you encounter. If you get stuck, see any errors or run into any problems, or for information about other front ends, please contact Doug (doug@play.net or Doug#6198 on Discord) for help.
To install Lich on newer versions of Mac OS, you will need to install formulas using Homebrew that recreate the way older technologies worked. You will need a bit of familiarity with the Mac Terminal application to get this done. Some familiarity with Homebrew will help, although you should be able to follow the steps below without any prior knowledge of Homebrew.

This guide will attempt to install Lich for the Avalon Front End only. The entire process will take 60-90 minutes to complete, but the time required will depend on how many prerequisites you need to install and how many errors you encounter. If you get stuck, or for information about other front ends, please contact Doug (doug@play.net or Doug#6198 on Discord) for help.


Please note that this guide will involve changing settings on your device for the technologies involved. You will need to decide whether it’s safe for you to customize these tools to work with Lich. If you have no idea what any of these technologies are, then you probably aren’t using them for any other purpose, but proceed at your own risk.
Please note that this guide will involve changing settings on your device for the technologies involved. You will need to decide whether it’s safe for you to customize these tools to work with Lich. If you have no idea what any of these technologies are, then you probably aren’t using them for any other purpose, but proceed at your own risk.


This guide has only been tested under a limited number of system conditions. Systems with different initial states or versions of these tools installed will behave differently and errors will occur. Your mileage may vary, but these steps should provide hints to what may be going wrong and accelerate any debugging of the issues.


==Before You Start==
==Before You Start==


You will need to install a few things.
You will need to install Homebrew first. (You will install your front end, such as Saga, at the end of this guide.)


# Install [https://brew.sh Homebrew] by following the instructions at the Homebrew site. You will be asked to supply your sudo password at least once, and perhaps a couple of times through this process.
# Install the Avalon Front End [https://www.play.net/gs4/play/avalon-info.asp] from the play.net site.
# The Homebrew setup will also install Apple's Command Line Tools. You will be asked to accept the Apple license.
# Install Xquartz 2.7.11 [https://www.xquartz.org/]) from the Xquartz site.

# Install Homebrew [https://brew.sh] by following the instructions at the Homebrew site.
# Install Xcode command line tools by running the following Terminal command: <code>xcode-select --install</code>
When you are finished with these steps and Homebrew has installed, in the Terminal application you should run this command <code>brew doctor</code>

Your system should respond with <code>Ready to brew</code>. If you get any other result, please seek assistance.


After installing these new tools, please restart your device.


==The Process==
==The Process==


There are three general steps to installing all the packages and software needed to run Lich on Mac.
# Open the Terminal application and move to a folder where you would like to install this project. The following steps will all be run in the Terminal.

# Enter the following command to fetch Doug's ‘Old Skool Brew’ package: <p><code>curl -OL https://github.com/OSXLich-Doug/OSXLich-Install/raw/master/OldSkoolBrew.zip</code></p>
* First we will install various packages through Homebrew. This will include installing a different version of Ruby. Apple's version of Ruby does not work well with Lich.
# Enter the following command to expand the package: <p><code>unzip OldSkoolBrew.zip</code></p>

# Run the following command to copy the files to your Homebrew formulas folder: <p><code>cp ./OldSkoolBrew/* /usr/local/Homebrew/Library/Taps/homebrew/homebrew-core/Formula/</code></p>
* Second, we will download and unzip the current Lich software.
# Run the following command to install the first set of required formulas: <p><code>HOMEBREW_NO_AUTO_UPDATE=1 brew install cairo</code></p><p>Note, this may take 20-30 minutes to complete. You will see Homebrew performing a long list of installations. If the process completes successfully, you will return to a new Terminal prompt once all the packages are installed.</p>

# Run the following command to make sure these new formulas do not update automatically: <p><code>brew pin cairo</code></p>
* Finally, we will use Bundler to install the gems Lich needs (listed in Lich's own <code>Gemfile</code>) into the new Ruby that we installed.
# Run the following command to install the second set of required formulas: <p><code>HOMEBREW_NO_AUTO_UPDATE=1 brew install gtk+</code></p><p>Note, this may take 20-30 minutes to complete. You will see Homebrew performing a long list of installations. If the process completes successfully, you will return to a new Terminal prompt once all the packages are installed.</p>

# Run the following command to make sure these new formulas do not update automatically: <p><code>brew pin pango gtk+</code></p>
To get started, enter these commands in Terminal, one at a time, and press ENTER. Allow the system to complete the command before moving on to the next one.
# Run the following command to update the system Ruby (this has been tested to work with 2.6.5 and 2.7.1): <p><code>HOMEBREW_NO_AUTO_UPDATE=1 brew install ruby</code></p>

# Now you will need to check if you are running Bash or the Z shell. Enter the following command to check your shell: <p><code>echo $SHELL</code></p>
# <code>brew install gtk+3</code>
## If the Terminal displays <code>/bin/bash</code>, run the following commands: <p><code>echo 'export PATH=/usr/local/opt/ruby/bin:$PATH' >> ~/.bash_profile</code></p><p><code>source ~/.bash_profile</code></p>
# <code>brew install gobject-introspection</code>
## If the Terminal displays <code>/bin/zsh</code>, run the following commands: <p><code>echo 'export PATH=/usr/local/opt/ruby/bin:$PATH' >> ~/.zshrc</code></p><p><code>source ~/.zshrc</code></p>
# <code>brew install rbenv</code>
# We have two required Ruby gems to install. Run the following command to install the first gem: <p><code>gem install sqlite3 --no-document</code></p>
# Run the following command to install the second gem: <p><code>gem install gtk2 --no-document</code></p>
# <code>brew install adwaita-icon-theme</code>
# <code>brew install openssl@3</code>
# Now run a quick test to see if things work:
# <code>brew upgrade ca-certificates</code>
## Run the following command to start the Ruby shell (you will see the command prompt change): <p><code>Irb</code></p>

## Run this command to test if the first gem is working: <p><code>require 'sqlite3'</code></p><p>The system should respond <code>true</code></p>
Now we need to set up your SHELL environment to take advantage of these packages.
## Run this command to test if the second gem is working: <p><code>require 'gtk2'</code></p><p>This should start Xquartz in the background and respond <code>true</code> in the Terminal. It might take a few seconds!</p>

# Nearly there! Now get the Lich files:
Enter the following command to check your shell: <p><code>echo $SHELL</code></p>
## Download <code>Lich-4.6.52.zip</code> from the Lich site [https://lichproject.org/] (Windows/Mac all run the same files).

## Put the file in a location you know the path to (for example, your desktop or a folder for this project).
* If the Terminal displays <code>/bin/bash</code>, run the following commands: <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>
## Unzip it.
* If the Terminal displays <code>/bin/zsh</code>, run the following commands: <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>
# Run the following command in the Terminal (note, you must enter the correct path to the folder where you put Lich): <p><code>ruby ~/[PATH TO LICH]/lich/lich.rbw</code></p><p>(From now on, you must use this command to start the game, rather than opening the Front End directly.)</p>

# After a couple seconds, this will open the Lich login window.
This completes the installation of the core packages you will need. Now we'll use rbenv to install the new Ruby. You're welcome to select a Ruby version if you are comfortable with any particular one.
## Give it your login information, and click connect.

## Select your character, select the Avalon Front End, and click Play. (Don’t bother to save, that doesn’t work.)
Before we begin, let's check to be sure rbenv is working properly. Enter this command in Terminal and press ENTER.
## The game will start! You will see some new Lich-related text in the scroll, including a repository error (normal).

# Get started by installing the maps database with the following command (in game): <code>;repo download-mapdb</code>
* <code>rbenv versions</code>
# Good luck and have fun! For more instructions on Lich, look for guides elsewhere.

This should return one line that looks like <code>* system</code>. If you see that line, you can proceed. If not, seek assistance. If you are proceeding, then enter these commands in Terminal, one at a time, and press ENTER. Allow the system to complete the command before moving on to the next one.

# <code>rbenv install 4.0.9</code>
# <code>rbenv global 4.0.9</code>
# <code>ruby -v</code>

If everything worked, the last line will return the version of Ruby that is currently active. It should look something like this:
<code>ruby 4.0.9 (2026-10-23 revision 3e93b23afc) +PRISM [arm64-darwin25]</code>

If you did not receive that line, or if you received a line like this:
<code>ruby 2.6.10p210 (2022-04-12 revision 67958) [universal.arm64e-darwin22]</code>
seek assistance (restarting the terminal you used to run commands up to this point may be required for `ruby -v` to show the proper, updated version of ruby).

The key is the ruby 4.0.9 part -> it needs to read 4.0.9

If your version reflects 4.0.9, proceed to get the Lich files:
# Download the [https://github.com/elanthia-online/lich-5/releases/latest/download/lich-5.zip Lich5] files. (Windows/Mac all run the same files).
# Unzip the file in your Downloads folder. This will create a folder called Lich5. Drag the Lich5 folder (not the zip file, the folder) to your Desktop.

Now we will install the gems Lich needs. Lich includes a file called <code>Gemfile</code> that lists them, so Bundler can install exactly the right set. The Gemfile also lists some developer-only gems (the <code>development</code> and <code>vscode</code> groups) that you do not need, so we tell Bundler to skip them. Enter these commands in Terminal, one at a time, and press ENTER. Wait for the system to finish before moving on to the next.

# <code>cd ~/Desktop/Lich5</code>
# <code>bundle config set --local without 'development vscode'</code>
# <code>bundle install</code>

The <code>bundle install</code> step 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, seek assistance.

Note: you may see other guides use <code>bundle install --without development vscode</code>. That flag has been removed from the version of Bundler that ships with Ruby 4.0, so use the <code>bundle config set</code> command above instead.

Now run a quick test to see if things work:

* Run the following command to start the Ruby shell (you will see the command prompt change): <p><code>irb</code></p>
# Run this command to test if the first gem is working: <p><code>require 'sqlite3'</code></p><p>The system should respond <code>true</code></p>
# Run this command to test if the second gem is working: <p><code>require 'gtk3'</code></p><p>This should also respond <code>true</code> in the Terminal. It might take a second or two.</p>
# Now, run this command to return to your regular shell prompt: <p><code>exit</code></p>

If all of these activities show the right results, the hard part is behind you.

==Starting Lich==

To start Lich on its own, run the following command in the Terminal: <p><code>ruby ~/Desktop/Lich5/lich.rbw</code></p>
After a couple seconds, you should see the Lich login window. How you use it depends on your front end; see below.

The first time Lich connects to the game, it will automatically download the map database and associated image files. You will also see some new Lich-related text in the game window, including a repository error (normal).

==Front Ends==

===Saga (recommended)===
[[Saga]] is the official Simutronics front end for GemStone IV and DragonRealms, currently in beta. It replaces Wrayth and the old Simutronics launcher (SGE) with its own login screen, and it works with Lich.

'''Install Saga'''
# Go to the [https://www.play.net/gs4/play/saga-info.asp Saga info page] and click '''Download for Mac'''. Choose the '''Apple Silicon''' build for M1/M2/M3/M4 Macs, or '''Intel''' for older Macs. (Apple menu &rarr; About This Mac shows which you have.)
# Open the downloaded <code>.dmg</code> file and drag Saga into your Applications folder.
# Start Saga from Applications. During the beta the Mac builds are not signed, so macOS may refuse to open it the first time. If so, open System Settings &rarr; Privacy & Security, scroll down, and click '''Open Anyway''' next to the Saga message.
# Log in to the game from inside Saga once, without Lich, to make sure Saga itself works.

The Mac build of Saga does not update itself yet. Check the Saga info page now and then and download the newest version the same way.

'''Use Saga with Lich'''

Saga starts Lich for you:
# Log in with Saga normally, then choose '''File &rarr; Enable Login with Lich'''.
# Choose '''File &rarr; Return to login'''.
# Click '''Connect''', then '''Via Lich''', and point it to your Lich folder (<code>~/Desktop/Lich5</code>).
# If Saga asks where Ruby is, or Lich will not start, run <code>rbenv which ruby</code> in the Terminal and give Saga the path it prints (it ends in <code>.rbenv/versions/4.0.9/bin/ruby</code>). Apps started from Finder do not see the Ruby that rbenv set up in your Terminal.
# Log in. The game will start in Saga with Lich running.

Once that works, you can also start from the Lich login window instead (see [[#Starting Lich|Starting Lich]]): select your character, choose '''Saga''' as the front end, and click '''PLAY'''. Lich will open Saga and Saga logs in with its own saved login, so make sure Saga has saved your account and quit Saga before you do this.

See the [[Saga]] page for more about Saga, including importing Wrayth settings.

===Avalon===
[[Avalon]] is the older official Mac front end. Install it from the [https://www.play.net/gs4/play/avalon-info.asp Avalon info page], then:
# Start Lich (see [[#Starting Lich|Starting Lich]]).
# Enter your login information, and click CONNECT.
# Select your character, select the Avalon Front End, and click PLAY.
# The game will start!


==Lich for Other Front Ends==
===Other Front Ends===
[https://warlockfe.github.io/ Warlock] is a third-party front end that also works with Lich. Configuration for Mac (and other OS types) is here:


https://github.com/sproctor/warlock3/wiki/Lich-support
No guides are available at this time, please email doug@play.net for help.


==Resources==
==Resources==
* [[Lich scripting reference]]
* [[Lich scripting reference]]
* Tillmen's Lich Update (v4.6.52): https://lichproject.org/
* Playershops by Lich: https://ps.lichproject.org/
* Playershops by Lich: https://ps.lichproject.org/
* Unofficial Support for Lich: http://forum.gsplayers.com/forumdisplay.php?f=104
* Unofficial Support for Lich: http://forum.gsplayers.com/forumdisplay.php?f=104
Line 64: Line 141:


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

Latest revision as of 07:09, 28 October 2026

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

To install Lich on newer versions of Mac OS, you will need a bit of familiarity with the Mac Terminal application. Some familiarity with Homebrew will help, although you should be able to follow the steps below without any prior knowledge of Homebrew.

This guide installs Lich for use with Saga, the official Simutronics front end for Mac, Windows and Linux (currently in beta). Saga is now the recommended front end on Mac. Avalon and other front ends also work, and are covered in Front Ends below. The entire process will take 60-90 minutes to complete, but the time required will depend on how many prerequisites you need to install and how many errors you encounter. If you get stuck, see any errors or run into any problems, or for information about other front ends, please contact Doug (doug@play.net or Doug#6198 on Discord) for help.

Please note that this guide will involve changing settings on your device for the technologies involved. You will need to decide whether it’s safe for you to customize these tools to work with Lich. If you have no idea what any of these technologies are, then you probably aren’t using them for any other purpose, but proceed at your own risk.


Before You Start

You will need to install Homebrew first. (You will install your front end, such as Saga, at the end of this guide.)

  1. Install Homebrew by following the instructions at the Homebrew site. You will be asked to supply your sudo password at least once, and perhaps a couple of times through this process.
  2. The Homebrew setup will also install Apple's Command Line Tools. You will be asked to accept the Apple license.

When you are finished with these steps and Homebrew has installed, in the Terminal application you should run this command brew doctor

Your system should respond with Ready to brew. If you get any other result, please seek assistance.


The Process

There are three general steps to installing all the packages and software needed to run Lich on Mac.

  • First we will install various packages through Homebrew. This will include installing a different version of Ruby. Apple's version of Ruby does not work well with Lich.
  • Second, we will download and unzip the current Lich software.
  • Finally, we will use Bundler to install the gems Lich needs (listed in Lich's own Gemfile) into the new Ruby that we installed.

To get started, enter these commands in Terminal, one at a time, and press ENTER. Allow the system to complete the command before moving on to the next one.

  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

Now we need to set up your SHELL environment to take advantage of these packages.

Enter the following command to check your shell:

echo $SHELL

  • If the Terminal displays /bin/bash, run the following commands:

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

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

    source ~/.bash_profile

  • If the Terminal displays /bin/zsh, run the following commands:

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

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

    source ~/.zshrc

This completes the installation of the core packages you will need. Now we'll use rbenv to install the new Ruby. You're welcome to select a Ruby version if you are comfortable with any particular one.

Before we begin, let's check to be sure rbenv is working properly. Enter this command in Terminal and press ENTER.

  • rbenv versions

This should return one line that looks like * system. If you see that line, you can proceed. If not, seek assistance. If you are proceeding, then enter these commands in Terminal, one at a time, and press ENTER. Allow the system to complete the command before moving on to the next one.

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

If everything worked, the last line will return the version of Ruby that is currently active. It should look something like this: ruby 4.0.9 (2026-10-23 revision 3e93b23afc) +PRISM [arm64-darwin25]

If you did not receive that line, or if you received a line like this: ruby 2.6.10p210 (2022-04-12 revision 67958) [universal.arm64e-darwin22] seek assistance (restarting the terminal you used to run commands up to this point may be required for `ruby -v` to show the proper, updated version of ruby).

The key is the ruby 4.0.9 part -> it needs to read 4.0.9

If your version reflects 4.0.9, proceed to get the Lich files:

  1. Download the Lich5 files. (Windows/Mac all run the same files).
  2. Unzip the file in your Downloads folder. This will create a folder called Lich5. Drag the Lich5 folder (not the zip file, the folder) to your Desktop.

Now we will install the gems Lich needs. Lich includes a file called Gemfile that lists them, so Bundler can install exactly the right set. The Gemfile also lists some developer-only gems (the development and vscode groups) that you do not need, so we tell Bundler to skip them. Enter these commands in Terminal, one at a time, and press ENTER. Wait for the system to finish before moving on to the next.

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

The bundle install step 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, seek assistance.

Note: you may see other guides use bundle install --without development vscode. That flag has been removed from the version of Bundler that ships with Ruby 4.0, so use the bundle config set command above instead.

Now run a quick test to see if things work:

  • Run the following command to start the Ruby shell (you will see the command prompt change):

    irb

  1. Run this command to test if the first gem is working:

    require 'sqlite3'

    The system should respond true

  2. Run this command to test if the second gem is working:

    require 'gtk3'

    This should also respond true in the Terminal. It might take a second or two.

  3. Now, run this command to return to your regular shell prompt:

    exit

If all of these activities show the right results, the hard part is behind you.

Starting Lich

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

ruby ~/Desktop/Lich5/lich.rbw

After a couple seconds, you should see the Lich login window. How you use it depends on your front end; see below.

The first time Lich connects to the game, it will automatically download the map database and associated image files. You will also see some new Lich-related text in the game window, including a repository error (normal).

Front Ends

Saga (recommended)

Saga is the official Simutronics front end for GemStone IV and DragonRealms, currently in beta. It replaces Wrayth and the old Simutronics launcher (SGE) with its own login screen, and it works with Lich.

Install Saga

  1. Go to the Saga info page and click Download for Mac. Choose the Apple Silicon build for M1/M2/M3/M4 Macs, or Intel for older Macs. (Apple menu → About This Mac shows which you have.)
  2. Open the downloaded .dmg file and drag Saga into your Applications folder.
  3. Start Saga from Applications. During the beta the Mac builds are not signed, so macOS may refuse to open it the first time. If so, open System Settings → Privacy & Security, scroll down, and click Open Anyway next to the Saga message.
  4. Log in to the game from inside Saga once, without Lich, to make sure Saga itself works.

The Mac build of Saga does not update itself yet. Check the Saga info page now and then and download the newest version the same way.

Use Saga with Lich

Saga starts Lich for you:

  1. Log in with Saga normally, then choose File → Enable Login with Lich.
  2. Choose File → Return to login.
  3. Click Connect, then Via Lich, and point it to your Lich folder (~/Desktop/Lich5).
  4. If Saga asks where Ruby is, or Lich will not start, run rbenv which ruby in the Terminal and give Saga the path it prints (it ends in .rbenv/versions/4.0.9/bin/ruby). Apps started from Finder do not see the Ruby that rbenv set up in your Terminal.
  5. Log in. The game will start in Saga with Lich running.

Once that works, you can also start from the Lich login window instead (see Starting Lich): select your character, choose Saga as the front end, and click PLAY. Lich will open Saga and Saga logs in with its own saved login, so make sure Saga has saved your account and quit Saga before you do this.

See the Saga page for more about Saga, including importing Wrayth settings.

Avalon

Avalon is the older official Mac front end. Install it from the Avalon info page, then:

  1. Start Lich (see Starting Lich).
  2. Enter your login information, and click CONNECT.
  3. Select your character, select the Avalon Front End, and click PLAY.
  4. The game will start!

Other Front Ends

Warlock is a third-party front end that also works with Lich. Configuration for Mac (and other OS types) is here:

https://github.com/sproctor/warlock3/wiki/Lich-support

Resources

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