Lich:Software/Installation: Difference between revisions
(Clarification for when to restart the interface) |
m (→Windows) |
||
| Line 7: | Line 7: | ||
===Windows=== |
===Windows=== |
||
'''For Windows 10 / 8 / 7''' users |
'''For Windows 10 / 8 / 7''' users: you can download the [https://bit.ly/WinLich5 Installer] and install everything you need automatically. If you have never played before, follow the 'New Installation' instructions. If you have played before, and have used Lich before, follow the 'Safe Update' instructions. |
||
====New Installation for Lich 5 (3/6/2021)==== |
|||
# Download and Run the [https://bit.ly/WinLich5 Installer]. You will receive the Microsoft Warning because this is not distributed through the MS Store. Click on 'More Info' and then select the 'Run Anyway' button. |
|||
# Uninstall ALL existing Ruby installations. This includes deleting all existing Ruby folders (they should be located in the root C:\ drive folder). |
|||
# '''If you have been in the game already with Simutronics software, the default installation is fine'''. If you have not yet been in the game with Simutronics software, then you should check the box to add the Launcher, and then select a FrontEnd. StormFront is the current FE supported by Simutronics. |
|||
# 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. |
|||
# The installation may take a few minutes, especially on non-SSD harddrives. |
|||
# A |
# A Lich5 folder will be placed on your desktop after the install is finished, open that folder and double click the lich.rbw file contained inside to start Lich's Game Entry window. |
||
# Log in and do -> <code>;repo download-lich</code> <- when command completes exit the game. This is required for things to work proper. |
|||
# Use your existing Simutronics Account and Password and click connect. Then select the character you wish to play, and select the FrontEnd you wish to use. Then click the Play button. |
|||
| ⚫ | |||
# Your game FrontEnd should start, and you should see Lich5 initializing. You will see it downloading files - these are the map files, wait for the download to finish. |
|||
# 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. |
|||
# You should see a window open titled 'xNarost', this is the map window. |
|||
# 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. |
|||
====Upgrade Installation for Lich 5 (3/6/2021)==== |
|||
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. |
|||
'''Developers:''' This installer will associate all .rb and .rbw files to this installation. You may want to just check in with the [https://discord.gg/KF9Wr8u Discord] scripting channel to get the latest Lich files and roll your own Ruby. |
|||
'''Note:''' Back up your existing lich folder for a failsafe experience. Seriously. Put a copy somewhere safe. |
|||
'''Note2:''' You are updating to Ruby 2.6.6 and GTK3 - smoother running and more stable. This means that some of your existing scripts may need to be updated. At the present moment, the only script that is known to not be available is the Wizard script <code>;uberbarwiz</code>. If that script is critical to your gaming, do not upgrade yet. When this note changes, that will mean an updated script is available. |
|||
'''Note3:''' This installer is safe to run with existing installations of Ruby. This is done to facilitate a rapid return to the prior version, if something doesn't work right. Remember to uninstall your older Ruby if you are satisfied with this new installation to get back precious disk space. |
|||
# Download and Run the [https://bit.ly/WinLich5 Installer]. You will receive the Microsoft Warning because this is not distributed through the MS Store. Click on 'More Info' and then select the 'Run Anyway' button. |
|||
# The installation may take a few minutes, especially on non-SSD harddrives. |
|||
# A Lich5 folder will be placed on your desktop after the install is finished. |
|||
# Since you likely have a ton of information already saved in your previous lich folder, the fastest way to update to Lich5 is to open the Lich5 folder, open your existing lich folder, select ALL in your existing lich folder, and drag it over to the Lich5 folder. DO NOT OVERWRITE any files that already exist. If you do, your new Lich5 installation will not work. Always keep the existing Lich5 file when copying over your old information. You did back up your existing lich folder, right? |
|||
# Log in as you normally would. The Lich Quick Game Entry and Game Entry windows will look different, so don't be surprised. The Lich Quick Game Entry window should show your accounts in tabs on the left side, click through them to be sure your characters are all still listed under their tabs. |
|||
Special note to Profanity / Illthorn and other third-party FrontEnd users - this installer does not create an entry to the Environment Path variable. If you're using a third-party FrontEnd, be sure to add the Ruby4Lich5\bin directory to your path. See how [https://www.architectryan.com/2018/03/17/add-to-the-path-on-windows-10/ here]. |
|||
Additional assistance in installation can be found in the scripting channel of the GemStone [https://discord.gg/KF9Wr8u Discord]. |
Additional assistance in installation can be found in the scripting channel of the GemStone [https://discord.gg/KF9Wr8u Discord]. |
||
Revision as of 23:34, 6 March 2021
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: you can download the Installer and install everything you need automatically. If you have never played before, follow the 'New Installation' instructions. If you have played before, and have used Lich before, follow the 'Safe Update' instructions.
New Installation for Lich 5 (3/6/2021)
- Download and Run the Installer. You will receive the Microsoft Warning because this is not distributed through the MS Store. Click on 'More Info' and then select the 'Run Anyway' button.
- If you have been in the game already with Simutronics software, the default installation is fine. If you have not yet been in the game with Simutronics software, then you should check the box to add the Launcher, and then select a FrontEnd. StormFront is the current FE supported by Simutronics.
- The installation may take a few minutes, especially on non-SSD harddrives.
- A Lich5 folder will be placed on your desktop after the install is finished, open that folder and double click the lich.rbw file contained inside to start Lich's Game Entry window.
- Use your existing Simutronics Account and Password and click connect. Then select the character you wish to play, and select the FrontEnd you wish to use. Then click the Play button.
- Your game FrontEnd should start, and you should see Lich5 initializing. You will see it downloading files - these are the map files, wait for the download to finish.
- You should see a window open titled 'xNarost', this is the map window.
- In the game command line enter ->
;repo download jinx<- 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.
Upgrade Installation for Lich 5 (3/6/2021)
Developers: This installer will associate all .rb and .rbw files to this installation. You may want to just check in with the Discord scripting channel to get the latest Lich files and roll your own Ruby.
Note: Back up your existing lich folder for a failsafe experience. Seriously. Put a copy somewhere safe.
Note2: You are updating to Ruby 2.6.6 and GTK3 - smoother running and more stable. This means that some of your existing scripts may need to be updated. At the present moment, the only script that is known to not be available is the Wizard script ;uberbarwiz. If that script is critical to your gaming, do not upgrade yet. When this note changes, that will mean an updated script is available.
Note3: This installer is safe to run with existing installations of Ruby. This is done to facilitate a rapid return to the prior version, if something doesn't work right. Remember to uninstall your older Ruby if you are satisfied with this new installation to get back precious disk space.
- Download and Run the Installer. You will receive the Microsoft Warning because this is not distributed through the MS Store. Click on 'More Info' and then select the 'Run Anyway' button.
- The installation may take a few minutes, especially on non-SSD harddrives.
- A Lich5 folder will be placed on your desktop after the install is finished.
- Since you likely have a ton of information already saved in your previous lich folder, the fastest way to update to Lich5 is to open the Lich5 folder, open your existing lich folder, select ALL in your existing lich folder, and drag it over to the Lich5 folder. DO NOT OVERWRITE any files that already exist. If you do, your new Lich5 installation will not work. Always keep the existing Lich5 file when copying over your old information. You did back up your existing lich folder, right?
- Log in as you normally would. The Lich Quick Game Entry and Game Entry windows will look different, so don't be surprised. The Lich Quick Game Entry window should show your accounts in tabs on the left side, click through them to be sure your characters are all still listed under their tabs.
Special note to Profanity / Illthorn and other third-party FrontEnd users - this installer does not create an entry to the Environment Path variable. If you're using a third-party FrontEnd, be sure to add the Ruby4Lich5\bin directory to your path. See how here.
Additional assistance in installation can be found in the scripting channel of the GemStone 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:
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
Install rbenv, a Ruby version manager. Add it to the PATH so that it will work outside of its own directory, and set it up to work when you launch the shell (terminal):
git clone https://github.com/rbenv/rbenv.git ~/.rbenv echo 'export PATH="$HOME/.rbenv/bin:$PATH"' >> ~/.bashrc echo 'eval "$(rbenv init -)"' >> ~/.bashrc
Run the shell's launch script now to enable those two changes and get rbenv working:
source ~/.bashrc
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:
git clone https://github.com/rbenv/ruby-build.git ~/.rbenv/plugins/ruby-build rbenv install 2.5.1 -v rbenv global 2.5.1
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:
echo "gem: --no-document" > ~/.gemrc gem install sqlite3 gtk2 curses
Install Lich and Profanity:
curl --remote-name https://lichproject.org/download/lich-4.6.49.zip unzip lich-*.zip git clone https://github.com/matt-lowe/ProfanityFE.git
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:
$ sudo dnf -y update $ sudo dnf -y install vim git
2. Install required Ruby and Development packages:
$ 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
3. Perform Ruby Gem Installations:
$ gem install rake $ gem update
3.a. For GTK2 (base Lich)
$ gem install sqlite3 gtk2 curses
3.b. For GTK3 Beta
$ gem install sqlite3 gtk3 curses
4. Download Lich:
$ cd ~ $ curl --remote-name https://lichproject.org/download/lich-4.6.52.zip $ unzip lich-4.6.52.zip
5. Clone Profanity:
$ cd ~ $ git clone https://github.com/ondreian/ProfanityFE.git
Please refer to the Profanity FE page for initial configuration and additional instructions.
Ecosystem Information
- GTK3 Beta Version (for testing)
The combined Ruby and Lich installer is: BetaGTK3-Ruby4Lich
- DragonRealms Variant
This can be downloaded directly from Github at dragon-realms-lich
Resources
| Third-Party Software - edit |
|---|
| Lich Installation: Lich |
| Downloadable Lich Scripts: Go2 | Map | Repository | Popular Scripts |