Lich:Software/Mac Installation: Difference between revisions

The official GemStone IV encyclopedia.
< Lich:Software
Jump to navigation Jump to search
m (→‎Resources: Adding diag link)
(change to use Saga as the primary FE choice)
 
(62 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{3rd-party}}
==Installing the Lich script engine on your Mac OS X Computer==
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.
{{#lst:Lich_(software)|About}}


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.
==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_(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.


==Before You Start==
==Note for versions prior to Mavericks (10.9)==


You will need to install Homebrew first. (You will install your front end, such as Saga, at the end of this guide.)
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.


# 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.
==Steps to Install==
# 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 <code>brew doctor</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.


Your system should respond with <code>Ready to brew</code>. If you get any other result, please seek assistance.
To run this script, download the [https://www.dropbox.com/s/itj42g2bdza50se/lichdiag.sh?dl=0 file] and then:


1) Open up your Terminal window (you can use Spotlight to search for Terminal, then open the application)
2) In your terminal window enter the following commands:
cd
chmod 744 ./Downloads/lichdiag.sh
./Downloads/lichdiag.sh
3) The output in Terminal will tell you what you have and don't have.


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


There are three general steps to installing all the packages and software needed to run Lich on 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.


* 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.
'''Coming soon:''' A script to automate as much as possible the installation of Lich on your Mac OS X. Contact doug@play.net if you would like to try out the beta version of this script.


* Second, we will download and unzip the current Lich software.
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.


* 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.
==Detailed Installation Instructions==


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.
Let's get you set up to use Lich on your Mac system. '''Coming soon:''' a 3rd party script that will automate this process for you. If you'd like to try the beta version of this script, contact doug@play.net .


# <code>brew install gtk+3</code>
First, if you haven't already, download Avalon 4.3.3 (beta) from http://www.play.net/playdotnet/play/avalon-info.asp
# <code>brew install gobject-introspection</code>
''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!
# <code>brew install rbenv</code>
# <code>brew install adwaita-icon-theme</code>
# <code>brew install openssl@3</code>
# <code>brew upgrade ca-certificates</code>


Now we need to set up your SHELL environment to take advantage of these packages.
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!)


Enter the following command to check your shell: <p><code>echo $SHELL</code></p>
Now we get serious.


* 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>
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.
* 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>


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.
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.


Before we begin, let's check to be sure rbenv is working properly. Enter this command in Terminal and press ENTER.
{|{{prettytable}}
|'''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 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 --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
|-
|'''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''' || 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
|}


* <code>rbenv versions</code>


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.
That is everything we should need to worry about to get into the game with Lich operating.


# <code>rbenv install 4.0.9</code>
==Running Lich for the First Time==
# <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:
In order to start the game with Lich, from Terminal we'll have to run the following command:
<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:
sudo ruby lich/lich.rbw --gemstone --avalon
<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
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!


If your version reflects 4.0.9, proceed to get the Lich files:
'''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!
# 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.
==Final Steps==
After confirming everything is working the way you want, don't forget! Open up Terminal and type the following three commands:


# <code>cd ~/Desktop/Lich5</code>
brew pin gtk+
# <code>bundle config set --local without 'development vscode'</code>
brew pin cairo
# <code>bundle install</code>
brew pin pango


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.
Enjoy!

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!

===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


==Resources==
==Resources==
* [https://www.dropbox.com/s/itj42g2bdza50se/lichdiag.sh?dl=0 Lich Diagnostics] 3rd party, not supported by Simutronics
* [[Lich scripting reference]]
* [[Lich scripting reference]]
* Tillmen's Lich Update (v4.6.33): 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 129: 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