Lich:Software/Mac Installation: Difference between revisions

The official GemStone IV encyclopedia.
< Lich:Software
Jump to navigation Jump to search
mNo edit summary
(→‎The Process: remove note about Ruby 3.x not working)
 
(55 intermediate revisions by 8 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 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, 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 a few things.
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 the [https://www.play.net/gs4/play/avalon-info.asp Avalon Front End] from the play.net site.
==Steps to Install==
# 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.
# The Hombrew 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 Hombrew has installed, in the Terminal application you should run this command <code>brew doctor</code>
There are six steps to getting Lich up and running on your new Mac.


Your system should respond with <code>Ready to brew</code>. If you get any other result, please seek assistance.
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.


==The Process==
==Detailed Installation Instructions==


There are three general steps to installing all the packages and software needed to run Lich on Mac.
Let's get you set up to use Lich on your Mac system.


* 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.
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
* Second, we will install the gems in the new Ruby that we installed.
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!)


* Finally, we will download and unzip the current Lich software so that we can run Lich.
Now we get serious.


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


# <code>brew install gtk+3</code>
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.
# <code>brew install gobject-introspection</code>
# <code>brew install rbenv</code>
# <code>brew install adwaita-icon-theme</code>


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


Enter the following command to check your shell: <p><code>echo $SHELL</code></p>


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


Before we begin, let's check to be sure rbenv is working properly. Enter this command in Terminal and press ENTER.
In order to start the game with Lich, from Terminal we'll have to run the following command:


* <code>rbenv versions</code>
sudo ruby lich/lich.rbw --gemstone --avalon


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


# <code>rbenv install 3.2.3</code>
'''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!
# <code>rbenv global 3.2.3</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:
==Final Steps==
<code>ruby 3.2.3 (2024-01-16 revision 5124f9ac75) [arm64-darwin22]</code>
After confirming everything is working the way you want, don't forget! Open up Terminal and type the following three commands:


If you did not receive that line, or if you received a line like this:
brew pin gtk+
<code>ruby 2.6.10p210 (2022-04-12 revision 67958) [universal.arm64e-darwin22]</code>
brew pin cairo
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).
brew pin pango


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


'''3.2.3 is expected'''. If your version reflects 3.2.3, proceed to the next steps. Enter these commands, one at a time, and press ENTER. Wait for the system to finish before moving on to the next.
Enjoy!

# <code>gem install ascii_charts concurrent-ruby curses gtk3 jwt mechanize nokogiri redis sequel sqlite3 terminal-table tomlib tzinfo tzinfo-data webrick xmpp4r --no-document</code>
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. Now we simply need 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 it 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.

'''That's it!''' You will start / access Lich and the game from the Terminal window.

# 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.
# Enter your login information, and click CONNECT.
# Select your character, select the Avalon Front End, and click PLAY.
# The game will start! You will see some new Lich-related text in the scroll, including a repository error (normal).

Lich5 will then automatically start downloading the map database and associated image files for the game. After that's complete, you're ready to play. Good luck and have fun!

==Lich for Other Front Ends==

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.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 95: Line 100:


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

Latest revision as of 10:54, 17 October 2024

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 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, 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 a few things.

  1. Install the Avalon Front End from the play.net site.
  2. 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.
  3. The Hombrew 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 Hombrew 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 install the gems in the new Ruby that we installed.
  • Finally, we will download and unzip the current Lich software so that we can run Lich.

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

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 3.2.3
  2. rbenv global 3.2.3
  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 3.2.3 (2024-01-16 revision 5124f9ac75) [arm64-darwin22]

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 3.2.3 part -> it needs to read 3.2.3

3.2.3 is expected. If your version reflects 3.2.3, proceed to the next steps. Enter these commands, one at a time, and press ENTER. Wait for the system to finish before moving on to the next.

  1. gem install ascii_charts concurrent-ruby curses gtk3 jwt mechanize nokogiri redis sequel sqlite3 terminal-table tomlib tzinfo tzinfo-data webrick xmpp4r --no-document

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. Now we simply need to get the Lich files:

  1. Download the Lich5 files. (Windows/Mac all run the same files).
  2. Unzip it 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.

That's it! You will start / access Lich and the game from the Terminal window.

  1. Run the following command in the Terminal:

    ruby ~/Desktop/Lich5/lich.rbw

  2. After a couple seconds, you should see the Lich login window.
  3. Enter your login information, and click CONNECT.
  4. Select your character, select the Avalon Front End, and click PLAY.
  5. The game will start! You will see some new Lich-related text in the scroll, including a repository error (normal).

Lich5 will then automatically start downloading the map database and associated image files for the game. After that's complete, you're ready to play. Good luck and have fun!

Lich for Other Front Ends

No guides are available at this time, please email doug@play.net for help.

Resources

Third-Party Software - edit
Lich Installation: Lich
Downloadable Lich Scripts: Go2 | Map | Repository | Popular Scripts
Retrieved from "https://gswiki.play.net/index.php?title=Lich:Software/Mac_Installation&oldid=227234"