Lich:Software/Installation/Upgrading

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

Use this page if Lich 5 is already installed and you want the newest version of Lich, Ruby or both. The current release is Lich 5.24.2, which needs Ruby 4.0 or newer.

New to Lich? Start with the installation guides instead.

Before you start

1. Check what you have. In the game, with Lich running, enter:
   • ;e echo LICH_VERSION — your Lich version
   • ;e echo RUBY_VERSION — your Ruby version
2. Back up your Lich5 folder, especially the data folder inside it, which holds your saved logins and settings.
3. Pick the section that matches:

You have	Do this
Lich 5.7 or newer and Ruby 4.0 or newer	Update Lich only
Ruby older than 4.0 (any Lich 5) on Windows	Windows: update Ruby and Lich together
Ruby older than 4.0 on macOS or Linux	macOS and Linux: update Ruby, then update Lich
Lich 5.6 or older	Windows: update Ruby and Lich together. macOS and Linux: update Ruby, then download Lich again as in your installation guide
Lich 4	Moving from Lich 4

Update Lich only

For Lich 5.7 or newer, on any operating system. Lich 5.19 and newer needs Ruby 4.0 or newer, so update Ruby first if yours is older.

1. Back up your Lich5 folder.
2. In the game, enter: ;lich5-update --update
3. Quit and restart Lich.

You are now running the latest version of Lich.

Windows: update Ruby and Lich together

This reinstalls both with the Ruby4Lich5 installer. It is for Windows only.

1. Log out of all characters.
2. Back up your Lich5 folder.
3. Uninstall your existing Ruby4Lich5 from Settings → Apps (or Programs and Features). Alternatively, rename the existing C:\Ruby4Lich5 folder to C:\Ruby4Lich5save.
4. Download the latest Ruby4Lich5.exe installer.
5. Run the installer with both Ruby and Lich 5 selected.

You are now running the latest Lich and Ruby.

Windows: update Ruby only

Use this when Lich is already the latest version and only Ruby needs updating. If Lich is not already the latest version, use update Ruby and Lich together instead.

1. Log out of all characters.
2. Back up your Lich5 folder.
3. Uninstall your existing Ruby4Lich5 from Settings → Apps (or Programs and Features), and check that C:\Ruby4Lich5 is gone.
4. Download the latest Ruby4Lich5.exe installer.
5. Run the installer and choose Ruby only.

You are now running the latest Ruby.

macOS and Linux: update Ruby

On macOS and Linux, Ruby is installed with rbenv, so you update it with rbenv. Gems belong to one Ruby version, so after installing a new Ruby you must run bundle install again.

1. Log out of all characters, and back up your Lich5 folder.

2. Update ruby-build so it knows about the newest Ruby versions:

• macOS (Homebrew): brew upgrade rbenv ruby-build
• Linux: git -C ~/.rbenv/plugins/ruby-build pull

3. Install the new Ruby and make it the default:

rbenv install 4.0.9
rbenv global 4.0.9
ruby -v

The last command should print a line that starts with ruby 4.0.9. If not, open a new terminal and try again.

4. Reinstall Lich's gems for the new Ruby. Use the block for your system; if you put Lich somewhere else, change the cd line to your Lich folder.

macOS (Lich on your Desktop, as in the macOS guide):

cd ~/Desktop/Lich5
bundle config set --local without 'development vscode'
bundle install

Linux (Lich in your home folder, as in the Linux guide):

cd ~/Lich5
bundle config set --local without 'development vscode'
bundle install

5. If Saga asks where Ruby is, give it the new path that rbenv which ruby prints.

Then update Lich if it is not already the latest version.

Moving from Lich 4

Lich 5 cannot use a Lich 4 installation, so there is no in-place upgrade. Back up your Lich 4 folder, uninstall any existing Ruby, then follow the installation guide for your computer as a new install.

Getting help

Ask in the #scripting or #help channel of the GemStone IV Discord.