Lich:Software/Installation

2021-02-24T23:29:35Z

KERTHWAP: Clarification for when to restart the interface

==About==

Lich is an add-on scripting engine that works alongside existing front ends. The most common installation is a combination of Lich on Windows using the Stormfront or Wizard FE. Despite this, Lich is also used by many on both MacOS and multiple Linux distributions.

==Installing the Latest Stable Release==

===Windows===

'''For Windows 10 / 8 / 7''' users on 64-bit systems: you can download the [https://bit.ly/WinLich Installer] and install everything you need automatically. Always remember to back up existing Lich / Simutronics files.

Install Guide for Lich Version 4.6.58 (as of January 5th, 2021)

# Uninstall ALL existing Ruby installations. This includes deleting all existing Ruby folders (they should be located in the root C:\ drive folder).
# Run the installer created by Doug ( http://bit.ly/WinLich ). Do NOT change the install drive to be different than C: drive. Do NOT restart the computer if prompted (just cancel that message). The install will seem like it isn't doing anything when there's a black box on the screen, but just give it some time. When the installer window itself goes away it's done.
# A Lich folder will be placed on your desktop after the install is finished, open that folder and run the lich.rbw file contained inside to start Lich's launcher.
# Log in and do -> <code>;repo download-lich</code> <- when command completes exit the game. This is required for things to work proper.
# Log in and do -> <code>;repo download repository</code> <- and wait the few seconds for it to finish. This is required for the repository to work proper.
# Do -> <code>;repo download-mapdb</code> <- and wait the few seconds for it to finish. This is required for map related components to work proper.
# Do -> <code>;repo download jinx</code> <- and wait the few seconds for it to finish. This is an alternative, maintained by Elanthia Online, to the Lich repository to facilitate downloading/updating scripts when the repository is offline.
# Do -> <code>;jinx script update infomon.lic</code> <- and wait the few seconds for it to finish. After it's downloaded do -> <code>;repo unset-updatable infomon.lic</code> <- to prevent Lich from replacing it with an outdated version. Finally, do -> <code>;kill infomon</code> <- and then -> <code>;infomon</code> <- to restart infomon. This version of infomon is maintained by Elanthia Online to allow quicker updating as the game changes.
# Do -> <code>;jinx data update spell-list.xml</code> <- and wait the few seconds for it to finish. After it's downloaded do -> <code>;repo unset-updatable spell-list.xml</code> <- to prevent Lich from replacing it with an outdated version. Finally, do -> <code>;e Spell.load</code> <- to load the new data. This version of spell-list.xml is maintained by Elanthia Online to allow quicker updating as the game changes.
# Do -> <code>;jinx data update autostart.lic</code> <- and wait the few seconds for it to finish. After it's downloaded do -> <code>;repo unset-updatable autostart.lic</code> <- to prevent Lich from replacing it with an outdated version. This fixes an issue with the repository not checking for updates at startup. This may also introduce an unknown result with go2 and narost on a fresh install so just be aware.

PLEASE BE AWARE that Jinx currently does not have a way to auto update itself, or infomon and spell-list. This ability is on the list of features to be implemented at some point in the near future. As a result, be mindful of checking your versions from time to time or asking in the GemStone #scripting channel on Discord to see if there's been any significant updates recently.

Additional assistance in installation can be found in the scripting channel of the GemStone [https://discord.gg/KF9Wr8u Discord].

===Mac OS X===

Max OS X support is incoming with GTK3 Beta Lich. Installation and details on this are still incoming - Please stand by.

===Chromebook & Debian variants===
The following steps should install Lich and Profanity for users of Debian/Chromebooks. Profanity is a terminal-based Front-End that will let you play the game (in lieu of The Wizard or Stormfront).

Update the list of available software and make sure some requirements are installed:

<pre>
sudo apt-get -y update
sudo apt-get -y install autoconf bison build-essential libssl-dev libyaml-dev libreadline6-dev zlib1g-dev libncurses5-dev libffi-dev libgdbm6 libgdbm-dev libsqlite3-dev unzip
</pre>

Install '''<tt>[https://github.com/rbenv/rbenv rbenv]</tt>''', a Ruby version manager. Add it to the <tt>PATH</tt> so that it will work outside of its own directory, and set it up to work when you launch the shell (terminal):
<pre>
git clone https://github.com/rbenv/rbenv.git ~/.rbenv
echo 'export PATH="$HOME/.rbenv/bin:$PATH"' >> ~/.bashrc
echo 'eval "$(rbenv init -)"' >> ~/.bashrc
</pre>

Run the shell's launch script now to enable those two changes and get rbenv working:
<pre>
source ~/.bashrc
</pre>

Download the tools to let rbenv install Ruby on its own, then install Ruby 2.5.1 and set it to be our default version of Ruby system-wide:
<pre>
git clone https://github.com/rbenv/ruby-build.git ~/.rbenv/plugins/ruby-build
rbenv install 2.5.1 -v
rbenv global 2.5.1
</pre>

Tell Ruby not to create documentation for its gems (plugins/packages) unless asked, because it takes a long time and they are available online. Then install the dependencies for Lich and Profanity:
<pre>
echo "gem: --no-document" > ~/.gemrc
gem install sqlite3 gtk2 curses
</pre>

Install Lich and Profanity:
<pre>
curl --remote-name https://lichproject.org/download/lich-4.6.49.zip
unzip lich-*.zip
git clone https://github.com/matt-lowe/ProfanityFE.git
</pre>

===Fedora===

There are notable differences between the versions of Fedora that are commonly available:

* Fedora 31 uses Ruby version 2.6.5 which has no compatibility issues with the base lich version or the Beta GTK3 variant.
* Fedora 32 uses Ruby version 2.7.1 which requires modification of scripts to match SAFE commands. This is a minor version difference, but is notable.

1. Update The Base Installation:
<pre>
$ sudo dnf -y update
$ sudo dnf -y install vim git
</pre>

2. Install required Ruby and Development packages:
<pre>
$ sudo dnf install -y autoconf bison gcc gdbm gdbm-devel libyaml-devel \
libffi-devel make ncurses-devel openssl-devel readline-devel redhat-rpm-config \
ruby ruby-devel sqlite-devel unzip zlib-devel
</pre>

3. Perform Ruby Gem Installations:
<pre>
$ gem install rake
$ gem update
</pre>

3.a. For GTK2 (base Lich)
<pre>
$ gem install sqlite3 gtk2 curses
</pre>

3.b. For GTK3 Beta
<pre>
$ gem install sqlite3 gtk3 curses
</pre>

4. Download Lich:
<pre>
$ cd ~
$ curl --remote-name https://lichproject.org/download/lich-4.6.52.zip
$ unzip lich-4.6.52.zip
</pre>

5. Clone Profanity:
<pre>
$ cd ~
$ git clone https://github.com/ondreian/ProfanityFE.git
</pre>

Please refer to the '''[[Profanity | Profanity FE]]''' page for initial configuration and additional instructions.

===Ecosystem Information===

* GTK3 Beta Version (for testing)

The combined Ruby and Lich installer is: [https://www.dropbox.com/s/upkg2qy1vmip31z/BetaGTK3-Ruby4Lich.exe?dl=1 BetaGTK3-Ruby4Lich]

* DragonRealms Variant

This can be downloaded directly from Github at [https://github.com/dragon-realms/dr-lich dragon-realms-lich]

==Resources==
* [[Mac Installation - Lich (software)]]

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

GemStone IV Wiki - User contributions [en]

Lich:Software/Installation