GemStone IV Wiki - User contributions [en]

Lich:Software/Installation

2026-10-28T17:28:14Z

WHIGHTCNIGHT: /* Lich Changelog */ update to 5.23.0

{{3rd-party}}
=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 Wrayth or Wizard FE. Lich is also used by many on both MacOS and multiple Linux distributions.

=Installing the Latest Stable Release=

'''The latest stable lich version is 5.23.0 supporting Ruby 4.0 - published October 28, 2026'''

==In-Place Upgrade==

If you are on an older version of Lich 5 and want to upgrade to the most current version, you can choose to either upgrade Lich5 only or both Lich 5 and Ruby. If you're currently on Lich 4, able to check by running the command <CODE>;e echo LICH_VERSION</CODE>, go to the [[#Upgrade Installation for Lich 5 from Lich 4 (11/14/2023)|upgrade from Lich 4 section]].

For each section, please follow the directions/commands one at a time.

===Lich 5 Only===

====Lich 5.7 or newer====
# You must be running Ruby 4.0 or greater for Lich 5.19 +. If unsure, please update both (see below)!
# '''Backup existing Lich 5 folder'''
# Run this command in-game <CODE>;lich5-update --update</CODE>
# Quit and restart lich.
# Congratulations - you're now running on the latest version of Lich!

====Lich 5.6 or older====
Please proceed to updating both Ruby and Lich 5

===Both Ruby 4.0 & Lich 5===
This method is for Windows only. Linux and MacOS users, please do a Lich 5 only update and update Ruby manually via normal install/update methods for the OS.

# Logout of all characters
# '''Backup existing Lich 5 folder'''
# Uninstall existing Ruby4Lich5 installs from Programs & Features control panel, or alternatively, rename your existing Ruby4Lich5 folder to Ruby4Lich5save. (Defaults to C:\Ruby4Lich5)
# Download the latest [https://github.com/elanthia-online/lich-5/releases/latest/download/Ruby4Lich5.exe Ruby4Lich5.exe Installer]
# Run the installer and be sure to have both Ruby and Lich 5 option selected
# Congratulations - you're now running on the latest version of Lich & Ruby!

===Ruby 4.0 Only===
Use this to upgrade to the newest version of Ruby only if you're already on the latest version of Lich5 and now want to update Ruby afterwards. If you're not already on the latest version of Lich5, please use previous section steps instead.
# Logout of all instances/characters
# '''Backup existing Lich 5 folder'''
# Uninstall your existing Ruby4Lich5 install via Programs & Features (ensure it's now gone, default location was C:\Ruby4Lich5)
# Download the latest [https://github.com/elanthia-online/lich-5/releases/latest/download/Ruby4Lich5.exe Ruby4Lich5.exe Installer]
# Run the new installer and choose to only install Ruby Only
# Congratulations - you're now running on the latest version Ruby!

==Windows New Installation==

{{blue|These instructions are not for DragonRealms. [[#Ecosystem Information|For those scroll to the bottom]].}}

'''For Windows 11 / 10 / 8 / 7''' users: you can download the [https://github.com/elanthia-online/lich-5/releases/latest/download/Ruby4Lich5.exe Ruby4Lich5.exe Installer] and install everything you need automatically. Click on the '''Ruby4Lich5.exe''' and download it to your computer then double click on the executable in your default download folder. Note, a user may need to adjust their browser or security settings to allow download and installation.
If you have never played before, follow the 'New Installation' instructions. If you have played before, and have used Lich before, follow the 'Upgrade Installation' instructions.

===New Installation for Lich 5 (11/14/2023)===

# '''Please log into the game of your choice through the Simutronics website first'''. Install the launcher (not SGE), and install your FrontEnd of Choice. The Wrayth FrontEnd is presently the supported FrontEnd, but Wizard will work as well, if you are nostalgic. After you've logged in, log out and continue.
# Download and Run the [https://github.com/elanthia-online/lich-5/releases/latest/download/Ruby4Lich5.exe Ruby4Lich5.exe 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, 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.

===Upgrade Installation for Lich 5 from Lich 4 (11/14/2023)===

This option is deprecated. Lich 5 architectures are not compatible with Lich 4. Back up your existing Lich 4 folder, uninstall any existing Ruby executables, and then follow the instructions for a new install above.

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

==MacOS==
There are two common options for playing Gemstone IV on a Mac: play natively with Saga (the official front end) or Avalon, or use virtualization software such as Parallels with Wrayth/WizardFE. Below are the options on how to do that.

===Native (Saga or Avalon)===
Players with Macs can use [[Mac_Installation_-_Lich_(software) | Installing Lich on Macs]] for installation help. That guide sets Lich up with [[Saga]], the official Simutronics front end (currently in beta), and also covers [[Avalon]]. This process works well for Mac OS Catalina and Big Sur. If you have not updated your Mac OS yet, these instructions may work depending on your actual version. If you run into a snag, follow the contact instructions provided.

===Parallels Windows===
With the latest releases of Ruby4Lich5 installer, you can now follow the normal Windows installation for both Intel and Apple silicon based Apple computers.

To install Wrayth/WizardFE, Lich, and Ruby via Parallels you will need to do a few various steps as outlined below. Please note, the rubyw file in C:\Ruby4Lich5\X.X.X\bin may be set to run in compatibility mode for windows 7. On an ARM Mac running parallels, this may causes Wrayth scripts not to run. Turning compatibility mode off in the rubyw file could fixe this issue if it was enabled.

The following steps are to be done AFTER you've successfully installed Wrayth/WizardFE and can login normally without Lich5 on the machine. Once you've done that and can successful connect normally, then follow these steps:
# Download and install [https://github.com/elanthia-online/lich-5/releases/latest/download/Ruby4Lich5.exe Ruby4Lich5.exe Installer] and use default options presented during install
# Double click the lich.rbw file that is now located in the extracted Lich5 location you did above. Login and play as usual.

==Linux==
Pick the subsection for your distribution below. Each one installs Ruby and Lich; front ends (Saga, Profanity and Warlock) are covered once in [[#Frontends|Frontends]] at the end, since their steps are the same on every distribution.

===Chromebook & Debian variants===
<div class="mw-customtoggle-debian" style="font-size:16px;overflow:auto;color:#0000FF">[Click to Expand]</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-debian">
The following steps should install Lich for users of Debian/Chromebooks. To also install a front end such as Saga, Profanity or Warlock, see [[#Frontends|Frontends]] at the end of the Linux section.

'''Step 1.'''
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 curl libssl-dev libyaml-dev libreadline6-dev zlib1g-dev libncurses5-dev libffi-dev libgdbm6 libgdbm-dev libsqlite3-dev git unzip libcairo2-dev libgirepository1.0-dev libgtk-3-dev gobject-introspection
</pre>

{{side box|NOTE: If you are updating an existing Ruby installation rather than installing from scratch, skip steps 2, 3, and 4. Instead, update your ruby-build with the following command, and then proceed to Step 5.<pre>git -C ~/.rbenv/plugins/ruby-build pull</pre>}}

'''Step 2.'''
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>

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

'''Step 4.'''
Download the tools to let rbenv install Ruby on its own, then install Ruby 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</pre>

'''Step 5.'''
<pre>rbenv install 4.0.9 -v
rbenv global 4.0.9
</pre>

Install Lich:
<pre>
cd ~
curl -L "https://github.com/elanthia-online/lich-5/releases/latest/download/lich-5.zip" -o temp.zip && unzip temp.zip -d ./ && rm temp.zip
</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 using the <tt>Gemfile</tt> included with Lich5 by running <tt>bundle install</tt>. The Gemfile also lists developer-only gems (the <tt>development</tt> and <tt>vscode</tt> groups) that you do not need, so tell Bundler to skip them first:
<pre>
echo "gem: --no-document" > ~/.gemrc
cd ~/Lich5
bundle config set --local without 'development vscode'
bundle install
</pre>
:<small>Note: <tt>bundle install --without ...</tt> no longer works; that flag was removed from the version of Bundler that ships with Ruby 4.0. Use <tt>bundle config set</tt> as shown above.</small>
</div>

===Arch Linux & Arch-based distributions===
<div class="mw-customtoggle-arch" style="font-size:16px;overflow:auto;color:#0000FF">[Click to Expand]</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-arch">
The following steps should install Lich for users of Arch Linux and Arch-based distributions (Manjaro, EndeavourOS, etc.). To also install a front end such as Saga, Profanity or Warlock, see [[#Frontends|Frontends]] at the end of the Linux section.

Update the system and install required dependencies:
<pre>
sudo pacman -Syu
sudo pacman -S --needed base-devel openssl libyaml readline zlib ncurses libffi gdbm sqlite git unzip curl gtk3 gobject-introspection
</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 4.0.9 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 4.0.9 -v
rbenv global 4.0.9
</pre>

Install Lich:
<pre>
cd ~
curl -L "https://github.com/elanthia-online/lich-5/releases/latest/download/lich-5.zip" -o temp.zip && unzip temp.zip -d ./ && rm temp.zip
</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 using the <tt>Gemfile</tt> included with Lich5 by running <tt>bundle install</tt>. The Gemfile also lists developer-only gems (the <tt>development</tt> and <tt>vscode</tt> groups) that you do not need, so tell Bundler to skip them first:
<pre>
echo "gem: --no-document" > ~/.gemrc
cd ~/Lich5
bundle config set --local without 'development vscode'
bundle install
</pre>
:<small>Note: <tt>bundle install --without ...</tt> no longer works; that flag was removed from the version of Bundler that ships with Ruby 4.0. Use <tt>bundle config set</tt> as shown above.</small>
</div>

===Fedora===
<div class="mw-customtoggle-fedora" style="font-size:16px;overflow:auto;color:#0000FF">[Click to Expand]</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-fedora">
The following steps should install Lich for users of Fedora. To also install a front end such as Saga, Profanity or Warlock, see [[#Frontends|Frontends]] at the end of the Linux section.

Lich 5 requires Ruby 4.0 or newer. The Ruby that ships with currently supported versions of Fedora is older than that (41 uses Ruby 3.3; 42 and 43 use Ruby 3.4), so these steps install Ruby 4.0.9 with '''<tt>[https://github.com/rbenv/rbenv rbenv]</tt>''' instead of using Fedora's Ruby.

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 cairo-devel curl gcc gdbm gdbm-devel gdk-pixbuf2-devel glib2-devel \
gobject-introspection-devel gtk3-devel libyaml-devel libffi-devel make ncurses-devel openssl-devel readline-devel \
redhat-rpm-config sqlite-devel unzip zlib-devel
</pre>

{{side box|NOTE: If you are updating an existing rbenv Ruby installation rather than installing from scratch, skip step 3. Instead, update your ruby-build with the following command, and then run only the <tt>rbenv install</tt> and <tt>rbenv global</tt> lines from step 3.<pre>git -C ~/.rbenv/plugins/ruby-build pull</pre>}}

3. Install rbenv and Ruby 4.0.9:
<pre>
git clone https://github.com/rbenv/rbenv.git ~/.rbenv
echo 'export PATH="$HOME/.rbenv/bin:$PATH"' >> ~/.bashrc
echo 'eval "$(rbenv init -)"' >> ~/.bashrc
source ~/.bashrc
git clone https://github.com/rbenv/ruby-build.git ~/.rbenv/plugins/ruby-build
rbenv install 4.0.9 -v
rbenv global 4.0.9
ruby -v
</pre>
The last command should print a line starting with <tt>ruby 4.0.9</tt>. If it doesn't, close and reopen the terminal and try <tt>ruby -v</tt> again.

4. Install Lich:
<pre>
cd ~
curl -L "https://github.com/elanthia-online/lich-5/releases/latest/download/lich-5.zip" -o temp.zip && unzip temp.zip -d ./ && rm temp.zip
</pre>

5. 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 using the <tt>Gemfile</tt> included with Lich5 by running <tt>bundle install</tt>. The Gemfile also lists developer-only gems (the <tt>development</tt> and <tt>vscode</tt> groups) that you do not need, so tell Bundler to skip them first:
<pre>
echo "gem: --no-document" > ~/.gemrc
cd ~/Lich5
bundle config set --local without 'development vscode'
bundle install
</pre>
:<small>Note: <tt>bundle install --without ...</tt> no longer works; that flag was removed from the version of Bundler that ships with Ruby 4.0. Use <tt>bundle config set</tt> as shown above.</small>
</div>

===Frontends===
<div class="mw-customtoggle-frontends" style="font-size:16px;overflow:auto;color:#0000FF">[Click to Expand]</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-frontends">
Finish the Lich installation for your distribution above first, then set up one of these front ends.

====Saga====
[[Saga]] is the official Simutronics front end for GemStone IV and DragonRealms (currently in beta), and it works with Lich. On Linux it comes as a single AppImage file.

'''Install Saga'''

Go to the [https://www.play.net/gs4/play/saga-info.asp Saga info page] and click '''Download for Linux''' (AppImage, x86_64). On a Chromebook, move the downloaded file into the '''Linux files''' folder with the Files app so Linux can see it.

Then put it where Lich looks for Saga, make it runnable, and start it:
<pre>
sudo mkdir -p /opt/Saga
sudo mv ~/Downloads/Saga-*.AppImage /opt/Saga/saga
sudo chmod +x /opt/Saga/saga
/opt/Saga/saga
</pre>
:<small>On a Chromebook use <tt>~/Saga-*.AppImage</tt> in place of <tt>~/Downloads/Saga-*.AppImage</tt>.</small>

Log in to the game from inside Saga once, without Lich, to make sure Saga itself works.

If Saga will not start and mentions FUSE or <tt>libfuse.so.2</tt>, install FUSE 2 and try again: <tt>sudo apt-get install libfuse2</tt> on Debian/Chromebook (on Debian 13 and newer, <tt>libfuse2t64</tt>), <tt>sudo pacman -S fuse2</tt> on Arch, or <tt>sudo dnf install fuse-libs</tt> on Fedora.

'''Use Saga with Lich'''

Saga starts Lich for you:
# Log in with Saga normally, then choose '''File → Enable Login with Lich'''.
# Choose '''File → Return to login'''.
# Click '''Connect''', then '''Via Lich''', and point it to your Lich folder (<tt>~/Lich5</tt>).
# If Saga asks where Ruby is, or Lich will not start, run <tt>rbenv which ruby</tt> and give Saga the path it prints (it ends in <tt>.rbenv/versions/4.0.9/bin/ruby</tt>).
# Log in. The game will start in Saga with Lich running.

Once that works, you can also start from the Lich login window (<tt>ruby ~/Lich5/lich.rbw</tt>): 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.

====Profanity====
Profanity is a terminal-based Front-End that will let you play the game (in lieu of The Wizard or Wrayth). Its gems (such as <tt>curses</tt>) are installed by the <tt>bundle install</tt> step above. Download Profanity:
<pre>
cd ~
git clone https://github.com/elanthia-online/ProfanityFE.git
</pre>

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

====Warlock====
Download Warlock from https://sproctor.github.io/warlock3/download.html, then run Lich the normal way with Ruby:
<pre{{log2|margin-right=35%}}>
ruby ~/Lich5/lich.rbw
</pre>
Use your login information with these settings to use the Lich launcher: https://github.com/sproctor/warlock3/wiki/Lich-support
</div>

=Popular Scripts=
{{#section:Lich:Script Repository|popularscripts}}

=Ecosystem Information=

* DragonRealms Variant - [https://elanthipedia.play.net/Lich_script_repository#Setup_and_Installation Setup and Install instructions]

=Lich Changelog=
<div class="mw-customtoggle-changelog" style="font-size:16px;overflow:auto;color:#0000FF">[Click to Expand]</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-changelog">
'''5.23.0'''
<PRE>
### Features (general)
* Saga identifies as /P:SAGA in the headless handshake; add --fe-version (#1682)
* skip syncing eo/scripts scripts that need a newer Lich (#1692)
* parse the Saga <room> element natively (#1707)
* rewrite <room> to the legacy layout for front ends without room_element (#1708)
* replace a proxied front end's client string with Lich's (#1724)
* let each client declare the rich-stream rewrites it handles (#1726)
* log the intercepted and emitted client strings (#1731)
* count the first leg in Map.estimate_time with a from: room (#1739)
### Features (dr)
* DRCA.day_night_ok? exposes the waggle day/night rule (#1691)
* send the legacy compass after a <room> block rewritten for the front end (#1721)
* strip game links and doubled bold for front ends without them (#1722)
* opt-in filter for the room description DragonRealms sends with FLAG DESCRIPTION OFF (#1725)
* ignore NPCs by full name as well as noun (#1817)
### Bug Fixes (general)
* --login no longer rejects transport/bind options as game codes (#1685)
* --frontend=saga headless detachable clients get Saga handling (#1696)
* guard ActiveSpell and Gift references in XMLParser (#1711)
* ;hmr no longer reloads gem/stdlib files or dies on SyntaxError (#1718)
* trim whitespace from GameObj nouns (#1730)
* repair nested quotes before judging a stream desync (#1732)
* note Lich's client string on the Wizard and Frostbite paths (#1733)
* confirm a beta install with a second command instead of reading the client socket (#1737)
* write top-level Settings keys into the current row with a compare-and-swap (#1742)
* keep the existing map when Map.save_json fails (#1751)
* replace updated files atomically without moving them away (#1754)
* stage lich5-update snapshots and refuse to revert from an incomplete one (#1755)
* TextStripper.strip raises ArgumentError for invalid modes as documented (#1762)
* keep Vars dirty when a save fails so it is retried (#1763)
* share one end-anchored roundtime wait pattern across fput, dothis and move (#1767)
* show other sessions' Settings changes on the next read (#1769)
* let SQLite lock waits release the GVL on every connection (#1771)
* replay Settings proxy writes on the stored row, keeping other sessions' entries (#1772)
* recover session heartbeats after transient failures (#1775)
* bound set retries when the database remains busy (#1776)
* coordinate active-session handler lifetime (#1777)
* fail unreadable scripts without caching libraries (#1778)
* persist display settings before applying changes (#1779)
* preserve native dependency recovery rollback state (F63) (#1781)
* protect credential publication and CLI account updates (F1) (#1782)
* store writes made through Settings iteration and derived views (#1787)
* serialize the map without moving rooms off their ids (#1797)
* write personal map targets into go2's custom targets (#1800)
* respond, _respond and Lich::Messaging.msg return nil again (#1801)
* re-check GitHub on every lich5-update --update instead of reusing a stale target (#1806)
* make a Settings write under a navigation path a key-level compare-and-swap (#1807)
* close the frontend settings temp file before renaming it, and retry sharing violations (#1808)
* hold the revert lock while snapshotting and refuse cut-off older snapshots (#1810)
* make SQLite3::Backup on lich.db3 connections safe to interrupt and share (#1812)
* explain a missing .sal launch file instead of crashing (#1818)
* validate --add-account arguments and correct frontend note (#1820)
* normalize character names one way across entry.yaml writes and lookups (#1821)
* remove broken Win32 shellexecute path, fix Windows error paths (#1822)
* recommend Ruby 4.0.9 for security fixes and refresh Gemfile.lock (#1825)
* send Wrayth 1.0.1.28 client string for server XML feed (#1858)
### Bug Fixes (dr)
* DRC.bput resends once per roundtime refusal and ignores player speech (#1693)
* match DRParser patterns and Flags against a link-stripped line (#1702)
* use the GS link path for room objs/players when links are present (#1705)
* stage the worn inv stream and learn the stow container from its header (#1709)
* DRCMM.set_planet_data returns nil when no planet can be used (#1735)
* DRCT.find_empty_room skips a room walk_to can't reach (#1736)
* keep one experience reporter through expgains off/on and hot reload (#1738)
* bound SlackBot token request wait on a quiet stream (#1741)
* keep DRBanking balances in per-character rows (#1743)
* make the issue_command timeout guards fire and flag uncaptured health (#1744)
* recipe_lookup returns the recipe picked from its menu (#1746)
* keep DRC.collect practice mode on the cluttered-room retry (#1747)
* only mark SlackBot initialized after users.list succeeds (#1748)
* walk_to fails loudly from an unresolved room and reports arrival by Room.current (#1749)
* DRCC.get_crafting_item stops on "can't quite lift it" and keeps skip_exit (#1750)
* DRCC.stow_crafting_item stops retrying a belt tie that can't succeed (#1752)
* DRCC.empty_crucible? tilts molten metal and stops after 3 passes (#1756)
* alert when a held gear-set item fails to wear or put away (#1757)
* DRC.bput returns the immobile reply to callers that list it (#1758)
* bound check_moonwatch's wait and wait for real moon data (#1759)
* DRCT.find_empty_room falls back at once when the last buddy room is unreachable (#1760)
* identify a room without a usable UID by a unique text match (#1788)
* DRCI tie success reply must start with the TIE verb (#1790)
* bound DRC.collect retries in a room that stays cluttered (#1791)
* parse the current Moon Mage PERC MANA reply in DRCA.perc_mana (#1792)
* DRCI.dispose_trash never re-fetches an item it already held (#1793)
* DRCT.find_empty_room stops when it has no room it can reach (#1794)
* drop custom spell messages that can match zero characters (#1795)
* keep the SlackBot users cache per token (#1796)
* DRCC.repair_own_tools stows the tool once and stops on engaged (#1802)
* DRCT merchant helpers stop when the walk to the shop fails (#1803)
* don't charge or cast after a prep that drew no reply and shows no spell (#1804)
* DRC.retreat stops when held or unable to stand (#1805)
* stop SlackBot connection failures from killing the calling script (#1809)
* cap each Slack call SlackBot.new makes at startup (#1811)
* DRCT.find_empty_room asks the predicate in the buddy pass (#1815)
* list duplicate room NPCs as plain nouns and make DRRoom.npcs read-only (#1816)
* anchor DRParser state patterns against player speech and ESP (#1827)
* stop Flags.add from racing DRParser.check_events (#1828)
* enter the exp-columns branch only when the scan reads a column (#1829)
* rejoin lines cut by a roundtime refusal (#1857)
### Bug Fixes (gs)
* apply standalone crtrStatus updates to known creatures (#1716)
* drop Creature.damage_report delegators to removed methods (#1717)
* guard the GemStone Creature.register call in XMLParser (#1719)
* match held ready-list items by exact id, not substring (#1764)
* let a failed Infomon write be retried (#1765)
* release Infomon DB lock when a parsed section errors (#1766)
* recognize Council of Light Lodge joins (#1773)
* restore non-corporeal neck critical location (#1774)
</PRE>
'''5.22.0'''
<PRE>
### Features (general)
* add opt-in bounded script execution guards (#1575)
* add static-only map route selection (#1577)
* bounded fput with max_resends, interrupt, resend_transient and failure symbols (#1587)
* Spell.results_regex, the lines cast waits on, exposed (#1590)
* add Events, a script-to-script notification primitive; combat emits on it (#1619)
* add deterministic hook priorities (#1621)
* Map.boundary_rooms_for(ids), the perimeter of any set of rooms (#1660)
* sticky ever_hostile? keeps Sympathy'd creatures in targets (#1665)
* --pipe -g honours the frontend flag, and --sentinel requests the origin marker (#1677)

### Features (gs)
* add trustworthy combat observation provenance (#1576)
* Lich::Gemstone::Stance, a shared stance setter (#1578)
* Lich::Stash.wield and Stash.hands put named items into hands (#1579)
* Lich::Gemstone::Mana.pulse, the MANA PULSE verb once (#1580)
* Lich::Gemstone::Bank, Currency refresh, and WEALTH parser lines (#1581)
* PSM command and results_regex readers, factored out of use (#1583)
* Lich::Gemstone::Fog, the ways home on the spell and society readers (#1584)
* Combat::Messages - non-combat message families as observer events (#1586)
* society command readers, factored out of use (#1589)
* Group.join, the follower's side of Group.add (#1591)
* emit post-commit combat recorder receipts (#1592)
* combat definition supplements from a player YAML file (#1607)
* message definitions from the player supplement file (#1608)
* creature library - abilities from session logs, limbs flags, triggers as hash of arrays (#1623)
* expose exact server creature health from crtrStatus (#1661)

### Bug Fixes (general)
* fix spec stub race breaking FFI loads, gate WindowsCredentialManager to Windows (fixes #1542) (#1573)
* setup_files uses content hash for cache freshness (#1596) (#1599)
* creatures registry housekeeping independent of Combat::Tracker (#1603)
* place effect-list.xml backups in the update snapshot folder (#1606)
* retain discovery ownership through cleanup (#1612)
* Initial Lich state update and detachable-client split GS/DR (#1617)
* bound move()'s remedy retries, record why a move failed, lift it into Lich::Common::Move (#1622)
* update puts to Lich.log (#1630)
* create detachable-client session file without --login (#1656)
* converge server_time_offset instead of resetting it every prompt (#1663)
* plain-language lich5-update messages when GitHub fails (#1687)
* Inventory.refresh waits out roundtime before sending (#1688)

### Bug Fixes (dr)
* update HOW pattern to accommodate various soul states (#1620)
* restore script halt in DRCC.get_crafting_item on missing item (#1624)
* halt script when too distracted to turn recipe book (#1625)
* equipmentmanager energy bow handling (#1662)
* report when DRC.rummage can't read a container (#1671)
* DRCI.get_item? confirms #<id> gets by the item id in hand (#1674)
* DRCT.sell_item references the item through DRCI.item_ref (#1675)
* DRCA.do_buffs filters day/night spells without mutating settings (#1680)
* DRCI.tie_item? no longer reports an empty pouch as tied (#1684)
* DRC.play_song? keeps climbing and performance songs across instrument switches (#1686)

### Bug Fixes (gs)
* Injured cache lives on the class and keys on an injury fingerprint (#1582)
* infomon - a spell's start message refreshes a refreshable timer (#1585)
* Group.broken? waits on Lich::Claim::Lock, the constant that exists (#1588)
* combat module - hunt-log audit: interrupted-swing resume, status attribution by event, spell-loss cause, live defs (#1593)
* QStrike prices MSTRIKE's own stamina cost (#1594)
* combat module - a stand-up message later in the chunk outranks an earlier knockdown crit (#1595)
* track spell cooldowns on the characters a spell locks out (#1597)
* catalog missing deity-specific strike lines for Divine Wrath (335) (#1598)
* combat module - Rysk/Dreadt log audit: Holy Weapon release model, held maneuver rolls, AoE roll attribution, live defs (#1600)
* Combat defs add thrust as a basic attack (#1615)
* preserve group state after ambiguous disband reply (#1629)
* target ridden mounts before their first crtrStatus (#1669)
* snapshot Effects registries so scripts can't break the XML parser (#1672)
</PRE>
'''5.21.0'''
<PRE>
### Features (general)
* Add --refresh-characters and --add-character CLI flags (#1504)
* add --active-session-dir to decouple Active Sessions coordination from --temp (#1520)
* add read model for the inventoryManager extended feed (#1524)
* GUI add configurable frontend registry (#1558)
* add HTTPS web-login fallback for when EAccess (7910) is unreachable (#1570)

### Features (dr)
* player-supplied custom prep/cast/invoke messages (#1528)
* opt-in cambrinth charge distribution across configured items (#1549)
* populate GameObj from INV LIST full refresh (02 of 05) (#1554)
* non-destructive upsert for INV SEARCH / category scrapes (03 of 05) (#1556)
* reconcile GameObj containers on hand pickup (04 of 05) (#1557)
* [DRCC] add shared private-forge helpers (#1560)

### Features (gs)
* creature template library - measured combat data, HP/speed censuses, messaging (#1539)

### Bug Fixes (general)
* enforce Script#pause at every blocking/mutating checkpoint (#1537)
* always report missing gems on stderr; only wait on a dialog without a tty (#1544)
* dispatch --help and --version before the GTK require (#1546)
* global_def update deprecated method calls to include caller info (#1550)
* normalize colons in Lich::Util.normalize_lookup (#1561)
* Script.log respects --log-dir/LOG_DIR override; use File.join for paths in script.rb (#1572)

### Bug Fixes (dr)
* drvariables add more data to VOL_MAP (#1536)
* pin capped skills to 34 in DRSkill.clear_mind (#1548)
* match lowercase "it's already open" when opening a container (#1553)
* normalize capitalized leading articles in inventory scrape names (01 of 05) (#1555)
* make INV LIST refresh atomic and warn on interruption (05 of 05) (#1563)
* refresh before_name/after_name on a name-preserving container move (#1564)
* do not re-add a held item as worn inventory on inv scrape (#1565)
* evict orphaned identity-index entries on a name-changing upsert (#1566)
* unpause the exact scripts safe_pause_list paused, by object (#1574)

### Bug Fixes (gs)
* Infomon xmlparser additional npc death messaging (#1540)
* correct messaging drift in 13 crit table patterns (#1547)
* combat module - event defs, observer emissions, replay-verified parsing, SQLite recorder (#1559)
</PRE>
'''5.20.1'''
<PRE>
### Bug Fixes (general)
* bound EAccess auth with a timeout so a stalled SGE backend can't hang Lich silently (#1502)
* Linux WINE and Wrayth FE detection (#1517)
* update Gemstone game-code validations (#1518)
* preserve bundled display-state tags on quiet-suppressed chunks (#1530)
* prevent a stray formatting character from appearing in Saga during quiet script output (#1532)

### Bug Fixes (dr)
* make $safe_pause_lock holder immune to pause (#1525)

### Bug Fixes (gs)
* critranks.rb tolerate nil table rows, fix reload!, index patterns … (#1522)
* combat module hardening - ordered processing, 22x faster parsing, double-count fix (#1523)
</PRE>
'''5.20.0'''
<PRE>
### Features (general)
* add concurrent runtime I/O and multi-client detach support (#1459)
* --bind-address speaks the same keywords as --detachable-client (#1461)
* GUI Launcher Improvements (#1463)
* Add supervised child script APIs (01 of 06) (#1474)
* Add forced script teardown command (06 of 06) (#1479)
* teardown and distinguishable errors for Script.run_child (#1501)

### Features (dr)
* DRCMM.moon_weapon_duration - read a moon weapon's remaining life (#1483)
* id-based creature tracking from crtrStatus + assess (#1485)
* capture room UID from <nav> tag; stop enforcing ShowRoomID; opt-in room-id placement (#1491)
* user-extensible scroll substitutions via settings (01 of 06) (#1512)
* user-extensible boxes and trash receptacles (03 of 06) (#1514)
* user-extensible summoned-weapon adjectives (04 of 06) (#1515)
* user-extensible flavor-text stripping (05 of 06) (#1516)

### Features (gs)
* gameobj add full_name matcher to type/sellable classification (#1453)

### Bug Fixes (general)
* prevent empty/partial GameObj registry reads during mid-stream refresh (#1370)
* no-op Gtk.lich_main_quit when no main loop is nested (#1464)
* correct path-flag aliases and document all path options (#1472)
* Synchronize script lifecycle transitions (02 of 06) (#1475)
* Coordinate script shutdown draining (03 of 06) (#1476)
* Harden script lifecycle ownership (05 of 06) (#1478)
* surface the underlying LoadError in dependency alerts (#1480)
* extract game-agnostic CreatureBase into lib/common (#1484)
* bound GemCheck alert dialogs with a timeout so they can't hang forever (#1488)
* identify Genie as the frontend for headless launches (#1490)
* restore detachable client disconnect notice to stdout (#1492)
* harden detachable client teardown and escape init payload (#1493)
* resolve GameObj status visibility during staged refresh (#1497)
* compact client write queue instead of ending the session (#1498)
* scrub startup credentials once login completes (#1499)
* Honor Simu-side teardown for 10 seconds (#1505)

### Bug Fixes (dr)
* resolve no-UID rooms carrying a stored UID instead of returning nil (#1467)
* equipmanager.rb - reliable ranged-weapon transitions - stow ammo after unload + verify offhand wield hand (#1468)
* common-healing.rb - DRCH.bind_wound: only dispose a dislodged item while it is in hand (#1469)
* preserve game RealID in room title (GS parity for ";display roomid title") (#1500)
* Refine need_buffs? logic for non-recast spells to correctly check cyclic spells. (#1503)
* reduce symbol-torn scale scrolls to gettable noun (#1506)
</PRE>
'''5.19.1'''
<PRE>
### Bug Fixes (general)
* lower game socket keepalive idle from 120s to 30s (#1449)
* resilient ActiveSessions ownership + shutdown watchdog (#1452)
* Quit Gtk.main cleanly (#1455)
* Refactor regex to string comparisons for ARGV options (#1456)

### Bug Fixes (gs)
* ingest newly-exposed mindState experience and roommeta room fields (#1450)
</PRE>
'''5.19.0'''
<PRE>
### Features (general)
* Add character generator support via EAccess protocol (#1384)
* Add modern script command shutdown method (#1385)
* migrate the server-stream parser from REXML to Ox, with pipe-mode benchmark harness and DR parser coverage (#1396)
* enumerate script subdirs with file glob (#1397)
* add --bind-address option to set listen socket address (#1405)
* add central method to determine lich ver (#1417)
* setup_files: support scripts/data/custom for user data overrides (#1431)
* Modify running? method to support optional exact matching of script names (#1436)
* keyword bind hosts for the detachable client (tailscale/lan/any) (#1437)
* add roomlinks/roommono toggles for room display (#1438)
* self-healing gem requires (#1439)
* various Saga FE compatibility tweaks (#1443)
* add macOS limited gem recovery (#1448)

### Features (dr)
* Capture combat position from the balance status line (#1400)
* detect scheduled shutdown and expose it on DRParser (#1409)
* xmlparser: add structured parser for the assess (combat situation) stream (#1413)
* Implement DRCA.need_buffs? method for buff checks (#1428)

### Features (gs)
* anchor Infomon parser regex unions to line start (#1391)
* creature xml additions (#1425)
* add creature template library (#1427)

### Bug Fixes (general)
* surface a failed Game.open in the connect timeout (#1408)
* bound long-session memory growth (index/hook/watchfor/buffer leaks) (#1410)
* improve and harden shutdown (#1416)
* use bundler to check for required Ruby gems (#1420)
* pin lich directory for gemfile check (#1423)
* Show CLI login ARGV for SAL connections (#1424)
* increase read timeout on idle socket to 300 seconds (#1426)
* monkeypatch gi for memoryreleaser / asyncprocessor until patched upstream (#1429)
* Mapdb sort tags by downcase and original case (#1433)
* stop locking the load path at boot; keep Gemfile.lock in sync on self-update (#1434)
* minimum Ruby 4.0 required & migrate Ruby version check (#1444)
* align --announce with --update for Ruby version (#1447)

### Bug Fixes (dr)
* BalanceValue regex to match combat status lines (#1398)
* equipmanager.rb - Fix unload weapon detection when AimTimerDialog tag is prepended (#1414)

### Bug Fixes (gs)
* global_defs update pushStream regex to include 'reserve' id (#1379)
* psms Warcry.available? correction (#1387)
* xmlparser support new field exp, climate, terrain XML feeds (#1388)
* global_defs move() update regex for standing condition (#1407)
* Currency add method to retrieve aevit event currency (#1411)
* Stash check result type before comparing regex for wear_to_inv (#1430)
</PRE>
'''5.18.0'''
<PRE>
### Features (dr)
* common-crafting add method for creating mechanisms (#1375)

### Bug Fixes (general)
* stringproc normalize CRLF | CR to LF (#1378)
* rubocop custom cop ascii only cleanup (#1382)

### Bug Fixes (dr)
* equipmanager update to assume missing items aren't worn (#1376)

### Bug Fixes (gs)
* Infomon xmlparser additional npc death messaging (#1326)
</PRE>
'''5.17.3'''
<PRE>
### Bug Fixes (general)
* Script module replace MemoryReleaser with GC.start for cleanup (#1364)
* Add sqlite busy timeout policy to core (#1365)
* Script#kill remove GC.start and add optional instrumentation (#1368)
* reorder shutdown ala MahtraDR and detect script teardown de... (#1369)
</PRE>
'''5.17.2'''
<PRE>
### Bug Fixes (general)
* harden custom repo identity, collision, and contract boundaries (#1333)
* stop SessionLifecycle before closing database on normal exit (#1334)
* harden FeatureFlags for closed db handle (#1335)
* SynchronizedSocket write resilience and zombie client elimination (#1338)
* correct RP timing issue for release notes (#1348)
* gate object cleanup in GTK queue (#1354)
* recover from cross-process zombie in ActiveSessions service (#1355)
* Improve shutdown session state handling (#1359)
* non-ascii hygeine to address rubocop errors (#1360)
* Remove debug log IO from heartbeat tick loop (#1363)

### Bug Fixes (dr)
* DRC text2num correction for thousand (#1343)

### Bug Fixes (gs)
* Overwatch add REVEALED_EXPLODES regex pattern (#1356)
* Stash add_to_bag result type check before regex compare (#1357)
</PRE>
'''5.17.1'''
<PRE>
### Bug Fixes (general)
* enable heartbeat-driven failover for ActiveSessions service owner (#1340)
* copy Gemfile and LICENSE during self-update (#1345)
* Add top-level parse_args/display_args bridge to global_defs (#1346)

### Bug Fixes (dr)
* replace undefined custom_require in check_moonwatch (#1336)
* set_stance places 100 in the correct positional slot (#1337)
* cache SlackBot users list to prevent API throttling (#1342)
* Add CORE_AUTOSTART sentinel to skip dependency.lic autostart helpers (#1344)

### Bug Fixes (gs)
* Infomon Status.cutthroat? Effect Debuff correction (#1331)
* add support for RESERVE xml in GameObj.reserve (#1341)
</PRE>
'''5.17.0'''
<PRE>
### Features (general)
* custom 3rd-party repo support for ScriptSync (#1285)
* Add get_settings, get_data, start_scripts_if_available to core (#1305)
* Add Map.apply_wayto_overrides for personal map overrides (#1306)

### Features (dr)
* Decouple SetupFiles from script-scoped echo and XML feed timing (#1304)
* Add game flags and obsolete script warnings to DRInfomon startup (#1307)

### Bug Fixes (general)
* use :__unset for --without-frontend CLI request YAML matches (#1301)
* prevent zombie server deadlock in Active Sessions accept loop (#1302)
* improve MacOS keychain system check for older OS variants (#1310)
* stub sync_all_repos to prevent leaked thread in games_spec (#1311)
* enforce beta confirmation 10s timeout (#1315)
* use send(:respond) in StatusReporter fallback path (#1316)
* ensure SessionLifecycle.stop runs on abnormal exit (#1317)
* address ActiveSessions lifecycle hot path feature-flag polling (#1325)
* catch ECONNRESET in _puts and bound walk_to retry depth (#1327)
* safeguard gtk logo.png loading (#1329)

### Bug Fixes (gs)
* Add InnCheckedOut pattern to parser (#1309)
* Claim corrections to handle mounts in room_players stream (#1324)
</PRE>
'''5.16.2'''
<PRE>
### Features (general)
* session summary store and reporting (#1247)
* add core classes, ScriptSync, and login auto-sync (#1273)
* Add active sessions API (#1274)
* Add session status CLI query (#1276)
* configurable debug log retention (#1282)

### Features (dr)
* common-healing.rb - add vitality parsing to HealthResult (#1265)

### Bug Fixes (general)
* handle auth exceptions in manual login to prevent hang on bad password (#1267)
* set SO_REUSEADDR before bind to allow immediate port reuse (#1268)
* Persistent Launcher re-enable play button post launch (#1269)
* Restore manual login behaviors to not require saved entry t... (#1270)
* log and re-raise unexpected errors in saved login auth handler (#1271)
* narrow safe_write rollback scope so cleanup failure preserves successful write (#1287)
* fix three revert bugs in SnapshotManager (#1289)
* guard nil release asset and validate before deleting lib/ (#1290)
* guard nil stable version in beta channel resolution (#1291)
* remove dead code in BranchInstaller (#1292)
* repair regression on gui button reenable from refactor (#1297)

### Bug Fixes (dr)
* common-items.rb - move pattern from failure to success block (#1262)
* buffer_room_objs missed split components with leading stream tags (#1284)
* common-items.rb - get_item_unsafe false positives via XML feed verification (#1286)
* forward vitality and dead fields in perceive_health (#1288)

### Bug Fixes (gs)
* Infomon xmlparser additional npc death messaging (#1275)
* Infomon xmlparser additional npc death messaging (#1281)
</PRE>
'''5.16.1'''
<PRE>
### Features (general)
* session summary store and reporting (#1247)
* add core classes, ScriptSync, and login auto-sync (#1273)
* Add active sessions API (#1274)
* Add session status CLI query (#1276)
* configurable debug log retention (#1282)

### Features (dr)
* common-healing.rb - add vitality parsing to HealthResult (#1265)

### Bug Fixes (general)
* handle auth exceptions in manual login to prevent hang on bad password (#1267)
* set SO_REUSEADDR before bind to allow immediate port reuse (#1268)
* Persistent Launcher re-enable play button post launch (#1269)
* Restore manual login behaviors to not require saved entry t... (#1270)
* log and re-raise unexpected errors in saved login auth handler (#1271)
* narrow safe_write rollback scope so cleanup failure preserves successful write (#1287)
* fix three revert bugs in SnapshotManager (#1289)
* guard nil release asset and validate before deleting lib/ (#1290)
* guard nil stable version in beta channel resolution (#1291)
* remove dead code in BranchInstaller (#1292)

### Bug Fixes (dr)
* common-items.rb - move pattern from failure to success block (#1262)
* buffer_room_objs missed split components with leading stream tags (#1284)
* common-items.rb - get_item_unsafe false positives via XML feed verification (#1286)
* forward vitality and dead fields in perceive_health (#1288)

### Bug Fixes (gs)
* Infomon xmlparser additional npc death messaging (#1275)
* Infomon xmlparser additional npc death messaging (#1281)
</PRE>
'''5.16.0'''
<PRE>
### Features (general)
* session summary store and reporting (#1247)
* add core classes, ScriptSync, and login auto-sync (#1273)
* Add active sessions API (#1274)
* Add session status CLI query (#1276)
* configurable debug log retention (#1282)

### Features (dr)
* common-healing.rb - add vitality parsing to HealthResult (#1265)

### Bug Fixes (general)
* handle auth exceptions in manual login to prevent hang on bad password (#1267)
* set SO_REUSEADDR before bind to allow immediate port reuse (#1268)
* Persistent Launcher re-enable play button post launch (#1269)
* Restore manual login behaviors to not require saved entry t... (#1270)
* log and re-raise unexpected errors in saved login auth handler (#1271)

### Bug Fixes (dr)
* common-items.rb - move pattern from failure to success block (#1262)
* buffer_room_objs missed split components with leading stream tags (#1284)
* common-items.rb - get_item_unsafe false positives via XML feed verification (#1286)

### Bug Fixes (gs)
* Infomon xmlparser additional npc death messaging (#1275)
* Infomon xmlparser additional npc death messaging (#1281)
</PRE>
'''5.15.1'''
<PRE>
### Bug Fixes (general)
* Mutli-launch persistent login GUI (#1245)
* Remove Windows OS CMD prompt flash (#1255)
* guard against broken pipe errors in Game._puts and send_to_client (#1260)
* add timeout safety to fput to prevent infinite hangs (#1261)

### Bug Fixes (dr)
* anchor stow success pattern to prevent fan close recovery bypass (#1254)
* add bounded recursion depth limits to 9 methods (#1257)
* stow_helper failure detection + unload_weapon ammo recovery (#1259)
</PRE>
'''5.15.0'''
<PRE>
### Features (general)
* add InstanceSettings for core Settings API access (#1233)

### Features (gs)
* Overwatch module into core (#1201)

### Bug Fixes (general)
* fix GameObj container initialization and add clear_all_containers (#1226)
* GameObj object dedupe & GC (#1234)
* script.rb show Script.kill source (#1235)
* Exit quickly on CLI authentication failure (#1237)
* suppress wine detection noise and skip when unneeded (#1244)

### Bug Fixes (dr)
* DR modules fixes and enhancements (#1232)

### Bug Fixes (gs)
* psms.rb add additional failure matches (#1238)
* Bounty parser fix regex pattern for skin retrieval task (#1242)
</PRE>
'''5.14.2'''
<PRE>
### Bug Fixes (general)
* add retry with exponential backoff for all login authentication (#1205)
* update.rb allow for bugfix betas and branch updates (#1211)

### Bug Fixes (gs)
* infomon.rb bug in _key transformation (#1216)
</PRE>
'''5.14.1'''
<PRE>
### Bug Fixes (general)
* Change server_time_offset in XMLParser to be float instead of int (#1184)
* change encodings in main.rb to wizard FE only (#1199)

### Bug Fixes (gs)
* Infomon parser.rb update Account.subscription/type (#1192)
* spell.rb add last_cast to track last time casted (#1193)
* stash.rb additional improvements with ReadyList/StowList (#1197)
* Infomon parser.rb bug in EnhanciveEnd (#1198)
</PRE>
'''5.14.0'''
<PRE>
### Features (general)
* Add Genie map cross-reference fields to the DragonRealms map data model (#1169)

### Features (dr)
* DRExpMonitor move into core lich (#1154)

### Features (gs)
* add Enhancive module for enhancive item bonus tracking (#1113)
* add QStrike module for optimal stamina-based RT reduction (#1114)

### Bug Fixes (general)
* remove strip! from settingsInfo replacement (#1161)
* map_base.rb sort JSON better (#1171)

### Bug Fixes (dr)
* logbook_item recovery when crafted item not in hand (#1175)

### Bug Fixes (gs)
* xmlparser.rb capture additional death messaging (#1158)
* stash.rb ReadyList sheath handling and update inventory checks (#1166)
</PRE>
'''5.13.6'''
<PRE>
### Bug Fixes (general)
* allow --add-account to run without yaml and dat (#1143)
* enable --login for multi-variable custom launch commands (#1144)
* update.rb pervent update if MIN_RUBY not met (#1146)
* messaging.rb return "" for xml_encode with Wizard (#1147)
* prevent closing connection on module reload (#1148)
* Allow hmr to work on global_defs.rb (#1156)

### Bug Fixes (dr)
* buffer split room obj lines and merge instead of appending closing tag to broken line (#1149)
* add buffering for multiline room players (#1151)
* add verify_script def here instead of depending on dependency (#1155)

### Bug Fixes (gs)
* infomon.rb added updated_at field to upsert_batch (#1145)
* stowlist.rb check method fix when dead (#1152)
* readylist.rb check method fix when dead (#1153)
</PRE>
'''5.13.5'''
<PRE>
### Bug Fixes (general)
* util.rb only show gem installing debug messaging if gem mis… (#1131)
* add --gs and --dr, refactor argv_options to helpers (#1133)
* fix multiple custom entries, improvements to yaml save (#1134)
* login_tab_utils.rb expand helper text show Warlock (#1135)
* update CLI for YAML security signature, add auto-convert fo… (#1136)
* remove password parameter from debug logging in all cases (#1137)
* reduce minimum GUI window footprint for non-tabbed view (#1138)
* remove double save in YAML to preserve yaml.bak integrity (#1139)

### Bug Fixes (gs)
* stash.rb additional improvements (#1132)
</PRE>
'''5.13.4'''
<PRE>
### Bug Fixes (general)
* force system gem install if RubyGems fails (#1126)
* gui_login prevent destroying window if already destroyed (#1127)
* add window size / position saves to login GUI (#1128)
* non tabbed saved entries in reduced button / font size (not… (#1129)
</PRE>
'''5.13.3'''
<PRE>
### Bug Fixes (general)
* account manager sorting GUI fix (#1123)
</PRE>
'''5.13.2'''
<PRE>
### Bug Fixes (general)
* install_gem_requirements update available gems after install (#1120)
</PRE>
'''5.13.1'''
<PRE>
### Bug Fixes (general)
* password_cipher.rb upcase account_name for key (#1118)

### Bug Fixes (dr)
* validator.rb change sleep to should_sleep named param (#1116)

### Bug Fixes (gs)
* add base stats capture from 'info full' command (#1115)
</PRE>
'''5.13.0'''
<PRE>
### Features (general)
* Refocus Frontend (#960)
* socket configurator to better guard TCPSocket (#976)
* add simplified DB maintenance (#991)
* TextStripper module support for XML, HTML, Markdown (#1055)
* Login modernization and refactor to yaml (#1063)
* Ruby Memory Releaser module (#1066)

### Features (dr)
* support meta:trashcan tag for DRCI.dispose_trash (#966)
* Add GameObj.inv support for DR items (#1080)
* DRCS allow custom adjective for summoned weapons (#1088)
* DRParser support for new exp window xml stream elements (rested exp, tdps, favors) (#1104)

### Features (gs)
* Add Armaments (Weapon, Armor, and Shield) Module (#911)
* add creature module, including Hinterwilds creatures (#1002)
* Creature module combat tracking (#1003)
* track time of last total_experience record (#1030)
* add Injured class for checking ability to perform actions (#1035)

### Bug Fixes (general)
* map dijkstra optimization (#1061)
* update.rb keep script/data file incase of error on update (#1070)
* ensure proxy path is set for non-destructive array write-th… (#1073)
* [lib][global-defs] - move update (#1079)
* GameObj force new objects ID to be string (#1087)
* xmlparser.rb gate GSL exits sending behind @send_fake_tags (#1103)
* change Hash[] pair key conversion to use to_h for Ruby 4.0 (#1108)
* move gui-login.rb to Ruby standard gui_login.rb (#1111)
* update location for currency and move game-loader.rb to Ruby standard gameloader.rb (#1112)

### Bug Fixes (dr)
* DRCA allow custom spell prep messaging (#1089)
* Update Slackbot error handling, and lnet management (#1091)
* Fix exp mods parsing for DR (#1102)
* equipmanager.rb support for custom messaging in forester's longbow (#1105)
* Fix hang in equipment manager when game doesn't respond to commands (#1110)

### Bug Fixes (gs)
* Infomon additional CHE resign regex (#1067)
* Resource tracking for sorcerer shadow essence (#1085)
* cman.rb add hamstring regex for already lying down target (#1090)
* cman.rb hamstring regex update when can't perform on target (#1092)
* Bounty parser.rb FWI guard regex update (#1096)
* currency.rb track gold (#1109)
</PRE>
'''5.12.12'''
<PRE>
Bug Fixes (general)
Update module strip markdown comments (#1056)
Vars/UserVars module fixes and corrections (#1057)
Bug Fixes (gs)
Infomon parse fix for singular currency (#1051)
</PRE>
'''5.12.11'''
<PRE>
Bug Fixes (dr)
add bput match for system updates preventing actions (#1034)
drdefs.rb npc parsing (#1038)
Fix container reference in get_item_from_eddy_portal method (#1039)
Bug Fixes (gs)
bounty location regex needs to match "under" (#1037)
</PRE>
'''5.12.10'''
<PRE>
Bug Fixes
all: games.rb catch additional error for nested single/double quotes (#1031)
dr: change keys for DR_SKILLS_DATA[:guild_skill_aliases] to be strings instead of symbols (#1032)
gs: Bounty parser for SG npcs matching (#1027)
gs: match READY/STOW items with a/an/some inside the link (#1026)
</PRE>
'''5.12.9'''
<PRE>
Bug Fixes
gs: StowList/ReadyList reset bug if non-default keys added #1019
</PRE>
'''5.12.8'''
<PRE>
Bug Fixes
all: script.rb show custom at script exit as well (#993)
all: Updated update.rb for single trunk and release please (#1001)
</PRE>
'''5.12.7'''
<PRE>
fix(all): ensure updates do not target detached proxy views #990
fix(gs): bounty parser and move fixes for sailor's grief #987
fix(gs): Infomon xmlparser.rb Ready/Stow fix for LONG before exist #988
fix(gs): gameobj.rb for Sailor's Grief ghostly/boss/guild tentacles #989
</PRE>
'''5.12.6'''
<PRE>
fix(all): settings.rb update to preserve root of derived views #975
fix(all): show custom in various script output when custom script #967
fix(dr): drparser.rb update for PlayedSubscription #983
fix(gs): include store location for ReadyList #977
fix(gs): infomon parser.rb update for ACCOUNT output varies #979
fix(gs): global_defs.rb move def update for Hive traps #980
fix(gs): activespell.rb prevent removal of RF Penalty #981
fix(gs): add .compact to input of Disk.find_by_name #982
</PRE>
'''5.12.5'''
<PRE>
fix(all): update.rb word boundary for abbreviations #971
fix(dr): equipmanager.rb Fix for changed game output. #969
fix(dr): common-arcana.rb Regalia fix for changed game output. #970
fix(dr): common-items.rb Fix for changed inventory command output #973
fix(gs): StowList missing space in capture in xmlparser.rb #963
fix(gs): stowlist.rb wait for RT when issuing check #964
fix(gs): readylist.rb wait for RT when issuing check #965
fix(gs): Bounty heirloom return msg'ing update #972
</PRE>
'''5.12.4'''
<PRE>
build(all): installer.yml use windows-2022 #950
fix(all): restore Wrayth / Wizard script execution ability #952
fix(all): database_adapter.rb error handling improvement #956
fix(dr): common-items.rb wear/remove messaging additions #949
fix(dr): games.rb - ignore UIDs for Frostbite mapping #951
fix(dr): map_dr.rb prevent inadvertent settings changes #958
fix(gs): GameObj targets for new Sailor's Grief tentacle npc #948
fix(gs): map_gs.rb remove delete_if to prevent bad settings #957
fix(gs): weapon.rb assault break if no targets #962
</PRE>
'''5.12.3'''
<PRE>
fix(all): limitedarray.rb max_size increase #946
fix(all): uservars.rb update for vars method missing #940
fix(dr): drparser.rb to set ShowRoomID to on if turned off #945
fix(gs): change namespace accessors to Ruby 2.6 compatible #944
fix(gs): infomon state reset on status prompt #943
fix(gs): Societies to check membership for various methods #942
fix(gs): standardize warcry.rb to match other PSMS #941
</PRE>
'''5.12.2'''
<PRE>
fix(gs): infomon parser.rb for profile full name matching #938
fix(gs): force PROFILE FULL to sync CHE info for infomon #937
fix(dr): Tighten checks on releasing invisibility for thieves #936
</PRE>
'''5.12.1'''
<PRE>
- fix(all): gameobj.rb - add type? method for explicit type check #928
- fix(all): messaging.rb encoding issue #933
- fix(gs): Various CMan cost corrections #932
</PRE>
'''5.12.0'''
<PRE>
- feat(all): settings.rb - proposal for sequel based Settings #591, #875, #889, #896, #927
- feat(all): util.rb add Ruby gem install helper method #861
- feat(all): messaging.rb add cmd link method #866
- refactor(all): games.rb modernization #849, #882, #924
- fix(all): add class extensions #800
- fix(all): lich.rb deprecated FE message #852
- fix(all): messaging.rb fix XML encoding for wizard and avalon #853
- fix(all): lich.rb class variable not initialized #855
- fix(all): log.rb force msg to String for regexp comparison #856
- fix(all): global_defs.rb bug in fput #864
- fix(all): messaging.rb xml_encode mono method msg #868
- fix(all): script.rb class to is_a? checks #878
- fix(all): gameobj.rb deeper lookup #885
- fix(all): messaging.rb debug not compared to falseclass #887
- fix(all): change class to is_a? checks #91-3
- fix(all): Util.issue_command allow single line captures #918
- fix(dr): drparser.rb casing for Premium status check #842
- fix(dr): map_dr.rb Don't assign UID of zero to rooms #844
- fix(dr): drparser.rb add $last_logoff tracking #851
- fix(dr): update message patterns in common-items #859
- fix(dr): add moon_visible?(moon) convenience method to common-moonmage #860
- fix(dr): exp mods output is not enclosed in preset xml tags anymore #870
- fix(dr): update.rb beta send validation for genie lich char #880
- fix(dr): Update regex and parsing for active spells #894
- fix(dr): add 'You scoop' match pattern to common-items #900
- fix(dr): add missing match patterns #901
- fix(dr): common-items: add and fix match strings #904
- fix(dr): Add missing matches for common-items #905
- fix(dr): Release Khri Vanish if Thief, when going visible #906
- fix(dr): Fix race condition when clearing and repopulating XMLData.dr_active_spells #907
- fix(dr): Fix SLS release pattern #908
- fix(dr): resolve race condition in DR crafting_magic_routine #914
- fix(dr): xmlparser.rb - Fix XMLData.dr_active_spells race condition #915
- fix(dr): xmlparser.rb - Clear out spells properly #916
- fix(dr): drparser.rb update for Platinum account status #922
- feat(gs): gameobj.rb allow for custom gameobj data #848
- feat(gs): PSMS updates, including CMan.use #865, #874, #881, #890, #899
- feat(gs): ReadyList & StowList classes for item tracking #884
- feat(gs): Breakout and Buildout Societes #919
- fix(gs): infomon parsing for CHE membership #841
- fix(gs): map_gs.rb for no UID when hexdigest used #843
- fix(gs): warcry.rb yowlp :buff to string instead of regexp #847
- fix(gs): group.rb multiple corrections #850, #869, #883
- fix(gs): Bounty parser.rb fix for HW & KF guard return #862
- fix(gs): Bounty task.rb fix for assigned? and Ruby 2.6 #863
- fix(gs): stash.rb stale sheaths recheck #867
- fix(gs): allow spell.rb casting to take a force_stance parameter #902
- fix(gs): update Infomon parsing for new ACCOUNT output format #903
- fix(gs): PSMS cost for multiple cost types & add Excoriate feat #912
- fix(gs): Feat excoriate regex correction #920
- fix(gs): weapon PSM affordable check against Glorious Momentum #926
</PRE>
'''5.11.1'''
<PRE>
- fix(all): restore @theme_state and add to CLI capability #795
- fix(all): retire gtk2 monkey patch for gtk3 #823
- fix(all): games.rb XMLData.name wait till both not NIL and not EMPTY #826
- fix(all): standardize xmlparser game instance #827
- fix(all): games.rb fix multiple single and double quote in XML #832,836,837
- fix(dr): games.rb - optional hide Room Title display of Real IDs with FLAG on #782
- chore(dr): common-moonmage - refactor of peer_telescope #783
- fix(dr): move HMR load to common before for dragonrealms #784
- fix(dr): common-crafting.rb minor edit to add "You tuck" #787
- fix(dr): common-arcana.rb - remove unecessary pause from discern code #792
- fix(dr): drparser.rb Restore Premium status checking #834
- fix(gs): migrate PSMS.name_normal to Lich::Util.normalize_name #790,833
- fix(gs): add Char.che to know current character's CHE #791
- fix(gs): FEAT and Infomon module parsing of new Covert Art feats. #796
- fix(gs): add Currency.gemstone_dust and fix redsteel mark capture #797
- fix(gs): FEAT Covert Arts colon normalization and stamina costs #799
- fix(gs): escape dash in regex for HouseCHE #824
- fix(gs): disk.rb comparison helpers #828
- fix(gs): allow for Group.disks to show self disk in array #829
- fix(gs): feat.rb Covert Arts throw poison costs 15 stam #830
- fix(gs): add missing Feat.use ability #831
- fix(gs): multiple CritRanks updates #801-822
</PRE>
'''5.11.0'''
<PRE>
- [all] - chore: Namespace & File Path Updates #713
- [all] - [argv_options.rb] bugfix: correct darkmode to work via CLI #693
- [all] - [games.rb] feat: make show Room Exits of non-StringProc/Obvious Exits toggable for all games #699
- [all] - [games.rb] feat: toggleable display of StringProcs with clickable links #751
- [all] - [gui-manual-login.rb] fix: change label to Wrayth #720
- [all] - [gui-saved-login.rb] fix: update Stormfront label #721
- [all] - [update.rb] fix: purge old LIB folder prior to update release #729
- [all] - [util.rb] bugfix: allow issue_command to use fput or put #715
- [all] - [xmlparser.rb] feat: add XMLData.room_name attribute #685
- [all] - [main.rb] fix: create session file in regular connect method #733
- [all] - [init.rb] bugfix: error for Windows DISPLAY variable #735
- [all] - [main.rb] fix: Mudlet support #736
- [all] - [wine.rb] fix: add --no-wine CLI flag prevent WINE startup
- [all] - [init.rb] fix: add --no-gtk CLI flag prevent GTK3 gem load
- [dr] - [games.rb] feat: DRinfomon and common files as core lich libraries #686
- [dr] - [games.rb] chore: add DR requires here #690
- [dr] - [games.rb] fix: add Room# display for DR #697
- [dr] - [games.rb] bugfix: Genie FE real ID#s not supported, hide by default #728
- [dr] - [drdefs.rb] bugfix: fix for Shadow Servants #710
- [dr] - [map_dr.rb] fix: cleanup and support for UIDs #719
- [dr] - [xmldata.rb] bugfix: add support for DR Room IDs #716
- [dr] - [xmlparser.rb] feat: XMLData - adding dr_active_spells #691
- [gs] - [games.rb] bugfix: support for pre/post room name txt #683
- [gs] - [group.rb] chore: update to account for hold #701
- [gs] - [resource.rb] feat: add additional tracking of covert art charges #714
- [gs] - [spell.rb] bugfix: Spell.affordable? 515 release #687
- [gs] - [stash.rb] bugfix: sheath_bags when not found #694
- [gs] - [xmlparser.rb] bugfix: missing real ID in nav #684
- [gs] - [xmlparser.rb] bugfix: Claim module obvious hiding #717
- [gs] - [sk.rb] feat: Self-Knowledge functionality in core #748
</PRE>
'''5.10.4'''
<PRE>
-o- [GS4] - [xmlparser.rb] bugfix: Simu XML breaking change RoomID #679
</PRE>
'''5.10.3'''
<PRE>
-o- [GS4] - [crit_tables] fix: CritRanks regex fixes (multiple files and changes) #671
-o- [GS4] - [spellsong.rb] fix: Correct Spellsong sync method #674
-o- [GS4] - [parser.rb] fix: thorn status regex correction #673
-o- [All] - [xmlparser.rb] fix: Split out if elif block to account for DR having multiple… #670
-o- [All] - [global_defs.rb] fix: percentconcentration #676
-o- [All] - [global_defs.rb] fix: update move failure message to handle attack and casting #667
-o- [All] - [init.rb] fix: update required ruby check messaging #669
-o- [All] - [sessionvars.rb] feat: new module SessionVars for non-persistent variable storage #666
</PRE>
'''5.10.2'''
<PRE>
-o- [DR] - [games.rb] bugfix: tweak XML rewrite section #662
-o- [GS4] - [crit_tables] bugfix: additional crit table regex corrections #663
-o- [GS4] - [ascension.rb] bugfix: add new Transcend Destiny to lookups #661
-o- [GS4] - [effects.rb] bugfix: regexp escape txt #660
-o- [GS4] - [disruption_critical_table.rb] Bugfix in regex #659
</PRE>
'''5.10.1'''
<PRE>
-o- [All] - [games.rb] bugfix: prevent race condition in games thread #656
-o- [All] - [init.rb] bugfix: address WINE variance between linux / installs #655
-o- [GS4] - [gs][stash.rb] bugfix: wear code improvement #657
</PRE>
'''5.10.0'''
<PRE>
-o- [All] - [main.rb] bugfix: correct encoding for WizardFE PR #640
-o- [All] - [games.rb] bugfix: correct logic for room detection when using CLI --start-scripts PR #639
-o- [All] - [DB_Store.rb] feat: add direct support for Simu RENAME and CHANGE PROF PR #633
-o- [All] - chore: breakout code to individual files for easier management PR #617
-o- [All] - [lich.rbw] chore: add deprecated msg to old Settings/GameSettings/CharSettings methods PR #589
-o- [All] - [lich.rbw] feat: add new --dark-mode CLI option PR #583
-o- [All] - [global_defs.rb] bugfix: monsterbold fix for additional clients PR #581
-o- [All] - [update.rb] feat: update core scripts from source on Lich5 update/install PR #579
-o- [All] - [log.rb] feat: add new Log module copied from Olib PR #577
-o- [All] - [numeric.rb] feat: add days/hours/minutes/seconds methods to numerics PR #623
-o- [All] - [messaging.rb] feat: WizardFE Voln window support #647
-o- [All] - [init.rb] bugfix: WINE entries for Linux / MacOS #649
-o- [DR] - [lich.rbw] bugfix: cleanup downstream hook exclusions PR #593
-o- [DR] - [global_defs.rb] bugfix: missing climb failure message PR #592
-o- [GS4] - [effects.rb] bugfix: show non-standard Effects in `;magic` output PR #641
-o- [GS4] - [parser.rb] bugfix: fix WARCRY duplication results / add WALL OF THORNS effect detection PR #634 / PR #637
-o- [GS4] - [critranks.rb] feat: add critical rank resolution tables and methods PR #625
-o- [GS4] - [effects.rb] bugfix: to support regex for active? & time_left PR #590
-o- [GS4] - [infomon.rb] bugfix: add implicit NPC death monitoring PR #588
-o- [GS4] - [infomon.rb] bugfix: change PSM to be stored as type.mnemonic PR #587
-o- [GS4] - [lich.rbw] bugfix: strip_xml multiline fix PR #584
-o- [GS4] - [stash.rb] bugfix: fix sack detection to use Stash.container(param) PR #578
-o- [GS4] - [spell.rb] feat: Spell.after_stance #644
-o- [GS4] - [xmlparser.rb] bugfix: for Claim module #646
-o- [GS4] - [infomon] feat: track Voln favor via RESOURCE output #648
-o- [GS4] - [gameobj.rb] feat: add Bandit hidden target API #650
</PRE>
'''5.9.2'''
<PRE>
-o- [GS4] - [group.rb] bugfix: proper leader detection from GROUP output
-o- [GS4] - [char.rb] bugfix: add back depracted Char.maxvitals with msging to switch to new Char.max_vitals methods
</PRE>
'''5.9.1'''
<PRE>
-o- [GS4] - [group.rb] bugfix: group.check syntax change
-o- [GS4] - [spell.rb] bugfix: affordable? Char.mana parenthesis logic
</PRE>
'''5.9.0'''
<PRE>
-o- [All] - feat: sqlite3 gem syntax code cleanup PR#553
-o- [All] - [lich.rbw] bugfix: remove unused Setting, GameSetting, CharSetting PR#542
-o- [All] - [lich.rbw] bugfix: scrub login key from error message popups PR#548
-o- [All] - [messaging.rb] bugfix: color mismatch WizardFE white txt PR#554
-o- [All] - [lich.rb] feat: add new Lich.deprecated method to aid in deprecating older API calls PR#523
-o- [GS4] - [char.rb] feat: log method_missing calls PR#552
-o- [GS4] - [char.rb] feat: add missing global_def related methods PR#523
-o- [GS4] - [global_defs.rb] feat: deprecate various Char module methods PR#523
-o- [GS4] - [spellsong.rb] bugfix: cache spellsong duration calc PR#551
-o- [GS4] - [effects.rb] feat: Effects module breakout PR#549
-o- [GS4] - [group.rb][disk.rb] feat: Group & Disk class PR#532
-o- [GS4] - [activespell.rb] feat: add duration change messaging, off by default, see ;help for details PR#487
</PRE>
'''5.8.1'''
<PRE>
-o- [All] - [lich.rbw] feat: add Game:Character to debug log file ouput
-o- [All] - [init.rb] feat: add milliseconds to debug filename
-o- [GS4] - [lich.rbw] bugfix: reorder parsing of $SERVERSTRING to avoid certain conflicts
-o- [GS4] - [parser.rb] bugfix: update for new Empath resource and sleep/bind messaging
-o- [GS4] - [status.rb] bugfix: bound? calmed? and sleeping? support for spellnames flag being off
-o- [GS4] - [xmlparser.rb] bugfix: additional creature dying messaging to check against XML dead not being sent
-o- [GS4] - [gameobj.rb] bugfix: remove sorcerer arms and animates from GameObj.targets
</PRE>
'''5.8.0'''
<PRE>
-o- [All] - Ruby 3.3 compatibility
-o- [All] - [lich.rbw] feat: adds .sources for up/downstream hooks
-o- [All] - [lich.rbw] bugfix: don't use WINE for custom frontends
-o- [GS4] - [char.rb] bugfix: add back Char.stance
-o- [GS4] - [claim.rb] feat: new module and associated changes to xmlparser
-o- [GS4] - [experience.rb] feat: percent experience options
-o- [GS4] - [parser.rb] bugfix: allow for negative TNL exp value
-o- [GS4] - [parser.rb] bugfix: allow hyphenated last names in character names
-o- [GS4] - [parser.rb] feat: update resource matching for new Bard service
-o- [GS4] - [stash.rb] bugfix: catch more shield removal messages
-o- [GS4] - [util.rb] bugfix: underscore issue for PSMs
</PRE>
'''5.7.0'''
<PRE>
-o- Supports Ruby 3.2 - security enhancements and huge speed improvements for regex
-o- New libraries/modules/classes: Account, HMR (Hot Module Reloading)
-o- GS4 Infomon now baked into Lich5 as a library, no more need to run standalone script
-o- New GS4 libraries/modules/classes: Ascension, Bounty, Currency, Experience, Resources, Society, Status, Warcry
-o- Updates to existing libraries/modules/classes: Armor, Util, Weapon, Spell, GameObj, Messaging
-o- Several Bugfixes for lots of things
-o- Lots of code cleanup
</PRE>
'''5.6.2'''
<PRE>
-o- Fix for XML errors
-o- Adds the DR Plat instance for Frostbite FE
-o- Adds ‘ball’ as the noun used for ‘ball and chain’
-o- Adds the movement result ‘slip in the mud and fall flat’
-o- Corrects stamina cost for the feature Dispel Magic
-o- Plus all the latest script updates from Elanthia-Online!
</PRE>
'''5.6.1'''
<PRE>
-o- Fix for XML to limit login errors (DR)
-o- Fix for XMLData.active_spells to properly register wizard 'recovery' spell cooldowns
-o- Messaging updates to remove error in Wizard FE encodings
-o- Corrects for error in detecting PSM skill changes (cman) via warrior / rogue guild lessons
-o- Deprecates LNet script from master repository
-o- Miscellaneous small bug squashing
</PRE>

'''5.6.0'''
<PRE>
-o- (DragonRealms) Support for Genie and Frostbite frontends
-o- (GemStone) Changed methods to improve ;go2 speed and reduce lich.db3 calls
-o- (GemStone) Updates to support silver_count function
-o- (Both) Changed method for updating lich ecosystem
</PRE>

'''5.5.0'''
<PRE>
-o- Support for DragonRealms
-o- Updated support for scripts like BigShot
-o- Providing the LichID and UID on Profanity
-o- Spell.force_incant, .force_channel, and .force_evoke
-o- Standardized message method for script authors
-o- Sundry small improvements / fixes and changes
-o- And the creme de la creme - a custom directory
</PRE>

'''5.4.0'''
<PRE>
-o- Simu Room IDs (formally called 'unique ID' or 'uid' for Lich) added to Map, mapDB where known, and ;go2 for navigation (courtesy Xanlin and with our thanks!) ;go2 u7120 for all you ex-GMs out there.
-o- Room titles will now display the Lich ID and / or the UID for the room based on user selections - default is on for both, and enabled / disabled via Lich.display_lichid or Lich.display_uid toggles that can be set to on / off or true / false. (;e Lich.display_lichid=true/false and ;e Lich.display_uid=true/false) You can remove that rnum from your autostart now! To gain the benefit of the UID deployment, be sure to ;repo download-mapdb
-o- REQUESTS: Drop 5 minute timeout function from Lich
-o- waitrt? and waitcastrt? will still pause activities, but will return TRUE or FALSE in keeping with the Ruby functionname? tradition (no more failing to get a weapon out due to RT from climbing!)
-o- empty_hands and fill_hands will now check to see if the character is in roundtime before trying to put away or retrieve held items
-o- Infomon received an update that keeps spell timers in sync with the information received from the server - no more need to immediately do a spell active in game to get the right times to display for various legacy scripts and ;magic after visiting the invoker or using an SK item
-o- Lich now provides a facility to get current coins on the character that is a bit more agnostic to data changes from Simu - Lich::Util.silver_count
-o- Various other small tidbits to help ease maintenance and future development
-o- PLEASE NOTE: This update is required for the newest Bigshot (released today!) and for future eloot and eherbs scripts (release RSN)
</PRE>

'''5.3.0'''
<PRE>
-o- Added support for Wrayth (renamed Stormfront) installations
-o- Converted Linux | WINE login methods to 'method 0', does not use Simu launcher
</PRE>

'''5.2.1'''
<PRE>
-o- Support for STOWing items irrespective of special item scripts
-o- Improved query support for Effects and CMans
-o- Fix Lich bug to respect the 'groupmovement' flag in game
-o- Fix Lich round time calculations (more aggressive timing)
-o- Dark Mode is now a thing
-o- Lich4 Style GUI layout available
-o- Several file location changes to support future code change efforts
</PRE>

'''5.0.19'''
<PRE>
-o- Benefit: Monks with Mental Acuity (all 3 of you) rejoice - stamina casting!
-o- Benefit: PSM3 included, no charge. No hair remaining, either!
-o- Benefit: Ok, stay seated: Some of your various SF spell duration windows may work. . . better? Yes, not perfect, but better. No pictures, please!
-o- Updated infomon that properly detects Cloak of Shadows on those pesky sorcerers, and the Raise Dead Cooldown periods for those wondrous clerics.
-o- A new update process for Lich 5 - tired of having to download that script over and over just to update? Get yourself a copy of lich5-update.lic. Note, if you already have it, you're set! If not - ;jinx script install lich5-update --repo=elanthia-online
</PRE>

'''5.0.11'''
<PRE>
-o- Updated the method used to log onto SIMU servers.
-o- Added the Animalist item specifics to Lich5's empty and fill hands routines
-o- Improved Invoker messages for Avalon and Wizard FEs (no change for SF FE)
-o- Improved cleanup and store methods when player EXIT's or QUIT's game
-o- Crafted two new methods (stash_hands and equip_hands) for future script use
-o- Some behind-the-scenes cleanup to improve maintaining the Lich5 ecosystem
-o- Add Spell Active improvements
-o- Add PSM and Ranger improvements
</PRE>
</div>

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

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

Lich:Software/Installation

2026-10-28T17:27:14Z

WHIGHTCNIGHT: /* Installing the Latest Stable Release */ update to 5.23.0

{{3rd-party}}
=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 Wrayth or Wizard FE. Lich is also used by many on both MacOS and multiple Linux distributions.

=Installing the Latest Stable Release=

'''The latest stable lich version is 5.23.0 supporting Ruby 4.0 - published October 28, 2026'''

==In-Place Upgrade==

If you are on an older version of Lich 5 and want to upgrade to the most current version, you can choose to either upgrade Lich5 only or both Lich 5 and Ruby. If you're currently on Lich 4, able to check by running the command <CODE>;e echo LICH_VERSION</CODE>, go to the [[#Upgrade Installation for Lich 5 from Lich 4 (11/14/2023)|upgrade from Lich 4 section]].

For each section, please follow the directions/commands one at a time.

===Lich 5 Only===

====Lich 5.7 or newer====
# You must be running Ruby 4.0 or greater for Lich 5.19 +. If unsure, please update both (see below)!
# '''Backup existing Lich 5 folder'''
# Run this command in-game <CODE>;lich5-update --update</CODE>
# Quit and restart lich.
# Congratulations - you're now running on the latest version of Lich!

====Lich 5.6 or older====
Please proceed to updating both Ruby and Lich 5

===Both Ruby 4.0 & Lich 5===
This method is for Windows only. Linux and MacOS users, please do a Lich 5 only update and update Ruby manually via normal install/update methods for the OS.

# Logout of all characters
# '''Backup existing Lich 5 folder'''
# Uninstall existing Ruby4Lich5 installs from Programs & Features control panel, or alternatively, rename your existing Ruby4Lich5 folder to Ruby4Lich5save. (Defaults to C:\Ruby4Lich5)
# Download the latest [https://github.com/elanthia-online/lich-5/releases/latest/download/Ruby4Lich5.exe Ruby4Lich5.exe Installer]
# Run the installer and be sure to have both Ruby and Lich 5 option selected
# Congratulations - you're now running on the latest version of Lich & Ruby!

===Ruby 4.0 Only===
Use this to upgrade to the newest version of Ruby only if you're already on the latest version of Lich5 and now want to update Ruby afterwards. If you're not already on the latest version of Lich5, please use previous section steps instead.
# Logout of all instances/characters
# '''Backup existing Lich 5 folder'''
# Uninstall your existing Ruby4Lich5 install via Programs & Features (ensure it's now gone, default location was C:\Ruby4Lich5)
# Download the latest [https://github.com/elanthia-online/lich-5/releases/latest/download/Ruby4Lich5.exe Ruby4Lich5.exe Installer]
# Run the new installer and choose to only install Ruby Only
# Congratulations - you're now running on the latest version Ruby!

==Windows New Installation==

{{blue|These instructions are not for DragonRealms. [[#Ecosystem Information|For those scroll to the bottom]].}}

'''For Windows 11 / 10 / 8 / 7''' users: you can download the [https://github.com/elanthia-online/lich-5/releases/latest/download/Ruby4Lich5.exe Ruby4Lich5.exe Installer] and install everything you need automatically. Click on the '''Ruby4Lich5.exe''' and download it to your computer then double click on the executable in your default download folder. Note, a user may need to adjust their browser or security settings to allow download and installation.
If you have never played before, follow the 'New Installation' instructions. If you have played before, and have used Lich before, follow the 'Upgrade Installation' instructions.

===New Installation for Lich 5 (11/14/2023)===

# '''Please log into the game of your choice through the Simutronics website first'''. Install the launcher (not SGE), and install your FrontEnd of Choice. The Wrayth FrontEnd is presently the supported FrontEnd, but Wizard will work as well, if you are nostalgic. After you've logged in, log out and continue.
# Download and Run the [https://github.com/elanthia-online/lich-5/releases/latest/download/Ruby4Lich5.exe Ruby4Lich5.exe 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, 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.

===Upgrade Installation for Lich 5 from Lich 4 (11/14/2023)===

This option is deprecated. Lich 5 architectures are not compatible with Lich 4. Back up your existing Lich 4 folder, uninstall any existing Ruby executables, and then follow the instructions for a new install above.

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

==MacOS==
There are two common options for playing Gemstone IV on a Mac: play natively with Saga (the official front end) or Avalon, or use virtualization software such as Parallels with Wrayth/WizardFE. Below are the options on how to do that.

===Native (Saga or Avalon)===
Players with Macs can use [[Mac_Installation_-_Lich_(software) | Installing Lich on Macs]] for installation help. That guide sets Lich up with [[Saga]], the official Simutronics front end (currently in beta), and also covers [[Avalon]]. This process works well for Mac OS Catalina and Big Sur. If you have not updated your Mac OS yet, these instructions may work depending on your actual version. If you run into a snag, follow the contact instructions provided.

===Parallels Windows===
With the latest releases of Ruby4Lich5 installer, you can now follow the normal Windows installation for both Intel and Apple silicon based Apple computers.

To install Wrayth/WizardFE, Lich, and Ruby via Parallels you will need to do a few various steps as outlined below. Please note, the rubyw file in C:\Ruby4Lich5\X.X.X\bin may be set to run in compatibility mode for windows 7. On an ARM Mac running parallels, this may causes Wrayth scripts not to run. Turning compatibility mode off in the rubyw file could fixe this issue if it was enabled.

The following steps are to be done AFTER you've successfully installed Wrayth/WizardFE and can login normally without Lich5 on the machine. Once you've done that and can successful connect normally, then follow these steps:
# Download and install [https://github.com/elanthia-online/lich-5/releases/latest/download/Ruby4Lich5.exe Ruby4Lich5.exe Installer] and use default options presented during install
# Double click the lich.rbw file that is now located in the extracted Lich5 location you did above. Login and play as usual.

==Linux==
Pick the subsection for your distribution below. Each one installs Ruby and Lich; front ends (Saga, Profanity and Warlock) are covered once in [[#Frontends|Frontends]] at the end, since their steps are the same on every distribution.

===Chromebook & Debian variants===
<div class="mw-customtoggle-debian" style="font-size:16px;overflow:auto;color:#0000FF">[Click to Expand]</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-debian">
The following steps should install Lich for users of Debian/Chromebooks. To also install a front end such as Saga, Profanity or Warlock, see [[#Frontends|Frontends]] at the end of the Linux section.

'''Step 1.'''
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 curl libssl-dev libyaml-dev libreadline6-dev zlib1g-dev libncurses5-dev libffi-dev libgdbm6 libgdbm-dev libsqlite3-dev git unzip libcairo2-dev libgirepository1.0-dev libgtk-3-dev gobject-introspection
</pre>

{{side box|NOTE: If you are updating an existing Ruby installation rather than installing from scratch, skip steps 2, 3, and 4. Instead, update your ruby-build with the following command, and then proceed to Step 5.<pre>git -C ~/.rbenv/plugins/ruby-build pull</pre>}}

'''Step 2.'''
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>

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

'''Step 4.'''
Download the tools to let rbenv install Ruby on its own, then install Ruby 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</pre>

'''Step 5.'''
<pre>rbenv install 4.0.9 -v
rbenv global 4.0.9
</pre>

Install Lich:
<pre>
cd ~
curl -L "https://github.com/elanthia-online/lich-5/releases/latest/download/lich-5.zip" -o temp.zip && unzip temp.zip -d ./ && rm temp.zip
</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 using the <tt>Gemfile</tt> included with Lich5 by running <tt>bundle install</tt>. The Gemfile also lists developer-only gems (the <tt>development</tt> and <tt>vscode</tt> groups) that you do not need, so tell Bundler to skip them first:
<pre>
echo "gem: --no-document" > ~/.gemrc
cd ~/Lich5
bundle config set --local without 'development vscode'
bundle install
</pre>
:<small>Note: <tt>bundle install --without ...</tt> no longer works; that flag was removed from the version of Bundler that ships with Ruby 4.0. Use <tt>bundle config set</tt> as shown above.</small>
</div>

===Arch Linux & Arch-based distributions===
<div class="mw-customtoggle-arch" style="font-size:16px;overflow:auto;color:#0000FF">[Click to Expand]</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-arch">
The following steps should install Lich for users of Arch Linux and Arch-based distributions (Manjaro, EndeavourOS, etc.). To also install a front end such as Saga, Profanity or Warlock, see [[#Frontends|Frontends]] at the end of the Linux section.

Update the system and install required dependencies:
<pre>
sudo pacman -Syu
sudo pacman -S --needed base-devel openssl libyaml readline zlib ncurses libffi gdbm sqlite git unzip curl gtk3 gobject-introspection
</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 4.0.9 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 4.0.9 -v
rbenv global 4.0.9
</pre>

Install Lich:
<pre>
cd ~
curl -L "https://github.com/elanthia-online/lich-5/releases/latest/download/lich-5.zip" -o temp.zip && unzip temp.zip -d ./ && rm temp.zip
</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 using the <tt>Gemfile</tt> included with Lich5 by running <tt>bundle install</tt>. The Gemfile also lists developer-only gems (the <tt>development</tt> and <tt>vscode</tt> groups) that you do not need, so tell Bundler to skip them first:
<pre>
echo "gem: --no-document" > ~/.gemrc
cd ~/Lich5
bundle config set --local without 'development vscode'
bundle install
</pre>
:<small>Note: <tt>bundle install --without ...</tt> no longer works; that flag was removed from the version of Bundler that ships with Ruby 4.0. Use <tt>bundle config set</tt> as shown above.</small>
</div>

===Fedora===
<div class="mw-customtoggle-fedora" style="font-size:16px;overflow:auto;color:#0000FF">[Click to Expand]</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-fedora">
The following steps should install Lich for users of Fedora. To also install a front end such as Saga, Profanity or Warlock, see [[#Frontends|Frontends]] at the end of the Linux section.

Lich 5 requires Ruby 4.0 or newer. The Ruby that ships with currently supported versions of Fedora is older than that (41 uses Ruby 3.3; 42 and 43 use Ruby 3.4), so these steps install Ruby 4.0.9 with '''<tt>[https://github.com/rbenv/rbenv rbenv]</tt>''' instead of using Fedora's Ruby.

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 cairo-devel curl gcc gdbm gdbm-devel gdk-pixbuf2-devel glib2-devel \
gobject-introspection-devel gtk3-devel libyaml-devel libffi-devel make ncurses-devel openssl-devel readline-devel \
redhat-rpm-config sqlite-devel unzip zlib-devel
</pre>

{{side box|NOTE: If you are updating an existing rbenv Ruby installation rather than installing from scratch, skip step 3. Instead, update your ruby-build with the following command, and then run only the <tt>rbenv install</tt> and <tt>rbenv global</tt> lines from step 3.<pre>git -C ~/.rbenv/plugins/ruby-build pull</pre>}}

3. Install rbenv and Ruby 4.0.9:
<pre>
git clone https://github.com/rbenv/rbenv.git ~/.rbenv
echo 'export PATH="$HOME/.rbenv/bin:$PATH"' >> ~/.bashrc
echo 'eval "$(rbenv init -)"' >> ~/.bashrc
source ~/.bashrc
git clone https://github.com/rbenv/ruby-build.git ~/.rbenv/plugins/ruby-build
rbenv install 4.0.9 -v
rbenv global 4.0.9
ruby -v
</pre>
The last command should print a line starting with <tt>ruby 4.0.9</tt>. If it doesn't, close and reopen the terminal and try <tt>ruby -v</tt> again.

4. Install Lich:
<pre>
cd ~
curl -L "https://github.com/elanthia-online/lich-5/releases/latest/download/lich-5.zip" -o temp.zip && unzip temp.zip -d ./ && rm temp.zip
</pre>

5. 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 using the <tt>Gemfile</tt> included with Lich5 by running <tt>bundle install</tt>. The Gemfile also lists developer-only gems (the <tt>development</tt> and <tt>vscode</tt> groups) that you do not need, so tell Bundler to skip them first:
<pre>
echo "gem: --no-document" > ~/.gemrc
cd ~/Lich5
bundle config set --local without 'development vscode'
bundle install
</pre>
:<small>Note: <tt>bundle install --without ...</tt> no longer works; that flag was removed from the version of Bundler that ships with Ruby 4.0. Use <tt>bundle config set</tt> as shown above.</small>
</div>

===Frontends===
<div class="mw-customtoggle-frontends" style="font-size:16px;overflow:auto;color:#0000FF">[Click to Expand]</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-frontends">
Finish the Lich installation for your distribution above first, then set up one of these front ends.

====Saga====
[[Saga]] is the official Simutronics front end for GemStone IV and DragonRealms (currently in beta), and it works with Lich. On Linux it comes as a single AppImage file.

'''Install Saga'''

Go to the [https://www.play.net/gs4/play/saga-info.asp Saga info page] and click '''Download for Linux''' (AppImage, x86_64). On a Chromebook, move the downloaded file into the '''Linux files''' folder with the Files app so Linux can see it.

Then put it where Lich looks for Saga, make it runnable, and start it:
<pre>
sudo mkdir -p /opt/Saga
sudo mv ~/Downloads/Saga-*.AppImage /opt/Saga/saga
sudo chmod +x /opt/Saga/saga
/opt/Saga/saga
</pre>
:<small>On a Chromebook use <tt>~/Saga-*.AppImage</tt> in place of <tt>~/Downloads/Saga-*.AppImage</tt>.</small>

Log in to the game from inside Saga once, without Lich, to make sure Saga itself works.

If Saga will not start and mentions FUSE or <tt>libfuse.so.2</tt>, install FUSE 2 and try again: <tt>sudo apt-get install libfuse2</tt> on Debian/Chromebook (on Debian 13 and newer, <tt>libfuse2t64</tt>), <tt>sudo pacman -S fuse2</tt> on Arch, or <tt>sudo dnf install fuse-libs</tt> on Fedora.

'''Use Saga with Lich'''

Saga starts Lich for you:
# Log in with Saga normally, then choose '''File → Enable Login with Lich'''.
# Choose '''File → Return to login'''.
# Click '''Connect''', then '''Via Lich''', and point it to your Lich folder (<tt>~/Lich5</tt>).
# If Saga asks where Ruby is, or Lich will not start, run <tt>rbenv which ruby</tt> and give Saga the path it prints (it ends in <tt>.rbenv/versions/4.0.9/bin/ruby</tt>).
# Log in. The game will start in Saga with Lich running.

Once that works, you can also start from the Lich login window (<tt>ruby ~/Lich5/lich.rbw</tt>): 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.

====Profanity====
Profanity is a terminal-based Front-End that will let you play the game (in lieu of The Wizard or Wrayth). Its gems (such as <tt>curses</tt>) are installed by the <tt>bundle install</tt> step above. Download Profanity:
<pre>
cd ~
git clone https://github.com/elanthia-online/ProfanityFE.git
</pre>

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

====Warlock====
Download Warlock from https://sproctor.github.io/warlock3/download.html, then run Lich the normal way with Ruby:
<pre{{log2|margin-right=35%}}>
ruby ~/Lich5/lich.rbw
</pre>
Use your login information with these settings to use the Lich launcher: https://github.com/sproctor/warlock3/wiki/Lich-support
</div>

=Popular Scripts=
{{#section:Lich:Script Repository|popularscripts}}

=Ecosystem Information=

* DragonRealms Variant - [https://elanthipedia.play.net/Lich_script_repository#Setup_and_Installation Setup and Install instructions]

=Lich Changelog=
<div class="mw-customtoggle-changelog" style="font-size:16px;overflow:auto;color:#0000FF">[Click to Expand]</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-changelog">
'''5.22.0'''
<PRE>
### Features (general)
* add opt-in bounded script execution guards (#1575)
* add static-only map route selection (#1577)
* bounded fput with max_resends, interrupt, resend_transient and failure symbols (#1587)
* Spell.results_regex, the lines cast waits on, exposed (#1590)
* add Events, a script-to-script notification primitive; combat emits on it (#1619)
* add deterministic hook priorities (#1621)
* Map.boundary_rooms_for(ids), the perimeter of any set of rooms (#1660)
* sticky ever_hostile? keeps Sympathy'd creatures in targets (#1665)
* --pipe -g honours the frontend flag, and --sentinel requests the origin marker (#1677)

### Features (gs)
* add trustworthy combat observation provenance (#1576)
* Lich::Gemstone::Stance, a shared stance setter (#1578)
* Lich::Stash.wield and Stash.hands put named items into hands (#1579)
* Lich::Gemstone::Mana.pulse, the MANA PULSE verb once (#1580)
* Lich::Gemstone::Bank, Currency refresh, and WEALTH parser lines (#1581)
* PSM command and results_regex readers, factored out of use (#1583)
* Lich::Gemstone::Fog, the ways home on the spell and society readers (#1584)
* Combat::Messages - non-combat message families as observer events (#1586)
* society command readers, factored out of use (#1589)
* Group.join, the follower's side of Group.add (#1591)
* emit post-commit combat recorder receipts (#1592)
* combat definition supplements from a player YAML file (#1607)
* message definitions from the player supplement file (#1608)
* creature library - abilities from session logs, limbs flags, triggers as hash of arrays (#1623)
* expose exact server creature health from crtrStatus (#1661)

### Bug Fixes (general)
* fix spec stub race breaking FFI loads, gate WindowsCredentialManager to Windows (fixes #1542) (#1573)
* setup_files uses content hash for cache freshness (#1596) (#1599)
* creatures registry housekeeping independent of Combat::Tracker (#1603)
* place effect-list.xml backups in the update snapshot folder (#1606)
* retain discovery ownership through cleanup (#1612)
* Initial Lich state update and detachable-client split GS/DR (#1617)
* bound move()'s remedy retries, record why a move failed, lift it into Lich::Common::Move (#1622)
* update puts to Lich.log (#1630)
* create detachable-client session file without --login (#1656)
* converge server_time_offset instead of resetting it every prompt (#1663)
* plain-language lich5-update messages when GitHub fails (#1687)
* Inventory.refresh waits out roundtime before sending (#1688)

### Bug Fixes (dr)
* update HOW pattern to accommodate various soul states (#1620)
* restore script halt in DRCC.get_crafting_item on missing item (#1624)
* halt script when too distracted to turn recipe book (#1625)
* equipmentmanager energy bow handling (#1662)
* report when DRC.rummage can't read a container (#1671)
* DRCI.get_item? confirms #<id> gets by the item id in hand (#1674)
* DRCT.sell_item references the item through DRCI.item_ref (#1675)
* DRCA.do_buffs filters day/night spells without mutating settings (#1680)
* DRCI.tie_item? no longer reports an empty pouch as tied (#1684)
* DRC.play_song? keeps climbing and performance songs across instrument switches (#1686)

### Bug Fixes (gs)
* Injured cache lives on the class and keys on an injury fingerprint (#1582)
* infomon - a spell's start message refreshes a refreshable timer (#1585)
* Group.broken? waits on Lich::Claim::Lock, the constant that exists (#1588)
* combat module - hunt-log audit: interrupted-swing resume, status attribution by event, spell-loss cause, live defs (#1593)
* QStrike prices MSTRIKE's own stamina cost (#1594)
* combat module - a stand-up message later in the chunk outranks an earlier knockdown crit (#1595)
* track spell cooldowns on the characters a spell locks out (#1597)
* catalog missing deity-specific strike lines for Divine Wrath (335) (#1598)
* combat module - Rysk/Dreadt log audit: Holy Weapon release model, held maneuver rolls, AoE roll attribution, live defs (#1600)
* Combat defs add thrust as a basic attack (#1615)
* preserve group state after ambiguous disband reply (#1629)
* target ridden mounts before their first crtrStatus (#1669)
* snapshot Effects registries so scripts can't break the XML parser (#1672)
</PRE>
'''5.21.0'''
<PRE>
### Features (general)
* Add --refresh-characters and --add-character CLI flags (#1504)
* add --active-session-dir to decouple Active Sessions coordination from --temp (#1520)
* add read model for the inventoryManager extended feed (#1524)
* GUI add configurable frontend registry (#1558)
* add HTTPS web-login fallback for when EAccess (7910) is unreachable (#1570)

### Features (dr)
* player-supplied custom prep/cast/invoke messages (#1528)
* opt-in cambrinth charge distribution across configured items (#1549)
* populate GameObj from INV LIST full refresh (02 of 05) (#1554)
* non-destructive upsert for INV SEARCH / category scrapes (03 of 05) (#1556)
* reconcile GameObj containers on hand pickup (04 of 05) (#1557)
* [DRCC] add shared private-forge helpers (#1560)

### Features (gs)
* creature template library - measured combat data, HP/speed censuses, messaging (#1539)

### Bug Fixes (general)
* enforce Script#pause at every blocking/mutating checkpoint (#1537)
* always report missing gems on stderr; only wait on a dialog without a tty (#1544)
* dispatch --help and --version before the GTK require (#1546)
* global_def update deprecated method calls to include caller info (#1550)
* normalize colons in Lich::Util.normalize_lookup (#1561)
* Script.log respects --log-dir/LOG_DIR override; use File.join for paths in script.rb (#1572)

### Bug Fixes (dr)
* drvariables add more data to VOL_MAP (#1536)
* pin capped skills to 34 in DRSkill.clear_mind (#1548)
* match lowercase "it's already open" when opening a container (#1553)
* normalize capitalized leading articles in inventory scrape names (01 of 05) (#1555)
* make INV LIST refresh atomic and warn on interruption (05 of 05) (#1563)
* refresh before_name/after_name on a name-preserving container move (#1564)
* do not re-add a held item as worn inventory on inv scrape (#1565)
* evict orphaned identity-index entries on a name-changing upsert (#1566)
* unpause the exact scripts safe_pause_list paused, by object (#1574)

### Bug Fixes (gs)
* Infomon xmlparser additional npc death messaging (#1540)
* correct messaging drift in 13 crit table patterns (#1547)
* combat module - event defs, observer emissions, replay-verified parsing, SQLite recorder (#1559)
</PRE>
'''5.20.1'''
<PRE>
### Bug Fixes (general)
* bound EAccess auth with a timeout so a stalled SGE backend can't hang Lich silently (#1502)
* Linux WINE and Wrayth FE detection (#1517)
* update Gemstone game-code validations (#1518)
* preserve bundled display-state tags on quiet-suppressed chunks (#1530)
* prevent a stray formatting character from appearing in Saga during quiet script output (#1532)

### Bug Fixes (dr)
* make $safe_pause_lock holder immune to pause (#1525)

### Bug Fixes (gs)
* critranks.rb tolerate nil table rows, fix reload!, index patterns … (#1522)
* combat module hardening - ordered processing, 22x faster parsing, double-count fix (#1523)
</PRE>
'''5.20.0'''
<PRE>
### Features (general)
* add concurrent runtime I/O and multi-client detach support (#1459)
* --bind-address speaks the same keywords as --detachable-client (#1461)
* GUI Launcher Improvements (#1463)
* Add supervised child script APIs (01 of 06) (#1474)
* Add forced script teardown command (06 of 06) (#1479)
* teardown and distinguishable errors for Script.run_child (#1501)

### Features (dr)
* DRCMM.moon_weapon_duration - read a moon weapon's remaining life (#1483)
* id-based creature tracking from crtrStatus + assess (#1485)
* capture room UID from <nav> tag; stop enforcing ShowRoomID; opt-in room-id placement (#1491)
* user-extensible scroll substitutions via settings (01 of 06) (#1512)
* user-extensible boxes and trash receptacles (03 of 06) (#1514)
* user-extensible summoned-weapon adjectives (04 of 06) (#1515)
* user-extensible flavor-text stripping (05 of 06) (#1516)

### Features (gs)
* gameobj add full_name matcher to type/sellable classification (#1453)

### Bug Fixes (general)
* prevent empty/partial GameObj registry reads during mid-stream refresh (#1370)
* no-op Gtk.lich_main_quit when no main loop is nested (#1464)
* correct path-flag aliases and document all path options (#1472)
* Synchronize script lifecycle transitions (02 of 06) (#1475)
* Coordinate script shutdown draining (03 of 06) (#1476)
* Harden script lifecycle ownership (05 of 06) (#1478)
* surface the underlying LoadError in dependency alerts (#1480)
* extract game-agnostic CreatureBase into lib/common (#1484)
* bound GemCheck alert dialogs with a timeout so they can't hang forever (#1488)
* identify Genie as the frontend for headless launches (#1490)
* restore detachable client disconnect notice to stdout (#1492)
* harden detachable client teardown and escape init payload (#1493)
* resolve GameObj status visibility during staged refresh (#1497)
* compact client write queue instead of ending the session (#1498)
* scrub startup credentials once login completes (#1499)
* Honor Simu-side teardown for 10 seconds (#1505)

### Bug Fixes (dr)
* resolve no-UID rooms carrying a stored UID instead of returning nil (#1467)
* equipmanager.rb - reliable ranged-weapon transitions - stow ammo after unload + verify offhand wield hand (#1468)
* common-healing.rb - DRCH.bind_wound: only dispose a dislodged item while it is in hand (#1469)
* preserve game RealID in room title (GS parity for ";display roomid title") (#1500)
* Refine need_buffs? logic for non-recast spells to correctly check cyclic spells. (#1503)
* reduce symbol-torn scale scrolls to gettable noun (#1506)
</PRE>
'''5.19.1'''
<PRE>
### Bug Fixes (general)
* lower game socket keepalive idle from 120s to 30s (#1449)
* resilient ActiveSessions ownership + shutdown watchdog (#1452)
* Quit Gtk.main cleanly (#1455)
* Refactor regex to string comparisons for ARGV options (#1456)

### Bug Fixes (gs)
* ingest newly-exposed mindState experience and roommeta room fields (#1450)
</PRE>
'''5.19.0'''
<PRE>
### Features (general)
* Add character generator support via EAccess protocol (#1384)
* Add modern script command shutdown method (#1385)
* migrate the server-stream parser from REXML to Ox, with pipe-mode benchmark harness and DR parser coverage (#1396)
* enumerate script subdirs with file glob (#1397)
* add --bind-address option to set listen socket address (#1405)
* add central method to determine lich ver (#1417)
* setup_files: support scripts/data/custom for user data overrides (#1431)
* Modify running? method to support optional exact matching of script names (#1436)
* keyword bind hosts for the detachable client (tailscale/lan/any) (#1437)
* add roomlinks/roommono toggles for room display (#1438)
* self-healing gem requires (#1439)
* various Saga FE compatibility tweaks (#1443)
* add macOS limited gem recovery (#1448)

### Features (dr)
* Capture combat position from the balance status line (#1400)
* detect scheduled shutdown and expose it on DRParser (#1409)
* xmlparser: add structured parser for the assess (combat situation) stream (#1413)
* Implement DRCA.need_buffs? method for buff checks (#1428)

### Features (gs)
* anchor Infomon parser regex unions to line start (#1391)
* creature xml additions (#1425)
* add creature template library (#1427)

### Bug Fixes (general)
* surface a failed Game.open in the connect timeout (#1408)
* bound long-session memory growth (index/hook/watchfor/buffer leaks) (#1410)
* improve and harden shutdown (#1416)
* use bundler to check for required Ruby gems (#1420)
* pin lich directory for gemfile check (#1423)
* Show CLI login ARGV for SAL connections (#1424)
* increase read timeout on idle socket to 300 seconds (#1426)
* monkeypatch gi for memoryreleaser / asyncprocessor until patched upstream (#1429)
* Mapdb sort tags by downcase and original case (#1433)
* stop locking the load path at boot; keep Gemfile.lock in sync on self-update (#1434)
* minimum Ruby 4.0 required & migrate Ruby version check (#1444)
* align --announce with --update for Ruby version (#1447)

### Bug Fixes (dr)
* BalanceValue regex to match combat status lines (#1398)
* equipmanager.rb - Fix unload weapon detection when AimTimerDialog tag is prepended (#1414)

### Bug Fixes (gs)
* global_defs update pushStream regex to include 'reserve' id (#1379)
* psms Warcry.available? correction (#1387)
* xmlparser support new field exp, climate, terrain XML feeds (#1388)
* global_defs move() update regex for standing condition (#1407)
* Currency add method to retrieve aevit event currency (#1411)
* Stash check result type before comparing regex for wear_to_inv (#1430)
</PRE>
'''5.18.0'''
<PRE>
### Features (dr)
* common-crafting add method for creating mechanisms (#1375)

### Bug Fixes (general)
* stringproc normalize CRLF | CR to LF (#1378)
* rubocop custom cop ascii only cleanup (#1382)

### Bug Fixes (dr)
* equipmanager update to assume missing items aren't worn (#1376)

### Bug Fixes (gs)
* Infomon xmlparser additional npc death messaging (#1326)
</PRE>
'''5.17.3'''
<PRE>
### Bug Fixes (general)
* Script module replace MemoryReleaser with GC.start for cleanup (#1364)
* Add sqlite busy timeout policy to core (#1365)
* Script#kill remove GC.start and add optional instrumentation (#1368)
* reorder shutdown ala MahtraDR and detect script teardown de... (#1369)
</PRE>
'''5.17.2'''
<PRE>
### Bug Fixes (general)
* harden custom repo identity, collision, and contract boundaries (#1333)
* stop SessionLifecycle before closing database on normal exit (#1334)
* harden FeatureFlags for closed db handle (#1335)
* SynchronizedSocket write resilience and zombie client elimination (#1338)
* correct RP timing issue for release notes (#1348)
* gate object cleanup in GTK queue (#1354)
* recover from cross-process zombie in ActiveSessions service (#1355)
* Improve shutdown session state handling (#1359)
* non-ascii hygeine to address rubocop errors (#1360)
* Remove debug log IO from heartbeat tick loop (#1363)

### Bug Fixes (dr)
* DRC text2num correction for thousand (#1343)

### Bug Fixes (gs)
* Overwatch add REVEALED_EXPLODES regex pattern (#1356)
* Stash add_to_bag result type check before regex compare (#1357)
</PRE>
'''5.17.1'''
<PRE>
### Bug Fixes (general)
* enable heartbeat-driven failover for ActiveSessions service owner (#1340)
* copy Gemfile and LICENSE during self-update (#1345)
* Add top-level parse_args/display_args bridge to global_defs (#1346)

### Bug Fixes (dr)
* replace undefined custom_require in check_moonwatch (#1336)
* set_stance places 100 in the correct positional slot (#1337)
* cache SlackBot users list to prevent API throttling (#1342)
* Add CORE_AUTOSTART sentinel to skip dependency.lic autostart helpers (#1344)

### Bug Fixes (gs)
* Infomon Status.cutthroat? Effect Debuff correction (#1331)
* add support for RESERVE xml in GameObj.reserve (#1341)
</PRE>
'''5.17.0'''
<PRE>
### Features (general)
* custom 3rd-party repo support for ScriptSync (#1285)
* Add get_settings, get_data, start_scripts_if_available to core (#1305)
* Add Map.apply_wayto_overrides for personal map overrides (#1306)

### Features (dr)
* Decouple SetupFiles from script-scoped echo and XML feed timing (#1304)
* Add game flags and obsolete script warnings to DRInfomon startup (#1307)

### Bug Fixes (general)
* use :__unset for --without-frontend CLI request YAML matches (#1301)
* prevent zombie server deadlock in Active Sessions accept loop (#1302)
* improve MacOS keychain system check for older OS variants (#1310)
* stub sync_all_repos to prevent leaked thread in games_spec (#1311)
* enforce beta confirmation 10s timeout (#1315)
* use send(:respond) in StatusReporter fallback path (#1316)
* ensure SessionLifecycle.stop runs on abnormal exit (#1317)
* address ActiveSessions lifecycle hot path feature-flag polling (#1325)
* catch ECONNRESET in _puts and bound walk_to retry depth (#1327)
* safeguard gtk logo.png loading (#1329)

### Bug Fixes (gs)
* Add InnCheckedOut pattern to parser (#1309)
* Claim corrections to handle mounts in room_players stream (#1324)
</PRE>
'''5.16.2'''
<PRE>
### Features (general)
* session summary store and reporting (#1247)
* add core classes, ScriptSync, and login auto-sync (#1273)
* Add active sessions API (#1274)
* Add session status CLI query (#1276)
* configurable debug log retention (#1282)

### Features (dr)
* common-healing.rb - add vitality parsing to HealthResult (#1265)

### Bug Fixes (general)
* handle auth exceptions in manual login to prevent hang on bad password (#1267)
* set SO_REUSEADDR before bind to allow immediate port reuse (#1268)
* Persistent Launcher re-enable play button post launch (#1269)
* Restore manual login behaviors to not require saved entry t... (#1270)
* log and re-raise unexpected errors in saved login auth handler (#1271)
* narrow safe_write rollback scope so cleanup failure preserves successful write (#1287)
* fix three revert bugs in SnapshotManager (#1289)
* guard nil release asset and validate before deleting lib/ (#1290)
* guard nil stable version in beta channel resolution (#1291)
* remove dead code in BranchInstaller (#1292)
* repair regression on gui button reenable from refactor (#1297)

### Bug Fixes (dr)
* common-items.rb - move pattern from failure to success block (#1262)
* buffer_room_objs missed split components with leading stream tags (#1284)
* common-items.rb - get_item_unsafe false positives via XML feed verification (#1286)
* forward vitality and dead fields in perceive_health (#1288)

### Bug Fixes (gs)
* Infomon xmlparser additional npc death messaging (#1275)
* Infomon xmlparser additional npc death messaging (#1281)
</PRE>
'''5.16.1'''
<PRE>
### Features (general)
* session summary store and reporting (#1247)
* add core classes, ScriptSync, and login auto-sync (#1273)
* Add active sessions API (#1274)
* Add session status CLI query (#1276)
* configurable debug log retention (#1282)

### Features (dr)
* common-healing.rb - add vitality parsing to HealthResult (#1265)

### Bug Fixes (general)
* handle auth exceptions in manual login to prevent hang on bad password (#1267)
* set SO_REUSEADDR before bind to allow immediate port reuse (#1268)
* Persistent Launcher re-enable play button post launch (#1269)
* Restore manual login behaviors to not require saved entry t... (#1270)
* log and re-raise unexpected errors in saved login auth handler (#1271)
* narrow safe_write rollback scope so cleanup failure preserves successful write (#1287)
* fix three revert bugs in SnapshotManager (#1289)
* guard nil release asset and validate before deleting lib/ (#1290)
* guard nil stable version in beta channel resolution (#1291)
* remove dead code in BranchInstaller (#1292)

### Bug Fixes (dr)
* common-items.rb - move pattern from failure to success block (#1262)
* buffer_room_objs missed split components with leading stream tags (#1284)
* common-items.rb - get_item_unsafe false positives via XML feed verification (#1286)
* forward vitality and dead fields in perceive_health (#1288)

### Bug Fixes (gs)
* Infomon xmlparser additional npc death messaging (#1275)
* Infomon xmlparser additional npc death messaging (#1281)
</PRE>
'''5.16.0'''
<PRE>
### Features (general)
* session summary store and reporting (#1247)
* add core classes, ScriptSync, and login auto-sync (#1273)
* Add active sessions API (#1274)
* Add session status CLI query (#1276)
* configurable debug log retention (#1282)

### Features (dr)
* common-healing.rb - add vitality parsing to HealthResult (#1265)

### Bug Fixes (general)
* handle auth exceptions in manual login to prevent hang on bad password (#1267)
* set SO_REUSEADDR before bind to allow immediate port reuse (#1268)
* Persistent Launcher re-enable play button post launch (#1269)
* Restore manual login behaviors to not require saved entry t... (#1270)
* log and re-raise unexpected errors in saved login auth handler (#1271)

### Bug Fixes (dr)
* common-items.rb - move pattern from failure to success block (#1262)
* buffer_room_objs missed split components with leading stream tags (#1284)
* common-items.rb - get_item_unsafe false positives via XML feed verification (#1286)

### Bug Fixes (gs)
* Infomon xmlparser additional npc death messaging (#1275)
* Infomon xmlparser additional npc death messaging (#1281)
</PRE>
'''5.15.1'''
<PRE>
### Bug Fixes (general)
* Mutli-launch persistent login GUI (#1245)
* Remove Windows OS CMD prompt flash (#1255)
* guard against broken pipe errors in Game._puts and send_to_client (#1260)
* add timeout safety to fput to prevent infinite hangs (#1261)

### Bug Fixes (dr)
* anchor stow success pattern to prevent fan close recovery bypass (#1254)
* add bounded recursion depth limits to 9 methods (#1257)
* stow_helper failure detection + unload_weapon ammo recovery (#1259)
</PRE>
'''5.15.0'''
<PRE>
### Features (general)
* add InstanceSettings for core Settings API access (#1233)

### Features (gs)
* Overwatch module into core (#1201)

### Bug Fixes (general)
* fix GameObj container initialization and add clear_all_containers (#1226)
* GameObj object dedupe & GC (#1234)
* script.rb show Script.kill source (#1235)
* Exit quickly on CLI authentication failure (#1237)
* suppress wine detection noise and skip when unneeded (#1244)

### Bug Fixes (dr)
* DR modules fixes and enhancements (#1232)

### Bug Fixes (gs)
* psms.rb add additional failure matches (#1238)
* Bounty parser fix regex pattern for skin retrieval task (#1242)
</PRE>
'''5.14.2'''
<PRE>
### Bug Fixes (general)
* add retry with exponential backoff for all login authentication (#1205)
* update.rb allow for bugfix betas and branch updates (#1211)

### Bug Fixes (gs)
* infomon.rb bug in _key transformation (#1216)
</PRE>
'''5.14.1'''
<PRE>
### Bug Fixes (general)
* Change server_time_offset in XMLParser to be float instead of int (#1184)
* change encodings in main.rb to wizard FE only (#1199)

### Bug Fixes (gs)
* Infomon parser.rb update Account.subscription/type (#1192)
* spell.rb add last_cast to track last time casted (#1193)
* stash.rb additional improvements with ReadyList/StowList (#1197)
* Infomon parser.rb bug in EnhanciveEnd (#1198)
</PRE>
'''5.14.0'''
<PRE>
### Features (general)
* Add Genie map cross-reference fields to the DragonRealms map data model (#1169)

### Features (dr)
* DRExpMonitor move into core lich (#1154)

### Features (gs)
* add Enhancive module for enhancive item bonus tracking (#1113)
* add QStrike module for optimal stamina-based RT reduction (#1114)

### Bug Fixes (general)
* remove strip! from settingsInfo replacement (#1161)
* map_base.rb sort JSON better (#1171)

### Bug Fixes (dr)
* logbook_item recovery when crafted item not in hand (#1175)

### Bug Fixes (gs)
* xmlparser.rb capture additional death messaging (#1158)
* stash.rb ReadyList sheath handling and update inventory checks (#1166)
</PRE>
'''5.13.6'''
<PRE>
### Bug Fixes (general)
* allow --add-account to run without yaml and dat (#1143)
* enable --login for multi-variable custom launch commands (#1144)
* update.rb pervent update if MIN_RUBY not met (#1146)
* messaging.rb return "" for xml_encode with Wizard (#1147)
* prevent closing connection on module reload (#1148)
* Allow hmr to work on global_defs.rb (#1156)

### Bug Fixes (dr)
* buffer split room obj lines and merge instead of appending closing tag to broken line (#1149)
* add buffering for multiline room players (#1151)
* add verify_script def here instead of depending on dependency (#1155)

### Bug Fixes (gs)
* infomon.rb added updated_at field to upsert_batch (#1145)
* stowlist.rb check method fix when dead (#1152)
* readylist.rb check method fix when dead (#1153)
</PRE>
'''5.13.5'''
<PRE>
### Bug Fixes (general)
* util.rb only show gem installing debug messaging if gem mis… (#1131)
* add --gs and --dr, refactor argv_options to helpers (#1133)
* fix multiple custom entries, improvements to yaml save (#1134)
* login_tab_utils.rb expand helper text show Warlock (#1135)
* update CLI for YAML security signature, add auto-convert fo… (#1136)
* remove password parameter from debug logging in all cases (#1137)
* reduce minimum GUI window footprint for non-tabbed view (#1138)
* remove double save in YAML to preserve yaml.bak integrity (#1139)

### Bug Fixes (gs)
* stash.rb additional improvements (#1132)
</PRE>
'''5.13.4'''
<PRE>
### Bug Fixes (general)
* force system gem install if RubyGems fails (#1126)
* gui_login prevent destroying window if already destroyed (#1127)
* add window size / position saves to login GUI (#1128)
* non tabbed saved entries in reduced button / font size (not… (#1129)
</PRE>
'''5.13.3'''
<PRE>
### Bug Fixes (general)
* account manager sorting GUI fix (#1123)
</PRE>
'''5.13.2'''
<PRE>
### Bug Fixes (general)
* install_gem_requirements update available gems after install (#1120)
</PRE>
'''5.13.1'''
<PRE>
### Bug Fixes (general)
* password_cipher.rb upcase account_name for key (#1118)

### Bug Fixes (dr)
* validator.rb change sleep to should_sleep named param (#1116)

### Bug Fixes (gs)
* add base stats capture from 'info full' command (#1115)
</PRE>
'''5.13.0'''
<PRE>
### Features (general)
* Refocus Frontend (#960)
* socket configurator to better guard TCPSocket (#976)
* add simplified DB maintenance (#991)
* TextStripper module support for XML, HTML, Markdown (#1055)
* Login modernization and refactor to yaml (#1063)
* Ruby Memory Releaser module (#1066)

### Features (dr)
* support meta:trashcan tag for DRCI.dispose_trash (#966)
* Add GameObj.inv support for DR items (#1080)
* DRCS allow custom adjective for summoned weapons (#1088)
* DRParser support for new exp window xml stream elements (rested exp, tdps, favors) (#1104)

### Features (gs)
* Add Armaments (Weapon, Armor, and Shield) Module (#911)
* add creature module, including Hinterwilds creatures (#1002)
* Creature module combat tracking (#1003)
* track time of last total_experience record (#1030)
* add Injured class for checking ability to perform actions (#1035)

### Bug Fixes (general)
* map dijkstra optimization (#1061)
* update.rb keep script/data file incase of error on update (#1070)
* ensure proxy path is set for non-destructive array write-th… (#1073)
* [lib][global-defs] - move update (#1079)
* GameObj force new objects ID to be string (#1087)
* xmlparser.rb gate GSL exits sending behind @send_fake_tags (#1103)
* change Hash[] pair key conversion to use to_h for Ruby 4.0 (#1108)
* move gui-login.rb to Ruby standard gui_login.rb (#1111)
* update location for currency and move game-loader.rb to Ruby standard gameloader.rb (#1112)

### Bug Fixes (dr)
* DRCA allow custom spell prep messaging (#1089)
* Update Slackbot error handling, and lnet management (#1091)
* Fix exp mods parsing for DR (#1102)
* equipmanager.rb support for custom messaging in forester's longbow (#1105)
* Fix hang in equipment manager when game doesn't respond to commands (#1110)

### Bug Fixes (gs)
* Infomon additional CHE resign regex (#1067)
* Resource tracking for sorcerer shadow essence (#1085)
* cman.rb add hamstring regex for already lying down target (#1090)
* cman.rb hamstring regex update when can't perform on target (#1092)
* Bounty parser.rb FWI guard regex update (#1096)
* currency.rb track gold (#1109)
</PRE>
'''5.12.12'''
<PRE>
Bug Fixes (general)
Update module strip markdown comments (#1056)
Vars/UserVars module fixes and corrections (#1057)
Bug Fixes (gs)
Infomon parse fix for singular currency (#1051)
</PRE>
'''5.12.11'''
<PRE>
Bug Fixes (dr)
add bput match for system updates preventing actions (#1034)
drdefs.rb npc parsing (#1038)
Fix container reference in get_item_from_eddy_portal method (#1039)
Bug Fixes (gs)
bounty location regex needs to match "under" (#1037)
</PRE>
'''5.12.10'''
<PRE>
Bug Fixes
all: games.rb catch additional error for nested single/double quotes (#1031)
dr: change keys for DR_SKILLS_DATA[:guild_skill_aliases] to be strings instead of symbols (#1032)
gs: Bounty parser for SG npcs matching (#1027)
gs: match READY/STOW items with a/an/some inside the link (#1026)
</PRE>
'''5.12.9'''
<PRE>
Bug Fixes
gs: StowList/ReadyList reset bug if non-default keys added #1019
</PRE>
'''5.12.8'''
<PRE>
Bug Fixes
all: script.rb show custom at script exit as well (#993)
all: Updated update.rb for single trunk and release please (#1001)
</PRE>
'''5.12.7'''
<PRE>
fix(all): ensure updates do not target detached proxy views #990
fix(gs): bounty parser and move fixes for sailor's grief #987
fix(gs): Infomon xmlparser.rb Ready/Stow fix for LONG before exist #988
fix(gs): gameobj.rb for Sailor's Grief ghostly/boss/guild tentacles #989
</PRE>
'''5.12.6'''
<PRE>
fix(all): settings.rb update to preserve root of derived views #975
fix(all): show custom in various script output when custom script #967
fix(dr): drparser.rb update for PlayedSubscription #983
fix(gs): include store location for ReadyList #977
fix(gs): infomon parser.rb update for ACCOUNT output varies #979
fix(gs): global_defs.rb move def update for Hive traps #980
fix(gs): activespell.rb prevent removal of RF Penalty #981
fix(gs): add .compact to input of Disk.find_by_name #982
</PRE>
'''5.12.5'''
<PRE>
fix(all): update.rb word boundary for abbreviations #971
fix(dr): equipmanager.rb Fix for changed game output. #969
fix(dr): common-arcana.rb Regalia fix for changed game output. #970
fix(dr): common-items.rb Fix for changed inventory command output #973
fix(gs): StowList missing space in capture in xmlparser.rb #963
fix(gs): stowlist.rb wait for RT when issuing check #964
fix(gs): readylist.rb wait for RT when issuing check #965
fix(gs): Bounty heirloom return msg'ing update #972
</PRE>
'''5.12.4'''
<PRE>
build(all): installer.yml use windows-2022 #950
fix(all): restore Wrayth / Wizard script execution ability #952
fix(all): database_adapter.rb error handling improvement #956
fix(dr): common-items.rb wear/remove messaging additions #949
fix(dr): games.rb - ignore UIDs for Frostbite mapping #951
fix(dr): map_dr.rb prevent inadvertent settings changes #958
fix(gs): GameObj targets for new Sailor's Grief tentacle npc #948
fix(gs): map_gs.rb remove delete_if to prevent bad settings #957
fix(gs): weapon.rb assault break if no targets #962
</PRE>
'''5.12.3'''
<PRE>
fix(all): limitedarray.rb max_size increase #946
fix(all): uservars.rb update for vars method missing #940
fix(dr): drparser.rb to set ShowRoomID to on if turned off #945
fix(gs): change namespace accessors to Ruby 2.6 compatible #944
fix(gs): infomon state reset on status prompt #943
fix(gs): Societies to check membership for various methods #942
fix(gs): standardize warcry.rb to match other PSMS #941
</PRE>
'''5.12.2'''
<PRE>
fix(gs): infomon parser.rb for profile full name matching #938
fix(gs): force PROFILE FULL to sync CHE info for infomon #937
fix(dr): Tighten checks on releasing invisibility for thieves #936
</PRE>
'''5.12.1'''
<PRE>
- fix(all): gameobj.rb - add type? method for explicit type check #928
- fix(all): messaging.rb encoding issue #933
- fix(gs): Various CMan cost corrections #932
</PRE>
'''5.12.0'''
<PRE>
- feat(all): settings.rb - proposal for sequel based Settings #591, #875, #889, #896, #927
- feat(all): util.rb add Ruby gem install helper method #861
- feat(all): messaging.rb add cmd link method #866
- refactor(all): games.rb modernization #849, #882, #924
- fix(all): add class extensions #800
- fix(all): lich.rb deprecated FE message #852
- fix(all): messaging.rb fix XML encoding for wizard and avalon #853
- fix(all): lich.rb class variable not initialized #855
- fix(all): log.rb force msg to String for regexp comparison #856
- fix(all): global_defs.rb bug in fput #864
- fix(all): messaging.rb xml_encode mono method msg #868
- fix(all): script.rb class to is_a? checks #878
- fix(all): gameobj.rb deeper lookup #885
- fix(all): messaging.rb debug not compared to falseclass #887
- fix(all): change class to is_a? checks #91-3
- fix(all): Util.issue_command allow single line captures #918
- fix(dr): drparser.rb casing for Premium status check #842
- fix(dr): map_dr.rb Don't assign UID of zero to rooms #844
- fix(dr): drparser.rb add $last_logoff tracking #851
- fix(dr): update message patterns in common-items #859
- fix(dr): add moon_visible?(moon) convenience method to common-moonmage #860
- fix(dr): exp mods output is not enclosed in preset xml tags anymore #870
- fix(dr): update.rb beta send validation for genie lich char #880
- fix(dr): Update regex and parsing for active spells #894
- fix(dr): add 'You scoop' match pattern to common-items #900
- fix(dr): add missing match patterns #901
- fix(dr): common-items: add and fix match strings #904
- fix(dr): Add missing matches for common-items #905
- fix(dr): Release Khri Vanish if Thief, when going visible #906
- fix(dr): Fix race condition when clearing and repopulating XMLData.dr_active_spells #907
- fix(dr): Fix SLS release pattern #908
- fix(dr): resolve race condition in DR crafting_magic_routine #914
- fix(dr): xmlparser.rb - Fix XMLData.dr_active_spells race condition #915
- fix(dr): xmlparser.rb - Clear out spells properly #916
- fix(dr): drparser.rb update for Platinum account status #922
- feat(gs): gameobj.rb allow for custom gameobj data #848
- feat(gs): PSMS updates, including CMan.use #865, #874, #881, #890, #899
- feat(gs): ReadyList & StowList classes for item tracking #884
- feat(gs): Breakout and Buildout Societes #919
- fix(gs): infomon parsing for CHE membership #841
- fix(gs): map_gs.rb for no UID when hexdigest used #843
- fix(gs): warcry.rb yowlp :buff to string instead of regexp #847
- fix(gs): group.rb multiple corrections #850, #869, #883
- fix(gs): Bounty parser.rb fix for HW & KF guard return #862
- fix(gs): Bounty task.rb fix for assigned? and Ruby 2.6 #863
- fix(gs): stash.rb stale sheaths recheck #867
- fix(gs): allow spell.rb casting to take a force_stance parameter #902
- fix(gs): update Infomon parsing for new ACCOUNT output format #903
- fix(gs): PSMS cost for multiple cost types & add Excoriate feat #912
- fix(gs): Feat excoriate regex correction #920
- fix(gs): weapon PSM affordable check against Glorious Momentum #926
</PRE>
'''5.11.1'''
<PRE>
- fix(all): restore @theme_state and add to CLI capability #795
- fix(all): retire gtk2 monkey patch for gtk3 #823
- fix(all): games.rb XMLData.name wait till both not NIL and not EMPTY #826
- fix(all): standardize xmlparser game instance #827
- fix(all): games.rb fix multiple single and double quote in XML #832,836,837
- fix(dr): games.rb - optional hide Room Title display of Real IDs with FLAG on #782
- chore(dr): common-moonmage - refactor of peer_telescope #783
- fix(dr): move HMR load to common before for dragonrealms #784
- fix(dr): common-crafting.rb minor edit to add "You tuck" #787
- fix(dr): common-arcana.rb - remove unecessary pause from discern code #792
- fix(dr): drparser.rb Restore Premium status checking #834
- fix(gs): migrate PSMS.name_normal to Lich::Util.normalize_name #790,833
- fix(gs): add Char.che to know current character's CHE #791
- fix(gs): FEAT and Infomon module parsing of new Covert Art feats. #796
- fix(gs): add Currency.gemstone_dust and fix redsteel mark capture #797
- fix(gs): FEAT Covert Arts colon normalization and stamina costs #799
- fix(gs): escape dash in regex for HouseCHE #824
- fix(gs): disk.rb comparison helpers #828
- fix(gs): allow for Group.disks to show self disk in array #829
- fix(gs): feat.rb Covert Arts throw poison costs 15 stam #830
- fix(gs): add missing Feat.use ability #831
- fix(gs): multiple CritRanks updates #801-822
</PRE>
'''5.11.0'''
<PRE>
- [all] - chore: Namespace & File Path Updates #713
- [all] - [argv_options.rb] bugfix: correct darkmode to work via CLI #693
- [all] - [games.rb] feat: make show Room Exits of non-StringProc/Obvious Exits toggable for all games #699
- [all] - [games.rb] feat: toggleable display of StringProcs with clickable links #751
- [all] - [gui-manual-login.rb] fix: change label to Wrayth #720
- [all] - [gui-saved-login.rb] fix: update Stormfront label #721
- [all] - [update.rb] fix: purge old LIB folder prior to update release #729
- [all] - [util.rb] bugfix: allow issue_command to use fput or put #715
- [all] - [xmlparser.rb] feat: add XMLData.room_name attribute #685
- [all] - [main.rb] fix: create session file in regular connect method #733
- [all] - [init.rb] bugfix: error for Windows DISPLAY variable #735
- [all] - [main.rb] fix: Mudlet support #736
- [all] - [wine.rb] fix: add --no-wine CLI flag prevent WINE startup
- [all] - [init.rb] fix: add --no-gtk CLI flag prevent GTK3 gem load
- [dr] - [games.rb] feat: DRinfomon and common files as core lich libraries #686
- [dr] - [games.rb] chore: add DR requires here #690
- [dr] - [games.rb] fix: add Room# display for DR #697
- [dr] - [games.rb] bugfix: Genie FE real ID#s not supported, hide by default #728
- [dr] - [drdefs.rb] bugfix: fix for Shadow Servants #710
- [dr] - [map_dr.rb] fix: cleanup and support for UIDs #719
- [dr] - [xmldata.rb] bugfix: add support for DR Room IDs #716
- [dr] - [xmlparser.rb] feat: XMLData - adding dr_active_spells #691
- [gs] - [games.rb] bugfix: support for pre/post room name txt #683
- [gs] - [group.rb] chore: update to account for hold #701
- [gs] - [resource.rb] feat: add additional tracking of covert art charges #714
- [gs] - [spell.rb] bugfix: Spell.affordable? 515 release #687
- [gs] - [stash.rb] bugfix: sheath_bags when not found #694
- [gs] - [xmlparser.rb] bugfix: missing real ID in nav #684
- [gs] - [xmlparser.rb] bugfix: Claim module obvious hiding #717
- [gs] - [sk.rb] feat: Self-Knowledge functionality in core #748
</PRE>
'''5.10.4'''
<PRE>
-o- [GS4] - [xmlparser.rb] bugfix: Simu XML breaking change RoomID #679
</PRE>
'''5.10.3'''
<PRE>
-o- [GS4] - [crit_tables] fix: CritRanks regex fixes (multiple files and changes) #671
-o- [GS4] - [spellsong.rb] fix: Correct Spellsong sync method #674
-o- [GS4] - [parser.rb] fix: thorn status regex correction #673
-o- [All] - [xmlparser.rb] fix: Split out if elif block to account for DR having multiple… #670
-o- [All] - [global_defs.rb] fix: percentconcentration #676
-o- [All] - [global_defs.rb] fix: update move failure message to handle attack and casting #667
-o- [All] - [init.rb] fix: update required ruby check messaging #669
-o- [All] - [sessionvars.rb] feat: new module SessionVars for non-persistent variable storage #666
</PRE>
'''5.10.2'''
<PRE>
-o- [DR] - [games.rb] bugfix: tweak XML rewrite section #662
-o- [GS4] - [crit_tables] bugfix: additional crit table regex corrections #663
-o- [GS4] - [ascension.rb] bugfix: add new Transcend Destiny to lookups #661
-o- [GS4] - [effects.rb] bugfix: regexp escape txt #660
-o- [GS4] - [disruption_critical_table.rb] Bugfix in regex #659
</PRE>
'''5.10.1'''
<PRE>
-o- [All] - [games.rb] bugfix: prevent race condition in games thread #656
-o- [All] - [init.rb] bugfix: address WINE variance between linux / installs #655
-o- [GS4] - [gs][stash.rb] bugfix: wear code improvement #657
</PRE>
'''5.10.0'''
<PRE>
-o- [All] - [main.rb] bugfix: correct encoding for WizardFE PR #640
-o- [All] - [games.rb] bugfix: correct logic for room detection when using CLI --start-scripts PR #639
-o- [All] - [DB_Store.rb] feat: add direct support for Simu RENAME and CHANGE PROF PR #633
-o- [All] - chore: breakout code to individual files for easier management PR #617
-o- [All] - [lich.rbw] chore: add deprecated msg to old Settings/GameSettings/CharSettings methods PR #589
-o- [All] - [lich.rbw] feat: add new --dark-mode CLI option PR #583
-o- [All] - [global_defs.rb] bugfix: monsterbold fix for additional clients PR #581
-o- [All] - [update.rb] feat: update core scripts from source on Lich5 update/install PR #579
-o- [All] - [log.rb] feat: add new Log module copied from Olib PR #577
-o- [All] - [numeric.rb] feat: add days/hours/minutes/seconds methods to numerics PR #623
-o- [All] - [messaging.rb] feat: WizardFE Voln window support #647
-o- [All] - [init.rb] bugfix: WINE entries for Linux / MacOS #649
-o- [DR] - [lich.rbw] bugfix: cleanup downstream hook exclusions PR #593
-o- [DR] - [global_defs.rb] bugfix: missing climb failure message PR #592
-o- [GS4] - [effects.rb] bugfix: show non-standard Effects in `;magic` output PR #641
-o- [GS4] - [parser.rb] bugfix: fix WARCRY duplication results / add WALL OF THORNS effect detection PR #634 / PR #637
-o- [GS4] - [critranks.rb] feat: add critical rank resolution tables and methods PR #625
-o- [GS4] - [effects.rb] bugfix: to support regex for active? & time_left PR #590
-o- [GS4] - [infomon.rb] bugfix: add implicit NPC death monitoring PR #588
-o- [GS4] - [infomon.rb] bugfix: change PSM to be stored as type.mnemonic PR #587
-o- [GS4] - [lich.rbw] bugfix: strip_xml multiline fix PR #584
-o- [GS4] - [stash.rb] bugfix: fix sack detection to use Stash.container(param) PR #578
-o- [GS4] - [spell.rb] feat: Spell.after_stance #644
-o- [GS4] - [xmlparser.rb] bugfix: for Claim module #646
-o- [GS4] - [infomon] feat: track Voln favor via RESOURCE output #648
-o- [GS4] - [gameobj.rb] feat: add Bandit hidden target API #650
</PRE>
'''5.9.2'''
<PRE>
-o- [GS4] - [group.rb] bugfix: proper leader detection from GROUP output
-o- [GS4] - [char.rb] bugfix: add back depracted Char.maxvitals with msging to switch to new Char.max_vitals methods
</PRE>
'''5.9.1'''
<PRE>
-o- [GS4] - [group.rb] bugfix: group.check syntax change
-o- [GS4] - [spell.rb] bugfix: affordable? Char.mana parenthesis logic
</PRE>
'''5.9.0'''
<PRE>
-o- [All] - feat: sqlite3 gem syntax code cleanup PR#553
-o- [All] - [lich.rbw] bugfix: remove unused Setting, GameSetting, CharSetting PR#542
-o- [All] - [lich.rbw] bugfix: scrub login key from error message popups PR#548
-o- [All] - [messaging.rb] bugfix: color mismatch WizardFE white txt PR#554
-o- [All] - [lich.rb] feat: add new Lich.deprecated method to aid in deprecating older API calls PR#523
-o- [GS4] - [char.rb] feat: log method_missing calls PR#552
-o- [GS4] - [char.rb] feat: add missing global_def related methods PR#523
-o- [GS4] - [global_defs.rb] feat: deprecate various Char module methods PR#523
-o- [GS4] - [spellsong.rb] bugfix: cache spellsong duration calc PR#551
-o- [GS4] - [effects.rb] feat: Effects module breakout PR#549
-o- [GS4] - [group.rb][disk.rb] feat: Group & Disk class PR#532
-o- [GS4] - [activespell.rb] feat: add duration change messaging, off by default, see ;help for details PR#487
</PRE>
'''5.8.1'''
<PRE>
-o- [All] - [lich.rbw] feat: add Game:Character to debug log file ouput
-o- [All] - [init.rb] feat: add milliseconds to debug filename
-o- [GS4] - [lich.rbw] bugfix: reorder parsing of $SERVERSTRING to avoid certain conflicts
-o- [GS4] - [parser.rb] bugfix: update for new Empath resource and sleep/bind messaging
-o- [GS4] - [status.rb] bugfix: bound? calmed? and sleeping? support for spellnames flag being off
-o- [GS4] - [xmlparser.rb] bugfix: additional creature dying messaging to check against XML dead not being sent
-o- [GS4] - [gameobj.rb] bugfix: remove sorcerer arms and animates from GameObj.targets
</PRE>
'''5.8.0'''
<PRE>
-o- [All] - Ruby 3.3 compatibility
-o- [All] - [lich.rbw] feat: adds .sources for up/downstream hooks
-o- [All] - [lich.rbw] bugfix: don't use WINE for custom frontends
-o- [GS4] - [char.rb] bugfix: add back Char.stance
-o- [GS4] - [claim.rb] feat: new module and associated changes to xmlparser
-o- [GS4] - [experience.rb] feat: percent experience options
-o- [GS4] - [parser.rb] bugfix: allow for negative TNL exp value
-o- [GS4] - [parser.rb] bugfix: allow hyphenated last names in character names
-o- [GS4] - [parser.rb] feat: update resource matching for new Bard service
-o- [GS4] - [stash.rb] bugfix: catch more shield removal messages
-o- [GS4] - [util.rb] bugfix: underscore issue for PSMs
</PRE>
'''5.7.0'''
<PRE>
-o- Supports Ruby 3.2 - security enhancements and huge speed improvements for regex
-o- New libraries/modules/classes: Account, HMR (Hot Module Reloading)
-o- GS4 Infomon now baked into Lich5 as a library, no more need to run standalone script
-o- New GS4 libraries/modules/classes: Ascension, Bounty, Currency, Experience, Resources, Society, Status, Warcry
-o- Updates to existing libraries/modules/classes: Armor, Util, Weapon, Spell, GameObj, Messaging
-o- Several Bugfixes for lots of things
-o- Lots of code cleanup
</PRE>
'''5.6.2'''
<PRE>
-o- Fix for XML errors
-o- Adds the DR Plat instance for Frostbite FE
-o- Adds ‘ball’ as the noun used for ‘ball and chain’
-o- Adds the movement result ‘slip in the mud and fall flat’
-o- Corrects stamina cost for the feature Dispel Magic
-o- Plus all the latest script updates from Elanthia-Online!
</PRE>
'''5.6.1'''
<PRE>
-o- Fix for XML to limit login errors (DR)
-o- Fix for XMLData.active_spells to properly register wizard 'recovery' spell cooldowns
-o- Messaging updates to remove error in Wizard FE encodings
-o- Corrects for error in detecting PSM skill changes (cman) via warrior / rogue guild lessons
-o- Deprecates LNet script from master repository
-o- Miscellaneous small bug squashing
</PRE>

'''5.6.0'''
<PRE>
-o- (DragonRealms) Support for Genie and Frostbite frontends
-o- (GemStone) Changed methods to improve ;go2 speed and reduce lich.db3 calls
-o- (GemStone) Updates to support silver_count function
-o- (Both) Changed method for updating lich ecosystem
</PRE>

'''5.5.0'''
<PRE>
-o- Support for DragonRealms
-o- Updated support for scripts like BigShot
-o- Providing the LichID and UID on Profanity
-o- Spell.force_incant, .force_channel, and .force_evoke
-o- Standardized message method for script authors
-o- Sundry small improvements / fixes and changes
-o- And the creme de la creme - a custom directory
</PRE>

'''5.4.0'''
<PRE>
-o- Simu Room IDs (formally called 'unique ID' or 'uid' for Lich) added to Map, mapDB where known, and ;go2 for navigation (courtesy Xanlin and with our thanks!) ;go2 u7120 for all you ex-GMs out there.
-o- Room titles will now display the Lich ID and / or the UID for the room based on user selections - default is on for both, and enabled / disabled via Lich.display_lichid or Lich.display_uid toggles that can be set to on / off or true / false. (;e Lich.display_lichid=true/false and ;e Lich.display_uid=true/false) You can remove that rnum from your autostart now! To gain the benefit of the UID deployment, be sure to ;repo download-mapdb
-o- REQUESTS: Drop 5 minute timeout function from Lich
-o- waitrt? and waitcastrt? will still pause activities, but will return TRUE or FALSE in keeping with the Ruby functionname? tradition (no more failing to get a weapon out due to RT from climbing!)
-o- empty_hands and fill_hands will now check to see if the character is in roundtime before trying to put away or retrieve held items
-o- Infomon received an update that keeps spell timers in sync with the information received from the server - no more need to immediately do a spell active in game to get the right times to display for various legacy scripts and ;magic after visiting the invoker or using an SK item
-o- Lich now provides a facility to get current coins on the character that is a bit more agnostic to data changes from Simu - Lich::Util.silver_count
-o- Various other small tidbits to help ease maintenance and future development
-o- PLEASE NOTE: This update is required for the newest Bigshot (released today!) and for future eloot and eherbs scripts (release RSN)
</PRE>

'''5.3.0'''
<PRE>
-o- Added support for Wrayth (renamed Stormfront) installations
-o- Converted Linux | WINE login methods to 'method 0', does not use Simu launcher
</PRE>

'''5.2.1'''
<PRE>
-o- Support for STOWing items irrespective of special item scripts
-o- Improved query support for Effects and CMans
-o- Fix Lich bug to respect the 'groupmovement' flag in game
-o- Fix Lich round time calculations (more aggressive timing)
-o- Dark Mode is now a thing
-o- Lich4 Style GUI layout available
-o- Several file location changes to support future code change efforts
</PRE>

'''5.0.19'''
<PRE>
-o- Benefit: Monks with Mental Acuity (all 3 of you) rejoice - stamina casting!
-o- Benefit: PSM3 included, no charge. No hair remaining, either!
-o- Benefit: Ok, stay seated: Some of your various SF spell duration windows may work. . . better? Yes, not perfect, but better. No pictures, please!
-o- Updated infomon that properly detects Cloak of Shadows on those pesky sorcerers, and the Raise Dead Cooldown periods for those wondrous clerics.
-o- A new update process for Lich 5 - tired of having to download that script over and over just to update? Get yourself a copy of lich5-update.lic. Note, if you already have it, you're set! If not - ;jinx script install lich5-update --repo=elanthia-online
</PRE>

'''5.0.11'''
<PRE>
-o- Updated the method used to log onto SIMU servers.
-o- Added the Animalist item specifics to Lich5's empty and fill hands routines
-o- Improved Invoker messages for Avalon and Wizard FEs (no change for SF FE)
-o- Improved cleanup and store methods when player EXIT's or QUIT's game
-o- Crafted two new methods (stash_hands and equip_hands) for future script use
-o- Some behind-the-scenes cleanup to improve maintaining the Lich5 ecosystem
-o- Add Spell Active improvements
-o- Add PSM and Ranger improvements
</PRE>
</div>

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

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

Saga

2026-10-28T13:17:06Z

WHIGHTCNIGHT: /* Getting Started */

'''Saga''' is an officially supported front end (FE) for [[GemStone IV]] and [[DragonRealms]], currently in '''beta''', offered by Simutronics as an alternative to [[Wrayth]]. It is a modern, cross-platform client built with Electron, React, and TypeScript that speaks the GemStone IV/DragonRealms protocol natively and renders the game stream into dockable panels, replacing the old Wrayth/Stormfront client. It supports [[Lich:Software|Lich]] scripting.

Download / info page: https://www.play.net/gs4/play/saga-info.asp

Because Saga is in active beta, features and settings menus described here may change between releases.

==Getting Started==

# Go to https://www.play.net/gs4/play/saga-info.asp and click the download button for your platform.
#* '''Windows''' — available as x64 and ARM64 install.
#* '''macOS''' — separate builds for Apple Silicon and Intel.
#* '''Linux''' — distributed as an AppImage (x86_64).
# Run the installer (Windows) or launch the downloaded build (Mac/Linux).
#* On Windows, the first launch may trigger a SmartScreen warning because the builds aren't code-signed yet during the beta. Choose "More info → Run anyway" to continue — this is expected and not a sign of a problem.
# Log in from inside Saga. Saga completely replaces the Simutronics Game Launcher/SGE with its own login screen — there is no separate launcher install and no <code>.sal</code> handshake file to deal with.
# New players can use the guided character creation flow built into the login screen; returning players get a Quick Logins grid with one click per character.

== Features ==

A few things Saga does that Wrayth doesn't:

* '''Cloud-synced settings''' — per-character settings (layout, highlights, preferences) sync automatically, so logging in from a different computer picks up where you left off.
* '''Inventory Manager''' — a live, structured view of everything worn, held, and on the ground as container cards you can open and nest (in/on/behind/under). Dragging an item between containers has Saga plan and issue the actual game commands for you. Weight/capacity show in sortable columns, and an inspector pane collects an item's LOOK/ANALYZE/RECALL output in one place.
* '''Custom panels''' — a widget palette (vitals bars, timer rings, compass rose, loadout rows, gauges) you assemble into your own panels. Floating script windows or server dialogs can be promoted into a docked panel that persists across logins.
* '''Scripting and highlights''' — full support for the classic script language with an editor and recording, switchable macro sets, layered highlights with capture-group precision and per-rule sounds, regex triggers with cooldowns, and a settings importer for existing Wrayth configs.
* '''Interactive maps''' — in-client area maps that dock into your layout or float standalone, with click-to-travel.
* '''Accessibility''' — a dedicated screen-reader mode.
* '''Environmental ambience''' — full-screen weather/ambient effects (snow, rain, sandstorm, embers, aurora) paired with panel skins that restyle the interface to match.

== Login with Lich ==

Saga can be used with [[Lich:Software|Lich]] in one of two ways:

* '''Saga Direct''' — After logging into Saga normally, go to '''File → Enable Login with Lich'''. Then disconnect and return to the login screen; a new "Via Lich" option will appear under the connect options. (Requires Lich v5.19+.)
* '''Lich Launcher GUI''' — (Requires Lich v5.20+.) The Lich Launcher autodetects Saga on both macOS and Windows as an available client when creating a saved entry, so you can select it directly without the manual toggle above.

If Lich still isn't connecting after trying the above, a refresh install of Lich is recommended — make sure you're on the latest version first. For further help, see the #help channel on the [https://discord.gg/KF9Wr8u Official Gemstone Discord].

== Settings ==

Saga stores settings (highlights, macros, scripts, panel layouts, etc.) per character and syncs them to the cloud automatically. If you're moving from Wrayth, you can bring your existing settings over:

# In Wrayth, go to '''Options → Settings → Export''' and export your settings to a file.
# In Saga, go to '''Settings → Import Settings''' and select the exported file.

=== Appearance ===

* '''Fonts''': Settings → Appearances & Themes → Fonts.
* '''Link/bold text/room name size''': Settings → Presets. The rightmost box controls font size (shown as "-" at default size).
* '''Per-panel look (background, trim, font)''': Right-click the panel you want to change.
* '''Roundtime display (RT / Cast RT wheel) and status icon size''': Settings → Appearances & Themes → Status Bar.
* '''Loadout panel text''': Settings → Appearances & Themes, bottom left (not under the panel's own alternative-text settings, despite being panel-specific).

=== Panels ===

* To stop thoughts, logins, deaths, etc. from displaying in your main story window, open a dedicated panel for that stream via '''View → Panels'''.
* To see your statuses in a separate panel: not yet available; on the development backlog.
* To make vitals display vertically instead of horizontally: not yet available as a built-in option. In the meantime, create a '''custom panel''' ('''View → Custom Panel'''), which allows flexible layout of individual elements (see [[#Features|Custom panels]] above).
* To pop a text panel (thoughts, speech, familiar, etc.) into its own tab, click and drag it onto another text panel.
* To remove a tab, click and drag it out of the header and release.

== Rest Mode ==

As in Wrayth, pressing CTRL-R puts you into rest mode, which periodically sends the EXP command to prevent an idle timeout.

== Logging ==

Logging is configured per-window from the Windows pane, similar to Wrayth.

== Backup ==

'''Backup Saga Settings and Scripts Regularly'''

Even though settings sync to the cloud, it's worth keeping your own backup of your macros, scripts, highlights, panel layout, and more:

# In Saga, go to '''Settings → Export'''.
# Save the exported file somewhere safe — cloud storage (Dropbox, Google Drive) or emailed to yourself both work well. Consider including the date and character name in the filename rather than overwriting a single backup file each time.
# Repeat this for each character, since each has its own settings.

== FAQ ==

=== Official FAQ ===

From the [https://www.play.net/gs4/play/saga-info.asp Saga info page]:

; Is Saga an official Simutronics product?
: Yes. Saga is an officially supported client for GemStone IV and DragonRealms, currently in beta, offered as an alternative to Wrayth.

; Is it safe to use?
: Saga connects to the game the same way Wrayth or SGE does, using your normal account login. The builds aren't currently code-signed, so Windows SmartScreen may warn you on first launch — this is expected during the beta and not a sign of a problem.

; Does this work with/require the SGE (Simutronics Game Entry) application?
: No. Saga completely replaces the SGE with its own modern login solution.

; What does "beta" mean here?
: Saga is under active development. Features may change between releases, and you may run into rough edges. It updates itself automatically, so you'll always be running the latest version without needing to reinstall.

; I found a bug, or Saga isn't working — who do I contact?
: You can report a bug or request a feature from inside Saga via '''File → Report Bug / Feature Request...'''.

; Why am I downloading a file from GitHub for this?
: While in beta, builds are hosted on the author's GitHub repository — GameMaster Auchand from GemStone IV.

=== Community FAQ ===

The following is drawn from an unofficial FAQ compiled by GM Casil and may not stay accurate as Saga continues development.

; How do I change links/bold text/room name size?
: Settings → Presets. The rightmost box is the font size (shows as "-" when at default size).

; How do I make Lich work?
: A refresh install of Lich is recommended, but at minimum make sure Lich is updated. Log in with Saga, then go to '''File → Enable login with Lich'''. Go to '''File → Return to login'''. Click "Connect", then "Via Lich", and point it to your Lich folder. Log in. If it's still not working, ask for help in the #help channel on the [https://discord.gg/KF9Wr8u Official Gemstone Discord].

; How do I get the roundtime wheel off my screen?
: Settings → Appearances & Themes → Status Bar. From here you can change how roundtime (RT and Cast RT) displays, and the size of the status icons in the corner.

; How do I change font?
: Settings → Appearances & Themes → Fonts.

; How do I change how a specific panel looks?
: Right-click the panel. You can update the background, trim, and font per panel this way.

; How do I make thoughts/logins/deaths stop displaying in my story window?
: View → Panels. From here you can open dedicated panels for different streams.

; How do I make something a tab or pop a tab out?
: To remove a tab, click and drag on the tab until it's out of the header, then release. To make a tab, click and drag a text-only panel (thoughts, speech, familiar, etc.) onto another text panel.

; How do I import highlights, scripts, etc. from Wrayth?
: Export your settings in Wrayth ('''Options → Settings → Export'''). In Saga, use '''Settings → Import Settings'''.

; How do I change the Lich command color?
: Not currently possible.

; How do I change the loadout panel text?
: It isn't in the panel's alternative-text settings — it's under '''Settings → Appearance & Themes''', bottom left. It's an unusual location since the loadout panel was one of the first panels built; moving it has been added to the backlog.

; How do you make vitals vertical instead of horizontal?
: Not built in yet. Create a custom panel under '''View → Custom Panel''' — custom panels are powerful and can be arranged this way, though some snapping/nudging behavior for them is a known rough edge that's been raised with the devs.

; What about putting my statuses in a separate panel?
: On the development backlog.

== Unofficial Plugins ==

See [[Lich:Software]].

== Other FEs ==
*[[Wrayth]] - previous official Windows front end
*[[Wizard (front end)]] - official Windows front end
*[[Avalon]] - official Mac OS X front end
*[[Lich:Software]] - unofficial scripting addon, works with any of Saga/Wrayth/Wizard/Avalon.

[[Category:Front Ends]]
[[Category:New Player]]

Lich:Software/Installation

2026-10-28T13:15:21Z

WHIGHTCNIGHT: /* Saga */ linux version does update itself

{{3rd-party}}
=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 Wrayth or Wizard FE. Lich is also used by many on both MacOS and multiple Linux distributions.

=Installing the Latest Stable Release=

'''The latest stable lich version is 5.22.0 supporting Ruby 4.0 - published October 8, 2026'''

==In-Place Upgrade==

If you are on an older version of Lich 5 and want to upgrade to the most current version, you can choose to either upgrade Lich5 only or both Lich 5 and Ruby. If you're currently on Lich 4, able to check by running the command <CODE>;e echo LICH_VERSION</CODE>, go to the [[#Upgrade Installation for Lich 5 from Lich 4 (11/14/2023)|upgrade from Lich 4 section]].

For each section, please follow the directions/commands one at a time.

===Lich 5 Only===

====Lich 5.7 or newer====
# You must be running Ruby 4.0 or greater for Lich 5.19 +. If unsure, please update both (see below)!
# '''Backup existing Lich 5 folder'''
# Run this command in-game <CODE>;lich5-update --update</CODE>
# Quit and restart lich.
# Congratulations - you're now running on the latest version of Lich!

====Lich 5.6 or older====
Please proceed to updating both Ruby and Lich 5

===Both Ruby 4.0 & Lich 5===
This method is for Windows only. Linux and MacOS users, please do a Lich 5 only update and update Ruby manually via normal install/update methods for the OS.

# Logout of all characters
# '''Backup existing Lich 5 folder'''
# Uninstall existing Ruby4Lich5 installs from Programs & Features control panel, or alternatively, rename your existing Ruby4Lich5 folder to Ruby4Lich5save. (Defaults to C:\Ruby4Lich5)
# Download the latest [https://github.com/elanthia-online/lich-5/releases/latest/download/Ruby4Lich5.exe Ruby4Lich5.exe Installer]
# Run the installer and be sure to have both Ruby and Lich 5 option selected
# Congratulations - you're now running on the latest version of Lich & Ruby!

===Ruby 4.0 Only===
Use this to upgrade to the newest version of Ruby only if you're already on the latest version of Lich5 and now want to update Ruby afterwards. If you're not already on the latest version of Lich5, please use previous section steps instead.
# Logout of all instances/characters
# '''Backup existing Lich 5 folder'''
# Uninstall your existing Ruby4Lich5 install via Programs & Features (ensure it's now gone, default location was C:\Ruby4Lich5)
# Download the latest [https://github.com/elanthia-online/lich-5/releases/latest/download/Ruby4Lich5.exe Ruby4Lich5.exe Installer]
# Run the new installer and choose to only install Ruby Only
# Congratulations - you're now running on the latest version Ruby!

==Windows New Installation==

{{blue|These instructions are not for DragonRealms. [[#Ecosystem Information|For those scroll to the bottom]].}}

'''For Windows 11 / 10 / 8 / 7''' users: you can download the [https://github.com/elanthia-online/lich-5/releases/latest/download/Ruby4Lich5.exe Ruby4Lich5.exe Installer] and install everything you need automatically. Click on the '''Ruby4Lich5.exe''' and download it to your computer then double click on the executable in your default download folder. Note, a user may need to adjust their browser or security settings to allow download and installation.
If you have never played before, follow the 'New Installation' instructions. If you have played before, and have used Lich before, follow the 'Upgrade Installation' instructions.

===New Installation for Lich 5 (11/14/2023)===

# '''Please log into the game of your choice through the Simutronics website first'''. Install the launcher (not SGE), and install your FrontEnd of Choice. The Wrayth FrontEnd is presently the supported FrontEnd, but Wizard will work as well, if you are nostalgic. After you've logged in, log out and continue.
# Download and Run the [https://github.com/elanthia-online/lich-5/releases/latest/download/Ruby4Lich5.exe Ruby4Lich5.exe 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, 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.

===Upgrade Installation for Lich 5 from Lich 4 (11/14/2023)===

This option is deprecated. Lich 5 architectures are not compatible with Lich 4. Back up your existing Lich 4 folder, uninstall any existing Ruby executables, and then follow the instructions for a new install above.

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

==MacOS==
There are two common options for playing Gemstone IV on a Mac: play natively with Saga (the official front end) or Avalon, or use virtualization software such as Parallels with Wrayth/WizardFE. Below are the options on how to do that.

===Native (Saga or Avalon)===
Players with Macs can use [[Mac_Installation_-_Lich_(software) | Installing Lich on Macs]] for installation help. That guide sets Lich up with [[Saga]], the official Simutronics front end (currently in beta), and also covers [[Avalon]]. This process works well for Mac OS Catalina and Big Sur. If you have not updated your Mac OS yet, these instructions may work depending on your actual version. If you run into a snag, follow the contact instructions provided.

===Parallels Windows===
With the latest releases of Ruby4Lich5 installer, you can now follow the normal Windows installation for both Intel and Apple silicon based Apple computers.

To install Wrayth/WizardFE, Lich, and Ruby via Parallels you will need to do a few various steps as outlined below. Please note, the rubyw file in C:\Ruby4Lich5\X.X.X\bin may be set to run in compatibility mode for windows 7. On an ARM Mac running parallels, this may causes Wrayth scripts not to run. Turning compatibility mode off in the rubyw file could fixe this issue if it was enabled.

The following steps are to be done AFTER you've successfully installed Wrayth/WizardFE and can login normally without Lich5 on the machine. Once you've done that and can successful connect normally, then follow these steps:
# Download and install [https://github.com/elanthia-online/lich-5/releases/latest/download/Ruby4Lich5.exe Ruby4Lich5.exe Installer] and use default options presented during install
# Double click the lich.rbw file that is now located in the extracted Lich5 location you did above. Login and play as usual.

==Linux==
Pick the subsection for your distribution below. Each one installs Ruby and Lich; front ends (Saga, Profanity and Warlock) are covered once in [[#Frontends|Frontends]] at the end, since their steps are the same on every distribution.

===Chromebook & Debian variants===
<div class="mw-customtoggle-debian" style="font-size:16px;overflow:auto;color:#0000FF">[Click to Expand]</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-debian">
The following steps should install Lich for users of Debian/Chromebooks. To also install a front end such as Saga, Profanity or Warlock, see [[#Frontends|Frontends]] at the end of the Linux section.

'''Step 1.'''
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 curl libssl-dev libyaml-dev libreadline6-dev zlib1g-dev libncurses5-dev libffi-dev libgdbm6 libgdbm-dev libsqlite3-dev git unzip libcairo2-dev libgirepository1.0-dev libgtk-3-dev gobject-introspection
</pre>

{{side box|NOTE: If you are updating an existing Ruby installation rather than installing from scratch, skip steps 2, 3, and 4. Instead, update your ruby-build with the following command, and then proceed to Step 5.<pre>git -C ~/.rbenv/plugins/ruby-build pull</pre>}}

'''Step 2.'''
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>

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

'''Step 4.'''
Download the tools to let rbenv install Ruby on its own, then install Ruby 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</pre>

'''Step 5.'''
<pre>rbenv install 4.0.9 -v
rbenv global 4.0.9
</pre>

Install Lich:
<pre>
cd ~
curl -L "https://github.com/elanthia-online/lich-5/releases/latest/download/lich-5.zip" -o temp.zip && unzip temp.zip -d ./ && rm temp.zip
</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 using the <tt>Gemfile</tt> included with Lich5 by running <tt>bundle install</tt>. The Gemfile also lists developer-only gems (the <tt>development</tt> and <tt>vscode</tt> groups) that you do not need, so tell Bundler to skip them first:
<pre>
echo "gem: --no-document" > ~/.gemrc
cd ~/Lich5
bundle config set --local without 'development vscode'
bundle install
</pre>
:<small>Note: <tt>bundle install --without ...</tt> no longer works; that flag was removed from the version of Bundler that ships with Ruby 4.0. Use <tt>bundle config set</tt> as shown above.</small>
</div>

===Arch Linux & Arch-based distributions===
<div class="mw-customtoggle-arch" style="font-size:16px;overflow:auto;color:#0000FF">[Click to Expand]</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-arch">
The following steps should install Lich for users of Arch Linux and Arch-based distributions (Manjaro, EndeavourOS, etc.). To also install a front end such as Saga, Profanity or Warlock, see [[#Frontends|Frontends]] at the end of the Linux section.

Update the system and install required dependencies:
<pre>
sudo pacman -Syu
sudo pacman -S --needed base-devel openssl libyaml readline zlib ncurses libffi gdbm sqlite git unzip curl gtk3 gobject-introspection
</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 4.0.9 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 4.0.9 -v
rbenv global 4.0.9
</pre>

Install Lich:
<pre>
cd ~
curl -L "https://github.com/elanthia-online/lich-5/releases/latest/download/lich-5.zip" -o temp.zip && unzip temp.zip -d ./ && rm temp.zip
</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 using the <tt>Gemfile</tt> included with Lich5 by running <tt>bundle install</tt>. The Gemfile also lists developer-only gems (the <tt>development</tt> and <tt>vscode</tt> groups) that you do not need, so tell Bundler to skip them first:
<pre>
echo "gem: --no-document" > ~/.gemrc
cd ~/Lich5
bundle config set --local without 'development vscode'
bundle install
</pre>
:<small>Note: <tt>bundle install --without ...</tt> no longer works; that flag was removed from the version of Bundler that ships with Ruby 4.0. Use <tt>bundle config set</tt> as shown above.</small>
</div>

===Fedora===
<div class="mw-customtoggle-fedora" style="font-size:16px;overflow:auto;color:#0000FF">[Click to Expand]</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-fedora">
The following steps should install Lich for users of Fedora. To also install a front end such as Saga, Profanity or Warlock, see [[#Frontends|Frontends]] at the end of the Linux section.

Lich 5 requires Ruby 4.0 or newer. The Ruby that ships with currently supported versions of Fedora is older than that (41 uses Ruby 3.3; 42 and 43 use Ruby 3.4), so these steps install Ruby 4.0.9 with '''<tt>[https://github.com/rbenv/rbenv rbenv]</tt>''' instead of using Fedora's Ruby.

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 cairo-devel curl gcc gdbm gdbm-devel gdk-pixbuf2-devel glib2-devel \
gobject-introspection-devel gtk3-devel libyaml-devel libffi-devel make ncurses-devel openssl-devel readline-devel \
redhat-rpm-config sqlite-devel unzip zlib-devel
</pre>

{{side box|NOTE: If you are updating an existing rbenv Ruby installation rather than installing from scratch, skip step 3. Instead, update your ruby-build with the following command, and then run only the <tt>rbenv install</tt> and <tt>rbenv global</tt> lines from step 3.<pre>git -C ~/.rbenv/plugins/ruby-build pull</pre>}}

3. Install rbenv and Ruby 4.0.9:
<pre>
git clone https://github.com/rbenv/rbenv.git ~/.rbenv
echo 'export PATH="$HOME/.rbenv/bin:$PATH"' >> ~/.bashrc
echo 'eval "$(rbenv init -)"' >> ~/.bashrc
source ~/.bashrc
git clone https://github.com/rbenv/ruby-build.git ~/.rbenv/plugins/ruby-build
rbenv install 4.0.9 -v
rbenv global 4.0.9
ruby -v
</pre>
The last command should print a line starting with <tt>ruby 4.0.9</tt>. If it doesn't, close and reopen the terminal and try <tt>ruby -v</tt> again.

4. Install Lich:
<pre>
cd ~
curl -L "https://github.com/elanthia-online/lich-5/releases/latest/download/lich-5.zip" -o temp.zip && unzip temp.zip -d ./ && rm temp.zip
</pre>

5. 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 using the <tt>Gemfile</tt> included with Lich5 by running <tt>bundle install</tt>. The Gemfile also lists developer-only gems (the <tt>development</tt> and <tt>vscode</tt> groups) that you do not need, so tell Bundler to skip them first:
<pre>
echo "gem: --no-document" > ~/.gemrc
cd ~/Lich5
bundle config set --local without 'development vscode'
bundle install
</pre>
:<small>Note: <tt>bundle install --without ...</tt> no longer works; that flag was removed from the version of Bundler that ships with Ruby 4.0. Use <tt>bundle config set</tt> as shown above.</small>
</div>

===Frontends===
<div class="mw-customtoggle-frontends" style="font-size:16px;overflow:auto;color:#0000FF">[Click to Expand]</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-frontends">
Finish the Lich installation for your distribution above first, then set up one of these front ends.

====Saga====
[[Saga]] is the official Simutronics front end for GemStone IV and DragonRealms (currently in beta), and it works with Lich. On Linux it comes as a single AppImage file.

'''Install Saga'''

Go to the [https://www.play.net/gs4/play/saga-info.asp Saga info page] and click '''Download for Linux''' (AppImage, x86_64). On a Chromebook, move the downloaded file into the '''Linux files''' folder with the Files app so Linux can see it.

Then put it where Lich looks for Saga, make it runnable, and start it:
<pre>
sudo mkdir -p /opt/Saga
sudo mv ~/Downloads/Saga-*.AppImage /opt/Saga/saga
sudo chmod +x /opt/Saga/saga
/opt/Saga/saga
</pre>
:<small>On a Chromebook use <tt>~/Saga-*.AppImage</tt> in place of <tt>~/Downloads/Saga-*.AppImage</tt>.</small>

Log in to the game from inside Saga once, without Lich, to make sure Saga itself works.

If Saga will not start and mentions FUSE or <tt>libfuse.so.2</tt>, install FUSE 2 and try again: <tt>sudo apt-get install libfuse2</tt> on Debian/Chromebook (on Debian 13 and newer, <tt>libfuse2t64</tt>), <tt>sudo pacman -S fuse2</tt> on Arch, or <tt>sudo dnf install fuse-libs</tt> on Fedora.

'''Use Saga with Lich'''

Saga starts Lich for you:
# Log in with Saga normally, then choose '''File → Enable Login with Lich'''.
# Choose '''File → Return to login'''.
# Click '''Connect''', then '''Via Lich''', and point it to your Lich folder (<tt>~/Lich5</tt>).
# If Saga asks where Ruby is, or Lich will not start, run <tt>rbenv which ruby</tt> and give Saga the path it prints (it ends in <tt>.rbenv/versions/4.0.9/bin/ruby</tt>).
# Log in. The game will start in Saga with Lich running.

Once that works, you can also start from the Lich login window (<tt>ruby ~/Lich5/lich.rbw</tt>): 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.

====Profanity====
Profanity is a terminal-based Front-End that will let you play the game (in lieu of The Wizard or Wrayth). Its gems (such as <tt>curses</tt>) are installed by the <tt>bundle install</tt> step above. Download Profanity:
<pre>
cd ~
git clone https://github.com/elanthia-online/ProfanityFE.git
</pre>

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

====Warlock====
Download Warlock from https://sproctor.github.io/warlock3/download.html, then run Lich the normal way with Ruby:
<pre{{log2|margin-right=35%}}>
ruby ~/Lich5/lich.rbw
</pre>
Use your login information with these settings to use the Lich launcher: https://github.com/sproctor/warlock3/wiki/Lich-support
</div>

=Popular Scripts=
{{#section:Lich:Script Repository|popularscripts}}

=Ecosystem Information=

* DragonRealms Variant - [https://elanthipedia.play.net/Lich_script_repository#Setup_and_Installation Setup and Install instructions]

=Lich Changelog=
<div class="mw-customtoggle-changelog" style="font-size:16px;overflow:auto;color:#0000FF">[Click to Expand]</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-changelog">
'''5.22.0'''
<PRE>
### Features (general)
* add opt-in bounded script execution guards (#1575)
* add static-only map route selection (#1577)
* bounded fput with max_resends, interrupt, resend_transient and failure symbols (#1587)
* Spell.results_regex, the lines cast waits on, exposed (#1590)
* add Events, a script-to-script notification primitive; combat emits on it (#1619)
* add deterministic hook priorities (#1621)
* Map.boundary_rooms_for(ids), the perimeter of any set of rooms (#1660)
* sticky ever_hostile? keeps Sympathy'd creatures in targets (#1665)
* --pipe -g honours the frontend flag, and --sentinel requests the origin marker (#1677)

### Features (gs)
* add trustworthy combat observation provenance (#1576)
* Lich::Gemstone::Stance, a shared stance setter (#1578)
* Lich::Stash.wield and Stash.hands put named items into hands (#1579)
* Lich::Gemstone::Mana.pulse, the MANA PULSE verb once (#1580)
* Lich::Gemstone::Bank, Currency refresh, and WEALTH parser lines (#1581)
* PSM command and results_regex readers, factored out of use (#1583)
* Lich::Gemstone::Fog, the ways home on the spell and society readers (#1584)
* Combat::Messages - non-combat message families as observer events (#1586)
* society command readers, factored out of use (#1589)
* Group.join, the follower's side of Group.add (#1591)
* emit post-commit combat recorder receipts (#1592)
* combat definition supplements from a player YAML file (#1607)
* message definitions from the player supplement file (#1608)
* creature library - abilities from session logs, limbs flags, triggers as hash of arrays (#1623)
* expose exact server creature health from crtrStatus (#1661)

### Bug Fixes (general)
* fix spec stub race breaking FFI loads, gate WindowsCredentialManager to Windows (fixes #1542) (#1573)
* setup_files uses content hash for cache freshness (#1596) (#1599)
* creatures registry housekeeping independent of Combat::Tracker (#1603)
* place effect-list.xml backups in the update snapshot folder (#1606)
* retain discovery ownership through cleanup (#1612)
* Initial Lich state update and detachable-client split GS/DR (#1617)
* bound move()'s remedy retries, record why a move failed, lift it into Lich::Common::Move (#1622)
* update puts to Lich.log (#1630)
* create detachable-client session file without --login (#1656)
* converge server_time_offset instead of resetting it every prompt (#1663)
* plain-language lich5-update messages when GitHub fails (#1687)
* Inventory.refresh waits out roundtime before sending (#1688)

### Bug Fixes (dr)
* update HOW pattern to accommodate various soul states (#1620)
* restore script halt in DRCC.get_crafting_item on missing item (#1624)
* halt script when too distracted to turn recipe book (#1625)
* equipmentmanager energy bow handling (#1662)
* report when DRC.rummage can't read a container (#1671)
* DRCI.get_item? confirms #<id> gets by the item id in hand (#1674)
* DRCT.sell_item references the item through DRCI.item_ref (#1675)
* DRCA.do_buffs filters day/night spells without mutating settings (#1680)
* DRCI.tie_item? no longer reports an empty pouch as tied (#1684)
* DRC.play_song? keeps climbing and performance songs across instrument switches (#1686)

### Bug Fixes (gs)
* Injured cache lives on the class and keys on an injury fingerprint (#1582)
* infomon - a spell's start message refreshes a refreshable timer (#1585)
* Group.broken? waits on Lich::Claim::Lock, the constant that exists (#1588)
* combat module - hunt-log audit: interrupted-swing resume, status attribution by event, spell-loss cause, live defs (#1593)
* QStrike prices MSTRIKE's own stamina cost (#1594)
* combat module - a stand-up message later in the chunk outranks an earlier knockdown crit (#1595)
* track spell cooldowns on the characters a spell locks out (#1597)
* catalog missing deity-specific strike lines for Divine Wrath (335) (#1598)
* combat module - Rysk/Dreadt log audit: Holy Weapon release model, held maneuver rolls, AoE roll attribution, live defs (#1600)
* Combat defs add thrust as a basic attack (#1615)
* preserve group state after ambiguous disband reply (#1629)
* target ridden mounts before their first crtrStatus (#1669)
* snapshot Effects registries so scripts can't break the XML parser (#1672)
</PRE>
'''5.21.0'''
<PRE>
### Features (general)
* Add --refresh-characters and --add-character CLI flags (#1504)
* add --active-session-dir to decouple Active Sessions coordination from --temp (#1520)
* add read model for the inventoryManager extended feed (#1524)
* GUI add configurable frontend registry (#1558)
* add HTTPS web-login fallback for when EAccess (7910) is unreachable (#1570)

### Features (dr)
* player-supplied custom prep/cast/invoke messages (#1528)
* opt-in cambrinth charge distribution across configured items (#1549)
* populate GameObj from INV LIST full refresh (02 of 05) (#1554)
* non-destructive upsert for INV SEARCH / category scrapes (03 of 05) (#1556)
* reconcile GameObj containers on hand pickup (04 of 05) (#1557)
* [DRCC] add shared private-forge helpers (#1560)

### Features (gs)
* creature template library - measured combat data, HP/speed censuses, messaging (#1539)

### Bug Fixes (general)
* enforce Script#pause at every blocking/mutating checkpoint (#1537)
* always report missing gems on stderr; only wait on a dialog without a tty (#1544)
* dispatch --help and --version before the GTK require (#1546)
* global_def update deprecated method calls to include caller info (#1550)
* normalize colons in Lich::Util.normalize_lookup (#1561)
* Script.log respects --log-dir/LOG_DIR override; use File.join for paths in script.rb (#1572)

### Bug Fixes (dr)
* drvariables add more data to VOL_MAP (#1536)
* pin capped skills to 34 in DRSkill.clear_mind (#1548)
* match lowercase "it's already open" when opening a container (#1553)
* normalize capitalized leading articles in inventory scrape names (01 of 05) (#1555)
* make INV LIST refresh atomic and warn on interruption (05 of 05) (#1563)
* refresh before_name/after_name on a name-preserving container move (#1564)
* do not re-add a held item as worn inventory on inv scrape (#1565)
* evict orphaned identity-index entries on a name-changing upsert (#1566)
* unpause the exact scripts safe_pause_list paused, by object (#1574)

### Bug Fixes (gs)
* Infomon xmlparser additional npc death messaging (#1540)
* correct messaging drift in 13 crit table patterns (#1547)
* combat module - event defs, observer emissions, replay-verified parsing, SQLite recorder (#1559)
</PRE>
'''5.20.1'''
<PRE>
### Bug Fixes (general)
* bound EAccess auth with a timeout so a stalled SGE backend can't hang Lich silently (#1502)
* Linux WINE and Wrayth FE detection (#1517)
* update Gemstone game-code validations (#1518)
* preserve bundled display-state tags on quiet-suppressed chunks (#1530)
* prevent a stray formatting character from appearing in Saga during quiet script output (#1532)

### Bug Fixes (dr)
* make $safe_pause_lock holder immune to pause (#1525)

### Bug Fixes (gs)
* critranks.rb tolerate nil table rows, fix reload!, index patterns … (#1522)
* combat module hardening - ordered processing, 22x faster parsing, double-count fix (#1523)
</PRE>
'''5.20.0'''
<PRE>
### Features (general)
* add concurrent runtime I/O and multi-client detach support (#1459)
* --bind-address speaks the same keywords as --detachable-client (#1461)
* GUI Launcher Improvements (#1463)
* Add supervised child script APIs (01 of 06) (#1474)
* Add forced script teardown command (06 of 06) (#1479)
* teardown and distinguishable errors for Script.run_child (#1501)

### Features (dr)
* DRCMM.moon_weapon_duration - read a moon weapon's remaining life (#1483)
* id-based creature tracking from crtrStatus + assess (#1485)
* capture room UID from <nav> tag; stop enforcing ShowRoomID; opt-in room-id placement (#1491)
* user-extensible scroll substitutions via settings (01 of 06) (#1512)
* user-extensible boxes and trash receptacles (03 of 06) (#1514)
* user-extensible summoned-weapon adjectives (04 of 06) (#1515)
* user-extensible flavor-text stripping (05 of 06) (#1516)

### Features (gs)
* gameobj add full_name matcher to type/sellable classification (#1453)

### Bug Fixes (general)
* prevent empty/partial GameObj registry reads during mid-stream refresh (#1370)
* no-op Gtk.lich_main_quit when no main loop is nested (#1464)
* correct path-flag aliases and document all path options (#1472)
* Synchronize script lifecycle transitions (02 of 06) (#1475)
* Coordinate script shutdown draining (03 of 06) (#1476)
* Harden script lifecycle ownership (05 of 06) (#1478)
* surface the underlying LoadError in dependency alerts (#1480)
* extract game-agnostic CreatureBase into lib/common (#1484)
* bound GemCheck alert dialogs with a timeout so they can't hang forever (#1488)
* identify Genie as the frontend for headless launches (#1490)
* restore detachable client disconnect notice to stdout (#1492)
* harden detachable client teardown and escape init payload (#1493)
* resolve GameObj status visibility during staged refresh (#1497)
* compact client write queue instead of ending the session (#1498)
* scrub startup credentials once login completes (#1499)
* Honor Simu-side teardown for 10 seconds (#1505)

### Bug Fixes (dr)
* resolve no-UID rooms carrying a stored UID instead of returning nil (#1467)
* equipmanager.rb - reliable ranged-weapon transitions - stow ammo after unload + verify offhand wield hand (#1468)
* common-healing.rb - DRCH.bind_wound: only dispose a dislodged item while it is in hand (#1469)
* preserve game RealID in room title (GS parity for ";display roomid title") (#1500)
* Refine need_buffs? logic for non-recast spells to correctly check cyclic spells. (#1503)
* reduce symbol-torn scale scrolls to gettable noun (#1506)
</PRE>
'''5.19.1'''
<PRE>
### Bug Fixes (general)
* lower game socket keepalive idle from 120s to 30s (#1449)
* resilient ActiveSessions ownership + shutdown watchdog (#1452)
* Quit Gtk.main cleanly (#1455)
* Refactor regex to string comparisons for ARGV options (#1456)

### Bug Fixes (gs)
* ingest newly-exposed mindState experience and roommeta room fields (#1450)
</PRE>
'''5.19.0'''
<PRE>
### Features (general)
* Add character generator support via EAccess protocol (#1384)
* Add modern script command shutdown method (#1385)
* migrate the server-stream parser from REXML to Ox, with pipe-mode benchmark harness and DR parser coverage (#1396)
* enumerate script subdirs with file glob (#1397)
* add --bind-address option to set listen socket address (#1405)
* add central method to determine lich ver (#1417)
* setup_files: support scripts/data/custom for user data overrides (#1431)
* Modify running? method to support optional exact matching of script names (#1436)
* keyword bind hosts for the detachable client (tailscale/lan/any) (#1437)
* add roomlinks/roommono toggles for room display (#1438)
* self-healing gem requires (#1439)
* various Saga FE compatibility tweaks (#1443)
* add macOS limited gem recovery (#1448)

### Features (dr)
* Capture combat position from the balance status line (#1400)
* detect scheduled shutdown and expose it on DRParser (#1409)
* xmlparser: add structured parser for the assess (combat situation) stream (#1413)
* Implement DRCA.need_buffs? method for buff checks (#1428)

### Features (gs)
* anchor Infomon parser regex unions to line start (#1391)
* creature xml additions (#1425)
* add creature template library (#1427)

### Bug Fixes (general)
* surface a failed Game.open in the connect timeout (#1408)
* bound long-session memory growth (index/hook/watchfor/buffer leaks) (#1410)
* improve and harden shutdown (#1416)
* use bundler to check for required Ruby gems (#1420)
* pin lich directory for gemfile check (#1423)
* Show CLI login ARGV for SAL connections (#1424)
* increase read timeout on idle socket to 300 seconds (#1426)
* monkeypatch gi for memoryreleaser / asyncprocessor until patched upstream (#1429)
* Mapdb sort tags by downcase and original case (#1433)
* stop locking the load path at boot; keep Gemfile.lock in sync on self-update (#1434)
* minimum Ruby 4.0 required & migrate Ruby version check (#1444)
* align --announce with --update for Ruby version (#1447)

### Bug Fixes (dr)
* BalanceValue regex to match combat status lines (#1398)
* equipmanager.rb - Fix unload weapon detection when AimTimerDialog tag is prepended (#1414)

### Bug Fixes (gs)
* global_defs update pushStream regex to include 'reserve' id (#1379)
* psms Warcry.available? correction (#1387)
* xmlparser support new field exp, climate, terrain XML feeds (#1388)
* global_defs move() update regex for standing condition (#1407)
* Currency add method to retrieve aevit event currency (#1411)
* Stash check result type before comparing regex for wear_to_inv (#1430)
</PRE>
'''5.18.0'''
<PRE>
### Features (dr)
* common-crafting add method for creating mechanisms (#1375)

### Bug Fixes (general)
* stringproc normalize CRLF | CR to LF (#1378)
* rubocop custom cop ascii only cleanup (#1382)

### Bug Fixes (dr)
* equipmanager update to assume missing items aren't worn (#1376)

### Bug Fixes (gs)
* Infomon xmlparser additional npc death messaging (#1326)
</PRE>
'''5.17.3'''
<PRE>
### Bug Fixes (general)
* Script module replace MemoryReleaser with GC.start for cleanup (#1364)
* Add sqlite busy timeout policy to core (#1365)
* Script#kill remove GC.start and add optional instrumentation (#1368)
* reorder shutdown ala MahtraDR and detect script teardown de... (#1369)
</PRE>
'''5.17.2'''
<PRE>
### Bug Fixes (general)
* harden custom repo identity, collision, and contract boundaries (#1333)
* stop SessionLifecycle before closing database on normal exit (#1334)
* harden FeatureFlags for closed db handle (#1335)
* SynchronizedSocket write resilience and zombie client elimination (#1338)
* correct RP timing issue for release notes (#1348)
* gate object cleanup in GTK queue (#1354)
* recover from cross-process zombie in ActiveSessions service (#1355)
* Improve shutdown session state handling (#1359)
* non-ascii hygeine to address rubocop errors (#1360)
* Remove debug log IO from heartbeat tick loop (#1363)

### Bug Fixes (dr)
* DRC text2num correction for thousand (#1343)

### Bug Fixes (gs)
* Overwatch add REVEALED_EXPLODES regex pattern (#1356)
* Stash add_to_bag result type check before regex compare (#1357)
</PRE>
'''5.17.1'''
<PRE>
### Bug Fixes (general)
* enable heartbeat-driven failover for ActiveSessions service owner (#1340)
* copy Gemfile and LICENSE during self-update (#1345)
* Add top-level parse_args/display_args bridge to global_defs (#1346)

### Bug Fixes (dr)
* replace undefined custom_require in check_moonwatch (#1336)
* set_stance places 100 in the correct positional slot (#1337)
* cache SlackBot users list to prevent API throttling (#1342)
* Add CORE_AUTOSTART sentinel to skip dependency.lic autostart helpers (#1344)

### Bug Fixes (gs)
* Infomon Status.cutthroat? Effect Debuff correction (#1331)
* add support for RESERVE xml in GameObj.reserve (#1341)
</PRE>
'''5.17.0'''
<PRE>
### Features (general)
* custom 3rd-party repo support for ScriptSync (#1285)
* Add get_settings, get_data, start_scripts_if_available to core (#1305)
* Add Map.apply_wayto_overrides for personal map overrides (#1306)

### Features (dr)
* Decouple SetupFiles from script-scoped echo and XML feed timing (#1304)
* Add game flags and obsolete script warnings to DRInfomon startup (#1307)

### Bug Fixes (general)
* use :__unset for --without-frontend CLI request YAML matches (#1301)
* prevent zombie server deadlock in Active Sessions accept loop (#1302)
* improve MacOS keychain system check for older OS variants (#1310)
* stub sync_all_repos to prevent leaked thread in games_spec (#1311)
* enforce beta confirmation 10s timeout (#1315)
* use send(:respond) in StatusReporter fallback path (#1316)
* ensure SessionLifecycle.stop runs on abnormal exit (#1317)
* address ActiveSessions lifecycle hot path feature-flag polling (#1325)
* catch ECONNRESET in _puts and bound walk_to retry depth (#1327)
* safeguard gtk logo.png loading (#1329)

### Bug Fixes (gs)
* Add InnCheckedOut pattern to parser (#1309)
* Claim corrections to handle mounts in room_players stream (#1324)
</PRE>
'''5.16.2'''
<PRE>
### Features (general)
* session summary store and reporting (#1247)
* add core classes, ScriptSync, and login auto-sync (#1273)
* Add active sessions API (#1274)
* Add session status CLI query (#1276)
* configurable debug log retention (#1282)

### Features (dr)
* common-healing.rb - add vitality parsing to HealthResult (#1265)

### Bug Fixes (general)
* handle auth exceptions in manual login to prevent hang on bad password (#1267)
* set SO_REUSEADDR before bind to allow immediate port reuse (#1268)
* Persistent Launcher re-enable play button post launch (#1269)
* Restore manual login behaviors to not require saved entry t... (#1270)
* log and re-raise unexpected errors in saved login auth handler (#1271)
* narrow safe_write rollback scope so cleanup failure preserves successful write (#1287)
* fix three revert bugs in SnapshotManager (#1289)
* guard nil release asset and validate before deleting lib/ (#1290)
* guard nil stable version in beta channel resolution (#1291)
* remove dead code in BranchInstaller (#1292)
* repair regression on gui button reenable from refactor (#1297)

### Bug Fixes (dr)
* common-items.rb - move pattern from failure to success block (#1262)
* buffer_room_objs missed split components with leading stream tags (#1284)
* common-items.rb - get_item_unsafe false positives via XML feed verification (#1286)
* forward vitality and dead fields in perceive_health (#1288)

### Bug Fixes (gs)
* Infomon xmlparser additional npc death messaging (#1275)
* Infomon xmlparser additional npc death messaging (#1281)
</PRE>
'''5.16.1'''
<PRE>
### Features (general)
* session summary store and reporting (#1247)
* add core classes, ScriptSync, and login auto-sync (#1273)
* Add active sessions API (#1274)
* Add session status CLI query (#1276)
* configurable debug log retention (#1282)

### Features (dr)
* common-healing.rb - add vitality parsing to HealthResult (#1265)

### Bug Fixes (general)
* handle auth exceptions in manual login to prevent hang on bad password (#1267)
* set SO_REUSEADDR before bind to allow immediate port reuse (#1268)
* Persistent Launcher re-enable play button post launch (#1269)
* Restore manual login behaviors to not require saved entry t... (#1270)
* log and re-raise unexpected errors in saved login auth handler (#1271)
* narrow safe_write rollback scope so cleanup failure preserves successful write (#1287)
* fix three revert bugs in SnapshotManager (#1289)
* guard nil release asset and validate before deleting lib/ (#1290)
* guard nil stable version in beta channel resolution (#1291)
* remove dead code in BranchInstaller (#1292)

### Bug Fixes (dr)
* common-items.rb - move pattern from failure to success block (#1262)
* buffer_room_objs missed split components with leading stream tags (#1284)
* common-items.rb - get_item_unsafe false positives via XML feed verification (#1286)
* forward vitality and dead fields in perceive_health (#1288)

### Bug Fixes (gs)
* Infomon xmlparser additional npc death messaging (#1275)
* Infomon xmlparser additional npc death messaging (#1281)
</PRE>
'''5.16.0'''
<PRE>
### Features (general)
* session summary store and reporting (#1247)
* add core classes, ScriptSync, and login auto-sync (#1273)
* Add active sessions API (#1274)
* Add session status CLI query (#1276)
* configurable debug log retention (#1282)

### Features (dr)
* common-healing.rb - add vitality parsing to HealthResult (#1265)

### Bug Fixes (general)
* handle auth exceptions in manual login to prevent hang on bad password (#1267)
* set SO_REUSEADDR before bind to allow immediate port reuse (#1268)
* Persistent Launcher re-enable play button post launch (#1269)
* Restore manual login behaviors to not require saved entry t... (#1270)
* log and re-raise unexpected errors in saved login auth handler (#1271)

### Bug Fixes (dr)
* common-items.rb - move pattern from failure to success block (#1262)
* buffer_room_objs missed split components with leading stream tags (#1284)
* common-items.rb - get_item_unsafe false positives via XML feed verification (#1286)

### Bug Fixes (gs)
* Infomon xmlparser additional npc death messaging (#1275)
* Infomon xmlparser additional npc death messaging (#1281)
</PRE>
'''5.15.1'''
<PRE>
### Bug Fixes (general)
* Mutli-launch persistent login GUI (#1245)
* Remove Windows OS CMD prompt flash (#1255)
* guard against broken pipe errors in Game._puts and send_to_client (#1260)
* add timeout safety to fput to prevent infinite hangs (#1261)

### Bug Fixes (dr)
* anchor stow success pattern to prevent fan close recovery bypass (#1254)
* add bounded recursion depth limits to 9 methods (#1257)
* stow_helper failure detection + unload_weapon ammo recovery (#1259)
</PRE>
'''5.15.0'''
<PRE>
### Features (general)
* add InstanceSettings for core Settings API access (#1233)

### Features (gs)
* Overwatch module into core (#1201)

### Bug Fixes (general)
* fix GameObj container initialization and add clear_all_containers (#1226)
* GameObj object dedupe & GC (#1234)
* script.rb show Script.kill source (#1235)
* Exit quickly on CLI authentication failure (#1237)
* suppress wine detection noise and skip when unneeded (#1244)

### Bug Fixes (dr)
* DR modules fixes and enhancements (#1232)

### Bug Fixes (gs)
* psms.rb add additional failure matches (#1238)
* Bounty parser fix regex pattern for skin retrieval task (#1242)
</PRE>
'''5.14.2'''
<PRE>
### Bug Fixes (general)
* add retry with exponential backoff for all login authentication (#1205)
* update.rb allow for bugfix betas and branch updates (#1211)

### Bug Fixes (gs)
* infomon.rb bug in _key transformation (#1216)
</PRE>
'''5.14.1'''
<PRE>
### Bug Fixes (general)
* Change server_time_offset in XMLParser to be float instead of int (#1184)
* change encodings in main.rb to wizard FE only (#1199)

### Bug Fixes (gs)
* Infomon parser.rb update Account.subscription/type (#1192)
* spell.rb add last_cast to track last time casted (#1193)
* stash.rb additional improvements with ReadyList/StowList (#1197)
* Infomon parser.rb bug in EnhanciveEnd (#1198)
</PRE>
'''5.14.0'''
<PRE>
### Features (general)
* Add Genie map cross-reference fields to the DragonRealms map data model (#1169)

### Features (dr)
* DRExpMonitor move into core lich (#1154)

### Features (gs)
* add Enhancive module for enhancive item bonus tracking (#1113)
* add QStrike module for optimal stamina-based RT reduction (#1114)

### Bug Fixes (general)
* remove strip! from settingsInfo replacement (#1161)
* map_base.rb sort JSON better (#1171)

### Bug Fixes (dr)
* logbook_item recovery when crafted item not in hand (#1175)

### Bug Fixes (gs)
* xmlparser.rb capture additional death messaging (#1158)
* stash.rb ReadyList sheath handling and update inventory checks (#1166)
</PRE>
'''5.13.6'''
<PRE>
### Bug Fixes (general)
* allow --add-account to run without yaml and dat (#1143)
* enable --login for multi-variable custom launch commands (#1144)
* update.rb pervent update if MIN_RUBY not met (#1146)
* messaging.rb return "" for xml_encode with Wizard (#1147)
* prevent closing connection on module reload (#1148)
* Allow hmr to work on global_defs.rb (#1156)

### Bug Fixes (dr)
* buffer split room obj lines and merge instead of appending closing tag to broken line (#1149)
* add buffering for multiline room players (#1151)
* add verify_script def here instead of depending on dependency (#1155)

### Bug Fixes (gs)
* infomon.rb added updated_at field to upsert_batch (#1145)
* stowlist.rb check method fix when dead (#1152)
* readylist.rb check method fix when dead (#1153)
</PRE>
'''5.13.5'''
<PRE>
### Bug Fixes (general)
* util.rb only show gem installing debug messaging if gem mis… (#1131)
* add --gs and --dr, refactor argv_options to helpers (#1133)
* fix multiple custom entries, improvements to yaml save (#1134)
* login_tab_utils.rb expand helper text show Warlock (#1135)
* update CLI for YAML security signature, add auto-convert fo… (#1136)
* remove password parameter from debug logging in all cases (#1137)
* reduce minimum GUI window footprint for non-tabbed view (#1138)
* remove double save in YAML to preserve yaml.bak integrity (#1139)

### Bug Fixes (gs)
* stash.rb additional improvements (#1132)
</PRE>
'''5.13.4'''
<PRE>
### Bug Fixes (general)
* force system gem install if RubyGems fails (#1126)
* gui_login prevent destroying window if already destroyed (#1127)
* add window size / position saves to login GUI (#1128)
* non tabbed saved entries in reduced button / font size (not… (#1129)
</PRE>
'''5.13.3'''
<PRE>
### Bug Fixes (general)
* account manager sorting GUI fix (#1123)
</PRE>
'''5.13.2'''
<PRE>
### Bug Fixes (general)
* install_gem_requirements update available gems after install (#1120)
</PRE>
'''5.13.1'''
<PRE>
### Bug Fixes (general)
* password_cipher.rb upcase account_name for key (#1118)

### Bug Fixes (dr)
* validator.rb change sleep to should_sleep named param (#1116)

### Bug Fixes (gs)
* add base stats capture from 'info full' command (#1115)
</PRE>
'''5.13.0'''
<PRE>
### Features (general)
* Refocus Frontend (#960)
* socket configurator to better guard TCPSocket (#976)
* add simplified DB maintenance (#991)
* TextStripper module support for XML, HTML, Markdown (#1055)
* Login modernization and refactor to yaml (#1063)
* Ruby Memory Releaser module (#1066)

### Features (dr)
* support meta:trashcan tag for DRCI.dispose_trash (#966)
* Add GameObj.inv support for DR items (#1080)
* DRCS allow custom adjective for summoned weapons (#1088)
* DRParser support for new exp window xml stream elements (rested exp, tdps, favors) (#1104)

### Features (gs)
* Add Armaments (Weapon, Armor, and Shield) Module (#911)
* add creature module, including Hinterwilds creatures (#1002)
* Creature module combat tracking (#1003)
* track time of last total_experience record (#1030)
* add Injured class for checking ability to perform actions (#1035)

### Bug Fixes (general)
* map dijkstra optimization (#1061)
* update.rb keep script/data file incase of error on update (#1070)
* ensure proxy path is set for non-destructive array write-th… (#1073)
* [lib][global-defs] - move update (#1079)
* GameObj force new objects ID to be string (#1087)
* xmlparser.rb gate GSL exits sending behind @send_fake_tags (#1103)
* change Hash[] pair key conversion to use to_h for Ruby 4.0 (#1108)
* move gui-login.rb to Ruby standard gui_login.rb (#1111)
* update location for currency and move game-loader.rb to Ruby standard gameloader.rb (#1112)

### Bug Fixes (dr)
* DRCA allow custom spell prep messaging (#1089)
* Update Slackbot error handling, and lnet management (#1091)
* Fix exp mods parsing for DR (#1102)
* equipmanager.rb support for custom messaging in forester's longbow (#1105)
* Fix hang in equipment manager when game doesn't respond to commands (#1110)

### Bug Fixes (gs)
* Infomon additional CHE resign regex (#1067)
* Resource tracking for sorcerer shadow essence (#1085)
* cman.rb add hamstring regex for already lying down target (#1090)
* cman.rb hamstring regex update when can't perform on target (#1092)
* Bounty parser.rb FWI guard regex update (#1096)
* currency.rb track gold (#1109)
</PRE>
'''5.12.12'''
<PRE>
Bug Fixes (general)
Update module strip markdown comments (#1056)
Vars/UserVars module fixes and corrections (#1057)
Bug Fixes (gs)
Infomon parse fix for singular currency (#1051)
</PRE>
'''5.12.11'''
<PRE>
Bug Fixes (dr)
add bput match for system updates preventing actions (#1034)
drdefs.rb npc parsing (#1038)
Fix container reference in get_item_from_eddy_portal method (#1039)
Bug Fixes (gs)
bounty location regex needs to match "under" (#1037)
</PRE>
'''5.12.10'''
<PRE>
Bug Fixes
all: games.rb catch additional error for nested single/double quotes (#1031)
dr: change keys for DR_SKILLS_DATA[:guild_skill_aliases] to be strings instead of symbols (#1032)
gs: Bounty parser for SG npcs matching (#1027)
gs: match READY/STOW items with a/an/some inside the link (#1026)
</PRE>
'''5.12.9'''
<PRE>
Bug Fixes
gs: StowList/ReadyList reset bug if non-default keys added #1019
</PRE>
'''5.12.8'''
<PRE>
Bug Fixes
all: script.rb show custom at script exit as well (#993)
all: Updated update.rb for single trunk and release please (#1001)
</PRE>
'''5.12.7'''
<PRE>
fix(all): ensure updates do not target detached proxy views #990
fix(gs): bounty parser and move fixes for sailor's grief #987
fix(gs): Infomon xmlparser.rb Ready/Stow fix for LONG before exist #988
fix(gs): gameobj.rb for Sailor's Grief ghostly/boss/guild tentacles #989
</PRE>
'''5.12.6'''
<PRE>
fix(all): settings.rb update to preserve root of derived views #975
fix(all): show custom in various script output when custom script #967
fix(dr): drparser.rb update for PlayedSubscription #983
fix(gs): include store location for ReadyList #977
fix(gs): infomon parser.rb update for ACCOUNT output varies #979
fix(gs): global_defs.rb move def update for Hive traps #980
fix(gs): activespell.rb prevent removal of RF Penalty #981
fix(gs): add .compact to input of Disk.find_by_name #982
</PRE>
'''5.12.5'''
<PRE>
fix(all): update.rb word boundary for abbreviations #971
fix(dr): equipmanager.rb Fix for changed game output. #969
fix(dr): common-arcana.rb Regalia fix for changed game output. #970
fix(dr): common-items.rb Fix for changed inventory command output #973
fix(gs): StowList missing space in capture in xmlparser.rb #963
fix(gs): stowlist.rb wait for RT when issuing check #964
fix(gs): readylist.rb wait for RT when issuing check #965
fix(gs): Bounty heirloom return msg'ing update #972
</PRE>
'''5.12.4'''
<PRE>
build(all): installer.yml use windows-2022 #950
fix(all): restore Wrayth / Wizard script execution ability #952
fix(all): database_adapter.rb error handling improvement #956
fix(dr): common-items.rb wear/remove messaging additions #949
fix(dr): games.rb - ignore UIDs for Frostbite mapping #951
fix(dr): map_dr.rb prevent inadvertent settings changes #958
fix(gs): GameObj targets for new Sailor's Grief tentacle npc #948
fix(gs): map_gs.rb remove delete_if to prevent bad settings #957
fix(gs): weapon.rb assault break if no targets #962
</PRE>
'''5.12.3'''
<PRE>
fix(all): limitedarray.rb max_size increase #946
fix(all): uservars.rb update for vars method missing #940
fix(dr): drparser.rb to set ShowRoomID to on if turned off #945
fix(gs): change namespace accessors to Ruby 2.6 compatible #944
fix(gs): infomon state reset on status prompt #943
fix(gs): Societies to check membership for various methods #942
fix(gs): standardize warcry.rb to match other PSMS #941
</PRE>
'''5.12.2'''
<PRE>
fix(gs): infomon parser.rb for profile full name matching #938
fix(gs): force PROFILE FULL to sync CHE info for infomon #937
fix(dr): Tighten checks on releasing invisibility for thieves #936
</PRE>
'''5.12.1'''
<PRE>
- fix(all): gameobj.rb - add type? method for explicit type check #928
- fix(all): messaging.rb encoding issue #933
- fix(gs): Various CMan cost corrections #932
</PRE>
'''5.12.0'''
<PRE>
- feat(all): settings.rb - proposal for sequel based Settings #591, #875, #889, #896, #927
- feat(all): util.rb add Ruby gem install helper method #861
- feat(all): messaging.rb add cmd link method #866
- refactor(all): games.rb modernization #849, #882, #924
- fix(all): add class extensions #800
- fix(all): lich.rb deprecated FE message #852
- fix(all): messaging.rb fix XML encoding for wizard and avalon #853
- fix(all): lich.rb class variable not initialized #855
- fix(all): log.rb force msg to String for regexp comparison #856
- fix(all): global_defs.rb bug in fput #864
- fix(all): messaging.rb xml_encode mono method msg #868
- fix(all): script.rb class to is_a? checks #878
- fix(all): gameobj.rb deeper lookup #885
- fix(all): messaging.rb debug not compared to falseclass #887
- fix(all): change class to is_a? checks #91-3
- fix(all): Util.issue_command allow single line captures #918
- fix(dr): drparser.rb casing for Premium status check #842
- fix(dr): map_dr.rb Don't assign UID of zero to rooms #844
- fix(dr): drparser.rb add $last_logoff tracking #851
- fix(dr): update message patterns in common-items #859
- fix(dr): add moon_visible?(moon) convenience method to common-moonmage #860
- fix(dr): exp mods output is not enclosed in preset xml tags anymore #870
- fix(dr): update.rb beta send validation for genie lich char #880
- fix(dr): Update regex and parsing for active spells #894
- fix(dr): add 'You scoop' match pattern to common-items #900
- fix(dr): add missing match patterns #901
- fix(dr): common-items: add and fix match strings #904
- fix(dr): Add missing matches for common-items #905
- fix(dr): Release Khri Vanish if Thief, when going visible #906
- fix(dr): Fix race condition when clearing and repopulating XMLData.dr_active_spells #907
- fix(dr): Fix SLS release pattern #908
- fix(dr): resolve race condition in DR crafting_magic_routine #914
- fix(dr): xmlparser.rb - Fix XMLData.dr_active_spells race condition #915
- fix(dr): xmlparser.rb - Clear out spells properly #916
- fix(dr): drparser.rb update for Platinum account status #922
- feat(gs): gameobj.rb allow for custom gameobj data #848
- feat(gs): PSMS updates, including CMan.use #865, #874, #881, #890, #899
- feat(gs): ReadyList & StowList classes for item tracking #884
- feat(gs): Breakout and Buildout Societes #919
- fix(gs): infomon parsing for CHE membership #841
- fix(gs): map_gs.rb for no UID when hexdigest used #843
- fix(gs): warcry.rb yowlp :buff to string instead of regexp #847
- fix(gs): group.rb multiple corrections #850, #869, #883
- fix(gs): Bounty parser.rb fix for HW & KF guard return #862
- fix(gs): Bounty task.rb fix for assigned? and Ruby 2.6 #863
- fix(gs): stash.rb stale sheaths recheck #867
- fix(gs): allow spell.rb casting to take a force_stance parameter #902
- fix(gs): update Infomon parsing for new ACCOUNT output format #903
- fix(gs): PSMS cost for multiple cost types & add Excoriate feat #912
- fix(gs): Feat excoriate regex correction #920
- fix(gs): weapon PSM affordable check against Glorious Momentum #926
</PRE>
'''5.11.1'''
<PRE>
- fix(all): restore @theme_state and add to CLI capability #795
- fix(all): retire gtk2 monkey patch for gtk3 #823
- fix(all): games.rb XMLData.name wait till both not NIL and not EMPTY #826
- fix(all): standardize xmlparser game instance #827
- fix(all): games.rb fix multiple single and double quote in XML #832,836,837
- fix(dr): games.rb - optional hide Room Title display of Real IDs with FLAG on #782
- chore(dr): common-moonmage - refactor of peer_telescope #783
- fix(dr): move HMR load to common before for dragonrealms #784
- fix(dr): common-crafting.rb minor edit to add "You tuck" #787
- fix(dr): common-arcana.rb - remove unecessary pause from discern code #792
- fix(dr): drparser.rb Restore Premium status checking #834
- fix(gs): migrate PSMS.name_normal to Lich::Util.normalize_name #790,833
- fix(gs): add Char.che to know current character's CHE #791
- fix(gs): FEAT and Infomon module parsing of new Covert Art feats. #796
- fix(gs): add Currency.gemstone_dust and fix redsteel mark capture #797
- fix(gs): FEAT Covert Arts colon normalization and stamina costs #799
- fix(gs): escape dash in regex for HouseCHE #824
- fix(gs): disk.rb comparison helpers #828
- fix(gs): allow for Group.disks to show self disk in array #829
- fix(gs): feat.rb Covert Arts throw poison costs 15 stam #830
- fix(gs): add missing Feat.use ability #831
- fix(gs): multiple CritRanks updates #801-822
</PRE>
'''5.11.0'''
<PRE>
- [all] - chore: Namespace & File Path Updates #713
- [all] - [argv_options.rb] bugfix: correct darkmode to work via CLI #693
- [all] - [games.rb] feat: make show Room Exits of non-StringProc/Obvious Exits toggable for all games #699
- [all] - [games.rb] feat: toggleable display of StringProcs with clickable links #751
- [all] - [gui-manual-login.rb] fix: change label to Wrayth #720
- [all] - [gui-saved-login.rb] fix: update Stormfront label #721
- [all] - [update.rb] fix: purge old LIB folder prior to update release #729
- [all] - [util.rb] bugfix: allow issue_command to use fput or put #715
- [all] - [xmlparser.rb] feat: add XMLData.room_name attribute #685
- [all] - [main.rb] fix: create session file in regular connect method #733
- [all] - [init.rb] bugfix: error for Windows DISPLAY variable #735
- [all] - [main.rb] fix: Mudlet support #736
- [all] - [wine.rb] fix: add --no-wine CLI flag prevent WINE startup
- [all] - [init.rb] fix: add --no-gtk CLI flag prevent GTK3 gem load
- [dr] - [games.rb] feat: DRinfomon and common files as core lich libraries #686
- [dr] - [games.rb] chore: add DR requires here #690
- [dr] - [games.rb] fix: add Room# display for DR #697
- [dr] - [games.rb] bugfix: Genie FE real ID#s not supported, hide by default #728
- [dr] - [drdefs.rb] bugfix: fix for Shadow Servants #710
- [dr] - [map_dr.rb] fix: cleanup and support for UIDs #719
- [dr] - [xmldata.rb] bugfix: add support for DR Room IDs #716
- [dr] - [xmlparser.rb] feat: XMLData - adding dr_active_spells #691
- [gs] - [games.rb] bugfix: support for pre/post room name txt #683
- [gs] - [group.rb] chore: update to account for hold #701
- [gs] - [resource.rb] feat: add additional tracking of covert art charges #714
- [gs] - [spell.rb] bugfix: Spell.affordable? 515 release #687
- [gs] - [stash.rb] bugfix: sheath_bags when not found #694
- [gs] - [xmlparser.rb] bugfix: missing real ID in nav #684
- [gs] - [xmlparser.rb] bugfix: Claim module obvious hiding #717
- [gs] - [sk.rb] feat: Self-Knowledge functionality in core #748
</PRE>
'''5.10.4'''
<PRE>
-o- [GS4] - [xmlparser.rb] bugfix: Simu XML breaking change RoomID #679
</PRE>
'''5.10.3'''
<PRE>
-o- [GS4] - [crit_tables] fix: CritRanks regex fixes (multiple files and changes) #671
-o- [GS4] - [spellsong.rb] fix: Correct Spellsong sync method #674
-o- [GS4] - [parser.rb] fix: thorn status regex correction #673
-o- [All] - [xmlparser.rb] fix: Split out if elif block to account for DR having multiple… #670
-o- [All] - [global_defs.rb] fix: percentconcentration #676
-o- [All] - [global_defs.rb] fix: update move failure message to handle attack and casting #667
-o- [All] - [init.rb] fix: update required ruby check messaging #669
-o- [All] - [sessionvars.rb] feat: new module SessionVars for non-persistent variable storage #666
</PRE>
'''5.10.2'''
<PRE>
-o- [DR] - [games.rb] bugfix: tweak XML rewrite section #662
-o- [GS4] - [crit_tables] bugfix: additional crit table regex corrections #663
-o- [GS4] - [ascension.rb] bugfix: add new Transcend Destiny to lookups #661
-o- [GS4] - [effects.rb] bugfix: regexp escape txt #660
-o- [GS4] - [disruption_critical_table.rb] Bugfix in regex #659
</PRE>
'''5.10.1'''
<PRE>
-o- [All] - [games.rb] bugfix: prevent race condition in games thread #656
-o- [All] - [init.rb] bugfix: address WINE variance between linux / installs #655
-o- [GS4] - [gs][stash.rb] bugfix: wear code improvement #657
</PRE>
'''5.10.0'''
<PRE>
-o- [All] - [main.rb] bugfix: correct encoding for WizardFE PR #640
-o- [All] - [games.rb] bugfix: correct logic for room detection when using CLI --start-scripts PR #639
-o- [All] - [DB_Store.rb] feat: add direct support for Simu RENAME and CHANGE PROF PR #633
-o- [All] - chore: breakout code to individual files for easier management PR #617
-o- [All] - [lich.rbw] chore: add deprecated msg to old Settings/GameSettings/CharSettings methods PR #589
-o- [All] - [lich.rbw] feat: add new --dark-mode CLI option PR #583
-o- [All] - [global_defs.rb] bugfix: monsterbold fix for additional clients PR #581
-o- [All] - [update.rb] feat: update core scripts from source on Lich5 update/install PR #579
-o- [All] - [log.rb] feat: add new Log module copied from Olib PR #577
-o- [All] - [numeric.rb] feat: add days/hours/minutes/seconds methods to numerics PR #623
-o- [All] - [messaging.rb] feat: WizardFE Voln window support #647
-o- [All] - [init.rb] bugfix: WINE entries for Linux / MacOS #649
-o- [DR] - [lich.rbw] bugfix: cleanup downstream hook exclusions PR #593
-o- [DR] - [global_defs.rb] bugfix: missing climb failure message PR #592
-o- [GS4] - [effects.rb] bugfix: show non-standard Effects in `;magic` output PR #641
-o- [GS4] - [parser.rb] bugfix: fix WARCRY duplication results / add WALL OF THORNS effect detection PR #634 / PR #637
-o- [GS4] - [critranks.rb] feat: add critical rank resolution tables and methods PR #625
-o- [GS4] - [effects.rb] bugfix: to support regex for active? & time_left PR #590
-o- [GS4] - [infomon.rb] bugfix: add implicit NPC death monitoring PR #588
-o- [GS4] - [infomon.rb] bugfix: change PSM to be stored as type.mnemonic PR #587
-o- [GS4] - [lich.rbw] bugfix: strip_xml multiline fix PR #584
-o- [GS4] - [stash.rb] bugfix: fix sack detection to use Stash.container(param) PR #578
-o- [GS4] - [spell.rb] feat: Spell.after_stance #644
-o- [GS4] - [xmlparser.rb] bugfix: for Claim module #646
-o- [GS4] - [infomon] feat: track Voln favor via RESOURCE output #648
-o- [GS4] - [gameobj.rb] feat: add Bandit hidden target API #650
</PRE>
'''5.9.2'''
<PRE>
-o- [GS4] - [group.rb] bugfix: proper leader detection from GROUP output
-o- [GS4] - [char.rb] bugfix: add back depracted Char.maxvitals with msging to switch to new Char.max_vitals methods
</PRE>
'''5.9.1'''
<PRE>
-o- [GS4] - [group.rb] bugfix: group.check syntax change
-o- [GS4] - [spell.rb] bugfix: affordable? Char.mana parenthesis logic
</PRE>
'''5.9.0'''
<PRE>
-o- [All] - feat: sqlite3 gem syntax code cleanup PR#553
-o- [All] - [lich.rbw] bugfix: remove unused Setting, GameSetting, CharSetting PR#542
-o- [All] - [lich.rbw] bugfix: scrub login key from error message popups PR#548
-o- [All] - [messaging.rb] bugfix: color mismatch WizardFE white txt PR#554
-o- [All] - [lich.rb] feat: add new Lich.deprecated method to aid in deprecating older API calls PR#523
-o- [GS4] - [char.rb] feat: log method_missing calls PR#552
-o- [GS4] - [char.rb] feat: add missing global_def related methods PR#523
-o- [GS4] - [global_defs.rb] feat: deprecate various Char module methods PR#523
-o- [GS4] - [spellsong.rb] bugfix: cache spellsong duration calc PR#551
-o- [GS4] - [effects.rb] feat: Effects module breakout PR#549
-o- [GS4] - [group.rb][disk.rb] feat: Group & Disk class PR#532
-o- [GS4] - [activespell.rb] feat: add duration change messaging, off by default, see ;help for details PR#487
</PRE>
'''5.8.1'''
<PRE>
-o- [All] - [lich.rbw] feat: add Game:Character to debug log file ouput
-o- [All] - [init.rb] feat: add milliseconds to debug filename
-o- [GS4] - [lich.rbw] bugfix: reorder parsing of $SERVERSTRING to avoid certain conflicts
-o- [GS4] - [parser.rb] bugfix: update for new Empath resource and sleep/bind messaging
-o- [GS4] - [status.rb] bugfix: bound? calmed? and sleeping? support for spellnames flag being off
-o- [GS4] - [xmlparser.rb] bugfix: additional creature dying messaging to check against XML dead not being sent
-o- [GS4] - [gameobj.rb] bugfix: remove sorcerer arms and animates from GameObj.targets
</PRE>
'''5.8.0'''
<PRE>
-o- [All] - Ruby 3.3 compatibility
-o- [All] - [lich.rbw] feat: adds .sources for up/downstream hooks
-o- [All] - [lich.rbw] bugfix: don't use WINE for custom frontends
-o- [GS4] - [char.rb] bugfix: add back Char.stance
-o- [GS4] - [claim.rb] feat: new module and associated changes to xmlparser
-o- [GS4] - [experience.rb] feat: percent experience options
-o- [GS4] - [parser.rb] bugfix: allow for negative TNL exp value
-o- [GS4] - [parser.rb] bugfix: allow hyphenated last names in character names
-o- [GS4] - [parser.rb] feat: update resource matching for new Bard service
-o- [GS4] - [stash.rb] bugfix: catch more shield removal messages
-o- [GS4] - [util.rb] bugfix: underscore issue for PSMs
</PRE>
'''5.7.0'''
<PRE>
-o- Supports Ruby 3.2 - security enhancements and huge speed improvements for regex
-o- New libraries/modules/classes: Account, HMR (Hot Module Reloading)
-o- GS4 Infomon now baked into Lich5 as a library, no more need to run standalone script
-o- New GS4 libraries/modules/classes: Ascension, Bounty, Currency, Experience, Resources, Society, Status, Warcry
-o- Updates to existing libraries/modules/classes: Armor, Util, Weapon, Spell, GameObj, Messaging
-o- Several Bugfixes for lots of things
-o- Lots of code cleanup
</PRE>
'''5.6.2'''
<PRE>
-o- Fix for XML errors
-o- Adds the DR Plat instance for Frostbite FE
-o- Adds ‘ball’ as the noun used for ‘ball and chain’
-o- Adds the movement result ‘slip in the mud and fall flat’
-o- Corrects stamina cost for the feature Dispel Magic
-o- Plus all the latest script updates from Elanthia-Online!
</PRE>
'''5.6.1'''
<PRE>
-o- Fix for XML to limit login errors (DR)
-o- Fix for XMLData.active_spells to properly register wizard 'recovery' spell cooldowns
-o- Messaging updates to remove error in Wizard FE encodings
-o- Corrects for error in detecting PSM skill changes (cman) via warrior / rogue guild lessons
-o- Deprecates LNet script from master repository
-o- Miscellaneous small bug squashing
</PRE>

'''5.6.0'''
<PRE>
-o- (DragonRealms) Support for Genie and Frostbite frontends
-o- (GemStone) Changed methods to improve ;go2 speed and reduce lich.db3 calls
-o- (GemStone) Updates to support silver_count function
-o- (Both) Changed method for updating lich ecosystem
</PRE>

'''5.5.0'''
<PRE>
-o- Support for DragonRealms
-o- Updated support for scripts like BigShot
-o- Providing the LichID and UID on Profanity
-o- Spell.force_incant, .force_channel, and .force_evoke
-o- Standardized message method for script authors
-o- Sundry small improvements / fixes and changes
-o- And the creme de la creme - a custom directory
</PRE>

'''5.4.0'''
<PRE>
-o- Simu Room IDs (formally called 'unique ID' or 'uid' for Lich) added to Map, mapDB where known, and ;go2 for navigation (courtesy Xanlin and with our thanks!) ;go2 u7120 for all you ex-GMs out there.
-o- Room titles will now display the Lich ID and / or the UID for the room based on user selections - default is on for both, and enabled / disabled via Lich.display_lichid or Lich.display_uid toggles that can be set to on / off or true / false. (;e Lich.display_lichid=true/false and ;e Lich.display_uid=true/false) You can remove that rnum from your autostart now! To gain the benefit of the UID deployment, be sure to ;repo download-mapdb
-o- REQUESTS: Drop 5 minute timeout function from Lich
-o- waitrt? and waitcastrt? will still pause activities, but will return TRUE or FALSE in keeping with the Ruby functionname? tradition (no more failing to get a weapon out due to RT from climbing!)
-o- empty_hands and fill_hands will now check to see if the character is in roundtime before trying to put away or retrieve held items
-o- Infomon received an update that keeps spell timers in sync with the information received from the server - no more need to immediately do a spell active in game to get the right times to display for various legacy scripts and ;magic after visiting the invoker or using an SK item
-o- Lich now provides a facility to get current coins on the character that is a bit more agnostic to data changes from Simu - Lich::Util.silver_count
-o- Various other small tidbits to help ease maintenance and future development
-o- PLEASE NOTE: This update is required for the newest Bigshot (released today!) and for future eloot and eherbs scripts (release RSN)
</PRE>

'''5.3.0'''
<PRE>
-o- Added support for Wrayth (renamed Stormfront) installations
-o- Converted Linux | WINE login methods to 'method 0', does not use Simu launcher
</PRE>

'''5.2.1'''
<PRE>
-o- Support for STOWing items irrespective of special item scripts
-o- Improved query support for Effects and CMans
-o- Fix Lich bug to respect the 'groupmovement' flag in game
-o- Fix Lich round time calculations (more aggressive timing)
-o- Dark Mode is now a thing
-o- Lich4 Style GUI layout available
-o- Several file location changes to support future code change efforts
</PRE>

'''5.0.19'''
<PRE>
-o- Benefit: Monks with Mental Acuity (all 3 of you) rejoice - stamina casting!
-o- Benefit: PSM3 included, no charge. No hair remaining, either!
-o- Benefit: Ok, stay seated: Some of your various SF spell duration windows may work. . . better? Yes, not perfect, but better. No pictures, please!
-o- Updated infomon that properly detects Cloak of Shadows on those pesky sorcerers, and the Raise Dead Cooldown periods for those wondrous clerics.
-o- A new update process for Lich 5 - tired of having to download that script over and over just to update? Get yourself a copy of lich5-update.lic. Note, if you already have it, you're set! If not - ;jinx script install lich5-update --repo=elanthia-online
</PRE>

'''5.0.11'''
<PRE>
-o- Updated the method used to log onto SIMU servers.
-o- Added the Animalist item specifics to Lich5's empty and fill hands routines
-o- Improved Invoker messages for Avalon and Wizard FEs (no change for SF FE)
-o- Improved cleanup and store methods when player EXIT's or QUIT's game
-o- Crafted two new methods (stash_hands and equip_hands) for future script use
-o- Some behind-the-scenes cleanup to improve maintaining the Lich5 ecosystem
-o- Add Spell Active improvements
-o- Add PSM and Ranger improvements
</PRE>
</div>

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

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

Lich:Software/Installation

2026-10-28T13:13:26Z

WHIGHTCNIGHT: update to include mention of Saga for MacOS and Linux

{{3rd-party}}
=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 Wrayth or Wizard FE. Lich is also used by many on both MacOS and multiple Linux distributions.

=Installing the Latest Stable Release=

'''The latest stable lich version is 5.22.0 supporting Ruby 4.0 - published October 8, 2026'''

==In-Place Upgrade==

If you are on an older version of Lich 5 and want to upgrade to the most current version, you can choose to either upgrade Lich5 only or both Lich 5 and Ruby. If you're currently on Lich 4, able to check by running the command <CODE>;e echo LICH_VERSION</CODE>, go to the [[#Upgrade Installation for Lich 5 from Lich 4 (11/14/2023)|upgrade from Lich 4 section]].

For each section, please follow the directions/commands one at a time.

===Lich 5 Only===

====Lich 5.7 or newer====
# You must be running Ruby 4.0 or greater for Lich 5.19 +. If unsure, please update both (see below)!
# '''Backup existing Lich 5 folder'''
# Run this command in-game <CODE>;lich5-update --update</CODE>
# Quit and restart lich.
# Congratulations - you're now running on the latest version of Lich!

====Lich 5.6 or older====
Please proceed to updating both Ruby and Lich 5

===Both Ruby 4.0 & Lich 5===
This method is for Windows only. Linux and MacOS users, please do a Lich 5 only update and update Ruby manually via normal install/update methods for the OS.

# Logout of all characters
# '''Backup existing Lich 5 folder'''
# Uninstall existing Ruby4Lich5 installs from Programs & Features control panel, or alternatively, rename your existing Ruby4Lich5 folder to Ruby4Lich5save. (Defaults to C:\Ruby4Lich5)
# Download the latest [https://github.com/elanthia-online/lich-5/releases/latest/download/Ruby4Lich5.exe Ruby4Lich5.exe Installer]
# Run the installer and be sure to have both Ruby and Lich 5 option selected
# Congratulations - you're now running on the latest version of Lich & Ruby!

===Ruby 4.0 Only===
Use this to upgrade to the newest version of Ruby only if you're already on the latest version of Lich5 and now want to update Ruby afterwards. If you're not already on the latest version of Lich5, please use previous section steps instead.
# Logout of all instances/characters
# '''Backup existing Lich 5 folder'''
# Uninstall your existing Ruby4Lich5 install via Programs & Features (ensure it's now gone, default location was C:\Ruby4Lich5)
# Download the latest [https://github.com/elanthia-online/lich-5/releases/latest/download/Ruby4Lich5.exe Ruby4Lich5.exe Installer]
# Run the new installer and choose to only install Ruby Only
# Congratulations - you're now running on the latest version Ruby!

==Windows New Installation==

{{blue|These instructions are not for DragonRealms. [[#Ecosystem Information|For those scroll to the bottom]].}}

'''For Windows 11 / 10 / 8 / 7''' users: you can download the [https://github.com/elanthia-online/lich-5/releases/latest/download/Ruby4Lich5.exe Ruby4Lich5.exe Installer] and install everything you need automatically. Click on the '''Ruby4Lich5.exe''' and download it to your computer then double click on the executable in your default download folder. Note, a user may need to adjust their browser or security settings to allow download and installation.
If you have never played before, follow the 'New Installation' instructions. If you have played before, and have used Lich before, follow the 'Upgrade Installation' instructions.

===New Installation for Lich 5 (11/14/2023)===

# '''Please log into the game of your choice through the Simutronics website first'''. Install the launcher (not SGE), and install your FrontEnd of Choice. The Wrayth FrontEnd is presently the supported FrontEnd, but Wizard will work as well, if you are nostalgic. After you've logged in, log out and continue.
# Download and Run the [https://github.com/elanthia-online/lich-5/releases/latest/download/Ruby4Lich5.exe Ruby4Lich5.exe 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, 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.

===Upgrade Installation for Lich 5 from Lich 4 (11/14/2023)===

This option is deprecated. Lich 5 architectures are not compatible with Lich 4. Back up your existing Lich 4 folder, uninstall any existing Ruby executables, and then follow the instructions for a new install above.

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

==MacOS==
There are two common options for playing Gemstone IV on a Mac: play natively with Saga (the official front end) or Avalon, or use virtualization software such as Parallels with Wrayth/WizardFE. Below are the options on how to do that.

===Native (Saga or Avalon)===
Players with Macs can use [[Mac_Installation_-_Lich_(software) | Installing Lich on Macs]] for installation help. That guide sets Lich up with [[Saga]], the official Simutronics front end (currently in beta), and also covers [[Avalon]]. This process works well for Mac OS Catalina and Big Sur. If you have not updated your Mac OS yet, these instructions may work depending on your actual version. If you run into a snag, follow the contact instructions provided.

===Parallels Windows===
With the latest releases of Ruby4Lich5 installer, you can now follow the normal Windows installation for both Intel and Apple silicon based Apple computers.

To install Wrayth/WizardFE, Lich, and Ruby via Parallels you will need to do a few various steps as outlined below. Please note, the rubyw file in C:\Ruby4Lich5\X.X.X\bin may be set to run in compatibility mode for windows 7. On an ARM Mac running parallels, this may causes Wrayth scripts not to run. Turning compatibility mode off in the rubyw file could fixe this issue if it was enabled.

The following steps are to be done AFTER you've successfully installed Wrayth/WizardFE and can login normally without Lich5 on the machine. Once you've done that and can successful connect normally, then follow these steps:
# Download and install [https://github.com/elanthia-online/lich-5/releases/latest/download/Ruby4Lich5.exe Ruby4Lich5.exe Installer] and use default options presented during install
# Double click the lich.rbw file that is now located in the extracted Lich5 location you did above. Login and play as usual.

==Linux==
Pick the subsection for your distribution below. Each one installs Ruby and Lich; front ends (Saga, Profanity and Warlock) are covered once in [[#Frontends|Frontends]] at the end, since their steps are the same on every distribution.

===Chromebook & Debian variants===
<div class="mw-customtoggle-debian" style="font-size:16px;overflow:auto;color:#0000FF">[Click to Expand]</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-debian">
The following steps should install Lich for users of Debian/Chromebooks. To also install a front end such as Saga, Profanity or Warlock, see [[#Frontends|Frontends]] at the end of the Linux section.

'''Step 1.'''
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 curl libssl-dev libyaml-dev libreadline6-dev zlib1g-dev libncurses5-dev libffi-dev libgdbm6 libgdbm-dev libsqlite3-dev git unzip libcairo2-dev libgirepository1.0-dev libgtk-3-dev gobject-introspection
</pre>

{{side box|NOTE: If you are updating an existing Ruby installation rather than installing from scratch, skip steps 2, 3, and 4. Instead, update your ruby-build with the following command, and then proceed to Step 5.<pre>git -C ~/.rbenv/plugins/ruby-build pull</pre>}}

'''Step 2.'''
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>

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

'''Step 4.'''
Download the tools to let rbenv install Ruby on its own, then install Ruby 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</pre>

'''Step 5.'''
<pre>rbenv install 4.0.9 -v
rbenv global 4.0.9
</pre>

Install Lich:
<pre>
cd ~
curl -L "https://github.com/elanthia-online/lich-5/releases/latest/download/lich-5.zip" -o temp.zip && unzip temp.zip -d ./ && rm temp.zip
</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 using the <tt>Gemfile</tt> included with Lich5 by running <tt>bundle install</tt>. The Gemfile also lists developer-only gems (the <tt>development</tt> and <tt>vscode</tt> groups) that you do not need, so tell Bundler to skip them first:
<pre>
echo "gem: --no-document" > ~/.gemrc
cd ~/Lich5
bundle config set --local without 'development vscode'
bundle install
</pre>
:<small>Note: <tt>bundle install --without ...</tt> no longer works; that flag was removed from the version of Bundler that ships with Ruby 4.0. Use <tt>bundle config set</tt> as shown above.</small>
</div>

===Arch Linux & Arch-based distributions===
<div class="mw-customtoggle-arch" style="font-size:16px;overflow:auto;color:#0000FF">[Click to Expand]</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-arch">
The following steps should install Lich for users of Arch Linux and Arch-based distributions (Manjaro, EndeavourOS, etc.). To also install a front end such as Saga, Profanity or Warlock, see [[#Frontends|Frontends]] at the end of the Linux section.

Update the system and install required dependencies:
<pre>
sudo pacman -Syu
sudo pacman -S --needed base-devel openssl libyaml readline zlib ncurses libffi gdbm sqlite git unzip curl gtk3 gobject-introspection
</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 4.0.9 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 4.0.9 -v
rbenv global 4.0.9
</pre>

Install Lich:
<pre>
cd ~
curl -L "https://github.com/elanthia-online/lich-5/releases/latest/download/lich-5.zip" -o temp.zip && unzip temp.zip -d ./ && rm temp.zip
</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 using the <tt>Gemfile</tt> included with Lich5 by running <tt>bundle install</tt>. The Gemfile also lists developer-only gems (the <tt>development</tt> and <tt>vscode</tt> groups) that you do not need, so tell Bundler to skip them first:
<pre>
echo "gem: --no-document" > ~/.gemrc
cd ~/Lich5
bundle config set --local without 'development vscode'
bundle install
</pre>
:<small>Note: <tt>bundle install --without ...</tt> no longer works; that flag was removed from the version of Bundler that ships with Ruby 4.0. Use <tt>bundle config set</tt> as shown above.</small>
</div>

===Fedora===
<div class="mw-customtoggle-fedora" style="font-size:16px;overflow:auto;color:#0000FF">[Click to Expand]</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-fedora">
The following steps should install Lich for users of Fedora. To also install a front end such as Saga, Profanity or Warlock, see [[#Frontends|Frontends]] at the end of the Linux section.

Lich 5 requires Ruby 4.0 or newer. The Ruby that ships with currently supported versions of Fedora is older than that (41 uses Ruby 3.3; 42 and 43 use Ruby 3.4), so these steps install Ruby 4.0.9 with '''<tt>[https://github.com/rbenv/rbenv rbenv]</tt>''' instead of using Fedora's Ruby.

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 cairo-devel curl gcc gdbm gdbm-devel gdk-pixbuf2-devel glib2-devel \
gobject-introspection-devel gtk3-devel libyaml-devel libffi-devel make ncurses-devel openssl-devel readline-devel \
redhat-rpm-config sqlite-devel unzip zlib-devel
</pre>

{{side box|NOTE: If you are updating an existing rbenv Ruby installation rather than installing from scratch, skip step 3. Instead, update your ruby-build with the following command, and then run only the <tt>rbenv install</tt> and <tt>rbenv global</tt> lines from step 3.<pre>git -C ~/.rbenv/plugins/ruby-build pull</pre>}}

3. Install rbenv and Ruby 4.0.9:
<pre>
git clone https://github.com/rbenv/rbenv.git ~/.rbenv
echo 'export PATH="$HOME/.rbenv/bin:$PATH"' >> ~/.bashrc
echo 'eval "$(rbenv init -)"' >> ~/.bashrc
source ~/.bashrc
git clone https://github.com/rbenv/ruby-build.git ~/.rbenv/plugins/ruby-build
rbenv install 4.0.9 -v
rbenv global 4.0.9
ruby -v
</pre>
The last command should print a line starting with <tt>ruby 4.0.9</tt>. If it doesn't, close and reopen the terminal and try <tt>ruby -v</tt> again.

4. Install Lich:
<pre>
cd ~
curl -L "https://github.com/elanthia-online/lich-5/releases/latest/download/lich-5.zip" -o temp.zip && unzip temp.zip -d ./ && rm temp.zip
</pre>

5. 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 using the <tt>Gemfile</tt> included with Lich5 by running <tt>bundle install</tt>. The Gemfile also lists developer-only gems (the <tt>development</tt> and <tt>vscode</tt> groups) that you do not need, so tell Bundler to skip them first:
<pre>
echo "gem: --no-document" > ~/.gemrc
cd ~/Lich5
bundle config set --local without 'development vscode'
bundle install
</pre>
:<small>Note: <tt>bundle install --without ...</tt> no longer works; that flag was removed from the version of Bundler that ships with Ruby 4.0. Use <tt>bundle config set</tt> as shown above.</small>
</div>

===Frontends===
<div class="mw-customtoggle-frontends" style="font-size:16px;overflow:auto;color:#0000FF">[Click to Expand]</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-frontends">
Finish the Lich installation for your distribution above first, then set up one of these front ends.

====Saga====
[[Saga]] is the official Simutronics front end for GemStone IV and DragonRealms (currently in beta), and it works with Lich. On Linux it comes as a single AppImage file.

'''Install Saga'''

Go to the [https://www.play.net/gs4/play/saga-info.asp Saga info page] and click '''Download for Linux''' (AppImage, x86_64). On a Chromebook, move the downloaded file into the '''Linux files''' folder with the Files app so Linux can see it.

Then put it where Lich looks for Saga, make it runnable, and start it:
<pre>
sudo mkdir -p /opt/Saga
sudo mv ~/Downloads/Saga-*.AppImage /opt/Saga/saga
sudo chmod +x /opt/Saga/saga
/opt/Saga/saga
</pre>
:<small>On a Chromebook use <tt>~/Saga-*.AppImage</tt> in place of <tt>~/Downloads/Saga-*.AppImage</tt>.</small>

Log in to the game from inside Saga once, without Lich, to make sure Saga itself works.

If Saga will not start and mentions FUSE or <tt>libfuse.so.2</tt>, install FUSE 2 and try again: <tt>sudo apt-get install libfuse2</tt> on Debian/Chromebook (on Debian 13 and newer, <tt>libfuse2t64</tt>), <tt>sudo pacman -S fuse2</tt> on Arch, or <tt>sudo dnf install fuse-libs</tt> on Fedora.

The Linux build of Saga does not update itself yet. Check the Saga info page now and then, download the newest AppImage, and repeat the <tt>sudo mv</tt> and <tt>sudo chmod</tt> steps.

'''Use Saga with Lich'''

Saga starts Lich for you:
# Log in with Saga normally, then choose '''File → Enable Login with Lich'''.
# Choose '''File → Return to login'''.
# Click '''Connect''', then '''Via Lich''', and point it to your Lich folder (<tt>~/Lich5</tt>).
# If Saga asks where Ruby is, or Lich will not start, run <tt>rbenv which ruby</tt> and give Saga the path it prints (it ends in <tt>.rbenv/versions/4.0.9/bin/ruby</tt>).
# Log in. The game will start in Saga with Lich running.

Once that works, you can also start from the Lich login window (<tt>ruby ~/Lich5/lich.rbw</tt>): 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.

====Profanity====
Profanity is a terminal-based Front-End that will let you play the game (in lieu of The Wizard or Wrayth). Its gems (such as <tt>curses</tt>) are installed by the <tt>bundle install</tt> step above. Download Profanity:
<pre>
cd ~
git clone https://github.com/elanthia-online/ProfanityFE.git
</pre>

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

====Warlock====
Download Warlock from https://sproctor.github.io/warlock3/download.html, then run Lich the normal way with Ruby:
<pre{{log2|margin-right=35%}}>
ruby ~/Lich5/lich.rbw
</pre>
Use your login information with these settings to use the Lich launcher: https://github.com/sproctor/warlock3/wiki/Lich-support
</div>

=Popular Scripts=
{{#section:Lich:Script Repository|popularscripts}}

=Ecosystem Information=

* DragonRealms Variant - [https://elanthipedia.play.net/Lich_script_repository#Setup_and_Installation Setup and Install instructions]

=Lich Changelog=
<div class="mw-customtoggle-changelog" style="font-size:16px;overflow:auto;color:#0000FF">[Click to Expand]</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-changelog">
'''5.22.0'''
<PRE>
### Features (general)
* add opt-in bounded script execution guards (#1575)
* add static-only map route selection (#1577)
* bounded fput with max_resends, interrupt, resend_transient and failure symbols (#1587)
* Spell.results_regex, the lines cast waits on, exposed (#1590)
* add Events, a script-to-script notification primitive; combat emits on it (#1619)
* add deterministic hook priorities (#1621)
* Map.boundary_rooms_for(ids), the perimeter of any set of rooms (#1660)
* sticky ever_hostile? keeps Sympathy'd creatures in targets (#1665)
* --pipe -g honours the frontend flag, and --sentinel requests the origin marker (#1677)

### Features (gs)
* add trustworthy combat observation provenance (#1576)
* Lich::Gemstone::Stance, a shared stance setter (#1578)
* Lich::Stash.wield and Stash.hands put named items into hands (#1579)
* Lich::Gemstone::Mana.pulse, the MANA PULSE verb once (#1580)
* Lich::Gemstone::Bank, Currency refresh, and WEALTH parser lines (#1581)
* PSM command and results_regex readers, factored out of use (#1583)
* Lich::Gemstone::Fog, the ways home on the spell and society readers (#1584)
* Combat::Messages - non-combat message families as observer events (#1586)
* society command readers, factored out of use (#1589)
* Group.join, the follower's side of Group.add (#1591)
* emit post-commit combat recorder receipts (#1592)
* combat definition supplements from a player YAML file (#1607)
* message definitions from the player supplement file (#1608)
* creature library - abilities from session logs, limbs flags, triggers as hash of arrays (#1623)
* expose exact server creature health from crtrStatus (#1661)

### Bug Fixes (general)
* fix spec stub race breaking FFI loads, gate WindowsCredentialManager to Windows (fixes #1542) (#1573)
* setup_files uses content hash for cache freshness (#1596) (#1599)
* creatures registry housekeeping independent of Combat::Tracker (#1603)
* place effect-list.xml backups in the update snapshot folder (#1606)
* retain discovery ownership through cleanup (#1612)
* Initial Lich state update and detachable-client split GS/DR (#1617)
* bound move()'s remedy retries, record why a move failed, lift it into Lich::Common::Move (#1622)
* update puts to Lich.log (#1630)
* create detachable-client session file without --login (#1656)
* converge server_time_offset instead of resetting it every prompt (#1663)
* plain-language lich5-update messages when GitHub fails (#1687)
* Inventory.refresh waits out roundtime before sending (#1688)

### Bug Fixes (dr)
* update HOW pattern to accommodate various soul states (#1620)
* restore script halt in DRCC.get_crafting_item on missing item (#1624)
* halt script when too distracted to turn recipe book (#1625)
* equipmentmanager energy bow handling (#1662)
* report when DRC.rummage can't read a container (#1671)
* DRCI.get_item? confirms #<id> gets by the item id in hand (#1674)
* DRCT.sell_item references the item through DRCI.item_ref (#1675)
* DRCA.do_buffs filters day/night spells without mutating settings (#1680)
* DRCI.tie_item? no longer reports an empty pouch as tied (#1684)
* DRC.play_song? keeps climbing and performance songs across instrument switches (#1686)

### Bug Fixes (gs)
* Injured cache lives on the class and keys on an injury fingerprint (#1582)
* infomon - a spell's start message refreshes a refreshable timer (#1585)
* Group.broken? waits on Lich::Claim::Lock, the constant that exists (#1588)
* combat module - hunt-log audit: interrupted-swing resume, status attribution by event, spell-loss cause, live defs (#1593)
* QStrike prices MSTRIKE's own stamina cost (#1594)
* combat module - a stand-up message later in the chunk outranks an earlier knockdown crit (#1595)
* track spell cooldowns on the characters a spell locks out (#1597)
* catalog missing deity-specific strike lines for Divine Wrath (335) (#1598)
* combat module - Rysk/Dreadt log audit: Holy Weapon release model, held maneuver rolls, AoE roll attribution, live defs (#1600)
* Combat defs add thrust as a basic attack (#1615)
* preserve group state after ambiguous disband reply (#1629)
* target ridden mounts before their first crtrStatus (#1669)
* snapshot Effects registries so scripts can't break the XML parser (#1672)
</PRE>
'''5.21.0'''
<PRE>
### Features (general)
* Add --refresh-characters and --add-character CLI flags (#1504)
* add --active-session-dir to decouple Active Sessions coordination from --temp (#1520)
* add read model for the inventoryManager extended feed (#1524)
* GUI add configurable frontend registry (#1558)
* add HTTPS web-login fallback for when EAccess (7910) is unreachable (#1570)

### Features (dr)
* player-supplied custom prep/cast/invoke messages (#1528)
* opt-in cambrinth charge distribution across configured items (#1549)
* populate GameObj from INV LIST full refresh (02 of 05) (#1554)
* non-destructive upsert for INV SEARCH / category scrapes (03 of 05) (#1556)
* reconcile GameObj containers on hand pickup (04 of 05) (#1557)
* [DRCC] add shared private-forge helpers (#1560)

### Features (gs)
* creature template library - measured combat data, HP/speed censuses, messaging (#1539)

### Bug Fixes (general)
* enforce Script#pause at every blocking/mutating checkpoint (#1537)
* always report missing gems on stderr; only wait on a dialog without a tty (#1544)
* dispatch --help and --version before the GTK require (#1546)
* global_def update deprecated method calls to include caller info (#1550)
* normalize colons in Lich::Util.normalize_lookup (#1561)
* Script.log respects --log-dir/LOG_DIR override; use File.join for paths in script.rb (#1572)

### Bug Fixes (dr)
* drvariables add more data to VOL_MAP (#1536)
* pin capped skills to 34 in DRSkill.clear_mind (#1548)
* match lowercase "it's already open" when opening a container (#1553)
* normalize capitalized leading articles in inventory scrape names (01 of 05) (#1555)
* make INV LIST refresh atomic and warn on interruption (05 of 05) (#1563)
* refresh before_name/after_name on a name-preserving container move (#1564)
* do not re-add a held item as worn inventory on inv scrape (#1565)
* evict orphaned identity-index entries on a name-changing upsert (#1566)
* unpause the exact scripts safe_pause_list paused, by object (#1574)

### Bug Fixes (gs)
* Infomon xmlparser additional npc death messaging (#1540)
* correct messaging drift in 13 crit table patterns (#1547)
* combat module - event defs, observer emissions, replay-verified parsing, SQLite recorder (#1559)
</PRE>
'''5.20.1'''
<PRE>
### Bug Fixes (general)
* bound EAccess auth with a timeout so a stalled SGE backend can't hang Lich silently (#1502)
* Linux WINE and Wrayth FE detection (#1517)
* update Gemstone game-code validations (#1518)
* preserve bundled display-state tags on quiet-suppressed chunks (#1530)
* prevent a stray formatting character from appearing in Saga during quiet script output (#1532)

### Bug Fixes (dr)
* make $safe_pause_lock holder immune to pause (#1525)

### Bug Fixes (gs)
* critranks.rb tolerate nil table rows, fix reload!, index patterns … (#1522)
* combat module hardening - ordered processing, 22x faster parsing, double-count fix (#1523)
</PRE>
'''5.20.0'''
<PRE>
### Features (general)
* add concurrent runtime I/O and multi-client detach support (#1459)
* --bind-address speaks the same keywords as --detachable-client (#1461)
* GUI Launcher Improvements (#1463)
* Add supervised child script APIs (01 of 06) (#1474)
* Add forced script teardown command (06 of 06) (#1479)
* teardown and distinguishable errors for Script.run_child (#1501)

### Features (dr)
* DRCMM.moon_weapon_duration - read a moon weapon's remaining life (#1483)
* id-based creature tracking from crtrStatus + assess (#1485)
* capture room UID from <nav> tag; stop enforcing ShowRoomID; opt-in room-id placement (#1491)
* user-extensible scroll substitutions via settings (01 of 06) (#1512)
* user-extensible boxes and trash receptacles (03 of 06) (#1514)
* user-extensible summoned-weapon adjectives (04 of 06) (#1515)
* user-extensible flavor-text stripping (05 of 06) (#1516)

### Features (gs)
* gameobj add full_name matcher to type/sellable classification (#1453)

### Bug Fixes (general)
* prevent empty/partial GameObj registry reads during mid-stream refresh (#1370)
* no-op Gtk.lich_main_quit when no main loop is nested (#1464)
* correct path-flag aliases and document all path options (#1472)
* Synchronize script lifecycle transitions (02 of 06) (#1475)
* Coordinate script shutdown draining (03 of 06) (#1476)
* Harden script lifecycle ownership (05 of 06) (#1478)
* surface the underlying LoadError in dependency alerts (#1480)
* extract game-agnostic CreatureBase into lib/common (#1484)
* bound GemCheck alert dialogs with a timeout so they can't hang forever (#1488)
* identify Genie as the frontend for headless launches (#1490)
* restore detachable client disconnect notice to stdout (#1492)
* harden detachable client teardown and escape init payload (#1493)
* resolve GameObj status visibility during staged refresh (#1497)
* compact client write queue instead of ending the session (#1498)
* scrub startup credentials once login completes (#1499)
* Honor Simu-side teardown for 10 seconds (#1505)

### Bug Fixes (dr)
* resolve no-UID rooms carrying a stored UID instead of returning nil (#1467)
* equipmanager.rb - reliable ranged-weapon transitions - stow ammo after unload + verify offhand wield hand (#1468)
* common-healing.rb - DRCH.bind_wound: only dispose a dislodged item while it is in hand (#1469)
* preserve game RealID in room title (GS parity for ";display roomid title") (#1500)
* Refine need_buffs? logic for non-recast spells to correctly check cyclic spells. (#1503)
* reduce symbol-torn scale scrolls to gettable noun (#1506)
</PRE>
'''5.19.1'''
<PRE>
### Bug Fixes (general)
* lower game socket keepalive idle from 120s to 30s (#1449)
* resilient ActiveSessions ownership + shutdown watchdog (#1452)
* Quit Gtk.main cleanly (#1455)
* Refactor regex to string comparisons for ARGV options (#1456)

### Bug Fixes (gs)
* ingest newly-exposed mindState experience and roommeta room fields (#1450)
</PRE>
'''5.19.0'''
<PRE>
### Features (general)
* Add character generator support via EAccess protocol (#1384)
* Add modern script command shutdown method (#1385)
* migrate the server-stream parser from REXML to Ox, with pipe-mode benchmark harness and DR parser coverage (#1396)
* enumerate script subdirs with file glob (#1397)
* add --bind-address option to set listen socket address (#1405)
* add central method to determine lich ver (#1417)
* setup_files: support scripts/data/custom for user data overrides (#1431)
* Modify running? method to support optional exact matching of script names (#1436)
* keyword bind hosts for the detachable client (tailscale/lan/any) (#1437)
* add roomlinks/roommono toggles for room display (#1438)
* self-healing gem requires (#1439)
* various Saga FE compatibility tweaks (#1443)
* add macOS limited gem recovery (#1448)

### Features (dr)
* Capture combat position from the balance status line (#1400)
* detect scheduled shutdown and expose it on DRParser (#1409)
* xmlparser: add structured parser for the assess (combat situation) stream (#1413)
* Implement DRCA.need_buffs? method for buff checks (#1428)

### Features (gs)
* anchor Infomon parser regex unions to line start (#1391)
* creature xml additions (#1425)
* add creature template library (#1427)

### Bug Fixes (general)
* surface a failed Game.open in the connect timeout (#1408)
* bound long-session memory growth (index/hook/watchfor/buffer leaks) (#1410)
* improve and harden shutdown (#1416)
* use bundler to check for required Ruby gems (#1420)
* pin lich directory for gemfile check (#1423)
* Show CLI login ARGV for SAL connections (#1424)
* increase read timeout on idle socket to 300 seconds (#1426)
* monkeypatch gi for memoryreleaser / asyncprocessor until patched upstream (#1429)
* Mapdb sort tags by downcase and original case (#1433)
* stop locking the load path at boot; keep Gemfile.lock in sync on self-update (#1434)
* minimum Ruby 4.0 required & migrate Ruby version check (#1444)
* align --announce with --update for Ruby version (#1447)

### Bug Fixes (dr)
* BalanceValue regex to match combat status lines (#1398)
* equipmanager.rb - Fix unload weapon detection when AimTimerDialog tag is prepended (#1414)

### Bug Fixes (gs)
* global_defs update pushStream regex to include 'reserve' id (#1379)
* psms Warcry.available? correction (#1387)
* xmlparser support new field exp, climate, terrain XML feeds (#1388)
* global_defs move() update regex for standing condition (#1407)
* Currency add method to retrieve aevit event currency (#1411)
* Stash check result type before comparing regex for wear_to_inv (#1430)
</PRE>
'''5.18.0'''
<PRE>
### Features (dr)
* common-crafting add method for creating mechanisms (#1375)

### Bug Fixes (general)
* stringproc normalize CRLF | CR to LF (#1378)
* rubocop custom cop ascii only cleanup (#1382)

### Bug Fixes (dr)
* equipmanager update to assume missing items aren't worn (#1376)

### Bug Fixes (gs)
* Infomon xmlparser additional npc death messaging (#1326)
</PRE>
'''5.17.3'''
<PRE>
### Bug Fixes (general)
* Script module replace MemoryReleaser with GC.start for cleanup (#1364)
* Add sqlite busy timeout policy to core (#1365)
* Script#kill remove GC.start and add optional instrumentation (#1368)
* reorder shutdown ala MahtraDR and detect script teardown de... (#1369)
</PRE>
'''5.17.2'''
<PRE>
### Bug Fixes (general)
* harden custom repo identity, collision, and contract boundaries (#1333)
* stop SessionLifecycle before closing database on normal exit (#1334)
* harden FeatureFlags for closed db handle (#1335)
* SynchronizedSocket write resilience and zombie client elimination (#1338)
* correct RP timing issue for release notes (#1348)
* gate object cleanup in GTK queue (#1354)
* recover from cross-process zombie in ActiveSessions service (#1355)
* Improve shutdown session state handling (#1359)
* non-ascii hygeine to address rubocop errors (#1360)
* Remove debug log IO from heartbeat tick loop (#1363)

### Bug Fixes (dr)
* DRC text2num correction for thousand (#1343)

### Bug Fixes (gs)
* Overwatch add REVEALED_EXPLODES regex pattern (#1356)
* Stash add_to_bag result type check before regex compare (#1357)
</PRE>
'''5.17.1'''
<PRE>
### Bug Fixes (general)
* enable heartbeat-driven failover for ActiveSessions service owner (#1340)
* copy Gemfile and LICENSE during self-update (#1345)
* Add top-level parse_args/display_args bridge to global_defs (#1346)

### Bug Fixes (dr)
* replace undefined custom_require in check_moonwatch (#1336)
* set_stance places 100 in the correct positional slot (#1337)
* cache SlackBot users list to prevent API throttling (#1342)
* Add CORE_AUTOSTART sentinel to skip dependency.lic autostart helpers (#1344)

### Bug Fixes (gs)
* Infomon Status.cutthroat? Effect Debuff correction (#1331)
* add support for RESERVE xml in GameObj.reserve (#1341)
</PRE>
'''5.17.0'''
<PRE>
### Features (general)
* custom 3rd-party repo support for ScriptSync (#1285)
* Add get_settings, get_data, start_scripts_if_available to core (#1305)
* Add Map.apply_wayto_overrides for personal map overrides (#1306)

### Features (dr)
* Decouple SetupFiles from script-scoped echo and XML feed timing (#1304)
* Add game flags and obsolete script warnings to DRInfomon startup (#1307)

### Bug Fixes (general)
* use :__unset for --without-frontend CLI request YAML matches (#1301)
* prevent zombie server deadlock in Active Sessions accept loop (#1302)
* improve MacOS keychain system check for older OS variants (#1310)
* stub sync_all_repos to prevent leaked thread in games_spec (#1311)
* enforce beta confirmation 10s timeout (#1315)
* use send(:respond) in StatusReporter fallback path (#1316)
* ensure SessionLifecycle.stop runs on abnormal exit (#1317)
* address ActiveSessions lifecycle hot path feature-flag polling (#1325)
* catch ECONNRESET in _puts and bound walk_to retry depth (#1327)
* safeguard gtk logo.png loading (#1329)

### Bug Fixes (gs)
* Add InnCheckedOut pattern to parser (#1309)
* Claim corrections to handle mounts in room_players stream (#1324)
</PRE>
'''5.16.2'''
<PRE>
### Features (general)
* session summary store and reporting (#1247)
* add core classes, ScriptSync, and login auto-sync (#1273)
* Add active sessions API (#1274)
* Add session status CLI query (#1276)
* configurable debug log retention (#1282)

### Features (dr)
* common-healing.rb - add vitality parsing to HealthResult (#1265)

### Bug Fixes (general)
* handle auth exceptions in manual login to prevent hang on bad password (#1267)
* set SO_REUSEADDR before bind to allow immediate port reuse (#1268)
* Persistent Launcher re-enable play button post launch (#1269)
* Restore manual login behaviors to not require saved entry t... (#1270)
* log and re-raise unexpected errors in saved login auth handler (#1271)
* narrow safe_write rollback scope so cleanup failure preserves successful write (#1287)
* fix three revert bugs in SnapshotManager (#1289)
* guard nil release asset and validate before deleting lib/ (#1290)
* guard nil stable version in beta channel resolution (#1291)
* remove dead code in BranchInstaller (#1292)
* repair regression on gui button reenable from refactor (#1297)

### Bug Fixes (dr)
* common-items.rb - move pattern from failure to success block (#1262)
* buffer_room_objs missed split components with leading stream tags (#1284)
* common-items.rb - get_item_unsafe false positives via XML feed verification (#1286)
* forward vitality and dead fields in perceive_health (#1288)

### Bug Fixes (gs)
* Infomon xmlparser additional npc death messaging (#1275)
* Infomon xmlparser additional npc death messaging (#1281)
</PRE>
'''5.16.1'''
<PRE>
### Features (general)
* session summary store and reporting (#1247)
* add core classes, ScriptSync, and login auto-sync (#1273)
* Add active sessions API (#1274)
* Add session status CLI query (#1276)
* configurable debug log retention (#1282)

### Features (dr)
* common-healing.rb - add vitality parsing to HealthResult (#1265)

### Bug Fixes (general)
* handle auth exceptions in manual login to prevent hang on bad password (#1267)
* set SO_REUSEADDR before bind to allow immediate port reuse (#1268)
* Persistent Launcher re-enable play button post launch (#1269)
* Restore manual login behaviors to not require saved entry t... (#1270)
* log and re-raise unexpected errors in saved login auth handler (#1271)
* narrow safe_write rollback scope so cleanup failure preserves successful write (#1287)
* fix three revert bugs in SnapshotManager (#1289)
* guard nil release asset and validate before deleting lib/ (#1290)
* guard nil stable version in beta channel resolution (#1291)
* remove dead code in BranchInstaller (#1292)

### Bug Fixes (dr)
* common-items.rb - move pattern from failure to success block (#1262)
* buffer_room_objs missed split components with leading stream tags (#1284)
* common-items.rb - get_item_unsafe false positives via XML feed verification (#1286)
* forward vitality and dead fields in perceive_health (#1288)

### Bug Fixes (gs)
* Infomon xmlparser additional npc death messaging (#1275)
* Infomon xmlparser additional npc death messaging (#1281)
</PRE>
'''5.16.0'''
<PRE>
### Features (general)
* session summary store and reporting (#1247)
* add core classes, ScriptSync, and login auto-sync (#1273)
* Add active sessions API (#1274)
* Add session status CLI query (#1276)
* configurable debug log retention (#1282)

### Features (dr)
* common-healing.rb - add vitality parsing to HealthResult (#1265)

### Bug Fixes (general)
* handle auth exceptions in manual login to prevent hang on bad password (#1267)
* set SO_REUSEADDR before bind to allow immediate port reuse (#1268)
* Persistent Launcher re-enable play button post launch (#1269)
* Restore manual login behaviors to not require saved entry t... (#1270)
* log and re-raise unexpected errors in saved login auth handler (#1271)

### Bug Fixes (dr)
* common-items.rb - move pattern from failure to success block (#1262)
* buffer_room_objs missed split components with leading stream tags (#1284)
* common-items.rb - get_item_unsafe false positives via XML feed verification (#1286)

### Bug Fixes (gs)
* Infomon xmlparser additional npc death messaging (#1275)
* Infomon xmlparser additional npc death messaging (#1281)
</PRE>
'''5.15.1'''
<PRE>
### Bug Fixes (general)
* Mutli-launch persistent login GUI (#1245)
* Remove Windows OS CMD prompt flash (#1255)
* guard against broken pipe errors in Game._puts and send_to_client (#1260)
* add timeout safety to fput to prevent infinite hangs (#1261)

### Bug Fixes (dr)
* anchor stow success pattern to prevent fan close recovery bypass (#1254)
* add bounded recursion depth limits to 9 methods (#1257)
* stow_helper failure detection + unload_weapon ammo recovery (#1259)
</PRE>
'''5.15.0'''
<PRE>
### Features (general)
* add InstanceSettings for core Settings API access (#1233)

### Features (gs)
* Overwatch module into core (#1201)

### Bug Fixes (general)
* fix GameObj container initialization and add clear_all_containers (#1226)
* GameObj object dedupe & GC (#1234)
* script.rb show Script.kill source (#1235)
* Exit quickly on CLI authentication failure (#1237)
* suppress wine detection noise and skip when unneeded (#1244)

### Bug Fixes (dr)
* DR modules fixes and enhancements (#1232)

### Bug Fixes (gs)
* psms.rb add additional failure matches (#1238)
* Bounty parser fix regex pattern for skin retrieval task (#1242)
</PRE>
'''5.14.2'''
<PRE>
### Bug Fixes (general)
* add retry with exponential backoff for all login authentication (#1205)
* update.rb allow for bugfix betas and branch updates (#1211)

### Bug Fixes (gs)
* infomon.rb bug in _key transformation (#1216)
</PRE>
'''5.14.1'''
<PRE>
### Bug Fixes (general)
* Change server_time_offset in XMLParser to be float instead of int (#1184)
* change encodings in main.rb to wizard FE only (#1199)

### Bug Fixes (gs)
* Infomon parser.rb update Account.subscription/type (#1192)
* spell.rb add last_cast to track last time casted (#1193)
* stash.rb additional improvements with ReadyList/StowList (#1197)
* Infomon parser.rb bug in EnhanciveEnd (#1198)
</PRE>
'''5.14.0'''
<PRE>
### Features (general)
* Add Genie map cross-reference fields to the DragonRealms map data model (#1169)

### Features (dr)
* DRExpMonitor move into core lich (#1154)

### Features (gs)
* add Enhancive module for enhancive item bonus tracking (#1113)
* add QStrike module for optimal stamina-based RT reduction (#1114)

### Bug Fixes (general)
* remove strip! from settingsInfo replacement (#1161)
* map_base.rb sort JSON better (#1171)

### Bug Fixes (dr)
* logbook_item recovery when crafted item not in hand (#1175)

### Bug Fixes (gs)
* xmlparser.rb capture additional death messaging (#1158)
* stash.rb ReadyList sheath handling and update inventory checks (#1166)
</PRE>
'''5.13.6'''
<PRE>
### Bug Fixes (general)
* allow --add-account to run without yaml and dat (#1143)
* enable --login for multi-variable custom launch commands (#1144)
* update.rb pervent update if MIN_RUBY not met (#1146)
* messaging.rb return "" for xml_encode with Wizard (#1147)
* prevent closing connection on module reload (#1148)
* Allow hmr to work on global_defs.rb (#1156)

### Bug Fixes (dr)
* buffer split room obj lines and merge instead of appending closing tag to broken line (#1149)
* add buffering for multiline room players (#1151)
* add verify_script def here instead of depending on dependency (#1155)

### Bug Fixes (gs)
* infomon.rb added updated_at field to upsert_batch (#1145)
* stowlist.rb check method fix when dead (#1152)
* readylist.rb check method fix when dead (#1153)
</PRE>
'''5.13.5'''
<PRE>
### Bug Fixes (general)
* util.rb only show gem installing debug messaging if gem mis… (#1131)
* add --gs and --dr, refactor argv_options to helpers (#1133)
* fix multiple custom entries, improvements to yaml save (#1134)
* login_tab_utils.rb expand helper text show Warlock (#1135)
* update CLI for YAML security signature, add auto-convert fo… (#1136)
* remove password parameter from debug logging in all cases (#1137)
* reduce minimum GUI window footprint for non-tabbed view (#1138)
* remove double save in YAML to preserve yaml.bak integrity (#1139)

### Bug Fixes (gs)
* stash.rb additional improvements (#1132)
</PRE>
'''5.13.4'''
<PRE>
### Bug Fixes (general)
* force system gem install if RubyGems fails (#1126)
* gui_login prevent destroying window if already destroyed (#1127)
* add window size / position saves to login GUI (#1128)
* non tabbed saved entries in reduced button / font size (not… (#1129)
</PRE>
'''5.13.3'''
<PRE>
### Bug Fixes (general)
* account manager sorting GUI fix (#1123)
</PRE>
'''5.13.2'''
<PRE>
### Bug Fixes (general)
* install_gem_requirements update available gems after install (#1120)
</PRE>
'''5.13.1'''
<PRE>
### Bug Fixes (general)
* password_cipher.rb upcase account_name for key (#1118)

### Bug Fixes (dr)
* validator.rb change sleep to should_sleep named param (#1116)

### Bug Fixes (gs)
* add base stats capture from 'info full' command (#1115)
</PRE>
'''5.13.0'''
<PRE>
### Features (general)
* Refocus Frontend (#960)
* socket configurator to better guard TCPSocket (#976)
* add simplified DB maintenance (#991)
* TextStripper module support for XML, HTML, Markdown (#1055)
* Login modernization and refactor to yaml (#1063)
* Ruby Memory Releaser module (#1066)

### Features (dr)
* support meta:trashcan tag for DRCI.dispose_trash (#966)
* Add GameObj.inv support for DR items (#1080)
* DRCS allow custom adjective for summoned weapons (#1088)
* DRParser support for new exp window xml stream elements (rested exp, tdps, favors) (#1104)

### Features (gs)
* Add Armaments (Weapon, Armor, and Shield) Module (#911)
* add creature module, including Hinterwilds creatures (#1002)
* Creature module combat tracking (#1003)
* track time of last total_experience record (#1030)
* add Injured class for checking ability to perform actions (#1035)

### Bug Fixes (general)
* map dijkstra optimization (#1061)
* update.rb keep script/data file incase of error on update (#1070)
* ensure proxy path is set for non-destructive array write-th… (#1073)
* [lib][global-defs] - move update (#1079)
* GameObj force new objects ID to be string (#1087)
* xmlparser.rb gate GSL exits sending behind @send_fake_tags (#1103)
* change Hash[] pair key conversion to use to_h for Ruby 4.0 (#1108)
* move gui-login.rb to Ruby standard gui_login.rb (#1111)
* update location for currency and move game-loader.rb to Ruby standard gameloader.rb (#1112)

### Bug Fixes (dr)
* DRCA allow custom spell prep messaging (#1089)
* Update Slackbot error handling, and lnet management (#1091)
* Fix exp mods parsing for DR (#1102)
* equipmanager.rb support for custom messaging in forester's longbow (#1105)
* Fix hang in equipment manager when game doesn't respond to commands (#1110)

### Bug Fixes (gs)
* Infomon additional CHE resign regex (#1067)
* Resource tracking for sorcerer shadow essence (#1085)
* cman.rb add hamstring regex for already lying down target (#1090)
* cman.rb hamstring regex update when can't perform on target (#1092)
* Bounty parser.rb FWI guard regex update (#1096)
* currency.rb track gold (#1109)
</PRE>
'''5.12.12'''
<PRE>
Bug Fixes (general)
Update module strip markdown comments (#1056)
Vars/UserVars module fixes and corrections (#1057)
Bug Fixes (gs)
Infomon parse fix for singular currency (#1051)
</PRE>
'''5.12.11'''
<PRE>
Bug Fixes (dr)
add bput match for system updates preventing actions (#1034)
drdefs.rb npc parsing (#1038)
Fix container reference in get_item_from_eddy_portal method (#1039)
Bug Fixes (gs)
bounty location regex needs to match "under" (#1037)
</PRE>
'''5.12.10'''
<PRE>
Bug Fixes
all: games.rb catch additional error for nested single/double quotes (#1031)
dr: change keys for DR_SKILLS_DATA[:guild_skill_aliases] to be strings instead of symbols (#1032)
gs: Bounty parser for SG npcs matching (#1027)
gs: match READY/STOW items with a/an/some inside the link (#1026)
</PRE>
'''5.12.9'''
<PRE>
Bug Fixes
gs: StowList/ReadyList reset bug if non-default keys added #1019
</PRE>
'''5.12.8'''
<PRE>
Bug Fixes
all: script.rb show custom at script exit as well (#993)
all: Updated update.rb for single trunk and release please (#1001)
</PRE>
'''5.12.7'''
<PRE>
fix(all): ensure updates do not target detached proxy views #990
fix(gs): bounty parser and move fixes for sailor's grief #987
fix(gs): Infomon xmlparser.rb Ready/Stow fix for LONG before exist #988
fix(gs): gameobj.rb for Sailor's Grief ghostly/boss/guild tentacles #989
</PRE>
'''5.12.6'''
<PRE>
fix(all): settings.rb update to preserve root of derived views #975
fix(all): show custom in various script output when custom script #967
fix(dr): drparser.rb update for PlayedSubscription #983
fix(gs): include store location for ReadyList #977
fix(gs): infomon parser.rb update for ACCOUNT output varies #979
fix(gs): global_defs.rb move def update for Hive traps #980
fix(gs): activespell.rb prevent removal of RF Penalty #981
fix(gs): add .compact to input of Disk.find_by_name #982
</PRE>
'''5.12.5'''
<PRE>
fix(all): update.rb word boundary for abbreviations #971
fix(dr): equipmanager.rb Fix for changed game output. #969
fix(dr): common-arcana.rb Regalia fix for changed game output. #970
fix(dr): common-items.rb Fix for changed inventory command output #973
fix(gs): StowList missing space in capture in xmlparser.rb #963
fix(gs): stowlist.rb wait for RT when issuing check #964
fix(gs): readylist.rb wait for RT when issuing check #965
fix(gs): Bounty heirloom return msg'ing update #972
</PRE>
'''5.12.4'''
<PRE>
build(all): installer.yml use windows-2022 #950
fix(all): restore Wrayth / Wizard script execution ability #952
fix(all): database_adapter.rb error handling improvement #956
fix(dr): common-items.rb wear/remove messaging additions #949
fix(dr): games.rb - ignore UIDs for Frostbite mapping #951
fix(dr): map_dr.rb prevent inadvertent settings changes #958
fix(gs): GameObj targets for new Sailor's Grief tentacle npc #948
fix(gs): map_gs.rb remove delete_if to prevent bad settings #957
fix(gs): weapon.rb assault break if no targets #962
</PRE>
'''5.12.3'''
<PRE>
fix(all): limitedarray.rb max_size increase #946
fix(all): uservars.rb update for vars method missing #940
fix(dr): drparser.rb to set ShowRoomID to on if turned off #945
fix(gs): change namespace accessors to Ruby 2.6 compatible #944
fix(gs): infomon state reset on status prompt #943
fix(gs): Societies to check membership for various methods #942
fix(gs): standardize warcry.rb to match other PSMS #941
</PRE>
'''5.12.2'''
<PRE>
fix(gs): infomon parser.rb for profile full name matching #938
fix(gs): force PROFILE FULL to sync CHE info for infomon #937
fix(dr): Tighten checks on releasing invisibility for thieves #936
</PRE>
'''5.12.1'''
<PRE>
- fix(all): gameobj.rb - add type? method for explicit type check #928
- fix(all): messaging.rb encoding issue #933
- fix(gs): Various CMan cost corrections #932
</PRE>
'''5.12.0'''
<PRE>
- feat(all): settings.rb - proposal for sequel based Settings #591, #875, #889, #896, #927
- feat(all): util.rb add Ruby gem install helper method #861
- feat(all): messaging.rb add cmd link method #866
- refactor(all): games.rb modernization #849, #882, #924
- fix(all): add class extensions #800
- fix(all): lich.rb deprecated FE message #852
- fix(all): messaging.rb fix XML encoding for wizard and avalon #853
- fix(all): lich.rb class variable not initialized #855
- fix(all): log.rb force msg to String for regexp comparison #856
- fix(all): global_defs.rb bug in fput #864
- fix(all): messaging.rb xml_encode mono method msg #868
- fix(all): script.rb class to is_a? checks #878
- fix(all): gameobj.rb deeper lookup #885
- fix(all): messaging.rb debug not compared to falseclass #887
- fix(all): change class to is_a? checks #91-3
- fix(all): Util.issue_command allow single line captures #918
- fix(dr): drparser.rb casing for Premium status check #842
- fix(dr): map_dr.rb Don't assign UID of zero to rooms #844
- fix(dr): drparser.rb add $last_logoff tracking #851
- fix(dr): update message patterns in common-items #859
- fix(dr): add moon_visible?(moon) convenience method to common-moonmage #860
- fix(dr): exp mods output is not enclosed in preset xml tags anymore #870
- fix(dr): update.rb beta send validation for genie lich char #880
- fix(dr): Update regex and parsing for active spells #894
- fix(dr): add 'You scoop' match pattern to common-items #900
- fix(dr): add missing match patterns #901
- fix(dr): common-items: add and fix match strings #904
- fix(dr): Add missing matches for common-items #905
- fix(dr): Release Khri Vanish if Thief, when going visible #906
- fix(dr): Fix race condition when clearing and repopulating XMLData.dr_active_spells #907
- fix(dr): Fix SLS release pattern #908
- fix(dr): resolve race condition in DR crafting_magic_routine #914
- fix(dr): xmlparser.rb - Fix XMLData.dr_active_spells race condition #915
- fix(dr): xmlparser.rb - Clear out spells properly #916
- fix(dr): drparser.rb update for Platinum account status #922
- feat(gs): gameobj.rb allow for custom gameobj data #848
- feat(gs): PSMS updates, including CMan.use #865, #874, #881, #890, #899
- feat(gs): ReadyList & StowList classes for item tracking #884
- feat(gs): Breakout and Buildout Societes #919
- fix(gs): infomon parsing for CHE membership #841
- fix(gs): map_gs.rb for no UID when hexdigest used #843
- fix(gs): warcry.rb yowlp :buff to string instead of regexp #847
- fix(gs): group.rb multiple corrections #850, #869, #883
- fix(gs): Bounty parser.rb fix for HW & KF guard return #862
- fix(gs): Bounty task.rb fix for assigned? and Ruby 2.6 #863
- fix(gs): stash.rb stale sheaths recheck #867
- fix(gs): allow spell.rb casting to take a force_stance parameter #902
- fix(gs): update Infomon parsing for new ACCOUNT output format #903
- fix(gs): PSMS cost for multiple cost types & add Excoriate feat #912
- fix(gs): Feat excoriate regex correction #920
- fix(gs): weapon PSM affordable check against Glorious Momentum #926
</PRE>
'''5.11.1'''
<PRE>
- fix(all): restore @theme_state and add to CLI capability #795
- fix(all): retire gtk2 monkey patch for gtk3 #823
- fix(all): games.rb XMLData.name wait till both not NIL and not EMPTY #826
- fix(all): standardize xmlparser game instance #827
- fix(all): games.rb fix multiple single and double quote in XML #832,836,837
- fix(dr): games.rb - optional hide Room Title display of Real IDs with FLAG on #782
- chore(dr): common-moonmage - refactor of peer_telescope #783
- fix(dr): move HMR load to common before for dragonrealms #784
- fix(dr): common-crafting.rb minor edit to add "You tuck" #787
- fix(dr): common-arcana.rb - remove unecessary pause from discern code #792
- fix(dr): drparser.rb Restore Premium status checking #834
- fix(gs): migrate PSMS.name_normal to Lich::Util.normalize_name #790,833
- fix(gs): add Char.che to know current character's CHE #791
- fix(gs): FEAT and Infomon module parsing of new Covert Art feats. #796
- fix(gs): add Currency.gemstone_dust and fix redsteel mark capture #797
- fix(gs): FEAT Covert Arts colon normalization and stamina costs #799
- fix(gs): escape dash in regex for HouseCHE #824
- fix(gs): disk.rb comparison helpers #828
- fix(gs): allow for Group.disks to show self disk in array #829
- fix(gs): feat.rb Covert Arts throw poison costs 15 stam #830
- fix(gs): add missing Feat.use ability #831
- fix(gs): multiple CritRanks updates #801-822
</PRE>
'''5.11.0'''
<PRE>
- [all] - chore: Namespace & File Path Updates #713
- [all] - [argv_options.rb] bugfix: correct darkmode to work via CLI #693
- [all] - [games.rb] feat: make show Room Exits of non-StringProc/Obvious Exits toggable for all games #699
- [all] - [games.rb] feat: toggleable display of StringProcs with clickable links #751
- [all] - [gui-manual-login.rb] fix: change label to Wrayth #720
- [all] - [gui-saved-login.rb] fix: update Stormfront label #721
- [all] - [update.rb] fix: purge old LIB folder prior to update release #729
- [all] - [util.rb] bugfix: allow issue_command to use fput or put #715
- [all] - [xmlparser.rb] feat: add XMLData.room_name attribute #685
- [all] - [main.rb] fix: create session file in regular connect method #733
- [all] - [init.rb] bugfix: error for Windows DISPLAY variable #735
- [all] - [main.rb] fix: Mudlet support #736
- [all] - [wine.rb] fix: add --no-wine CLI flag prevent WINE startup
- [all] - [init.rb] fix: add --no-gtk CLI flag prevent GTK3 gem load
- [dr] - [games.rb] feat: DRinfomon and common files as core lich libraries #686
- [dr] - [games.rb] chore: add DR requires here #690
- [dr] - [games.rb] fix: add Room# display for DR #697
- [dr] - [games.rb] bugfix: Genie FE real ID#s not supported, hide by default #728
- [dr] - [drdefs.rb] bugfix: fix for Shadow Servants #710
- [dr] - [map_dr.rb] fix: cleanup and support for UIDs #719
- [dr] - [xmldata.rb] bugfix: add support for DR Room IDs #716
- [dr] - [xmlparser.rb] feat: XMLData - adding dr_active_spells #691
- [gs] - [games.rb] bugfix: support for pre/post room name txt #683
- [gs] - [group.rb] chore: update to account for hold #701
- [gs] - [resource.rb] feat: add additional tracking of covert art charges #714
- [gs] - [spell.rb] bugfix: Spell.affordable? 515 release #687
- [gs] - [stash.rb] bugfix: sheath_bags when not found #694
- [gs] - [xmlparser.rb] bugfix: missing real ID in nav #684
- [gs] - [xmlparser.rb] bugfix: Claim module obvious hiding #717
- [gs] - [sk.rb] feat: Self-Knowledge functionality in core #748
</PRE>
'''5.10.4'''
<PRE>
-o- [GS4] - [xmlparser.rb] bugfix: Simu XML breaking change RoomID #679
</PRE>
'''5.10.3'''
<PRE>
-o- [GS4] - [crit_tables] fix: CritRanks regex fixes (multiple files and changes) #671
-o- [GS4] - [spellsong.rb] fix: Correct Spellsong sync method #674
-o- [GS4] - [parser.rb] fix: thorn status regex correction #673
-o- [All] - [xmlparser.rb] fix: Split out if elif block to account for DR having multiple… #670
-o- [All] - [global_defs.rb] fix: percentconcentration #676
-o- [All] - [global_defs.rb] fix: update move failure message to handle attack and casting #667
-o- [All] - [init.rb] fix: update required ruby check messaging #669
-o- [All] - [sessionvars.rb] feat: new module SessionVars for non-persistent variable storage #666
</PRE>
'''5.10.2'''
<PRE>
-o- [DR] - [games.rb] bugfix: tweak XML rewrite section #662
-o- [GS4] - [crit_tables] bugfix: additional crit table regex corrections #663
-o- [GS4] - [ascension.rb] bugfix: add new Transcend Destiny to lookups #661
-o- [GS4] - [effects.rb] bugfix: regexp escape txt #660
-o- [GS4] - [disruption_critical_table.rb] Bugfix in regex #659
</PRE>
'''5.10.1'''
<PRE>
-o- [All] - [games.rb] bugfix: prevent race condition in games thread #656
-o- [All] - [init.rb] bugfix: address WINE variance between linux / installs #655
-o- [GS4] - [gs][stash.rb] bugfix: wear code improvement #657
</PRE>
'''5.10.0'''
<PRE>
-o- [All] - [main.rb] bugfix: correct encoding for WizardFE PR #640
-o- [All] - [games.rb] bugfix: correct logic for room detection when using CLI --start-scripts PR #639
-o- [All] - [DB_Store.rb] feat: add direct support for Simu RENAME and CHANGE PROF PR #633
-o- [All] - chore: breakout code to individual files for easier management PR #617
-o- [All] - [lich.rbw] chore: add deprecated msg to old Settings/GameSettings/CharSettings methods PR #589
-o- [All] - [lich.rbw] feat: add new --dark-mode CLI option PR #583
-o- [All] - [global_defs.rb] bugfix: monsterbold fix for additional clients PR #581
-o- [All] - [update.rb] feat: update core scripts from source on Lich5 update/install PR #579
-o- [All] - [log.rb] feat: add new Log module copied from Olib PR #577
-o- [All] - [numeric.rb] feat: add days/hours/minutes/seconds methods to numerics PR #623
-o- [All] - [messaging.rb] feat: WizardFE Voln window support #647
-o- [All] - [init.rb] bugfix: WINE entries for Linux / MacOS #649
-o- [DR] - [lich.rbw] bugfix: cleanup downstream hook exclusions PR #593
-o- [DR] - [global_defs.rb] bugfix: missing climb failure message PR #592
-o- [GS4] - [effects.rb] bugfix: show non-standard Effects in `;magic` output PR #641
-o- [GS4] - [parser.rb] bugfix: fix WARCRY duplication results / add WALL OF THORNS effect detection PR #634 / PR #637
-o- [GS4] - [critranks.rb] feat: add critical rank resolution tables and methods PR #625
-o- [GS4] - [effects.rb] bugfix: to support regex for active? & time_left PR #590
-o- [GS4] - [infomon.rb] bugfix: add implicit NPC death monitoring PR #588
-o- [GS4] - [infomon.rb] bugfix: change PSM to be stored as type.mnemonic PR #587
-o- [GS4] - [lich.rbw] bugfix: strip_xml multiline fix PR #584
-o- [GS4] - [stash.rb] bugfix: fix sack detection to use Stash.container(param) PR #578
-o- [GS4] - [spell.rb] feat: Spell.after_stance #644
-o- [GS4] - [xmlparser.rb] bugfix: for Claim module #646
-o- [GS4] - [infomon] feat: track Voln favor via RESOURCE output #648
-o- [GS4] - [gameobj.rb] feat: add Bandit hidden target API #650
</PRE>
'''5.9.2'''
<PRE>
-o- [GS4] - [group.rb] bugfix: proper leader detection from GROUP output
-o- [GS4] - [char.rb] bugfix: add back depracted Char.maxvitals with msging to switch to new Char.max_vitals methods
</PRE>
'''5.9.1'''
<PRE>
-o- [GS4] - [group.rb] bugfix: group.check syntax change
-o- [GS4] - [spell.rb] bugfix: affordable? Char.mana parenthesis logic
</PRE>
'''5.9.0'''
<PRE>
-o- [All] - feat: sqlite3 gem syntax code cleanup PR#553
-o- [All] - [lich.rbw] bugfix: remove unused Setting, GameSetting, CharSetting PR#542
-o- [All] - [lich.rbw] bugfix: scrub login key from error message popups PR#548
-o- [All] - [messaging.rb] bugfix: color mismatch WizardFE white txt PR#554
-o- [All] - [lich.rb] feat: add new Lich.deprecated method to aid in deprecating older API calls PR#523
-o- [GS4] - [char.rb] feat: log method_missing calls PR#552
-o- [GS4] - [char.rb] feat: add missing global_def related methods PR#523
-o- [GS4] - [global_defs.rb] feat: deprecate various Char module methods PR#523
-o- [GS4] - [spellsong.rb] bugfix: cache spellsong duration calc PR#551
-o- [GS4] - [effects.rb] feat: Effects module breakout PR#549
-o- [GS4] - [group.rb][disk.rb] feat: Group & Disk class PR#532
-o- [GS4] - [activespell.rb] feat: add duration change messaging, off by default, see ;help for details PR#487
</PRE>
'''5.8.1'''
<PRE>
-o- [All] - [lich.rbw] feat: add Game:Character to debug log file ouput
-o- [All] - [init.rb] feat: add milliseconds to debug filename
-o- [GS4] - [lich.rbw] bugfix: reorder parsing of $SERVERSTRING to avoid certain conflicts
-o- [GS4] - [parser.rb] bugfix: update for new Empath resource and sleep/bind messaging
-o- [GS4] - [status.rb] bugfix: bound? calmed? and sleeping? support for spellnames flag being off
-o- [GS4] - [xmlparser.rb] bugfix: additional creature dying messaging to check against XML dead not being sent
-o- [GS4] - [gameobj.rb] bugfix: remove sorcerer arms and animates from GameObj.targets
</PRE>
'''5.8.0'''
<PRE>
-o- [All] - Ruby 3.3 compatibility
-o- [All] - [lich.rbw] feat: adds .sources for up/downstream hooks
-o- [All] - [lich.rbw] bugfix: don't use WINE for custom frontends
-o- [GS4] - [char.rb] bugfix: add back Char.stance
-o- [GS4] - [claim.rb] feat: new module and associated changes to xmlparser
-o- [GS4] - [experience.rb] feat: percent experience options
-o- [GS4] - [parser.rb] bugfix: allow for negative TNL exp value
-o- [GS4] - [parser.rb] bugfix: allow hyphenated last names in character names
-o- [GS4] - [parser.rb] feat: update resource matching for new Bard service
-o- [GS4] - [stash.rb] bugfix: catch more shield removal messages
-o- [GS4] - [util.rb] bugfix: underscore issue for PSMs
</PRE>
'''5.7.0'''
<PRE>
-o- Supports Ruby 3.2 - security enhancements and huge speed improvements for regex
-o- New libraries/modules/classes: Account, HMR (Hot Module Reloading)
-o- GS4 Infomon now baked into Lich5 as a library, no more need to run standalone script
-o- New GS4 libraries/modules/classes: Ascension, Bounty, Currency, Experience, Resources, Society, Status, Warcry
-o- Updates to existing libraries/modules/classes: Armor, Util, Weapon, Spell, GameObj, Messaging
-o- Several Bugfixes for lots of things
-o- Lots of code cleanup
</PRE>
'''5.6.2'''
<PRE>
-o- Fix for XML errors
-o- Adds the DR Plat instance for Frostbite FE
-o- Adds ‘ball’ as the noun used for ‘ball and chain’
-o- Adds the movement result ‘slip in the mud and fall flat’
-o- Corrects stamina cost for the feature Dispel Magic
-o- Plus all the latest script updates from Elanthia-Online!
</PRE>
'''5.6.1'''
<PRE>
-o- Fix for XML to limit login errors (DR)
-o- Fix for XMLData.active_spells to properly register wizard 'recovery' spell cooldowns
-o- Messaging updates to remove error in Wizard FE encodings
-o- Corrects for error in detecting PSM skill changes (cman) via warrior / rogue guild lessons
-o- Deprecates LNet script from master repository
-o- Miscellaneous small bug squashing
</PRE>

'''5.6.0'''
<PRE>
-o- (DragonRealms) Support for Genie and Frostbite frontends
-o- (GemStone) Changed methods to improve ;go2 speed and reduce lich.db3 calls
-o- (GemStone) Updates to support silver_count function
-o- (Both) Changed method for updating lich ecosystem
</PRE>

'''5.5.0'''
<PRE>
-o- Support for DragonRealms
-o- Updated support for scripts like BigShot
-o- Providing the LichID and UID on Profanity
-o- Spell.force_incant, .force_channel, and .force_evoke
-o- Standardized message method for script authors
-o- Sundry small improvements / fixes and changes
-o- And the creme de la creme - a custom directory
</PRE>

'''5.4.0'''
<PRE>
-o- Simu Room IDs (formally called 'unique ID' or 'uid' for Lich) added to Map, mapDB where known, and ;go2 for navigation (courtesy Xanlin and with our thanks!) ;go2 u7120 for all you ex-GMs out there.
-o- Room titles will now display the Lich ID and / or the UID for the room based on user selections - default is on for both, and enabled / disabled via Lich.display_lichid or Lich.display_uid toggles that can be set to on / off or true / false. (;e Lich.display_lichid=true/false and ;e Lich.display_uid=true/false) You can remove that rnum from your autostart now! To gain the benefit of the UID deployment, be sure to ;repo download-mapdb
-o- REQUESTS: Drop 5 minute timeout function from Lich
-o- waitrt? and waitcastrt? will still pause activities, but will return TRUE or FALSE in keeping with the Ruby functionname? tradition (no more failing to get a weapon out due to RT from climbing!)
-o- empty_hands and fill_hands will now check to see if the character is in roundtime before trying to put away or retrieve held items
-o- Infomon received an update that keeps spell timers in sync with the information received from the server - no more need to immediately do a spell active in game to get the right times to display for various legacy scripts and ;magic after visiting the invoker or using an SK item
-o- Lich now provides a facility to get current coins on the character that is a bit more agnostic to data changes from Simu - Lich::Util.silver_count
-o- Various other small tidbits to help ease maintenance and future development
-o- PLEASE NOTE: This update is required for the newest Bigshot (released today!) and for future eloot and eherbs scripts (release RSN)
</PRE>

'''5.3.0'''
<PRE>
-o- Added support for Wrayth (renamed Stormfront) installations
-o- Converted Linux | WINE login methods to 'method 0', does not use Simu launcher
</PRE>

'''5.2.1'''
<PRE>
-o- Support for STOWing items irrespective of special item scripts
-o- Improved query support for Effects and CMans
-o- Fix Lich bug to respect the 'groupmovement' flag in game
-o- Fix Lich round time calculations (more aggressive timing)
-o- Dark Mode is now a thing
-o- Lich4 Style GUI layout available
-o- Several file location changes to support future code change efforts
</PRE>

'''5.0.19'''
<PRE>
-o- Benefit: Monks with Mental Acuity (all 3 of you) rejoice - stamina casting!
-o- Benefit: PSM3 included, no charge. No hair remaining, either!
-o- Benefit: Ok, stay seated: Some of your various SF spell duration windows may work. . . better? Yes, not perfect, but better. No pictures, please!
-o- Updated infomon that properly detects Cloak of Shadows on those pesky sorcerers, and the Raise Dead Cooldown periods for those wondrous clerics.
-o- A new update process for Lich 5 - tired of having to download that script over and over just to update? Get yourself a copy of lich5-update.lic. Note, if you already have it, you're set! If not - ;jinx script install lich5-update --repo=elanthia-online
</PRE>

'''5.0.11'''
<PRE>
-o- Updated the method used to log onto SIMU servers.
-o- Added the Animalist item specifics to Lich5's empty and fill hands routines
-o- Improved Invoker messages for Avalon and Wizard FEs (no change for SF FE)
-o- Improved cleanup and store methods when player EXIT's or QUIT's game
-o- Crafted two new methods (stash_hands and equip_hands) for future script use
-o- Some behind-the-scenes cleanup to improve maintaining the Lich5 ecosystem
-o- Add Spell Active improvements
-o- Add PSM and Ranger improvements
</PRE>
</div>

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

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

Lich:Software

2026-10-28T13:13:05Z

WHIGHTCNIGHT: Undo revision 267455 by WHIGHTCNIGHT (talk) wrong page... oops

{{3rd-party}}
<div class="alert alert-info"><center>'''{{mono|;TUNE TOWNCRIER }}to join the TownCrier channel and get GS news and tips every five minutes. There is no chat on this channel.'''</center></div>

===About===
<section begin=About />
'''The Lich''' is third-party software that expands scripting capabilities on Simutronics front end clients ([[Wizard (front end)|The Wizard]] and [[Wrayth]] for Windows users, and [[Avalon]] for Mac OS X users), allowing players to script using the Ruby Programming Language, a high-level programming language with almost limitless capability. The program comes bundled with several scripts, such as scripts that calculate a character's [[redux]], move from any location to another within a database, walk through an area until a creature is found, and spell up a character using all available spells. Also, there is a repository that allows for the quick, easy downloading of user-made scripts through The Lich, itself. Scripts can range from being very simple to quite advanced; for example, there is a script, titled xpSF, that modifies the experience window in Wrayth to display additional information about the character's experience level that updates itself when experience is gained. <section end=About />

<div {{prettydiv}}>

<CENTER>{{boldmono|<tt>Installation Guides</tt>}}</CENTER>

* '''Windows'''
** [[Lich_(software)/Installation#Windows|Windows]]
*'''Mac'''
** [[Mac_Installation_-_Lich_(software)|Mac OS X]]
* '''Linux'''
** [[Lich_(software)/Installation#Chromebook_.26_Debian_variants|Chromebook & Debian Variants]]
** [[Lich_(software)/Installation#Fedora|Fedora Installation - Lich (software)]]
</div>

==What is "Lich"?==
Lich is an open source scripting engine for text-based MUDs. It is not a complete front-end in and of itself: it operates much like a proxy server and communicates with the user through their chosen front-end (effectively giving the appearance of expanding the front-end's features with its own). It allows you to write and run scripts for a text-based MUD in the Ruby language.
==How Does Lich Function==
Lich defaults on Windows to a Lich 5 folder on your desktop. Lich launches by double clicking on the lich.rbw file. Folders are created inside the Lich 5 directory, the primary ones of user interest are the <CODE>/scripts</CODE> directory and the <CODE>/data</CODE> directory. Scripts contains user downloaded scripts and the Data directory contains information used by lich. The most notable items here are <CODE>alias.db3</CODE>
<CODE>entry.dat</CODE>
<CODE>lich.db3</CODE> which contains all your user information. This file should be backed up often, preferable with something like ;Lich Script:

Lich was originally created by [http://lichproject.sourceforge.net/ Shaelun], who brought it up from an idea to version 3.57. Starting with version 3.58 through 4.6.56, Lich was maintained by [http://lichproject.org/ Tillmen]. Tillmen's versions focused more heavily on Simutronics games, specifically Gemstone IV. If you are interested in non-Simutronics games, you might be better served with Shaelun's version. Starting with Lich v5, Lich has been forked over by the team at [https://github.com/elanthia-online/lich-5/ Elanthia-Online] to update and continue development in a collaborative format with contributions from both GemstoneIV and DragonRealms contributors. Current [[Lich_(software)/Installation|installation]] instructions now use Lich v5.

==How do I use it==
Lich itself doesn't do much. At it's core, it parses incoming XML from the game and runs it through an engine. Scripts that a user downloads perform a varity of functions with that information.

{{#section:Lich:Script Repository|popularscripts}}

==F.A.Q and Common commands.==
'''Q: Where did my inventory windows go?'''
: A: If you use inventory windows in Wrayth, you’ll find they have disappeared the first time you run Lich on each character. Lich hijacks the setting to provide container contents to scripts. In doing so, it’s unable to tell what the setting was to start with, so it turns it off (from Wrayth’s point of view). Just type “set inv on” to turn it back on.

'''Q: Why do I keep disconnecting immediately after login?'''
: A: This generally happens on only one character, and affects only Wrayth. It seems to be caused by Wrayth downloading a characters settings from the Simu server. To fix it, change Wrayth to store scripts/highlights/macros/etc locally, or log in once on Wrayth without Lich to allow it to do whatever it’s trying to do.

'''Q: How come when I cast spells on people it doesn't tell the correct duration for the spell?'''
: A: This is due to not setting permissions correctly with LNet once logged in. In general, most people should be fine with typing: ;LNET ALLOW ALL ALL. This should allow anyone with Lich installed to detect your spell durations. It also allows other things, to see exactly what you can do type ;LNET HELP ingame and read over the output it provides.

'''Q: How do I enable or disable the various LichID or RealID in room description title?'''
: A: To enable/disable the LichID or RealID you would use one of the following commands in-game:
<syntaxhighlight lang="ruby">
# LichID
;display lichid <true|false>

# RealID
;display uid <true|false>
</syntaxhighlight>

==Resources==
* [[Lich scripting reference]]
* [[Lich:Script_Repository#Popular_Lich_Scripts | Popular Lich Scripts ]]
* [https://nisugi.github.io/lich-5-docs/ Lich 5 AI Generated Documentation]
* [https://deepwiki.com/elanthia-online/lich-5 Alternative AI Lich5 Generated Wiki]
* [https://lich-mapdb-room.ffng.xyz/ Mapdb Lookup Reference]
* [https://blue-tracker.duckdns.org Blue/GM Discord Post Tracker]
* [https://shops.elanthia.online/ New Playershops]
* [https://ps.lichproject.org/ Old Playershops]
* [https://discord.gg/KF9Wr8u GS Discord] #scripting channel for additional Lich Support

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

Lich:Software

2026-10-28T13:12:25Z

WHIGHTCNIGHT: update to include mention of Saga for MacOS and Linux

{{3rd-party}}
=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 Wrayth or Wizard FE. Lich is also used by many on both MacOS and multiple Linux distributions.

=Installing the Latest Stable Release=

'''The latest stable lich version is 5.22.0 supporting Ruby 4.0 - published October 8, 2026'''

==In-Place Upgrade==

If you are on an older version of Lich 5 and want to upgrade to the most current version, you can choose to either upgrade Lich5 only or both Lich 5 and Ruby. If you're currently on Lich 4, able to check by running the command <CODE>;e echo LICH_VERSION</CODE>, go to the [[#Upgrade Installation for Lich 5 from Lich 4 (11/14/2023)|upgrade from Lich 4 section]].

For each section, please follow the directions/commands one at a time.

===Lich 5 Only===

====Lich 5.7 or newer====
# You must be running Ruby 4.0 or greater for Lich 5.19 +. If unsure, please update both (see below)!
# '''Backup existing Lich 5 folder'''
# Run this command in-game <CODE>;lich5-update --update</CODE>
# Quit and restart lich.
# Congratulations - you're now running on the latest version of Lich!

====Lich 5.6 or older====
Please proceed to updating both Ruby and Lich 5

===Both Ruby 4.0 & Lich 5===
This method is for Windows only. Linux and MacOS users, please do a Lich 5 only update and update Ruby manually via normal install/update methods for the OS.

# Logout of all characters
# '''Backup existing Lich 5 folder'''
# Uninstall existing Ruby4Lich5 installs from Programs & Features control panel, or alternatively, rename your existing Ruby4Lich5 folder to Ruby4Lich5save. (Defaults to C:\Ruby4Lich5)
# Download the latest [https://github.com/elanthia-online/lich-5/releases/latest/download/Ruby4Lich5.exe Ruby4Lich5.exe Installer]
# Run the installer and be sure to have both Ruby and Lich 5 option selected
# Congratulations - you're now running on the latest version of Lich & Ruby!

===Ruby 4.0 Only===
Use this to upgrade to the newest version of Ruby only if you're already on the latest version of Lich5 and now want to update Ruby afterwards. If you're not already on the latest version of Lich5, please use previous section steps instead.
# Logout of all instances/characters
# '''Backup existing Lich 5 folder'''
# Uninstall your existing Ruby4Lich5 install via Programs & Features (ensure it's now gone, default location was C:\Ruby4Lich5)
# Download the latest [https://github.com/elanthia-online/lich-5/releases/latest/download/Ruby4Lich5.exe Ruby4Lich5.exe Installer]
# Run the new installer and choose to only install Ruby Only
# Congratulations - you're now running on the latest version Ruby!

==Windows New Installation==

{{blue|These instructions are not for DragonRealms. [[#Ecosystem Information|For those scroll to the bottom]].}}

'''For Windows 11 / 10 / 8 / 7''' users: you can download the [https://github.com/elanthia-online/lich-5/releases/latest/download/Ruby4Lich5.exe Ruby4Lich5.exe Installer] and install everything you need automatically. Click on the '''Ruby4Lich5.exe''' and download it to your computer then double click on the executable in your default download folder. Note, a user may need to adjust their browser or security settings to allow download and installation.
If you have never played before, follow the 'New Installation' instructions. If you have played before, and have used Lich before, follow the 'Upgrade Installation' instructions.

===New Installation for Lich 5 (11/14/2023)===

# '''Please log into the game of your choice through the Simutronics website first'''. Install the launcher (not SGE), and install your FrontEnd of Choice. The Wrayth FrontEnd is presently the supported FrontEnd, but Wizard will work as well, if you are nostalgic. After you've logged in, log out and continue.
# Download and Run the [https://github.com/elanthia-online/lich-5/releases/latest/download/Ruby4Lich5.exe Ruby4Lich5.exe 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, 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.

===Upgrade Installation for Lich 5 from Lich 4 (11/14/2023)===

This option is deprecated. Lich 5 architectures are not compatible with Lich 4. Back up your existing Lich 4 folder, uninstall any existing Ruby executables, and then follow the instructions for a new install above.

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

==MacOS==
There are two common options for playing Gemstone IV on a Mac: play natively with Saga (the official front end) or Avalon, or use virtualization software such as Parallels with Wrayth/WizardFE. Below are the options on how to do that.

===Native (Saga or Avalon)===
Players with Macs can use [[Mac_Installation_-_Lich_(software) | Installing Lich on Macs]] for installation help. That guide sets Lich up with [[Saga]], the official Simutronics front end (currently in beta), and also covers [[Avalon]]. This process works well for Mac OS Catalina and Big Sur. If you have not updated your Mac OS yet, these instructions may work depending on your actual version. If you run into a snag, follow the contact instructions provided.

===Parallels Windows===
With the latest releases of Ruby4Lich5 installer, you can now follow the normal Windows installation for both Intel and Apple silicon based Apple computers.

To install Wrayth/WizardFE, Lich, and Ruby via Parallels you will need to do a few various steps as outlined below. Please note, the rubyw file in C:\Ruby4Lich5\X.X.X\bin may be set to run in compatibility mode for windows 7. On an ARM Mac running parallels, this may causes Wrayth scripts not to run. Turning compatibility mode off in the rubyw file could fixe this issue if it was enabled.

The following steps are to be done AFTER you've successfully installed Wrayth/WizardFE and can login normally without Lich5 on the machine. Once you've done that and can successful connect normally, then follow these steps:
# Download and install [https://github.com/elanthia-online/lich-5/releases/latest/download/Ruby4Lich5.exe Ruby4Lich5.exe Installer] and use default options presented during install
# Double click the lich.rbw file that is now located in the extracted Lich5 location you did above. Login and play as usual.

==Linux==
Pick the subsection for your distribution below. Each one installs Ruby and Lich; front ends (Saga, Profanity and Warlock) are covered once in [[#Frontends|Frontends]] at the end, since their steps are the same on every distribution.

===Chromebook & Debian variants===
<div class="mw-customtoggle-debian" style="font-size:16px;overflow:auto;color:#0000FF">[Click to Expand]</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-debian">
The following steps should install Lich for users of Debian/Chromebooks. To also install a front end such as Saga, Profanity or Warlock, see [[#Frontends|Frontends]] at the end of the Linux section.

'''Step 1.'''
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 curl libssl-dev libyaml-dev libreadline6-dev zlib1g-dev libncurses5-dev libffi-dev libgdbm6 libgdbm-dev libsqlite3-dev git unzip libcairo2-dev libgirepository1.0-dev libgtk-3-dev gobject-introspection
</pre>

{{side box|NOTE: If you are updating an existing Ruby installation rather than installing from scratch, skip steps 2, 3, and 4. Instead, update your ruby-build with the following command, and then proceed to Step 5.<pre>git -C ~/.rbenv/plugins/ruby-build pull</pre>}}

'''Step 2.'''
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>

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

'''Step 4.'''
Download the tools to let rbenv install Ruby on its own, then install Ruby 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</pre>

'''Step 5.'''
<pre>rbenv install 4.0.9 -v
rbenv global 4.0.9
</pre>

Install Lich:
<pre>
cd ~
curl -L "https://github.com/elanthia-online/lich-5/releases/latest/download/lich-5.zip" -o temp.zip && unzip temp.zip -d ./ && rm temp.zip
</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 using the <tt>Gemfile</tt> included with Lich5 by running <tt>bundle install</tt>. The Gemfile also lists developer-only gems (the <tt>development</tt> and <tt>vscode</tt> groups) that you do not need, so tell Bundler to skip them first:
<pre>
echo "gem: --no-document" > ~/.gemrc
cd ~/Lich5
bundle config set --local without 'development vscode'
bundle install
</pre>
:<small>Note: <tt>bundle install --without ...</tt> no longer works; that flag was removed from the version of Bundler that ships with Ruby 4.0. Use <tt>bundle config set</tt> as shown above.</small>
</div>

===Arch Linux & Arch-based distributions===
<div class="mw-customtoggle-arch" style="font-size:16px;overflow:auto;color:#0000FF">[Click to Expand]</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-arch">
The following steps should install Lich for users of Arch Linux and Arch-based distributions (Manjaro, EndeavourOS, etc.). To also install a front end such as Saga, Profanity or Warlock, see [[#Frontends|Frontends]] at the end of the Linux section.

Update the system and install required dependencies:
<pre>
sudo pacman -Syu
sudo pacman -S --needed base-devel openssl libyaml readline zlib ncurses libffi gdbm sqlite git unzip curl gtk3 gobject-introspection
</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 4.0.9 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 4.0.9 -v
rbenv global 4.0.9
</pre>

Install Lich:
<pre>
cd ~
curl -L "https://github.com/elanthia-online/lich-5/releases/latest/download/lich-5.zip" -o temp.zip && unzip temp.zip -d ./ && rm temp.zip
</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 using the <tt>Gemfile</tt> included with Lich5 by running <tt>bundle install</tt>. The Gemfile also lists developer-only gems (the <tt>development</tt> and <tt>vscode</tt> groups) that you do not need, so tell Bundler to skip them first:
<pre>
echo "gem: --no-document" > ~/.gemrc
cd ~/Lich5
bundle config set --local without 'development vscode'
bundle install
</pre>
:<small>Note: <tt>bundle install --without ...</tt> no longer works; that flag was removed from the version of Bundler that ships with Ruby 4.0. Use <tt>bundle config set</tt> as shown above.</small>
</div>

===Fedora===
<div class="mw-customtoggle-fedora" style="font-size:16px;overflow:auto;color:#0000FF">[Click to Expand]</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-fedora">
The following steps should install Lich for users of Fedora. To also install a front end such as Saga, Profanity or Warlock, see [[#Frontends|Frontends]] at the end of the Linux section.

Lich 5 requires Ruby 4.0 or newer. The Ruby that ships with currently supported versions of Fedora is older than that (41 uses Ruby 3.3; 42 and 43 use Ruby 3.4), so these steps install Ruby 4.0.9 with '''<tt>[https://github.com/rbenv/rbenv rbenv]</tt>''' instead of using Fedora's Ruby.

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 cairo-devel curl gcc gdbm gdbm-devel gdk-pixbuf2-devel glib2-devel \
gobject-introspection-devel gtk3-devel libyaml-devel libffi-devel make ncurses-devel openssl-devel readline-devel \
redhat-rpm-config sqlite-devel unzip zlib-devel
</pre>

{{side box|NOTE: If you are updating an existing rbenv Ruby installation rather than installing from scratch, skip step 3. Instead, update your ruby-build with the following command, and then run only the <tt>rbenv install</tt> and <tt>rbenv global</tt> lines from step 3.<pre>git -C ~/.rbenv/plugins/ruby-build pull</pre>}}

3. Install rbenv and Ruby 4.0.9:
<pre>
git clone https://github.com/rbenv/rbenv.git ~/.rbenv
echo 'export PATH="$HOME/.rbenv/bin:$PATH"' >> ~/.bashrc
echo 'eval "$(rbenv init -)"' >> ~/.bashrc
source ~/.bashrc
git clone https://github.com/rbenv/ruby-build.git ~/.rbenv/plugins/ruby-build
rbenv install 4.0.9 -v
rbenv global 4.0.9
ruby -v
</pre>
The last command should print a line starting with <tt>ruby 4.0.9</tt>. If it doesn't, close and reopen the terminal and try <tt>ruby -v</tt> again.

4. Install Lich:
<pre>
cd ~
curl -L "https://github.com/elanthia-online/lich-5/releases/latest/download/lich-5.zip" -o temp.zip && unzip temp.zip -d ./ && rm temp.zip
</pre>

5. 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 using the <tt>Gemfile</tt> included with Lich5 by running <tt>bundle install</tt>. The Gemfile also lists developer-only gems (the <tt>development</tt> and <tt>vscode</tt> groups) that you do not need, so tell Bundler to skip them first:
<pre>
echo "gem: --no-document" > ~/.gemrc
cd ~/Lich5
bundle config set --local without 'development vscode'
bundle install
</pre>
:<small>Note: <tt>bundle install --without ...</tt> no longer works; that flag was removed from the version of Bundler that ships with Ruby 4.0. Use <tt>bundle config set</tt> as shown above.</small>
</div>

===Frontends===
<div class="mw-customtoggle-frontends" style="font-size:16px;overflow:auto;color:#0000FF">[Click to Expand]</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-frontends">
Finish the Lich installation for your distribution above first, then set up one of these front ends.

====Saga====
[[Saga]] is the official Simutronics front end for GemStone IV and DragonRealms (currently in beta), and it works with Lich. On Linux it comes as a single AppImage file.

'''Install Saga'''

Go to the [https://www.play.net/gs4/play/saga-info.asp Saga info page] and click '''Download for Linux''' (AppImage, x86_64). On a Chromebook, move the downloaded file into the '''Linux files''' folder with the Files app so Linux can see it.

Then put it where Lich looks for Saga, make it runnable, and start it:
<pre>
sudo mkdir -p /opt/Saga
sudo mv ~/Downloads/Saga-*.AppImage /opt/Saga/saga
sudo chmod +x /opt/Saga/saga
/opt/Saga/saga
</pre>
:<small>On a Chromebook use <tt>~/Saga-*.AppImage</tt> in place of <tt>~/Downloads/Saga-*.AppImage</tt>.</small>

Log in to the game from inside Saga once, without Lich, to make sure Saga itself works.

If Saga will not start and mentions FUSE or <tt>libfuse.so.2</tt>, install FUSE 2 and try again: <tt>sudo apt-get install libfuse2</tt> on Debian/Chromebook (on Debian 13 and newer, <tt>libfuse2t64</tt>), <tt>sudo pacman -S fuse2</tt> on Arch, or <tt>sudo dnf install fuse-libs</tt> on Fedora.

The Linux build of Saga does not update itself yet. Check the Saga info page now and then, download the newest AppImage, and repeat the <tt>sudo mv</tt> and <tt>sudo chmod</tt> steps.

'''Use Saga with Lich'''

Saga starts Lich for you:
# Log in with Saga normally, then choose '''File → Enable Login with Lich'''.
# Choose '''File → Return to login'''.
# Click '''Connect''', then '''Via Lich''', and point it to your Lich folder (<tt>~/Lich5</tt>).
# If Saga asks where Ruby is, or Lich will not start, run <tt>rbenv which ruby</tt> and give Saga the path it prints (it ends in <tt>.rbenv/versions/4.0.9/bin/ruby</tt>).
# Log in. The game will start in Saga with Lich running.

Once that works, you can also start from the Lich login window (<tt>ruby ~/Lich5/lich.rbw</tt>): 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.

====Profanity====
Profanity is a terminal-based Front-End that will let you play the game (in lieu of The Wizard or Wrayth). Its gems (such as <tt>curses</tt>) are installed by the <tt>bundle install</tt> step above. Download Profanity:
<pre>
cd ~
git clone https://github.com/elanthia-online/ProfanityFE.git
</pre>

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

====Warlock====
Download Warlock from https://sproctor.github.io/warlock3/download.html, then run Lich the normal way with Ruby:
<pre{{log2|margin-right=35%}}>
ruby ~/Lich5/lich.rbw
</pre>
Use your login information with these settings to use the Lich launcher: https://github.com/sproctor/warlock3/wiki/Lich-support
</div>

=Popular Scripts=
{{#section:Lich:Script Repository|popularscripts}}

=Ecosystem Information=

* DragonRealms Variant - [https://elanthipedia.play.net/Lich_script_repository#Setup_and_Installation Setup and Install instructions]

=Lich Changelog=
<div class="mw-customtoggle-changelog" style="font-size:16px;overflow:auto;color:#0000FF">[Click to Expand]</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-changelog">
'''5.22.0'''
<PRE>
### Features (general)
* add opt-in bounded script execution guards (#1575)
* add static-only map route selection (#1577)
* bounded fput with max_resends, interrupt, resend_transient and failure symbols (#1587)
* Spell.results_regex, the lines cast waits on, exposed (#1590)
* add Events, a script-to-script notification primitive; combat emits on it (#1619)
* add deterministic hook priorities (#1621)
* Map.boundary_rooms_for(ids), the perimeter of any set of rooms (#1660)
* sticky ever_hostile? keeps Sympathy'd creatures in targets (#1665)
* --pipe -g honours the frontend flag, and --sentinel requests the origin marker (#1677)

### Features (gs)
* add trustworthy combat observation provenance (#1576)
* Lich::Gemstone::Stance, a shared stance setter (#1578)
* Lich::Stash.wield and Stash.hands put named items into hands (#1579)
* Lich::Gemstone::Mana.pulse, the MANA PULSE verb once (#1580)
* Lich::Gemstone::Bank, Currency refresh, and WEALTH parser lines (#1581)
* PSM command and results_regex readers, factored out of use (#1583)
* Lich::Gemstone::Fog, the ways home on the spell and society readers (#1584)
* Combat::Messages - non-combat message families as observer events (#1586)
* society command readers, factored out of use (#1589)
* Group.join, the follower's side of Group.add (#1591)
* emit post-commit combat recorder receipts (#1592)
* combat definition supplements from a player YAML file (#1607)
* message definitions from the player supplement file (#1608)
* creature library - abilities from session logs, limbs flags, triggers as hash of arrays (#1623)
* expose exact server creature health from crtrStatus (#1661)

### Bug Fixes (general)
* fix spec stub race breaking FFI loads, gate WindowsCredentialManager to Windows (fixes #1542) (#1573)
* setup_files uses content hash for cache freshness (#1596) (#1599)
* creatures registry housekeeping independent of Combat::Tracker (#1603)
* place effect-list.xml backups in the update snapshot folder (#1606)
* retain discovery ownership through cleanup (#1612)
* Initial Lich state update and detachable-client split GS/DR (#1617)
* bound move()'s remedy retries, record why a move failed, lift it into Lich::Common::Move (#1622)
* update puts to Lich.log (#1630)
* create detachable-client session file without --login (#1656)
* converge server_time_offset instead of resetting it every prompt (#1663)
* plain-language lich5-update messages when GitHub fails (#1687)
* Inventory.refresh waits out roundtime before sending (#1688)

### Bug Fixes (dr)
* update HOW pattern to accommodate various soul states (#1620)
* restore script halt in DRCC.get_crafting_item on missing item (#1624)
* halt script when too distracted to turn recipe book (#1625)
* equipmentmanager energy bow handling (#1662)
* report when DRC.rummage can't read a container (#1671)
* DRCI.get_item? confirms #<id> gets by the item id in hand (#1674)
* DRCT.sell_item references the item through DRCI.item_ref (#1675)
* DRCA.do_buffs filters day/night spells without mutating settings (#1680)
* DRCI.tie_item? no longer reports an empty pouch as tied (#1684)
* DRC.play_song? keeps climbing and performance songs across instrument switches (#1686)

### Bug Fixes (gs)
* Injured cache lives on the class and keys on an injury fingerprint (#1582)
* infomon - a spell's start message refreshes a refreshable timer (#1585)
* Group.broken? waits on Lich::Claim::Lock, the constant that exists (#1588)
* combat module - hunt-log audit: interrupted-swing resume, status attribution by event, spell-loss cause, live defs (#1593)
* QStrike prices MSTRIKE's own stamina cost (#1594)
* combat module - a stand-up message later in the chunk outranks an earlier knockdown crit (#1595)
* track spell cooldowns on the characters a spell locks out (#1597)
* catalog missing deity-specific strike lines for Divine Wrath (335) (#1598)
* combat module - Rysk/Dreadt log audit: Holy Weapon release model, held maneuver rolls, AoE roll attribution, live defs (#1600)
* Combat defs add thrust as a basic attack (#1615)
* preserve group state after ambiguous disband reply (#1629)
* target ridden mounts before their first crtrStatus (#1669)
* snapshot Effects registries so scripts can't break the XML parser (#1672)
</PRE>
'''5.21.0'''
<PRE>
### Features (general)
* Add --refresh-characters and --add-character CLI flags (#1504)
* add --active-session-dir to decouple Active Sessions coordination from --temp (#1520)
* add read model for the inventoryManager extended feed (#1524)
* GUI add configurable frontend registry (#1558)
* add HTTPS web-login fallback for when EAccess (7910) is unreachable (#1570)

### Features (dr)
* player-supplied custom prep/cast/invoke messages (#1528)
* opt-in cambrinth charge distribution across configured items (#1549)
* populate GameObj from INV LIST full refresh (02 of 05) (#1554)
* non-destructive upsert for INV SEARCH / category scrapes (03 of 05) (#1556)
* reconcile GameObj containers on hand pickup (04 of 05) (#1557)
* [DRCC] add shared private-forge helpers (#1560)

### Features (gs)
* creature template library - measured combat data, HP/speed censuses, messaging (#1539)

### Bug Fixes (general)
* enforce Script#pause at every blocking/mutating checkpoint (#1537)
* always report missing gems on stderr; only wait on a dialog without a tty (#1544)
* dispatch --help and --version before the GTK require (#1546)
* global_def update deprecated method calls to include caller info (#1550)
* normalize colons in Lich::Util.normalize_lookup (#1561)
* Script.log respects --log-dir/LOG_DIR override; use File.join for paths in script.rb (#1572)

### Bug Fixes (dr)
* drvariables add more data to VOL_MAP (#1536)
* pin capped skills to 34 in DRSkill.clear_mind (#1548)
* match lowercase "it's already open" when opening a container (#1553)
* normalize capitalized leading articles in inventory scrape names (01 of 05) (#1555)
* make INV LIST refresh atomic and warn on interruption (05 of 05) (#1563)
* refresh before_name/after_name on a name-preserving container move (#1564)
* do not re-add a held item as worn inventory on inv scrape (#1565)
* evict orphaned identity-index entries on a name-changing upsert (#1566)
* unpause the exact scripts safe_pause_list paused, by object (#1574)

### Bug Fixes (gs)
* Infomon xmlparser additional npc death messaging (#1540)
* correct messaging drift in 13 crit table patterns (#1547)
* combat module - event defs, observer emissions, replay-verified parsing, SQLite recorder (#1559)
</PRE>
'''5.20.1'''
<PRE>
### Bug Fixes (general)
* bound EAccess auth with a timeout so a stalled SGE backend can't hang Lich silently (#1502)
* Linux WINE and Wrayth FE detection (#1517)
* update Gemstone game-code validations (#1518)
* preserve bundled display-state tags on quiet-suppressed chunks (#1530)
* prevent a stray formatting character from appearing in Saga during quiet script output (#1532)

### Bug Fixes (dr)
* make $safe_pause_lock holder immune to pause (#1525)

### Bug Fixes (gs)
* critranks.rb tolerate nil table rows, fix reload!, index patterns … (#1522)
* combat module hardening - ordered processing, 22x faster parsing, double-count fix (#1523)
</PRE>
'''5.20.0'''
<PRE>
### Features (general)
* add concurrent runtime I/O and multi-client detach support (#1459)
* --bind-address speaks the same keywords as --detachable-client (#1461)
* GUI Launcher Improvements (#1463)
* Add supervised child script APIs (01 of 06) (#1474)
* Add forced script teardown command (06 of 06) (#1479)
* teardown and distinguishable errors for Script.run_child (#1501)

### Features (dr)
* DRCMM.moon_weapon_duration - read a moon weapon's remaining life (#1483)
* id-based creature tracking from crtrStatus + assess (#1485)
* capture room UID from <nav> tag; stop enforcing ShowRoomID; opt-in room-id placement (#1491)
* user-extensible scroll substitutions via settings (01 of 06) (#1512)
* user-extensible boxes and trash receptacles (03 of 06) (#1514)
* user-extensible summoned-weapon adjectives (04 of 06) (#1515)
* user-extensible flavor-text stripping (05 of 06) (#1516)

### Features (gs)
* gameobj add full_name matcher to type/sellable classification (#1453)

### Bug Fixes (general)
* prevent empty/partial GameObj registry reads during mid-stream refresh (#1370)
* no-op Gtk.lich_main_quit when no main loop is nested (#1464)
* correct path-flag aliases and document all path options (#1472)
* Synchronize script lifecycle transitions (02 of 06) (#1475)
* Coordinate script shutdown draining (03 of 06) (#1476)
* Harden script lifecycle ownership (05 of 06) (#1478)
* surface the underlying LoadError in dependency alerts (#1480)
* extract game-agnostic CreatureBase into lib/common (#1484)
* bound GemCheck alert dialogs with a timeout so they can't hang forever (#1488)
* identify Genie as the frontend for headless launches (#1490)
* restore detachable client disconnect notice to stdout (#1492)
* harden detachable client teardown and escape init payload (#1493)
* resolve GameObj status visibility during staged refresh (#1497)
* compact client write queue instead of ending the session (#1498)
* scrub startup credentials once login completes (#1499)
* Honor Simu-side teardown for 10 seconds (#1505)

### Bug Fixes (dr)
* resolve no-UID rooms carrying a stored UID instead of returning nil (#1467)
* equipmanager.rb - reliable ranged-weapon transitions - stow ammo after unload + verify offhand wield hand (#1468)
* common-healing.rb - DRCH.bind_wound: only dispose a dislodged item while it is in hand (#1469)
* preserve game RealID in room title (GS parity for ";display roomid title") (#1500)
* Refine need_buffs? logic for non-recast spells to correctly check cyclic spells. (#1503)
* reduce symbol-torn scale scrolls to gettable noun (#1506)
</PRE>
'''5.19.1'''
<PRE>
### Bug Fixes (general)
* lower game socket keepalive idle from 120s to 30s (#1449)
* resilient ActiveSessions ownership + shutdown watchdog (#1452)
* Quit Gtk.main cleanly (#1455)
* Refactor regex to string comparisons for ARGV options (#1456)

### Bug Fixes (gs)
* ingest newly-exposed mindState experience and roommeta room fields (#1450)
</PRE>
'''5.19.0'''
<PRE>
### Features (general)
* Add character generator support via EAccess protocol (#1384)
* Add modern script command shutdown method (#1385)
* migrate the server-stream parser from REXML to Ox, with pipe-mode benchmark harness and DR parser coverage (#1396)
* enumerate script subdirs with file glob (#1397)
* add --bind-address option to set listen socket address (#1405)
* add central method to determine lich ver (#1417)
* setup_files: support scripts/data/custom for user data overrides (#1431)
* Modify running? method to support optional exact matching of script names (#1436)
* keyword bind hosts for the detachable client (tailscale/lan/any) (#1437)
* add roomlinks/roommono toggles for room display (#1438)
* self-healing gem requires (#1439)
* various Saga FE compatibility tweaks (#1443)
* add macOS limited gem recovery (#1448)

### Features (dr)
* Capture combat position from the balance status line (#1400)
* detect scheduled shutdown and expose it on DRParser (#1409)
* xmlparser: add structured parser for the assess (combat situation) stream (#1413)
* Implement DRCA.need_buffs? method for buff checks (#1428)

### Features (gs)
* anchor Infomon parser regex unions to line start (#1391)
* creature xml additions (#1425)
* add creature template library (#1427)

### Bug Fixes (general)
* surface a failed Game.open in the connect timeout (#1408)
* bound long-session memory growth (index/hook/watchfor/buffer leaks) (#1410)
* improve and harden shutdown (#1416)
* use bundler to check for required Ruby gems (#1420)
* pin lich directory for gemfile check (#1423)
* Show CLI login ARGV for SAL connections (#1424)
* increase read timeout on idle socket to 300 seconds (#1426)
* monkeypatch gi for memoryreleaser / asyncprocessor until patched upstream (#1429)
* Mapdb sort tags by downcase and original case (#1433)
* stop locking the load path at boot; keep Gemfile.lock in sync on self-update (#1434)
* minimum Ruby 4.0 required & migrate Ruby version check (#1444)
* align --announce with --update for Ruby version (#1447)

### Bug Fixes (dr)
* BalanceValue regex to match combat status lines (#1398)
* equipmanager.rb - Fix unload weapon detection when AimTimerDialog tag is prepended (#1414)

### Bug Fixes (gs)
* global_defs update pushStream regex to include 'reserve' id (#1379)
* psms Warcry.available? correction (#1387)
* xmlparser support new field exp, climate, terrain XML feeds (#1388)
* global_defs move() update regex for standing condition (#1407)
* Currency add method to retrieve aevit event currency (#1411)
* Stash check result type before comparing regex for wear_to_inv (#1430)
</PRE>
'''5.18.0'''
<PRE>
### Features (dr)
* common-crafting add method for creating mechanisms (#1375)

### Bug Fixes (general)
* stringproc normalize CRLF | CR to LF (#1378)
* rubocop custom cop ascii only cleanup (#1382)

### Bug Fixes (dr)
* equipmanager update to assume missing items aren't worn (#1376)

### Bug Fixes (gs)
* Infomon xmlparser additional npc death messaging (#1326)
</PRE>
'''5.17.3'''
<PRE>
### Bug Fixes (general)
* Script module replace MemoryReleaser with GC.start for cleanup (#1364)
* Add sqlite busy timeout policy to core (#1365)
* Script#kill remove GC.start and add optional instrumentation (#1368)
* reorder shutdown ala MahtraDR and detect script teardown de... (#1369)
</PRE>
'''5.17.2'''
<PRE>
### Bug Fixes (general)
* harden custom repo identity, collision, and contract boundaries (#1333)
* stop SessionLifecycle before closing database on normal exit (#1334)
* harden FeatureFlags for closed db handle (#1335)
* SynchronizedSocket write resilience and zombie client elimination (#1338)
* correct RP timing issue for release notes (#1348)
* gate object cleanup in GTK queue (#1354)
* recover from cross-process zombie in ActiveSessions service (#1355)
* Improve shutdown session state handling (#1359)
* non-ascii hygeine to address rubocop errors (#1360)
* Remove debug log IO from heartbeat tick loop (#1363)

### Bug Fixes (dr)
* DRC text2num correction for thousand (#1343)

### Bug Fixes (gs)
* Overwatch add REVEALED_EXPLODES regex pattern (#1356)
* Stash add_to_bag result type check before regex compare (#1357)
</PRE>
'''5.17.1'''
<PRE>
### Bug Fixes (general)
* enable heartbeat-driven failover for ActiveSessions service owner (#1340)
* copy Gemfile and LICENSE during self-update (#1345)
* Add top-level parse_args/display_args bridge to global_defs (#1346)

### Bug Fixes (dr)
* replace undefined custom_require in check_moonwatch (#1336)
* set_stance places 100 in the correct positional slot (#1337)
* cache SlackBot users list to prevent API throttling (#1342)
* Add CORE_AUTOSTART sentinel to skip dependency.lic autostart helpers (#1344)

### Bug Fixes (gs)
* Infomon Status.cutthroat? Effect Debuff correction (#1331)
* add support for RESERVE xml in GameObj.reserve (#1341)
</PRE>
'''5.17.0'''
<PRE>
### Features (general)
* custom 3rd-party repo support for ScriptSync (#1285)
* Add get_settings, get_data, start_scripts_if_available to core (#1305)
* Add Map.apply_wayto_overrides for personal map overrides (#1306)

### Features (dr)
* Decouple SetupFiles from script-scoped echo and XML feed timing (#1304)
* Add game flags and obsolete script warnings to DRInfomon startup (#1307)

### Bug Fixes (general)
* use :__unset for --without-frontend CLI request YAML matches (#1301)
* prevent zombie server deadlock in Active Sessions accept loop (#1302)
* improve MacOS keychain system check for older OS variants (#1310)
* stub sync_all_repos to prevent leaked thread in games_spec (#1311)
* enforce beta confirmation 10s timeout (#1315)
* use send(:respond) in StatusReporter fallback path (#1316)
* ensure SessionLifecycle.stop runs on abnormal exit (#1317)
* address ActiveSessions lifecycle hot path feature-flag polling (#1325)
* catch ECONNRESET in _puts and bound walk_to retry depth (#1327)
* safeguard gtk logo.png loading (#1329)

### Bug Fixes (gs)
* Add InnCheckedOut pattern to parser (#1309)
* Claim corrections to handle mounts in room_players stream (#1324)
</PRE>
'''5.16.2'''
<PRE>
### Features (general)
* session summary store and reporting (#1247)
* add core classes, ScriptSync, and login auto-sync (#1273)
* Add active sessions API (#1274)
* Add session status CLI query (#1276)
* configurable debug log retention (#1282)

### Features (dr)
* common-healing.rb - add vitality parsing to HealthResult (#1265)

### Bug Fixes (general)
* handle auth exceptions in manual login to prevent hang on bad password (#1267)
* set SO_REUSEADDR before bind to allow immediate port reuse (#1268)
* Persistent Launcher re-enable play button post launch (#1269)
* Restore manual login behaviors to not require saved entry t... (#1270)
* log and re-raise unexpected errors in saved login auth handler (#1271)
* narrow safe_write rollback scope so cleanup failure preserves successful write (#1287)
* fix three revert bugs in SnapshotManager (#1289)
* guard nil release asset and validate before deleting lib/ (#1290)
* guard nil stable version in beta channel resolution (#1291)
* remove dead code in BranchInstaller (#1292)
* repair regression on gui button reenable from refactor (#1297)

### Bug Fixes (dr)
* common-items.rb - move pattern from failure to success block (#1262)
* buffer_room_objs missed split components with leading stream tags (#1284)
* common-items.rb - get_item_unsafe false positives via XML feed verification (#1286)
* forward vitality and dead fields in perceive_health (#1288)

### Bug Fixes (gs)
* Infomon xmlparser additional npc death messaging (#1275)
* Infomon xmlparser additional npc death messaging (#1281)
</PRE>
'''5.16.1'''
<PRE>
### Features (general)
* session summary store and reporting (#1247)
* add core classes, ScriptSync, and login auto-sync (#1273)
* Add active sessions API (#1274)
* Add session status CLI query (#1276)
* configurable debug log retention (#1282)

### Features (dr)
* common-healing.rb - add vitality parsing to HealthResult (#1265)

### Bug Fixes (general)
* handle auth exceptions in manual login to prevent hang on bad password (#1267)
* set SO_REUSEADDR before bind to allow immediate port reuse (#1268)
* Persistent Launcher re-enable play button post launch (#1269)
* Restore manual login behaviors to not require saved entry t... (#1270)
* log and re-raise unexpected errors in saved login auth handler (#1271)
* narrow safe_write rollback scope so cleanup failure preserves successful write (#1287)
* fix three revert bugs in SnapshotManager (#1289)
* guard nil release asset and validate before deleting lib/ (#1290)
* guard nil stable version in beta channel resolution (#1291)
* remove dead code in BranchInstaller (#1292)

### Bug Fixes (dr)
* common-items.rb - move pattern from failure to success block (#1262)
* buffer_room_objs missed split components with leading stream tags (#1284)
* common-items.rb - get_item_unsafe false positives via XML feed verification (#1286)
* forward vitality and dead fields in perceive_health (#1288)

### Bug Fixes (gs)
* Infomon xmlparser additional npc death messaging (#1275)
* Infomon xmlparser additional npc death messaging (#1281)
</PRE>
'''5.16.0'''
<PRE>
### Features (general)
* session summary store and reporting (#1247)
* add core classes, ScriptSync, and login auto-sync (#1273)
* Add active sessions API (#1274)
* Add session status CLI query (#1276)
* configurable debug log retention (#1282)

### Features (dr)
* common-healing.rb - add vitality parsing to HealthResult (#1265)

### Bug Fixes (general)
* handle auth exceptions in manual login to prevent hang on bad password (#1267)
* set SO_REUSEADDR before bind to allow immediate port reuse (#1268)
* Persistent Launcher re-enable play button post launch (#1269)
* Restore manual login behaviors to not require saved entry t... (#1270)
* log and re-raise unexpected errors in saved login auth handler (#1271)

### Bug Fixes (dr)
* common-items.rb - move pattern from failure to success block (#1262)
* buffer_room_objs missed split components with leading stream tags (#1284)
* common-items.rb - get_item_unsafe false positives via XML feed verification (#1286)

### Bug Fixes (gs)
* Infomon xmlparser additional npc death messaging (#1275)
* Infomon xmlparser additional npc death messaging (#1281)
</PRE>
'''5.15.1'''
<PRE>
### Bug Fixes (general)
* Mutli-launch persistent login GUI (#1245)
* Remove Windows OS CMD prompt flash (#1255)
* guard against broken pipe errors in Game._puts and send_to_client (#1260)
* add timeout safety to fput to prevent infinite hangs (#1261)

### Bug Fixes (dr)
* anchor stow success pattern to prevent fan close recovery bypass (#1254)
* add bounded recursion depth limits to 9 methods (#1257)
* stow_helper failure detection + unload_weapon ammo recovery (#1259)
</PRE>
'''5.15.0'''
<PRE>
### Features (general)
* add InstanceSettings for core Settings API access (#1233)

### Features (gs)
* Overwatch module into core (#1201)

### Bug Fixes (general)
* fix GameObj container initialization and add clear_all_containers (#1226)
* GameObj object dedupe & GC (#1234)
* script.rb show Script.kill source (#1235)
* Exit quickly on CLI authentication failure (#1237)
* suppress wine detection noise and skip when unneeded (#1244)

### Bug Fixes (dr)
* DR modules fixes and enhancements (#1232)

### Bug Fixes (gs)
* psms.rb add additional failure matches (#1238)
* Bounty parser fix regex pattern for skin retrieval task (#1242)
</PRE>
'''5.14.2'''
<PRE>
### Bug Fixes (general)
* add retry with exponential backoff for all login authentication (#1205)
* update.rb allow for bugfix betas and branch updates (#1211)

### Bug Fixes (gs)
* infomon.rb bug in _key transformation (#1216)
</PRE>
'''5.14.1'''
<PRE>
### Bug Fixes (general)
* Change server_time_offset in XMLParser to be float instead of int (#1184)
* change encodings in main.rb to wizard FE only (#1199)

### Bug Fixes (gs)
* Infomon parser.rb update Account.subscription/type (#1192)
* spell.rb add last_cast to track last time casted (#1193)
* stash.rb additional improvements with ReadyList/StowList (#1197)
* Infomon parser.rb bug in EnhanciveEnd (#1198)
</PRE>
'''5.14.0'''
<PRE>
### Features (general)
* Add Genie map cross-reference fields to the DragonRealms map data model (#1169)

### Features (dr)
* DRExpMonitor move into core lich (#1154)

### Features (gs)
* add Enhancive module for enhancive item bonus tracking (#1113)
* add QStrike module for optimal stamina-based RT reduction (#1114)

### Bug Fixes (general)
* remove strip! from settingsInfo replacement (#1161)
* map_base.rb sort JSON better (#1171)

### Bug Fixes (dr)
* logbook_item recovery when crafted item not in hand (#1175)

### Bug Fixes (gs)
* xmlparser.rb capture additional death messaging (#1158)
* stash.rb ReadyList sheath handling and update inventory checks (#1166)
</PRE>
'''5.13.6'''
<PRE>
### Bug Fixes (general)
* allow --add-account to run without yaml and dat (#1143)
* enable --login for multi-variable custom launch commands (#1144)
* update.rb pervent update if MIN_RUBY not met (#1146)
* messaging.rb return "" for xml_encode with Wizard (#1147)
* prevent closing connection on module reload (#1148)
* Allow hmr to work on global_defs.rb (#1156)

### Bug Fixes (dr)
* buffer split room obj lines and merge instead of appending closing tag to broken line (#1149)
* add buffering for multiline room players (#1151)
* add verify_script def here instead of depending on dependency (#1155)

### Bug Fixes (gs)
* infomon.rb added updated_at field to upsert_batch (#1145)
* stowlist.rb check method fix when dead (#1152)
* readylist.rb check method fix when dead (#1153)
</PRE>
'''5.13.5'''
<PRE>
### Bug Fixes (general)
* util.rb only show gem installing debug messaging if gem mis… (#1131)
* add --gs and --dr, refactor argv_options to helpers (#1133)
* fix multiple custom entries, improvements to yaml save (#1134)
* login_tab_utils.rb expand helper text show Warlock (#1135)
* update CLI for YAML security signature, add auto-convert fo… (#1136)
* remove password parameter from debug logging in all cases (#1137)
* reduce minimum GUI window footprint for non-tabbed view (#1138)
* remove double save in YAML to preserve yaml.bak integrity (#1139)

### Bug Fixes (gs)
* stash.rb additional improvements (#1132)
</PRE>
'''5.13.4'''
<PRE>
### Bug Fixes (general)
* force system gem install if RubyGems fails (#1126)
* gui_login prevent destroying window if already destroyed (#1127)
* add window size / position saves to login GUI (#1128)
* non tabbed saved entries in reduced button / font size (not… (#1129)
</PRE>
'''5.13.3'''
<PRE>
### Bug Fixes (general)
* account manager sorting GUI fix (#1123)
</PRE>
'''5.13.2'''
<PRE>
### Bug Fixes (general)
* install_gem_requirements update available gems after install (#1120)
</PRE>
'''5.13.1'''
<PRE>
### Bug Fixes (general)
* password_cipher.rb upcase account_name for key (#1118)

### Bug Fixes (dr)
* validator.rb change sleep to should_sleep named param (#1116)

### Bug Fixes (gs)
* add base stats capture from 'info full' command (#1115)
</PRE>
'''5.13.0'''
<PRE>
### Features (general)
* Refocus Frontend (#960)
* socket configurator to better guard TCPSocket (#976)
* add simplified DB maintenance (#991)
* TextStripper module support for XML, HTML, Markdown (#1055)
* Login modernization and refactor to yaml (#1063)
* Ruby Memory Releaser module (#1066)

### Features (dr)
* support meta:trashcan tag for DRCI.dispose_trash (#966)
* Add GameObj.inv support for DR items (#1080)
* DRCS allow custom adjective for summoned weapons (#1088)
* DRParser support for new exp window xml stream elements (rested exp, tdps, favors) (#1104)

### Features (gs)
* Add Armaments (Weapon, Armor, and Shield) Module (#911)
* add creature module, including Hinterwilds creatures (#1002)
* Creature module combat tracking (#1003)
* track time of last total_experience record (#1030)
* add Injured class for checking ability to perform actions (#1035)

### Bug Fixes (general)
* map dijkstra optimization (#1061)
* update.rb keep script/data file incase of error on update (#1070)
* ensure proxy path is set for non-destructive array write-th… (#1073)
* [lib][global-defs] - move update (#1079)
* GameObj force new objects ID to be string (#1087)
* xmlparser.rb gate GSL exits sending behind @send_fake_tags (#1103)
* change Hash[] pair key conversion to use to_h for Ruby 4.0 (#1108)
* move gui-login.rb to Ruby standard gui_login.rb (#1111)
* update location for currency and move game-loader.rb to Ruby standard gameloader.rb (#1112)

### Bug Fixes (dr)
* DRCA allow custom spell prep messaging (#1089)
* Update Slackbot error handling, and lnet management (#1091)
* Fix exp mods parsing for DR (#1102)
* equipmanager.rb support for custom messaging in forester's longbow (#1105)
* Fix hang in equipment manager when game doesn't respond to commands (#1110)

### Bug Fixes (gs)
* Infomon additional CHE resign regex (#1067)
* Resource tracking for sorcerer shadow essence (#1085)
* cman.rb add hamstring regex for already lying down target (#1090)
* cman.rb hamstring regex update when can't perform on target (#1092)
* Bounty parser.rb FWI guard regex update (#1096)
* currency.rb track gold (#1109)
</PRE>
'''5.12.12'''
<PRE>
Bug Fixes (general)
Update module strip markdown comments (#1056)
Vars/UserVars module fixes and corrections (#1057)
Bug Fixes (gs)
Infomon parse fix for singular currency (#1051)
</PRE>
'''5.12.11'''
<PRE>
Bug Fixes (dr)
add bput match for system updates preventing actions (#1034)
drdefs.rb npc parsing (#1038)
Fix container reference in get_item_from_eddy_portal method (#1039)
Bug Fixes (gs)
bounty location regex needs to match "under" (#1037)
</PRE>
'''5.12.10'''
<PRE>
Bug Fixes
all: games.rb catch additional error for nested single/double quotes (#1031)
dr: change keys for DR_SKILLS_DATA[:guild_skill_aliases] to be strings instead of symbols (#1032)
gs: Bounty parser for SG npcs matching (#1027)
gs: match READY/STOW items with a/an/some inside the link (#1026)
</PRE>
'''5.12.9'''
<PRE>
Bug Fixes
gs: StowList/ReadyList reset bug if non-default keys added #1019
</PRE>
'''5.12.8'''
<PRE>
Bug Fixes
all: script.rb show custom at script exit as well (#993)
all: Updated update.rb for single trunk and release please (#1001)
</PRE>
'''5.12.7'''
<PRE>
fix(all): ensure updates do not target detached proxy views #990
fix(gs): bounty parser and move fixes for sailor's grief #987
fix(gs): Infomon xmlparser.rb Ready/Stow fix for LONG before exist #988
fix(gs): gameobj.rb for Sailor's Grief ghostly/boss/guild tentacles #989
</PRE>
'''5.12.6'''
<PRE>
fix(all): settings.rb update to preserve root of derived views #975
fix(all): show custom in various script output when custom script #967
fix(dr): drparser.rb update for PlayedSubscription #983
fix(gs): include store location for ReadyList #977
fix(gs): infomon parser.rb update for ACCOUNT output varies #979
fix(gs): global_defs.rb move def update for Hive traps #980
fix(gs): activespell.rb prevent removal of RF Penalty #981
fix(gs): add .compact to input of Disk.find_by_name #982
</PRE>
'''5.12.5'''
<PRE>
fix(all): update.rb word boundary for abbreviations #971
fix(dr): equipmanager.rb Fix for changed game output. #969
fix(dr): common-arcana.rb Regalia fix for changed game output. #970
fix(dr): common-items.rb Fix for changed inventory command output #973
fix(gs): StowList missing space in capture in xmlparser.rb #963
fix(gs): stowlist.rb wait for RT when issuing check #964
fix(gs): readylist.rb wait for RT when issuing check #965
fix(gs): Bounty heirloom return msg'ing update #972
</PRE>
'''5.12.4'''
<PRE>
build(all): installer.yml use windows-2022 #950
fix(all): restore Wrayth / Wizard script execution ability #952
fix(all): database_adapter.rb error handling improvement #956
fix(dr): common-items.rb wear/remove messaging additions #949
fix(dr): games.rb - ignore UIDs for Frostbite mapping #951
fix(dr): map_dr.rb prevent inadvertent settings changes #958
fix(gs): GameObj targets for new Sailor's Grief tentacle npc #948
fix(gs): map_gs.rb remove delete_if to prevent bad settings #957
fix(gs): weapon.rb assault break if no targets #962
</PRE>
'''5.12.3'''
<PRE>
fix(all): limitedarray.rb max_size increase #946
fix(all): uservars.rb update for vars method missing #940
fix(dr): drparser.rb to set ShowRoomID to on if turned off #945
fix(gs): change namespace accessors to Ruby 2.6 compatible #944
fix(gs): infomon state reset on status prompt #943
fix(gs): Societies to check membership for various methods #942
fix(gs): standardize warcry.rb to match other PSMS #941
</PRE>
'''5.12.2'''
<PRE>
fix(gs): infomon parser.rb for profile full name matching #938
fix(gs): force PROFILE FULL to sync CHE info for infomon #937
fix(dr): Tighten checks on releasing invisibility for thieves #936
</PRE>
'''5.12.1'''
<PRE>
- fix(all): gameobj.rb - add type? method for explicit type check #928
- fix(all): messaging.rb encoding issue #933
- fix(gs): Various CMan cost corrections #932
</PRE>
'''5.12.0'''
<PRE>
- feat(all): settings.rb - proposal for sequel based Settings #591, #875, #889, #896, #927
- feat(all): util.rb add Ruby gem install helper method #861
- feat(all): messaging.rb add cmd link method #866
- refactor(all): games.rb modernization #849, #882, #924
- fix(all): add class extensions #800
- fix(all): lich.rb deprecated FE message #852
- fix(all): messaging.rb fix XML encoding for wizard and avalon #853
- fix(all): lich.rb class variable not initialized #855
- fix(all): log.rb force msg to String for regexp comparison #856
- fix(all): global_defs.rb bug in fput #864
- fix(all): messaging.rb xml_encode mono method msg #868
- fix(all): script.rb class to is_a? checks #878
- fix(all): gameobj.rb deeper lookup #885
- fix(all): messaging.rb debug not compared to falseclass #887
- fix(all): change class to is_a? checks #91-3
- fix(all): Util.issue_command allow single line captures #918
- fix(dr): drparser.rb casing for Premium status check #842
- fix(dr): map_dr.rb Don't assign UID of zero to rooms #844
- fix(dr): drparser.rb add $last_logoff tracking #851
- fix(dr): update message patterns in common-items #859
- fix(dr): add moon_visible?(moon) convenience method to common-moonmage #860
- fix(dr): exp mods output is not enclosed in preset xml tags anymore #870
- fix(dr): update.rb beta send validation for genie lich char #880
- fix(dr): Update regex and parsing for active spells #894
- fix(dr): add 'You scoop' match pattern to common-items #900
- fix(dr): add missing match patterns #901
- fix(dr): common-items: add and fix match strings #904
- fix(dr): Add missing matches for common-items #905
- fix(dr): Release Khri Vanish if Thief, when going visible #906
- fix(dr): Fix race condition when clearing and repopulating XMLData.dr_active_spells #907
- fix(dr): Fix SLS release pattern #908
- fix(dr): resolve race condition in DR crafting_magic_routine #914
- fix(dr): xmlparser.rb - Fix XMLData.dr_active_spells race condition #915
- fix(dr): xmlparser.rb - Clear out spells properly #916
- fix(dr): drparser.rb update for Platinum account status #922
- feat(gs): gameobj.rb allow for custom gameobj data #848
- feat(gs): PSMS updates, including CMan.use #865, #874, #881, #890, #899
- feat(gs): ReadyList & StowList classes for item tracking #884
- feat(gs): Breakout and Buildout Societes #919
- fix(gs): infomon parsing for CHE membership #841
- fix(gs): map_gs.rb for no UID when hexdigest used #843
- fix(gs): warcry.rb yowlp :buff to string instead of regexp #847
- fix(gs): group.rb multiple corrections #850, #869, #883
- fix(gs): Bounty parser.rb fix for HW & KF guard return #862
- fix(gs): Bounty task.rb fix for assigned? and Ruby 2.6 #863
- fix(gs): stash.rb stale sheaths recheck #867
- fix(gs): allow spell.rb casting to take a force_stance parameter #902
- fix(gs): update Infomon parsing for new ACCOUNT output format #903
- fix(gs): PSMS cost for multiple cost types & add Excoriate feat #912
- fix(gs): Feat excoriate regex correction #920
- fix(gs): weapon PSM affordable check against Glorious Momentum #926
</PRE>
'''5.11.1'''
<PRE>
- fix(all): restore @theme_state and add to CLI capability #795
- fix(all): retire gtk2 monkey patch for gtk3 #823
- fix(all): games.rb XMLData.name wait till both not NIL and not EMPTY #826
- fix(all): standardize xmlparser game instance #827
- fix(all): games.rb fix multiple single and double quote in XML #832,836,837
- fix(dr): games.rb - optional hide Room Title display of Real IDs with FLAG on #782
- chore(dr): common-moonmage - refactor of peer_telescope #783
- fix(dr): move HMR load to common before for dragonrealms #784
- fix(dr): common-crafting.rb minor edit to add "You tuck" #787
- fix(dr): common-arcana.rb - remove unecessary pause from discern code #792
- fix(dr): drparser.rb Restore Premium status checking #834
- fix(gs): migrate PSMS.name_normal to Lich::Util.normalize_name #790,833
- fix(gs): add Char.che to know current character's CHE #791
- fix(gs): FEAT and Infomon module parsing of new Covert Art feats. #796
- fix(gs): add Currency.gemstone_dust and fix redsteel mark capture #797
- fix(gs): FEAT Covert Arts colon normalization and stamina costs #799
- fix(gs): escape dash in regex for HouseCHE #824
- fix(gs): disk.rb comparison helpers #828
- fix(gs): allow for Group.disks to show self disk in array #829
- fix(gs): feat.rb Covert Arts throw poison costs 15 stam #830
- fix(gs): add missing Feat.use ability #831
- fix(gs): multiple CritRanks updates #801-822
</PRE>
'''5.11.0'''
<PRE>
- [all] - chore: Namespace & File Path Updates #713
- [all] - [argv_options.rb] bugfix: correct darkmode to work via CLI #693
- [all] - [games.rb] feat: make show Room Exits of non-StringProc/Obvious Exits toggable for all games #699
- [all] - [games.rb] feat: toggleable display of StringProcs with clickable links #751
- [all] - [gui-manual-login.rb] fix: change label to Wrayth #720
- [all] - [gui-saved-login.rb] fix: update Stormfront label #721
- [all] - [update.rb] fix: purge old LIB folder prior to update release #729
- [all] - [util.rb] bugfix: allow issue_command to use fput or put #715
- [all] - [xmlparser.rb] feat: add XMLData.room_name attribute #685
- [all] - [main.rb] fix: create session file in regular connect method #733
- [all] - [init.rb] bugfix: error for Windows DISPLAY variable #735
- [all] - [main.rb] fix: Mudlet support #736
- [all] - [wine.rb] fix: add --no-wine CLI flag prevent WINE startup
- [all] - [init.rb] fix: add --no-gtk CLI flag prevent GTK3 gem load
- [dr] - [games.rb] feat: DRinfomon and common files as core lich libraries #686
- [dr] - [games.rb] chore: add DR requires here #690
- [dr] - [games.rb] fix: add Room# display for DR #697
- [dr] - [games.rb] bugfix: Genie FE real ID#s not supported, hide by default #728
- [dr] - [drdefs.rb] bugfix: fix for Shadow Servants #710
- [dr] - [map_dr.rb] fix: cleanup and support for UIDs #719
- [dr] - [xmldata.rb] bugfix: add support for DR Room IDs #716
- [dr] - [xmlparser.rb] feat: XMLData - adding dr_active_spells #691
- [gs] - [games.rb] bugfix: support for pre/post room name txt #683
- [gs] - [group.rb] chore: update to account for hold #701
- [gs] - [resource.rb] feat: add additional tracking of covert art charges #714
- [gs] - [spell.rb] bugfix: Spell.affordable? 515 release #687
- [gs] - [stash.rb] bugfix: sheath_bags when not found #694
- [gs] - [xmlparser.rb] bugfix: missing real ID in nav #684
- [gs] - [xmlparser.rb] bugfix: Claim module obvious hiding #717
- [gs] - [sk.rb] feat: Self-Knowledge functionality in core #748
</PRE>
'''5.10.4'''
<PRE>
-o- [GS4] - [xmlparser.rb] bugfix: Simu XML breaking change RoomID #679
</PRE>
'''5.10.3'''
<PRE>
-o- [GS4] - [crit_tables] fix: CritRanks regex fixes (multiple files and changes) #671
-o- [GS4] - [spellsong.rb] fix: Correct Spellsong sync method #674
-o- [GS4] - [parser.rb] fix: thorn status regex correction #673
-o- [All] - [xmlparser.rb] fix: Split out if elif block to account for DR having multiple… #670
-o- [All] - [global_defs.rb] fix: percentconcentration #676
-o- [All] - [global_defs.rb] fix: update move failure message to handle attack and casting #667
-o- [All] - [init.rb] fix: update required ruby check messaging #669
-o- [All] - [sessionvars.rb] feat: new module SessionVars for non-persistent variable storage #666
</PRE>
'''5.10.2'''
<PRE>
-o- [DR] - [games.rb] bugfix: tweak XML rewrite section #662
-o- [GS4] - [crit_tables] bugfix: additional crit table regex corrections #663
-o- [GS4] - [ascension.rb] bugfix: add new Transcend Destiny to lookups #661
-o- [GS4] - [effects.rb] bugfix: regexp escape txt #660
-o- [GS4] - [disruption_critical_table.rb] Bugfix in regex #659
</PRE>
'''5.10.1'''
<PRE>
-o- [All] - [games.rb] bugfix: prevent race condition in games thread #656
-o- [All] - [init.rb] bugfix: address WINE variance between linux / installs #655
-o- [GS4] - [gs][stash.rb] bugfix: wear code improvement #657
</PRE>
'''5.10.0'''
<PRE>
-o- [All] - [main.rb] bugfix: correct encoding for WizardFE PR #640
-o- [All] - [games.rb] bugfix: correct logic for room detection when using CLI --start-scripts PR #639
-o- [All] - [DB_Store.rb] feat: add direct support for Simu RENAME and CHANGE PROF PR #633
-o- [All] - chore: breakout code to individual files for easier management PR #617
-o- [All] - [lich.rbw] chore: add deprecated msg to old Settings/GameSettings/CharSettings methods PR #589
-o- [All] - [lich.rbw] feat: add new --dark-mode CLI option PR #583
-o- [All] - [global_defs.rb] bugfix: monsterbold fix for additional clients PR #581
-o- [All] - [update.rb] feat: update core scripts from source on Lich5 update/install PR #579
-o- [All] - [log.rb] feat: add new Log module copied from Olib PR #577
-o- [All] - [numeric.rb] feat: add days/hours/minutes/seconds methods to numerics PR #623
-o- [All] - [messaging.rb] feat: WizardFE Voln window support #647
-o- [All] - [init.rb] bugfix: WINE entries for Linux / MacOS #649
-o- [DR] - [lich.rbw] bugfix: cleanup downstream hook exclusions PR #593
-o- [DR] - [global_defs.rb] bugfix: missing climb failure message PR #592
-o- [GS4] - [effects.rb] bugfix: show non-standard Effects in `;magic` output PR #641
-o- [GS4] - [parser.rb] bugfix: fix WARCRY duplication results / add WALL OF THORNS effect detection PR #634 / PR #637
-o- [GS4] - [critranks.rb] feat: add critical rank resolution tables and methods PR #625
-o- [GS4] - [effects.rb] bugfix: to support regex for active? & time_left PR #590
-o- [GS4] - [infomon.rb] bugfix: add implicit NPC death monitoring PR #588
-o- [GS4] - [infomon.rb] bugfix: change PSM to be stored as type.mnemonic PR #587
-o- [GS4] - [lich.rbw] bugfix: strip_xml multiline fix PR #584
-o- [GS4] - [stash.rb] bugfix: fix sack detection to use Stash.container(param) PR #578
-o- [GS4] - [spell.rb] feat: Spell.after_stance #644
-o- [GS4] - [xmlparser.rb] bugfix: for Claim module #646
-o- [GS4] - [infomon] feat: track Voln favor via RESOURCE output #648
-o- [GS4] - [gameobj.rb] feat: add Bandit hidden target API #650
</PRE>
'''5.9.2'''
<PRE>
-o- [GS4] - [group.rb] bugfix: proper leader detection from GROUP output
-o- [GS4] - [char.rb] bugfix: add back depracted Char.maxvitals with msging to switch to new Char.max_vitals methods
</PRE>
'''5.9.1'''
<PRE>
-o- [GS4] - [group.rb] bugfix: group.check syntax change
-o- [GS4] - [spell.rb] bugfix: affordable? Char.mana parenthesis logic
</PRE>
'''5.9.0'''
<PRE>
-o- [All] - feat: sqlite3 gem syntax code cleanup PR#553
-o- [All] - [lich.rbw] bugfix: remove unused Setting, GameSetting, CharSetting PR#542
-o- [All] - [lich.rbw] bugfix: scrub login key from error message popups PR#548
-o- [All] - [messaging.rb] bugfix: color mismatch WizardFE white txt PR#554
-o- [All] - [lich.rb] feat: add new Lich.deprecated method to aid in deprecating older API calls PR#523
-o- [GS4] - [char.rb] feat: log method_missing calls PR#552
-o- [GS4] - [char.rb] feat: add missing global_def related methods PR#523
-o- [GS4] - [global_defs.rb] feat: deprecate various Char module methods PR#523
-o- [GS4] - [spellsong.rb] bugfix: cache spellsong duration calc PR#551
-o- [GS4] - [effects.rb] feat: Effects module breakout PR#549
-o- [GS4] - [group.rb][disk.rb] feat: Group & Disk class PR#532
-o- [GS4] - [activespell.rb] feat: add duration change messaging, off by default, see ;help for details PR#487
</PRE>
'''5.8.1'''
<PRE>
-o- [All] - [lich.rbw] feat: add Game:Character to debug log file ouput
-o- [All] - [init.rb] feat: add milliseconds to debug filename
-o- [GS4] - [lich.rbw] bugfix: reorder parsing of $SERVERSTRING to avoid certain conflicts
-o- [GS4] - [parser.rb] bugfix: update for new Empath resource and sleep/bind messaging
-o- [GS4] - [status.rb] bugfix: bound? calmed? and sleeping? support for spellnames flag being off
-o- [GS4] - [xmlparser.rb] bugfix: additional creature dying messaging to check against XML dead not being sent
-o- [GS4] - [gameobj.rb] bugfix: remove sorcerer arms and animates from GameObj.targets
</PRE>
'''5.8.0'''
<PRE>
-o- [All] - Ruby 3.3 compatibility
-o- [All] - [lich.rbw] feat: adds .sources for up/downstream hooks
-o- [All] - [lich.rbw] bugfix: don't use WINE for custom frontends
-o- [GS4] - [char.rb] bugfix: add back Char.stance
-o- [GS4] - [claim.rb] feat: new module and associated changes to xmlparser
-o- [GS4] - [experience.rb] feat: percent experience options
-o- [GS4] - [parser.rb] bugfix: allow for negative TNL exp value
-o- [GS4] - [parser.rb] bugfix: allow hyphenated last names in character names
-o- [GS4] - [parser.rb] feat: update resource matching for new Bard service
-o- [GS4] - [stash.rb] bugfix: catch more shield removal messages
-o- [GS4] - [util.rb] bugfix: underscore issue for PSMs
</PRE>
'''5.7.0'''
<PRE>
-o- Supports Ruby 3.2 - security enhancements and huge speed improvements for regex
-o- New libraries/modules/classes: Account, HMR (Hot Module Reloading)
-o- GS4 Infomon now baked into Lich5 as a library, no more need to run standalone script
-o- New GS4 libraries/modules/classes: Ascension, Bounty, Currency, Experience, Resources, Society, Status, Warcry
-o- Updates to existing libraries/modules/classes: Armor, Util, Weapon, Spell, GameObj, Messaging
-o- Several Bugfixes for lots of things
-o- Lots of code cleanup
</PRE>
'''5.6.2'''
<PRE>
-o- Fix for XML errors
-o- Adds the DR Plat instance for Frostbite FE
-o- Adds ‘ball’ as the noun used for ‘ball and chain’
-o- Adds the movement result ‘slip in the mud and fall flat’
-o- Corrects stamina cost for the feature Dispel Magic
-o- Plus all the latest script updates from Elanthia-Online!
</PRE>
'''5.6.1'''
<PRE>
-o- Fix for XML to limit login errors (DR)
-o- Fix for XMLData.active_spells to properly register wizard 'recovery' spell cooldowns
-o- Messaging updates to remove error in Wizard FE encodings
-o- Corrects for error in detecting PSM skill changes (cman) via warrior / rogue guild lessons
-o- Deprecates LNet script from master repository
-o- Miscellaneous small bug squashing
</PRE>

'''5.6.0'''
<PRE>
-o- (DragonRealms) Support for Genie and Frostbite frontends
-o- (GemStone) Changed methods to improve ;go2 speed and reduce lich.db3 calls
-o- (GemStone) Updates to support silver_count function
-o- (Both) Changed method for updating lich ecosystem
</PRE>

'''5.5.0'''
<PRE>
-o- Support for DragonRealms
-o- Updated support for scripts like BigShot
-o- Providing the LichID and UID on Profanity
-o- Spell.force_incant, .force_channel, and .force_evoke
-o- Standardized message method for script authors
-o- Sundry small improvements / fixes and changes
-o- And the creme de la creme - a custom directory
</PRE>

'''5.4.0'''
<PRE>
-o- Simu Room IDs (formally called 'unique ID' or 'uid' for Lich) added to Map, mapDB where known, and ;go2 for navigation (courtesy Xanlin and with our thanks!) ;go2 u7120 for all you ex-GMs out there.
-o- Room titles will now display the Lich ID and / or the UID for the room based on user selections - default is on for both, and enabled / disabled via Lich.display_lichid or Lich.display_uid toggles that can be set to on / off or true / false. (;e Lich.display_lichid=true/false and ;e Lich.display_uid=true/false) You can remove that rnum from your autostart now! To gain the benefit of the UID deployment, be sure to ;repo download-mapdb
-o- REQUESTS: Drop 5 minute timeout function from Lich
-o- waitrt? and waitcastrt? will still pause activities, but will return TRUE or FALSE in keeping with the Ruby functionname? tradition (no more failing to get a weapon out due to RT from climbing!)
-o- empty_hands and fill_hands will now check to see if the character is in roundtime before trying to put away or retrieve held items
-o- Infomon received an update that keeps spell timers in sync with the information received from the server - no more need to immediately do a spell active in game to get the right times to display for various legacy scripts and ;magic after visiting the invoker or using an SK item
-o- Lich now provides a facility to get current coins on the character that is a bit more agnostic to data changes from Simu - Lich::Util.silver_count
-o- Various other small tidbits to help ease maintenance and future development
-o- PLEASE NOTE: This update is required for the newest Bigshot (released today!) and for future eloot and eherbs scripts (release RSN)
</PRE>

'''5.3.0'''
<PRE>
-o- Added support for Wrayth (renamed Stormfront) installations
-o- Converted Linux | WINE login methods to 'method 0', does not use Simu launcher
</PRE>

'''5.2.1'''
<PRE>
-o- Support for STOWing items irrespective of special item scripts
-o- Improved query support for Effects and CMans
-o- Fix Lich bug to respect the 'groupmovement' flag in game
-o- Fix Lich round time calculations (more aggressive timing)
-o- Dark Mode is now a thing
-o- Lich4 Style GUI layout available
-o- Several file location changes to support future code change efforts
</PRE>

'''5.0.19'''
<PRE>
-o- Benefit: Monks with Mental Acuity (all 3 of you) rejoice - stamina casting!
-o- Benefit: PSM3 included, no charge. No hair remaining, either!
-o- Benefit: Ok, stay seated: Some of your various SF spell duration windows may work. . . better? Yes, not perfect, but better. No pictures, please!
-o- Updated infomon that properly detects Cloak of Shadows on those pesky sorcerers, and the Raise Dead Cooldown periods for those wondrous clerics.
-o- A new update process for Lich 5 - tired of having to download that script over and over just to update? Get yourself a copy of lich5-update.lic. Note, if you already have it, you're set! If not - ;jinx script install lich5-update --repo=elanthia-online
</PRE>

'''5.0.11'''
<PRE>
-o- Updated the method used to log onto SIMU servers.
-o- Added the Animalist item specifics to Lich5's empty and fill hands routines
-o- Improved Invoker messages for Avalon and Wizard FEs (no change for SF FE)
-o- Improved cleanup and store methods when player EXIT's or QUIT's game
-o- Crafted two new methods (stash_hands and equip_hands) for future script use
-o- Some behind-the-scenes cleanup to improve maintaining the Lich5 ecosystem
-o- Add Spell Active improvements
-o- Add PSM and Ranger improvements
</PRE>
</div>

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

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

Lich:Software/Mac Installation

2026-10-28T13:09:29Z

WHIGHTCNIGHT: change to use Saga as the primary FE choice

{{3rd-party}}
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.

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

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

Your system should respond with <code>Ready to brew</code>. 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 <code>Gemfile</code>) 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.

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

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

Before we begin, let's check to be sure rbenv is working properly. Enter this command in Terminal and press ENTER.

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

# <code>rbenv install 4.0.9</code>
# <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:
<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:
<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

If your version reflects 4.0.9, proceed 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 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.

# <code>cd ~/Desktop/Lich5</code>
# <code>bundle config set --local without 'development vscode'</code>
# <code>bundle install</code>

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.

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 → 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 → 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 → Enable Login with Lich'''.
# Choose '''File → 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==
* [[Lich scripting reference]]
* Playershops by Lich: https://ps.lichproject.org/
* Unofficial Support for Lich: http://forum.gsplayers.com/forumdisplay.php?f=104
* Popular Lich script thread: http://forum.gsplayers.com/showthread.php?81229-What-Lich-Scripts-Do-You-Regularly-Use

{{Third-Party Software}}

Lich:Software/Installation

2026-10-28T12:53:19Z

WHIGHTCNIGHT: collapse frontend section

{{3rd-party}}
=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 Wrayth or Wizard FE. Lich is also used by many on both MacOS and multiple Linux distributions.

=Installing the Latest Stable Release=

'''The latest stable lich version is 5.22.0 supporting Ruby 4.0 - published October 8, 2026'''

==In-Place Upgrade==

If you are on an older version of Lich 5 and want to upgrade to the most current version, you can choose to either upgrade Lich5 only or both Lich 5 and Ruby. If you're currently on Lich 4, able to check by running the command <CODE>;e echo LICH_VERSION</CODE>, go to the [[#Upgrade Installation for Lich 5 from Lich 4 (11/14/2023)|upgrade from Lich 4 section]].

For each section, please follow the directions/commands one at a time.

===Lich 5 Only===

====Lich 5.7 or newer====
# You must be running Ruby 4.0 or greater for Lich 5.19 +. If unsure, please update both (see below)!
# '''Backup existing Lich 5 folder'''
# Run this command in-game <CODE>;lich5-update --update</CODE>
# Quit and restart lich.
# Congratulations - you're now running on the latest version of Lich!

====Lich 5.6 or older====
Please proceed to updating both Ruby and Lich 5

===Both Ruby 4.0 & Lich 5===
This method is for Windows only. Linux and MacOS users, please do a Lich 5 only update and update Ruby manually via normal install/update methods for the OS.

# Logout of all characters
# '''Backup existing Lich 5 folder'''
# Uninstall existing Ruby4Lich5 installs from Programs & Features control panel, or alternatively, rename your existing Ruby4Lich5 folder to Ruby4Lich5save. (Defaults to C:\Ruby4Lich5)
# Download the latest [https://github.com/elanthia-online/lich-5/releases/latest/download/Ruby4Lich5.exe Ruby4Lich5.exe Installer]
# Run the installer and be sure to have both Ruby and Lich 5 option selected
# Congratulations - you're now running on the latest version of Lich & Ruby!

===Ruby 4.0 Only===
Use this to upgrade to the newest version of Ruby only if you're already on the latest version of Lich5 and now want to update Ruby afterwards. If you're not already on the latest version of Lich5, please use previous section steps instead.
# Logout of all instances/characters
# '''Backup existing Lich 5 folder'''
# Uninstall your existing Ruby4Lich5 install via Programs & Features (ensure it's now gone, default location was C:\Ruby4Lich5)
# Download the latest [https://github.com/elanthia-online/lich-5/releases/latest/download/Ruby4Lich5.exe Ruby4Lich5.exe Installer]
# Run the new installer and choose to only install Ruby Only
# Congratulations - you're now running on the latest version Ruby!

==Windows New Installation==

{{blue|These instructions are not for DragonRealms. [[#Ecosystem Information|For those scroll to the bottom]].}}

'''For Windows 11 / 10 / 8 / 7''' users: you can download the [https://github.com/elanthia-online/lich-5/releases/latest/download/Ruby4Lich5.exe Ruby4Lich5.exe Installer] and install everything you need automatically. Click on the '''Ruby4Lich5.exe''' and download it to your computer then double click on the executable in your default download folder. Note, a user may need to adjust their browser or security settings to allow download and installation.
If you have never played before, follow the 'New Installation' instructions. If you have played before, and have used Lich before, follow the 'Upgrade Installation' instructions.

===New Installation for Lich 5 (11/14/2023)===

# '''Please log into the game of your choice through the Simutronics website first'''. Install the launcher (not SGE), and install your FrontEnd of Choice. The Wrayth FrontEnd is presently the supported FrontEnd, but Wizard will work as well, if you are nostalgic. After you've logged in, log out and continue.
# Download and Run the [https://github.com/elanthia-online/lich-5/releases/latest/download/Ruby4Lich5.exe Ruby4Lich5.exe 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, 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.

===Upgrade Installation for Lich 5 from Lich 4 (11/14/2023)===

This option is deprecated. Lich 5 architectures are not compatible with Lich 4. Back up your existing Lich 4 folder, uninstall any existing Ruby executables, and then follow the instructions for a new install above.

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

==MacOS==
There two common options for playing Gemstone IV on a Mac is either to play natively with Avalon or to use virtualization software such as Parallels with Wrayth/WizardFE. Below are the options on how to do that.

===Native Avalon===
Players with Macs can use [[Mac_Installation_-_Lich_(software) | Installing Lich on Macs]] for installation help. This process works well for Mac OS Catalina and Big Sur. If you have not updated your Mac OS yet, these instructions may work depending on your actual version. If you run into a snag, follow the contact instructions provided.

===Parallels Windows===
With the latest releases of Ruby4Lich5 installer, you can now follow the normal Windows installation for both Intel and Apple silicon based Apple computers.

To install Wrayth/WizardFE, Lich, and Ruby via Parallels you will need to do a few various steps as outlined below. Please note, the rubyw file in C:\Ruby4Lich5\X.X.X\bin may be set to run in compatibility mode for windows 7. On an ARM Mac running parallels, this may causes Wrayth scripts not to run. Turning compatibility mode off in the rubyw file could fixe this issue if it was enabled.

The following steps are to be done AFTER you've successfully installed Wrayth/WizardFE and can login normally without Lich5 on the machine. Once you've done that and can successful connect normally, then follow these steps:
# Download and install [https://github.com/elanthia-online/lich-5/releases/latest/download/Ruby4Lich5.exe Ruby4Lich5.exe Installer] and use default options presented during install
# Double click the lich.rbw file that is now located in the extracted Lich5 location you did above. Login and play as usual.

==Linux==
Pick the subsection for your distribution below. Each one installs Ruby and Lich; front ends (Profanity and Warlock) are covered once in [[#Frontends|Frontends]] at the end, since their steps are the same on every distribution.

===Chromebook & Debian variants===
<div class="mw-customtoggle-debian" style="font-size:16px;overflow:auto;color:#0000FF">[Click to Expand]</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-debian">
The following steps should install Lich for users of Debian/Chromebooks. To also install a front end such as Profanity or Warlock, see [[#Frontends|Frontends]] at the end of the Linux section.

'''Step 1.'''
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 curl libssl-dev libyaml-dev libreadline6-dev zlib1g-dev libncurses5-dev libffi-dev libgdbm6 libgdbm-dev libsqlite3-dev git unzip libcairo2-dev libgirepository1.0-dev libgtk-3-dev gobject-introspection
</pre>

{{side box|NOTE: If you are updating an existing Ruby installation rather than installing from scratch, skip steps 2, 3, and 4. Instead, update your ruby-build with the following command, and then proceed to Step 5.<pre>git -C ~/.rbenv/plugins/ruby-build pull</pre>}}

'''Step 2.'''
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>

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

'''Step 4.'''
Download the tools to let rbenv install Ruby on its own, then install Ruby 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</pre>

'''Step 5.'''
<pre>rbenv install 4.0.9 -v
rbenv global 4.0.9
</pre>

Install Lich:
<pre>
cd ~
curl -L "https://github.com/elanthia-online/lich-5/releases/latest/download/lich-5.zip" -o temp.zip && unzip temp.zip -d ./ && rm temp.zip
</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 using the <tt>Gemfile</tt> included with Lich5 by running <tt>bundle install</tt>. The Gemfile also lists developer-only gems (the <tt>development</tt> and <tt>vscode</tt> groups) that you do not need, so tell Bundler to skip them first:
<pre>
echo "gem: --no-document" > ~/.gemrc
cd ~/Lich5
bundle config set --local without 'development vscode'
bundle install
</pre>
:<small>Note: <tt>bundle install --without ...</tt> no longer works; that flag was removed from the version of Bundler that ships with Ruby 4.0. Use <tt>bundle config set</tt> as shown above.</small>
</div>

===Arch Linux & Arch-based distributions===
<div class="mw-customtoggle-arch" style="font-size:16px;overflow:auto;color:#0000FF">[Click to Expand]</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-arch">
The following steps should install Lich for users of Arch Linux and Arch-based distributions (Manjaro, EndeavourOS, etc.). To also install a front end such as Profanity or Warlock, see [[#Frontends|Frontends]] at the end of the Linux section.

Update the system and install required dependencies:
<pre>
sudo pacman -Syu
sudo pacman -S --needed base-devel openssl libyaml readline zlib ncurses libffi gdbm sqlite git unzip curl gtk3 gobject-introspection
</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 4.0.9 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 4.0.9 -v
rbenv global 4.0.9
</pre>

Install Lich:
<pre>
cd ~
curl -L "https://github.com/elanthia-online/lich-5/releases/latest/download/lich-5.zip" -o temp.zip && unzip temp.zip -d ./ && rm temp.zip
</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 using the <tt>Gemfile</tt> included with Lich5 by running <tt>bundle install</tt>. The Gemfile also lists developer-only gems (the <tt>development</tt> and <tt>vscode</tt> groups) that you do not need, so tell Bundler to skip them first:
<pre>
echo "gem: --no-document" > ~/.gemrc
cd ~/Lich5
bundle config set --local without 'development vscode'
bundle install
</pre>
:<small>Note: <tt>bundle install --without ...</tt> no longer works; that flag was removed from the version of Bundler that ships with Ruby 4.0. Use <tt>bundle config set</tt> as shown above.</small>
</div>

===Fedora===
<div class="mw-customtoggle-fedora" style="font-size:16px;overflow:auto;color:#0000FF">[Click to Expand]</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-fedora">
The following steps should install Lich for users of Fedora. To also install a front end such as Profanity or Warlock, see [[#Frontends|Frontends]] at the end of the Linux section.

Lich 5 requires Ruby 4.0 or newer. The Ruby that ships with currently supported versions of Fedora is older than that (41 uses Ruby 3.3; 42 and 43 use Ruby 3.4), so these steps install Ruby 4.0.9 with '''<tt>[https://github.com/rbenv/rbenv rbenv]</tt>''' instead of using Fedora's Ruby.

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 cairo-devel curl gcc gdbm gdbm-devel gdk-pixbuf2-devel glib2-devel \
gobject-introspection-devel gtk3-devel libyaml-devel libffi-devel make ncurses-devel openssl-devel readline-devel \
redhat-rpm-config sqlite-devel unzip zlib-devel
</pre>

{{side box|NOTE: If you are updating an existing rbenv Ruby installation rather than installing from scratch, skip step 3. Instead, update your ruby-build with the following command, and then run only the <tt>rbenv install</tt> and <tt>rbenv global</tt> lines from step 3.<pre>git -C ~/.rbenv/plugins/ruby-build pull</pre>}}

3. Install rbenv and Ruby 4.0.9:
<pre>
git clone https://github.com/rbenv/rbenv.git ~/.rbenv
echo 'export PATH="$HOME/.rbenv/bin:$PATH"' >> ~/.bashrc
echo 'eval "$(rbenv init -)"' >> ~/.bashrc
source ~/.bashrc
git clone https://github.com/rbenv/ruby-build.git ~/.rbenv/plugins/ruby-build
rbenv install 4.0.9 -v
rbenv global 4.0.9
ruby -v
</pre>
The last command should print a line starting with <tt>ruby 4.0.9</tt>. If it doesn't, close and reopen the terminal and try <tt>ruby -v</tt> again.

4. Install Lich:
<pre>
cd ~
curl -L "https://github.com/elanthia-online/lich-5/releases/latest/download/lich-5.zip" -o temp.zip && unzip temp.zip -d ./ && rm temp.zip
</pre>

5. 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 using the <tt>Gemfile</tt> included with Lich5 by running <tt>bundle install</tt>. The Gemfile also lists developer-only gems (the <tt>development</tt> and <tt>vscode</tt> groups) that you do not need, so tell Bundler to skip them first:
<pre>
echo "gem: --no-document" > ~/.gemrc
cd ~/Lich5
bundle config set --local without 'development vscode'
bundle install
</pre>
:<small>Note: <tt>bundle install --without ...</tt> no longer works; that flag was removed from the version of Bundler that ships with Ruby 4.0. Use <tt>bundle config set</tt> as shown above.</small>
</div>

===Frontends===
<div class="mw-customtoggle-frontends" style="font-size:16px;overflow:auto;color:#0000FF">[Click to Expand]</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-frontends">
Finish the Lich installation for your distribution above first, then set up one of these front ends.

====Profanity====
Profanity is a terminal-based Front-End that will let you play the game (in lieu of The Wizard or Wrayth). Its gems (such as <tt>curses</tt>) are installed by the <tt>bundle install</tt> step above. Download Profanity:
<pre>
cd ~
git clone https://github.com/elanthia-online/ProfanityFE.git
</pre>

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

====Warlock====
Download Warlock from https://sproctor.github.io/warlock3/download.html, then run Lich the normal way with Ruby:
<pre{{log2|margin-right=35%}}>
ruby ~/Lich5/lich.rbw
</pre>
Use your login information with these settings to use the Lich launcher: https://github.com/sproctor/warlock3/wiki/Lich-support
</div>

=Popular Scripts=
{{#section:Lich:Script Repository|popularscripts}}

=Ecosystem Information=

* DragonRealms Variant - [https://elanthipedia.play.net/Lich_script_repository#Setup_and_Installation Setup and Install instructions]

=Lich Changelog=
<div class="mw-customtoggle-changelog" style="font-size:16px;overflow:auto;color:#0000FF">[Click to Expand]</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-changelog">
'''5.22.0'''
<PRE>
### Features (general)
* add opt-in bounded script execution guards (#1575)
* add static-only map route selection (#1577)
* bounded fput with max_resends, interrupt, resend_transient and failure symbols (#1587)
* Spell.results_regex, the lines cast waits on, exposed (#1590)
* add Events, a script-to-script notification primitive; combat emits on it (#1619)
* add deterministic hook priorities (#1621)
* Map.boundary_rooms_for(ids), the perimeter of any set of rooms (#1660)
* sticky ever_hostile? keeps Sympathy'd creatures in targets (#1665)
* --pipe -g honours the frontend flag, and --sentinel requests the origin marker (#1677)

### Features (gs)
* add trustworthy combat observation provenance (#1576)
* Lich::Gemstone::Stance, a shared stance setter (#1578)
* Lich::Stash.wield and Stash.hands put named items into hands (#1579)
* Lich::Gemstone::Mana.pulse, the MANA PULSE verb once (#1580)
* Lich::Gemstone::Bank, Currency refresh, and WEALTH parser lines (#1581)
* PSM command and results_regex readers, factored out of use (#1583)
* Lich::Gemstone::Fog, the ways home on the spell and society readers (#1584)
* Combat::Messages - non-combat message families as observer events (#1586)
* society command readers, factored out of use (#1589)
* Group.join, the follower's side of Group.add (#1591)
* emit post-commit combat recorder receipts (#1592)
* combat definition supplements from a player YAML file (#1607)
* message definitions from the player supplement file (#1608)
* creature library - abilities from session logs, limbs flags, triggers as hash of arrays (#1623)
* expose exact server creature health from crtrStatus (#1661)

### Bug Fixes (general)
* fix spec stub race breaking FFI loads, gate WindowsCredentialManager to Windows (fixes #1542) (#1573)
* setup_files uses content hash for cache freshness (#1596) (#1599)
* creatures registry housekeeping independent of Combat::Tracker (#1603)
* place effect-list.xml backups in the update snapshot folder (#1606)
* retain discovery ownership through cleanup (#1612)
* Initial Lich state update and detachable-client split GS/DR (#1617)
* bound move()'s remedy retries, record why a move failed, lift it into Lich::Common::Move (#1622)
* update puts to Lich.log (#1630)
* create detachable-client session file without --login (#1656)
* converge server_time_offset instead of resetting it every prompt (#1663)
* plain-language lich5-update messages when GitHub fails (#1687)
* Inventory.refresh waits out roundtime before sending (#1688)

### Bug Fixes (dr)
* update HOW pattern to accommodate various soul states (#1620)
* restore script halt in DRCC.get_crafting_item on missing item (#1624)
* halt script when too distracted to turn recipe book (#1625)
* equipmentmanager energy bow handling (#1662)
* report when DRC.rummage can't read a container (#1671)
* DRCI.get_item? confirms #<id> gets by the item id in hand (#1674)
* DRCT.sell_item references the item through DRCI.item_ref (#1675)
* DRCA.do_buffs filters day/night spells without mutating settings (#1680)
* DRCI.tie_item? no longer reports an empty pouch as tied (#1684)
* DRC.play_song? keeps climbing and performance songs across instrument switches (#1686)

### Bug Fixes (gs)
* Injured cache lives on the class and keys on an injury fingerprint (#1582)
* infomon - a spell's start message refreshes a refreshable timer (#1585)
* Group.broken? waits on Lich::Claim::Lock, the constant that exists (#1588)
* combat module - hunt-log audit: interrupted-swing resume, status attribution by event, spell-loss cause, live defs (#1593)
* QStrike prices MSTRIKE's own stamina cost (#1594)
* combat module - a stand-up message later in the chunk outranks an earlier knockdown crit (#1595)
* track spell cooldowns on the characters a spell locks out (#1597)
* catalog missing deity-specific strike lines for Divine Wrath (335) (#1598)
* combat module - Rysk/Dreadt log audit: Holy Weapon release model, held maneuver rolls, AoE roll attribution, live defs (#1600)
* Combat defs add thrust as a basic attack (#1615)
* preserve group state after ambiguous disband reply (#1629)
* target ridden mounts before their first crtrStatus (#1669)
* snapshot Effects registries so scripts can't break the XML parser (#1672)
</PRE>
'''5.21.0'''
<PRE>
### Features (general)
* Add --refresh-characters and --add-character CLI flags (#1504)
* add --active-session-dir to decouple Active Sessions coordination from --temp (#1520)
* add read model for the inventoryManager extended feed (#1524)
* GUI add configurable frontend registry (#1558)
* add HTTPS web-login fallback for when EAccess (7910) is unreachable (#1570)

### Features (dr)
* player-supplied custom prep/cast/invoke messages (#1528)
* opt-in cambrinth charge distribution across configured items (#1549)
* populate GameObj from INV LIST full refresh (02 of 05) (#1554)
* non-destructive upsert for INV SEARCH / category scrapes (03 of 05) (#1556)
* reconcile GameObj containers on hand pickup (04 of 05) (#1557)
* [DRCC] add shared private-forge helpers (#1560)

### Features (gs)
* creature template library - measured combat data, HP/speed censuses, messaging (#1539)

### Bug Fixes (general)
* enforce Script#pause at every blocking/mutating checkpoint (#1537)
* always report missing gems on stderr; only wait on a dialog without a tty (#1544)
* dispatch --help and --version before the GTK require (#1546)
* global_def update deprecated method calls to include caller info (#1550)
* normalize colons in Lich::Util.normalize_lookup (#1561)
* Script.log respects --log-dir/LOG_DIR override; use File.join for paths in script.rb (#1572)

### Bug Fixes (dr)
* drvariables add more data to VOL_MAP (#1536)
* pin capped skills to 34 in DRSkill.clear_mind (#1548)
* match lowercase "it's already open" when opening a container (#1553)
* normalize capitalized leading articles in inventory scrape names (01 of 05) (#1555)
* make INV LIST refresh atomic and warn on interruption (05 of 05) (#1563)
* refresh before_name/after_name on a name-preserving container move (#1564)
* do not re-add a held item as worn inventory on inv scrape (#1565)
* evict orphaned identity-index entries on a name-changing upsert (#1566)
* unpause the exact scripts safe_pause_list paused, by object (#1574)

### Bug Fixes (gs)
* Infomon xmlparser additional npc death messaging (#1540)
* correct messaging drift in 13 crit table patterns (#1547)
* combat module - event defs, observer emissions, replay-verified parsing, SQLite recorder (#1559)
</PRE>
'''5.20.1'''
<PRE>
### Bug Fixes (general)
* bound EAccess auth with a timeout so a stalled SGE backend can't hang Lich silently (#1502)
* Linux WINE and Wrayth FE detection (#1517)
* update Gemstone game-code validations (#1518)
* preserve bundled display-state tags on quiet-suppressed chunks (#1530)
* prevent a stray formatting character from appearing in Saga during quiet script output (#1532)

### Bug Fixes (dr)
* make $safe_pause_lock holder immune to pause (#1525)

### Bug Fixes (gs)
* critranks.rb tolerate nil table rows, fix reload!, index patterns … (#1522)
* combat module hardening - ordered processing, 22x faster parsing, double-count fix (#1523)
</PRE>
'''5.20.0'''
<PRE>
### Features (general)
* add concurrent runtime I/O and multi-client detach support (#1459)
* --bind-address speaks the same keywords as --detachable-client (#1461)
* GUI Launcher Improvements (#1463)
* Add supervised child script APIs (01 of 06) (#1474)
* Add forced script teardown command (06 of 06) (#1479)
* teardown and distinguishable errors for Script.run_child (#1501)

### Features (dr)
* DRCMM.moon_weapon_duration - read a moon weapon's remaining life (#1483)
* id-based creature tracking from crtrStatus + assess (#1485)
* capture room UID from <nav> tag; stop enforcing ShowRoomID; opt-in room-id placement (#1491)
* user-extensible scroll substitutions via settings (01 of 06) (#1512)
* user-extensible boxes and trash receptacles (03 of 06) (#1514)
* user-extensible summoned-weapon adjectives (04 of 06) (#1515)
* user-extensible flavor-text stripping (05 of 06) (#1516)

### Features (gs)
* gameobj add full_name matcher to type/sellable classification (#1453)

### Bug Fixes (general)
* prevent empty/partial GameObj registry reads during mid-stream refresh (#1370)
* no-op Gtk.lich_main_quit when no main loop is nested (#1464)
* correct path-flag aliases and document all path options (#1472)
* Synchronize script lifecycle transitions (02 of 06) (#1475)
* Coordinate script shutdown draining (03 of 06) (#1476)
* Harden script lifecycle ownership (05 of 06) (#1478)
* surface the underlying LoadError in dependency alerts (#1480)
* extract game-agnostic CreatureBase into lib/common (#1484)
* bound GemCheck alert dialogs with a timeout so they can't hang forever (#1488)
* identify Genie as the frontend for headless launches (#1490)
* restore detachable client disconnect notice to stdout (#1492)
* harden detachable client teardown and escape init payload (#1493)
* resolve GameObj status visibility during staged refresh (#1497)
* compact client write queue instead of ending the session (#1498)
* scrub startup credentials once login completes (#1499)
* Honor Simu-side teardown for 10 seconds (#1505)

### Bug Fixes (dr)
* resolve no-UID rooms carrying a stored UID instead of returning nil (#1467)
* equipmanager.rb - reliable ranged-weapon transitions - stow ammo after unload + verify offhand wield hand (#1468)
* common-healing.rb - DRCH.bind_wound: only dispose a dislodged item while it is in hand (#1469)
* preserve game RealID in room title (GS parity for ";display roomid title") (#1500)
* Refine need_buffs? logic for non-recast spells to correctly check cyclic spells. (#1503)
* reduce symbol-torn scale scrolls to gettable noun (#1506)
</PRE>
'''5.19.1'''
<PRE>
### Bug Fixes (general)
* lower game socket keepalive idle from 120s to 30s (#1449)
* resilient ActiveSessions ownership + shutdown watchdog (#1452)
* Quit Gtk.main cleanly (#1455)
* Refactor regex to string comparisons for ARGV options (#1456)

### Bug Fixes (gs)
* ingest newly-exposed mindState experience and roommeta room fields (#1450)
</PRE>
'''5.19.0'''
<PRE>
### Features (general)
* Add character generator support via EAccess protocol (#1384)
* Add modern script command shutdown method (#1385)
* migrate the server-stream parser from REXML to Ox, with pipe-mode benchmark harness and DR parser coverage (#1396)
* enumerate script subdirs with file glob (#1397)
* add --bind-address option to set listen socket address (#1405)
* add central method to determine lich ver (#1417)
* setup_files: support scripts/data/custom for user data overrides (#1431)
* Modify running? method to support optional exact matching of script names (#1436)
* keyword bind hosts for the detachable client (tailscale/lan/any) (#1437)
* add roomlinks/roommono toggles for room display (#1438)
* self-healing gem requires (#1439)
* various Saga FE compatibility tweaks (#1443)
* add macOS limited gem recovery (#1448)

### Features (dr)
* Capture combat position from the balance status line (#1400)
* detect scheduled shutdown and expose it on DRParser (#1409)
* xmlparser: add structured parser for the assess (combat situation) stream (#1413)
* Implement DRCA.need_buffs? method for buff checks (#1428)

### Features (gs)
* anchor Infomon parser regex unions to line start (#1391)
* creature xml additions (#1425)
* add creature template library (#1427)

### Bug Fixes (general)
* surface a failed Game.open in the connect timeout (#1408)
* bound long-session memory growth (index/hook/watchfor/buffer leaks) (#1410)
* improve and harden shutdown (#1416)
* use bundler to check for required Ruby gems (#1420)
* pin lich directory for gemfile check (#1423)
* Show CLI login ARGV for SAL connections (#1424)
* increase read timeout on idle socket to 300 seconds (#1426)
* monkeypatch gi for memoryreleaser / asyncprocessor until patched upstream (#1429)
* Mapdb sort tags by downcase and original case (#1433)
* stop locking the load path at boot; keep Gemfile.lock in sync on self-update (#1434)
* minimum Ruby 4.0 required & migrate Ruby version check (#1444)
* align --announce with --update for Ruby version (#1447)

### Bug Fixes (dr)
* BalanceValue regex to match combat status lines (#1398)
* equipmanager.rb - Fix unload weapon detection when AimTimerDialog tag is prepended (#1414)

### Bug Fixes (gs)
* global_defs update pushStream regex to include 'reserve' id (#1379)
* psms Warcry.available? correction (#1387)
* xmlparser support new field exp, climate, terrain XML feeds (#1388)
* global_defs move() update regex for standing condition (#1407)
* Currency add method to retrieve aevit event currency (#1411)
* Stash check result type before comparing regex for wear_to_inv (#1430)
</PRE>
'''5.18.0'''
<PRE>
### Features (dr)
* common-crafting add method for creating mechanisms (#1375)

### Bug Fixes (general)
* stringproc normalize CRLF | CR to LF (#1378)
* rubocop custom cop ascii only cleanup (#1382)

### Bug Fixes (dr)
* equipmanager update to assume missing items aren't worn (#1376)

### Bug Fixes (gs)
* Infomon xmlparser additional npc death messaging (#1326)
</PRE>
'''5.17.3'''
<PRE>
### Bug Fixes (general)
* Script module replace MemoryReleaser with GC.start for cleanup (#1364)
* Add sqlite busy timeout policy to core (#1365)
* Script#kill remove GC.start and add optional instrumentation (#1368)
* reorder shutdown ala MahtraDR and detect script teardown de... (#1369)
</PRE>
'''5.17.2'''
<PRE>
### Bug Fixes (general)
* harden custom repo identity, collision, and contract boundaries (#1333)
* stop SessionLifecycle before closing database on normal exit (#1334)
* harden FeatureFlags for closed db handle (#1335)
* SynchronizedSocket write resilience and zombie client elimination (#1338)
* correct RP timing issue for release notes (#1348)
* gate object cleanup in GTK queue (#1354)
* recover from cross-process zombie in ActiveSessions service (#1355)
* Improve shutdown session state handling (#1359)
* non-ascii hygeine to address rubocop errors (#1360)
* Remove debug log IO from heartbeat tick loop (#1363)

### Bug Fixes (dr)
* DRC text2num correction for thousand (#1343)

### Bug Fixes (gs)
* Overwatch add REVEALED_EXPLODES regex pattern (#1356)
* Stash add_to_bag result type check before regex compare (#1357)
</PRE>
'''5.17.1'''
<PRE>
### Bug Fixes (general)
* enable heartbeat-driven failover for ActiveSessions service owner (#1340)
* copy Gemfile and LICENSE during self-update (#1345)
* Add top-level parse_args/display_args bridge to global_defs (#1346)

### Bug Fixes (dr)
* replace undefined custom_require in check_moonwatch (#1336)
* set_stance places 100 in the correct positional slot (#1337)
* cache SlackBot users list to prevent API throttling (#1342)
* Add CORE_AUTOSTART sentinel to skip dependency.lic autostart helpers (#1344)

### Bug Fixes (gs)
* Infomon Status.cutthroat? Effect Debuff correction (#1331)
* add support for RESERVE xml in GameObj.reserve (#1341)
</PRE>
'''5.17.0'''
<PRE>
### Features (general)
* custom 3rd-party repo support for ScriptSync (#1285)
* Add get_settings, get_data, start_scripts_if_available to core (#1305)
* Add Map.apply_wayto_overrides for personal map overrides (#1306)

### Features (dr)
* Decouple SetupFiles from script-scoped echo and XML feed timing (#1304)
* Add game flags and obsolete script warnings to DRInfomon startup (#1307)

### Bug Fixes (general)
* use :__unset for --without-frontend CLI request YAML matches (#1301)
* prevent zombie server deadlock in Active Sessions accept loop (#1302)
* improve MacOS keychain system check for older OS variants (#1310)
* stub sync_all_repos to prevent leaked thread in games_spec (#1311)
* enforce beta confirmation 10s timeout (#1315)
* use send(:respond) in StatusReporter fallback path (#1316)
* ensure SessionLifecycle.stop runs on abnormal exit (#1317)
* address ActiveSessions lifecycle hot path feature-flag polling (#1325)
* catch ECONNRESET in _puts and bound walk_to retry depth (#1327)
* safeguard gtk logo.png loading (#1329)

### Bug Fixes (gs)
* Add InnCheckedOut pattern to parser (#1309)
* Claim corrections to handle mounts in room_players stream (#1324)
</PRE>
'''5.16.2'''
<PRE>
### Features (general)
* session summary store and reporting (#1247)
* add core classes, ScriptSync, and login auto-sync (#1273)
* Add active sessions API (#1274)
* Add session status CLI query (#1276)
* configurable debug log retention (#1282)

### Features (dr)
* common-healing.rb - add vitality parsing to HealthResult (#1265)

### Bug Fixes (general)
* handle auth exceptions in manual login to prevent hang on bad password (#1267)
* set SO_REUSEADDR before bind to allow immediate port reuse (#1268)
* Persistent Launcher re-enable play button post launch (#1269)
* Restore manual login behaviors to not require saved entry t... (#1270)
* log and re-raise unexpected errors in saved login auth handler (#1271)
* narrow safe_write rollback scope so cleanup failure preserves successful write (#1287)
* fix three revert bugs in SnapshotManager (#1289)
* guard nil release asset and validate before deleting lib/ (#1290)
* guard nil stable version in beta channel resolution (#1291)
* remove dead code in BranchInstaller (#1292)
* repair regression on gui button reenable from refactor (#1297)

### Bug Fixes (dr)
* common-items.rb - move pattern from failure to success block (#1262)
* buffer_room_objs missed split components with leading stream tags (#1284)
* common-items.rb - get_item_unsafe false positives via XML feed verification (#1286)
* forward vitality and dead fields in perceive_health (#1288)

### Bug Fixes (gs)
* Infomon xmlparser additional npc death messaging (#1275)
* Infomon xmlparser additional npc death messaging (#1281)
</PRE>
'''5.16.1'''
<PRE>
### Features (general)
* session summary store and reporting (#1247)
* add core classes, ScriptSync, and login auto-sync (#1273)
* Add active sessions API (#1274)
* Add session status CLI query (#1276)
* configurable debug log retention (#1282)

### Features (dr)
* common-healing.rb - add vitality parsing to HealthResult (#1265)

### Bug Fixes (general)
* handle auth exceptions in manual login to prevent hang on bad password (#1267)
* set SO_REUSEADDR before bind to allow immediate port reuse (#1268)
* Persistent Launcher re-enable play button post launch (#1269)
* Restore manual login behaviors to not require saved entry t... (#1270)
* log and re-raise unexpected errors in saved login auth handler (#1271)
* narrow safe_write rollback scope so cleanup failure preserves successful write (#1287)
* fix three revert bugs in SnapshotManager (#1289)
* guard nil release asset and validate before deleting lib/ (#1290)
* guard nil stable version in beta channel resolution (#1291)
* remove dead code in BranchInstaller (#1292)

### Bug Fixes (dr)
* common-items.rb - move pattern from failure to success block (#1262)
* buffer_room_objs missed split components with leading stream tags (#1284)
* common-items.rb - get_item_unsafe false positives via XML feed verification (#1286)
* forward vitality and dead fields in perceive_health (#1288)

### Bug Fixes (gs)
* Infomon xmlparser additional npc death messaging (#1275)
* Infomon xmlparser additional npc death messaging (#1281)
</PRE>
'''5.16.0'''
<PRE>
### Features (general)
* session summary store and reporting (#1247)
* add core classes, ScriptSync, and login auto-sync (#1273)
* Add active sessions API (#1274)
* Add session status CLI query (#1276)
* configurable debug log retention (#1282)

### Features (dr)
* common-healing.rb - add vitality parsing to HealthResult (#1265)

### Bug Fixes (general)
* handle auth exceptions in manual login to prevent hang on bad password (#1267)
* set SO_REUSEADDR before bind to allow immediate port reuse (#1268)
* Persistent Launcher re-enable play button post launch (#1269)
* Restore manual login behaviors to not require saved entry t... (#1270)
* log and re-raise unexpected errors in saved login auth handler (#1271)

### Bug Fixes (dr)
* common-items.rb - move pattern from failure to success block (#1262)
* buffer_room_objs missed split components with leading stream tags (#1284)
* common-items.rb - get_item_unsafe false positives via XML feed verification (#1286)

### Bug Fixes (gs)
* Infomon xmlparser additional npc death messaging (#1275)
* Infomon xmlparser additional npc death messaging (#1281)
</PRE>
'''5.15.1'''
<PRE>
### Bug Fixes (general)
* Mutli-launch persistent login GUI (#1245)
* Remove Windows OS CMD prompt flash (#1255)
* guard against broken pipe errors in Game._puts and send_to_client (#1260)
* add timeout safety to fput to prevent infinite hangs (#1261)

### Bug Fixes (dr)
* anchor stow success pattern to prevent fan close recovery bypass (#1254)
* add bounded recursion depth limits to 9 methods (#1257)
* stow_helper failure detection + unload_weapon ammo recovery (#1259)
</PRE>
'''5.15.0'''
<PRE>
### Features (general)
* add InstanceSettings for core Settings API access (#1233)

### Features (gs)
* Overwatch module into core (#1201)

### Bug Fixes (general)
* fix GameObj container initialization and add clear_all_containers (#1226)
* GameObj object dedupe & GC (#1234)
* script.rb show Script.kill source (#1235)
* Exit quickly on CLI authentication failure (#1237)
* suppress wine detection noise and skip when unneeded (#1244)

### Bug Fixes (dr)
* DR modules fixes and enhancements (#1232)

### Bug Fixes (gs)
* psms.rb add additional failure matches (#1238)
* Bounty parser fix regex pattern for skin retrieval task (#1242)
</PRE>
'''5.14.2'''
<PRE>
### Bug Fixes (general)
* add retry with exponential backoff for all login authentication (#1205)
* update.rb allow for bugfix betas and branch updates (#1211)

### Bug Fixes (gs)
* infomon.rb bug in _key transformation (#1216)
</PRE>
'''5.14.1'''
<PRE>
### Bug Fixes (general)
* Change server_time_offset in XMLParser to be float instead of int (#1184)
* change encodings in main.rb to wizard FE only (#1199)

### Bug Fixes (gs)
* Infomon parser.rb update Account.subscription/type (#1192)
* spell.rb add last_cast to track last time casted (#1193)
* stash.rb additional improvements with ReadyList/StowList (#1197)
* Infomon parser.rb bug in EnhanciveEnd (#1198)
</PRE>
'''5.14.0'''
<PRE>
### Features (general)
* Add Genie map cross-reference fields to the DragonRealms map data model (#1169)

### Features (dr)
* DRExpMonitor move into core lich (#1154)

### Features (gs)
* add Enhancive module for enhancive item bonus tracking (#1113)
* add QStrike module for optimal stamina-based RT reduction (#1114)

### Bug Fixes (general)
* remove strip! from settingsInfo replacement (#1161)
* map_base.rb sort JSON better (#1171)

### Bug Fixes (dr)
* logbook_item recovery when crafted item not in hand (#1175)

### Bug Fixes (gs)
* xmlparser.rb capture additional death messaging (#1158)
* stash.rb ReadyList sheath handling and update inventory checks (#1166)
</PRE>
'''5.13.6'''
<PRE>
### Bug Fixes (general)
* allow --add-account to run without yaml and dat (#1143)
* enable --login for multi-variable custom launch commands (#1144)
* update.rb pervent update if MIN_RUBY not met (#1146)
* messaging.rb return "" for xml_encode with Wizard (#1147)
* prevent closing connection on module reload (#1148)
* Allow hmr to work on global_defs.rb (#1156)

### Bug Fixes (dr)
* buffer split room obj lines and merge instead of appending closing tag to broken line (#1149)
* add buffering for multiline room players (#1151)
* add verify_script def here instead of depending on dependency (#1155)

### Bug Fixes (gs)
* infomon.rb added updated_at field to upsert_batch (#1145)
* stowlist.rb check method fix when dead (#1152)
* readylist.rb check method fix when dead (#1153)
</PRE>
'''5.13.5'''
<PRE>
### Bug Fixes (general)
* util.rb only show gem installing debug messaging if gem mis… (#1131)
* add --gs and --dr, refactor argv_options to helpers (#1133)
* fix multiple custom entries, improvements to yaml save (#1134)
* login_tab_utils.rb expand helper text show Warlock (#1135)
* update CLI for YAML security signature, add auto-convert fo… (#1136)
* remove password parameter from debug logging in all cases (#1137)
* reduce minimum GUI window footprint for non-tabbed view (#1138)
* remove double save in YAML to preserve yaml.bak integrity (#1139)

### Bug Fixes (gs)
* stash.rb additional improvements (#1132)
</PRE>
'''5.13.4'''
<PRE>
### Bug Fixes (general)
* force system gem install if RubyGems fails (#1126)
* gui_login prevent destroying window if already destroyed (#1127)
* add window size / position saves to login GUI (#1128)
* non tabbed saved entries in reduced button / font size (not… (#1129)
</PRE>
'''5.13.3'''
<PRE>
### Bug Fixes (general)
* account manager sorting GUI fix (#1123)
</PRE>
'''5.13.2'''
<PRE>
### Bug Fixes (general)
* install_gem_requirements update available gems after install (#1120)
</PRE>
'''5.13.1'''
<PRE>
### Bug Fixes (general)
* password_cipher.rb upcase account_name for key (#1118)

### Bug Fixes (dr)
* validator.rb change sleep to should_sleep named param (#1116)

### Bug Fixes (gs)
* add base stats capture from 'info full' command (#1115)
</PRE>
'''5.13.0'''
<PRE>
### Features (general)
* Refocus Frontend (#960)
* socket configurator to better guard TCPSocket (#976)
* add simplified DB maintenance (#991)
* TextStripper module support for XML, HTML, Markdown (#1055)
* Login modernization and refactor to yaml (#1063)
* Ruby Memory Releaser module (#1066)

### Features (dr)
* support meta:trashcan tag for DRCI.dispose_trash (#966)
* Add GameObj.inv support for DR items (#1080)
* DRCS allow custom adjective for summoned weapons (#1088)
* DRParser support for new exp window xml stream elements (rested exp, tdps, favors) (#1104)

### Features (gs)
* Add Armaments (Weapon, Armor, and Shield) Module (#911)
* add creature module, including Hinterwilds creatures (#1002)
* Creature module combat tracking (#1003)
* track time of last total_experience record (#1030)
* add Injured class for checking ability to perform actions (#1035)

### Bug Fixes (general)
* map dijkstra optimization (#1061)
* update.rb keep script/data file incase of error on update (#1070)
* ensure proxy path is set for non-destructive array write-th… (#1073)
* [lib][global-defs] - move update (#1079)
* GameObj force new objects ID to be string (#1087)
* xmlparser.rb gate GSL exits sending behind @send_fake_tags (#1103)
* change Hash[] pair key conversion to use to_h for Ruby 4.0 (#1108)
* move gui-login.rb to Ruby standard gui_login.rb (#1111)
* update location for currency and move game-loader.rb to Ruby standard gameloader.rb (#1112)

### Bug Fixes (dr)
* DRCA allow custom spell prep messaging (#1089)
* Update Slackbot error handling, and lnet management (#1091)
* Fix exp mods parsing for DR (#1102)
* equipmanager.rb support for custom messaging in forester's longbow (#1105)
* Fix hang in equipment manager when game doesn't respond to commands (#1110)

### Bug Fixes (gs)
* Infomon additional CHE resign regex (#1067)
* Resource tracking for sorcerer shadow essence (#1085)
* cman.rb add hamstring regex for already lying down target (#1090)
* cman.rb hamstring regex update when can't perform on target (#1092)
* Bounty parser.rb FWI guard regex update (#1096)
* currency.rb track gold (#1109)
</PRE>
'''5.12.12'''
<PRE>
Bug Fixes (general)
Update module strip markdown comments (#1056)
Vars/UserVars module fixes and corrections (#1057)
Bug Fixes (gs)
Infomon parse fix for singular currency (#1051)
</PRE>
'''5.12.11'''
<PRE>
Bug Fixes (dr)
add bput match for system updates preventing actions (#1034)
drdefs.rb npc parsing (#1038)
Fix container reference in get_item_from_eddy_portal method (#1039)
Bug Fixes (gs)
bounty location regex needs to match "under" (#1037)
</PRE>
'''5.12.10'''
<PRE>
Bug Fixes
all: games.rb catch additional error for nested single/double quotes (#1031)
dr: change keys for DR_SKILLS_DATA[:guild_skill_aliases] to be strings instead of symbols (#1032)
gs: Bounty parser for SG npcs matching (#1027)
gs: match READY/STOW items with a/an/some inside the link (#1026)
</PRE>
'''5.12.9'''
<PRE>
Bug Fixes
gs: StowList/ReadyList reset bug if non-default keys added #1019
</PRE>
'''5.12.8'''
<PRE>
Bug Fixes
all: script.rb show custom at script exit as well (#993)
all: Updated update.rb for single trunk and release please (#1001)
</PRE>
'''5.12.7'''
<PRE>
fix(all): ensure updates do not target detached proxy views #990
fix(gs): bounty parser and move fixes for sailor's grief #987
fix(gs): Infomon xmlparser.rb Ready/Stow fix for LONG before exist #988
fix(gs): gameobj.rb for Sailor's Grief ghostly/boss/guild tentacles #989
</PRE>
'''5.12.6'''
<PRE>
fix(all): settings.rb update to preserve root of derived views #975
fix(all): show custom in various script output when custom script #967
fix(dr): drparser.rb update for PlayedSubscription #983
fix(gs): include store location for ReadyList #977
fix(gs): infomon parser.rb update for ACCOUNT output varies #979
fix(gs): global_defs.rb move def update for Hive traps #980
fix(gs): activespell.rb prevent removal of RF Penalty #981
fix(gs): add .compact to input of Disk.find_by_name #982
</PRE>
'''5.12.5'''
<PRE>
fix(all): update.rb word boundary for abbreviations #971
fix(dr): equipmanager.rb Fix for changed game output. #969
fix(dr): common-arcana.rb Regalia fix for changed game output. #970
fix(dr): common-items.rb Fix for changed inventory command output #973
fix(gs): StowList missing space in capture in xmlparser.rb #963
fix(gs): stowlist.rb wait for RT when issuing check #964
fix(gs): readylist.rb wait for RT when issuing check #965
fix(gs): Bounty heirloom return msg'ing update #972
</PRE>
'''5.12.4'''
<PRE>
build(all): installer.yml use windows-2022 #950
fix(all): restore Wrayth / Wizard script execution ability #952
fix(all): database_adapter.rb error handling improvement #956
fix(dr): common-items.rb wear/remove messaging additions #949
fix(dr): games.rb - ignore UIDs for Frostbite mapping #951
fix(dr): map_dr.rb prevent inadvertent settings changes #958
fix(gs): GameObj targets for new Sailor's Grief tentacle npc #948
fix(gs): map_gs.rb remove delete_if to prevent bad settings #957
fix(gs): weapon.rb assault break if no targets #962
</PRE>
'''5.12.3'''
<PRE>
fix(all): limitedarray.rb max_size increase #946
fix(all): uservars.rb update for vars method missing #940
fix(dr): drparser.rb to set ShowRoomID to on if turned off #945
fix(gs): change namespace accessors to Ruby 2.6 compatible #944
fix(gs): infomon state reset on status prompt #943
fix(gs): Societies to check membership for various methods #942
fix(gs): standardize warcry.rb to match other PSMS #941
</PRE>
'''5.12.2'''
<PRE>
fix(gs): infomon parser.rb for profile full name matching #938
fix(gs): force PROFILE FULL to sync CHE info for infomon #937
fix(dr): Tighten checks on releasing invisibility for thieves #936
</PRE>
'''5.12.1'''
<PRE>
- fix(all): gameobj.rb - add type? method for explicit type check #928
- fix(all): messaging.rb encoding issue #933
- fix(gs): Various CMan cost corrections #932
</PRE>
'''5.12.0'''
<PRE>
- feat(all): settings.rb - proposal for sequel based Settings #591, #875, #889, #896, #927
- feat(all): util.rb add Ruby gem install helper method #861
- feat(all): messaging.rb add cmd link method #866
- refactor(all): games.rb modernization #849, #882, #924
- fix(all): add class extensions #800
- fix(all): lich.rb deprecated FE message #852
- fix(all): messaging.rb fix XML encoding for wizard and avalon #853
- fix(all): lich.rb class variable not initialized #855
- fix(all): log.rb force msg to String for regexp comparison #856
- fix(all): global_defs.rb bug in fput #864
- fix(all): messaging.rb xml_encode mono method msg #868
- fix(all): script.rb class to is_a? checks #878
- fix(all): gameobj.rb deeper lookup #885
- fix(all): messaging.rb debug not compared to falseclass #887
- fix(all): change class to is_a? checks #91-3
- fix(all): Util.issue_command allow single line captures #918
- fix(dr): drparser.rb casing for Premium status check #842
- fix(dr): map_dr.rb Don't assign UID of zero to rooms #844
- fix(dr): drparser.rb add $last_logoff tracking #851
- fix(dr): update message patterns in common-items #859
- fix(dr): add moon_visible?(moon) convenience method to common-moonmage #860
- fix(dr): exp mods output is not enclosed in preset xml tags anymore #870
- fix(dr): update.rb beta send validation for genie lich char #880
- fix(dr): Update regex and parsing for active spells #894
- fix(dr): add 'You scoop' match pattern to common-items #900
- fix(dr): add missing match patterns #901
- fix(dr): common-items: add and fix match strings #904
- fix(dr): Add missing matches for common-items #905
- fix(dr): Release Khri Vanish if Thief, when going visible #906
- fix(dr): Fix race condition when clearing and repopulating XMLData.dr_active_spells #907
- fix(dr): Fix SLS release pattern #908
- fix(dr): resolve race condition in DR crafting_magic_routine #914
- fix(dr): xmlparser.rb - Fix XMLData.dr_active_spells race condition #915
- fix(dr): xmlparser.rb - Clear out spells properly #916
- fix(dr): drparser.rb update for Platinum account status #922
- feat(gs): gameobj.rb allow for custom gameobj data #848
- feat(gs): PSMS updates, including CMan.use #865, #874, #881, #890, #899
- feat(gs): ReadyList & StowList classes for item tracking #884
- feat(gs): Breakout and Buildout Societes #919
- fix(gs): infomon parsing for CHE membership #841
- fix(gs): map_gs.rb for no UID when hexdigest used #843
- fix(gs): warcry.rb yowlp :buff to string instead of regexp #847
- fix(gs): group.rb multiple corrections #850, #869, #883
- fix(gs): Bounty parser.rb fix for HW & KF guard return #862
- fix(gs): Bounty task.rb fix for assigned? and Ruby 2.6 #863
- fix(gs): stash.rb stale sheaths recheck #867
- fix(gs): allow spell.rb casting to take a force_stance parameter #902
- fix(gs): update Infomon parsing for new ACCOUNT output format #903
- fix(gs): PSMS cost for multiple cost types & add Excoriate feat #912
- fix(gs): Feat excoriate regex correction #920
- fix(gs): weapon PSM affordable check against Glorious Momentum #926
</PRE>
'''5.11.1'''
<PRE>
- fix(all): restore @theme_state and add to CLI capability #795
- fix(all): retire gtk2 monkey patch for gtk3 #823
- fix(all): games.rb XMLData.name wait till both not NIL and not EMPTY #826
- fix(all): standardize xmlparser game instance #827
- fix(all): games.rb fix multiple single and double quote in XML #832,836,837
- fix(dr): games.rb - optional hide Room Title display of Real IDs with FLAG on #782
- chore(dr): common-moonmage - refactor of peer_telescope #783
- fix(dr): move HMR load to common before for dragonrealms #784
- fix(dr): common-crafting.rb minor edit to add "You tuck" #787
- fix(dr): common-arcana.rb - remove unecessary pause from discern code #792
- fix(dr): drparser.rb Restore Premium status checking #834
- fix(gs): migrate PSMS.name_normal to Lich::Util.normalize_name #790,833
- fix(gs): add Char.che to know current character's CHE #791
- fix(gs): FEAT and Infomon module parsing of new Covert Art feats. #796
- fix(gs): add Currency.gemstone_dust and fix redsteel mark capture #797
- fix(gs): FEAT Covert Arts colon normalization and stamina costs #799
- fix(gs): escape dash in regex for HouseCHE #824
- fix(gs): disk.rb comparison helpers #828
- fix(gs): allow for Group.disks to show self disk in array #829
- fix(gs): feat.rb Covert Arts throw poison costs 15 stam #830
- fix(gs): add missing Feat.use ability #831
- fix(gs): multiple CritRanks updates #801-822
</PRE>
'''5.11.0'''
<PRE>
- [all] - chore: Namespace & File Path Updates #713
- [all] - [argv_options.rb] bugfix: correct darkmode to work via CLI #693
- [all] - [games.rb] feat: make show Room Exits of non-StringProc/Obvious Exits toggable for all games #699
- [all] - [games.rb] feat: toggleable display of StringProcs with clickable links #751
- [all] - [gui-manual-login.rb] fix: change label to Wrayth #720
- [all] - [gui-saved-login.rb] fix: update Stormfront label #721
- [all] - [update.rb] fix: purge old LIB folder prior to update release #729
- [all] - [util.rb] bugfix: allow issue_command to use fput or put #715
- [all] - [xmlparser.rb] feat: add XMLData.room_name attribute #685
- [all] - [main.rb] fix: create session file in regular connect method #733
- [all] - [init.rb] bugfix: error for Windows DISPLAY variable #735
- [all] - [main.rb] fix: Mudlet support #736
- [all] - [wine.rb] fix: add --no-wine CLI flag prevent WINE startup
- [all] - [init.rb] fix: add --no-gtk CLI flag prevent GTK3 gem load
- [dr] - [games.rb] feat: DRinfomon and common files as core lich libraries #686
- [dr] - [games.rb] chore: add DR requires here #690
- [dr] - [games.rb] fix: add Room# display for DR #697
- [dr] - [games.rb] bugfix: Genie FE real ID#s not supported, hide by default #728
- [dr] - [drdefs.rb] bugfix: fix for Shadow Servants #710
- [dr] - [map_dr.rb] fix: cleanup and support for UIDs #719
- [dr] - [xmldata.rb] bugfix: add support for DR Room IDs #716
- [dr] - [xmlparser.rb] feat: XMLData - adding dr_active_spells #691
- [gs] - [games.rb] bugfix: support for pre/post room name txt #683
- [gs] - [group.rb] chore: update to account for hold #701
- [gs] - [resource.rb] feat: add additional tracking of covert art charges #714
- [gs] - [spell.rb] bugfix: Spell.affordable? 515 release #687
- [gs] - [stash.rb] bugfix: sheath_bags when not found #694
- [gs] - [xmlparser.rb] bugfix: missing real ID in nav #684
- [gs] - [xmlparser.rb] bugfix: Claim module obvious hiding #717
- [gs] - [sk.rb] feat: Self-Knowledge functionality in core #748
</PRE>
'''5.10.4'''
<PRE>
-o- [GS4] - [xmlparser.rb] bugfix: Simu XML breaking change RoomID #679
</PRE>
'''5.10.3'''
<PRE>
-o- [GS4] - [crit_tables] fix: CritRanks regex fixes (multiple files and changes) #671
-o- [GS4] - [spellsong.rb] fix: Correct Spellsong sync method #674
-o- [GS4] - [parser.rb] fix: thorn status regex correction #673
-o- [All] - [xmlparser.rb] fix: Split out if elif block to account for DR having multiple… #670
-o- [All] - [global_defs.rb] fix: percentconcentration #676
-o- [All] - [global_defs.rb] fix: update move failure message to handle attack and casting #667
-o- [All] - [init.rb] fix: update required ruby check messaging #669
-o- [All] - [sessionvars.rb] feat: new module SessionVars for non-persistent variable storage #666
</PRE>
'''5.10.2'''
<PRE>
-o- [DR] - [games.rb] bugfix: tweak XML rewrite section #662
-o- [GS4] - [crit_tables] bugfix: additional crit table regex corrections #663
-o- [GS4] - [ascension.rb] bugfix: add new Transcend Destiny to lookups #661
-o- [GS4] - [effects.rb] bugfix: regexp escape txt #660
-o- [GS4] - [disruption_critical_table.rb] Bugfix in regex #659
</PRE>
'''5.10.1'''
<PRE>
-o- [All] - [games.rb] bugfix: prevent race condition in games thread #656
-o- [All] - [init.rb] bugfix: address WINE variance between linux / installs #655
-o- [GS4] - [gs][stash.rb] bugfix: wear code improvement #657
</PRE>
'''5.10.0'''
<PRE>
-o- [All] - [main.rb] bugfix: correct encoding for WizardFE PR #640
-o- [All] - [games.rb] bugfix: correct logic for room detection when using CLI --start-scripts PR #639
-o- [All] - [DB_Store.rb] feat: add direct support for Simu RENAME and CHANGE PROF PR #633
-o- [All] - chore: breakout code to individual files for easier management PR #617
-o- [All] - [lich.rbw] chore: add deprecated msg to old Settings/GameSettings/CharSettings methods PR #589
-o- [All] - [lich.rbw] feat: add new --dark-mode CLI option PR #583
-o- [All] - [global_defs.rb] bugfix: monsterbold fix for additional clients PR #581
-o- [All] - [update.rb] feat: update core scripts from source on Lich5 update/install PR #579
-o- [All] - [log.rb] feat: add new Log module copied from Olib PR #577
-o- [All] - [numeric.rb] feat: add days/hours/minutes/seconds methods to numerics PR #623
-o- [All] - [messaging.rb] feat: WizardFE Voln window support #647
-o- [All] - [init.rb] bugfix: WINE entries for Linux / MacOS #649
-o- [DR] - [lich.rbw] bugfix: cleanup downstream hook exclusions PR #593
-o- [DR] - [global_defs.rb] bugfix: missing climb failure message PR #592
-o- [GS4] - [effects.rb] bugfix: show non-standard Effects in `;magic` output PR #641
-o- [GS4] - [parser.rb] bugfix: fix WARCRY duplication results / add WALL OF THORNS effect detection PR #634 / PR #637
-o- [GS4] - [critranks.rb] feat: add critical rank resolution tables and methods PR #625
-o- [GS4] - [effects.rb] bugfix: to support regex for active? & time_left PR #590
-o- [GS4] - [infomon.rb] bugfix: add implicit NPC death monitoring PR #588
-o- [GS4] - [infomon.rb] bugfix: change PSM to be stored as type.mnemonic PR #587
-o- [GS4] - [lich.rbw] bugfix: strip_xml multiline fix PR #584
-o- [GS4] - [stash.rb] bugfix: fix sack detection to use Stash.container(param) PR #578
-o- [GS4] - [spell.rb] feat: Spell.after_stance #644
-o- [GS4] - [xmlparser.rb] bugfix: for Claim module #646
-o- [GS4] - [infomon] feat: track Voln favor via RESOURCE output #648
-o- [GS4] - [gameobj.rb] feat: add Bandit hidden target API #650
</PRE>
'''5.9.2'''
<PRE>
-o- [GS4] - [group.rb] bugfix: proper leader detection from GROUP output
-o- [GS4] - [char.rb] bugfix: add back depracted Char.maxvitals with msging to switch to new Char.max_vitals methods
</PRE>
'''5.9.1'''
<PRE>
-o- [GS4] - [group.rb] bugfix: group.check syntax change
-o- [GS4] - [spell.rb] bugfix: affordable? Char.mana parenthesis logic
</PRE>
'''5.9.0'''
<PRE>
-o- [All] - feat: sqlite3 gem syntax code cleanup PR#553
-o- [All] - [lich.rbw] bugfix: remove unused Setting, GameSetting, CharSetting PR#542
-o- [All] - [lich.rbw] bugfix: scrub login key from error message popups PR#548
-o- [All] - [messaging.rb] bugfix: color mismatch WizardFE white txt PR#554
-o- [All] - [lich.rb] feat: add new Lich.deprecated method to aid in deprecating older API calls PR#523
-o- [GS4] - [char.rb] feat: log method_missing calls PR#552
-o- [GS4] - [char.rb] feat: add missing global_def related methods PR#523
-o- [GS4] - [global_defs.rb] feat: deprecate various Char module methods PR#523
-o- [GS4] - [spellsong.rb] bugfix: cache spellsong duration calc PR#551
-o- [GS4] - [effects.rb] feat: Effects module breakout PR#549
-o- [GS4] - [group.rb][disk.rb] feat: Group & Disk class PR#532
-o- [GS4] - [activespell.rb] feat: add duration change messaging, off by default, see ;help for details PR#487
</PRE>
'''5.8.1'''
<PRE>
-o- [All] - [lich.rbw] feat: add Game:Character to debug log file ouput
-o- [All] - [init.rb] feat: add milliseconds to debug filename
-o- [GS4] - [lich.rbw] bugfix: reorder parsing of $SERVERSTRING to avoid certain conflicts
-o- [GS4] - [parser.rb] bugfix: update for new Empath resource and sleep/bind messaging
-o- [GS4] - [status.rb] bugfix: bound? calmed? and sleeping? support for spellnames flag being off
-o- [GS4] - [xmlparser.rb] bugfix: additional creature dying messaging to check against XML dead not being sent
-o- [GS4] - [gameobj.rb] bugfix: remove sorcerer arms and animates from GameObj.targets
</PRE>
'''5.8.0'''
<PRE>
-o- [All] - Ruby 3.3 compatibility
-o- [All] - [lich.rbw] feat: adds .sources for up/downstream hooks
-o- [All] - [lich.rbw] bugfix: don't use WINE for custom frontends
-o- [GS4] - [char.rb] bugfix: add back Char.stance
-o- [GS4] - [claim.rb] feat: new module and associated changes to xmlparser
-o- [GS4] - [experience.rb] feat: percent experience options
-o- [GS4] - [parser.rb] bugfix: allow for negative TNL exp value
-o- [GS4] - [parser.rb] bugfix: allow hyphenated last names in character names
-o- [GS4] - [parser.rb] feat: update resource matching for new Bard service
-o- [GS4] - [stash.rb] bugfix: catch more shield removal messages
-o- [GS4] - [util.rb] bugfix: underscore issue for PSMs
</PRE>
'''5.7.0'''
<PRE>
-o- Supports Ruby 3.2 - security enhancements and huge speed improvements for regex
-o- New libraries/modules/classes: Account, HMR (Hot Module Reloading)
-o- GS4 Infomon now baked into Lich5 as a library, no more need to run standalone script
-o- New GS4 libraries/modules/classes: Ascension, Bounty, Currency, Experience, Resources, Society, Status, Warcry
-o- Updates to existing libraries/modules/classes: Armor, Util, Weapon, Spell, GameObj, Messaging
-o- Several Bugfixes for lots of things
-o- Lots of code cleanup
</PRE>
'''5.6.2'''
<PRE>
-o- Fix for XML errors
-o- Adds the DR Plat instance for Frostbite FE
-o- Adds ‘ball’ as the noun used for ‘ball and chain’
-o- Adds the movement result ‘slip in the mud and fall flat’
-o- Corrects stamina cost for the feature Dispel Magic
-o- Plus all the latest script updates from Elanthia-Online!
</PRE>
'''5.6.1'''
<PRE>
-o- Fix for XML to limit login errors (DR)
-o- Fix for XMLData.active_spells to properly register wizard 'recovery' spell cooldowns
-o- Messaging updates to remove error in Wizard FE encodings
-o- Corrects for error in detecting PSM skill changes (cman) via warrior / rogue guild lessons
-o- Deprecates LNet script from master repository
-o- Miscellaneous small bug squashing
</PRE>

'''5.6.0'''
<PRE>
-o- (DragonRealms) Support for Genie and Frostbite frontends
-o- (GemStone) Changed methods to improve ;go2 speed and reduce lich.db3 calls
-o- (GemStone) Updates to support silver_count function
-o- (Both) Changed method for updating lich ecosystem
</PRE>

'''5.5.0'''
<PRE>
-o- Support for DragonRealms
-o- Updated support for scripts like BigShot
-o- Providing the LichID and UID on Profanity
-o- Spell.force_incant, .force_channel, and .force_evoke
-o- Standardized message method for script authors
-o- Sundry small improvements / fixes and changes
-o- And the creme de la creme - a custom directory
</PRE>

'''5.4.0'''
<PRE>
-o- Simu Room IDs (formally called 'unique ID' or 'uid' for Lich) added to Map, mapDB where known, and ;go2 for navigation (courtesy Xanlin and with our thanks!) ;go2 u7120 for all you ex-GMs out there.
-o- Room titles will now display the Lich ID and / or the UID for the room based on user selections - default is on for both, and enabled / disabled via Lich.display_lichid or Lich.display_uid toggles that can be set to on / off or true / false. (;e Lich.display_lichid=true/false and ;e Lich.display_uid=true/false) You can remove that rnum from your autostart now! To gain the benefit of the UID deployment, be sure to ;repo download-mapdb
-o- REQUESTS: Drop 5 minute timeout function from Lich
-o- waitrt? and waitcastrt? will still pause activities, but will return TRUE or FALSE in keeping with the Ruby functionname? tradition (no more failing to get a weapon out due to RT from climbing!)
-o- empty_hands and fill_hands will now check to see if the character is in roundtime before trying to put away or retrieve held items
-o- Infomon received an update that keeps spell timers in sync with the information received from the server - no more need to immediately do a spell active in game to get the right times to display for various legacy scripts and ;magic after visiting the invoker or using an SK item
-o- Lich now provides a facility to get current coins on the character that is a bit more agnostic to data changes from Simu - Lich::Util.silver_count
-o- Various other small tidbits to help ease maintenance and future development
-o- PLEASE NOTE: This update is required for the newest Bigshot (released today!) and for future eloot and eherbs scripts (release RSN)
</PRE>

'''5.3.0'''
<PRE>
-o- Added support for Wrayth (renamed Stormfront) installations
-o- Converted Linux | WINE login methods to 'method 0', does not use Simu launcher
</PRE>

'''5.2.1'''
<PRE>
-o- Support for STOWing items irrespective of special item scripts
-o- Improved query support for Effects and CMans
-o- Fix Lich bug to respect the 'groupmovement' flag in game
-o- Fix Lich round time calculations (more aggressive timing)
-o- Dark Mode is now a thing
-o- Lich4 Style GUI layout available
-o- Several file location changes to support future code change efforts
</PRE>

'''5.0.19'''
<PRE>
-o- Benefit: Monks with Mental Acuity (all 3 of you) rejoice - stamina casting!
-o- Benefit: PSM3 included, no charge. No hair remaining, either!
-o- Benefit: Ok, stay seated: Some of your various SF spell duration windows may work. . . better? Yes, not perfect, but better. No pictures, please!
-o- Updated infomon that properly detects Cloak of Shadows on those pesky sorcerers, and the Raise Dead Cooldown periods for those wondrous clerics.
-o- A new update process for Lich 5 - tired of having to download that script over and over just to update? Get yourself a copy of lich5-update.lic. Note, if you already have it, you're set! If not - ;jinx script install lich5-update --repo=elanthia-online
</PRE>

'''5.0.11'''
<PRE>
-o- Updated the method used to log onto SIMU servers.
-o- Added the Animalist item specifics to Lich5's empty and fill hands routines
-o- Improved Invoker messages for Avalon and Wizard FEs (no change for SF FE)
-o- Improved cleanup and store methods when player EXIT's or QUIT's game
-o- Crafted two new methods (stash_hands and equip_hands) for future script use
-o- Some behind-the-scenes cleanup to improve maintaining the Lich5 ecosystem
-o- Add Spell Active improvements
-o- Add PSM and Ranger improvements
</PRE>
</div>

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

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

Lich:Software/Installation

2026-10-28T12:52:19Z

WHIGHTCNIGHT: /* Linux */ spacing

{{3rd-party}}
=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 Wrayth or Wizard FE. Lich is also used by many on both MacOS and multiple Linux distributions.

=Installing the Latest Stable Release=

'''The latest stable lich version is 5.22.0 supporting Ruby 4.0 - published October 8, 2026'''

==In-Place Upgrade==

If you are on an older version of Lich 5 and want to upgrade to the most current version, you can choose to either upgrade Lich5 only or both Lich 5 and Ruby. If you're currently on Lich 4, able to check by running the command <CODE>;e echo LICH_VERSION</CODE>, go to the [[#Upgrade Installation for Lich 5 from Lich 4 (11/14/2023)|upgrade from Lich 4 section]].

For each section, please follow the directions/commands one at a time.

===Lich 5 Only===

====Lich 5.7 or newer====
# You must be running Ruby 4.0 or greater for Lich 5.19 +. If unsure, please update both (see below)!
# '''Backup existing Lich 5 folder'''
# Run this command in-game <CODE>;lich5-update --update</CODE>
# Quit and restart lich.
# Congratulations - you're now running on the latest version of Lich!

====Lich 5.6 or older====
Please proceed to updating both Ruby and Lich 5

===Both Ruby 4.0 & Lich 5===
This method is for Windows only. Linux and MacOS users, please do a Lich 5 only update and update Ruby manually via normal install/update methods for the OS.

# Logout of all characters
# '''Backup existing Lich 5 folder'''
# Uninstall existing Ruby4Lich5 installs from Programs & Features control panel, or alternatively, rename your existing Ruby4Lich5 folder to Ruby4Lich5save. (Defaults to C:\Ruby4Lich5)
# Download the latest [https://github.com/elanthia-online/lich-5/releases/latest/download/Ruby4Lich5.exe Ruby4Lich5.exe Installer]
# Run the installer and be sure to have both Ruby and Lich 5 option selected
# Congratulations - you're now running on the latest version of Lich & Ruby!

===Ruby 4.0 Only===
Use this to upgrade to the newest version of Ruby only if you're already on the latest version of Lich5 and now want to update Ruby afterwards. If you're not already on the latest version of Lich5, please use previous section steps instead.
# Logout of all instances/characters
# '''Backup existing Lich 5 folder'''
# Uninstall your existing Ruby4Lich5 install via Programs & Features (ensure it's now gone, default location was C:\Ruby4Lich5)
# Download the latest [https://github.com/elanthia-online/lich-5/releases/latest/download/Ruby4Lich5.exe Ruby4Lich5.exe Installer]
# Run the new installer and choose to only install Ruby Only
# Congratulations - you're now running on the latest version Ruby!

==Windows New Installation==

{{blue|These instructions are not for DragonRealms. [[#Ecosystem Information|For those scroll to the bottom]].}}

'''For Windows 11 / 10 / 8 / 7''' users: you can download the [https://github.com/elanthia-online/lich-5/releases/latest/download/Ruby4Lich5.exe Ruby4Lich5.exe Installer] and install everything you need automatically. Click on the '''Ruby4Lich5.exe''' and download it to your computer then double click on the executable in your default download folder. Note, a user may need to adjust their browser or security settings to allow download and installation.
If you have never played before, follow the 'New Installation' instructions. If you have played before, and have used Lich before, follow the 'Upgrade Installation' instructions.

===New Installation for Lich 5 (11/14/2023)===

# '''Please log into the game of your choice through the Simutronics website first'''. Install the launcher (not SGE), and install your FrontEnd of Choice. The Wrayth FrontEnd is presently the supported FrontEnd, but Wizard will work as well, if you are nostalgic. After you've logged in, log out and continue.
# Download and Run the [https://github.com/elanthia-online/lich-5/releases/latest/download/Ruby4Lich5.exe Ruby4Lich5.exe 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, 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.

===Upgrade Installation for Lich 5 from Lich 4 (11/14/2023)===

This option is deprecated. Lich 5 architectures are not compatible with Lich 4. Back up your existing Lich 4 folder, uninstall any existing Ruby executables, and then follow the instructions for a new install above.

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

==MacOS==
There two common options for playing Gemstone IV on a Mac is either to play natively with Avalon or to use virtualization software such as Parallels with Wrayth/WizardFE. Below are the options on how to do that.

===Native Avalon===
Players with Macs can use [[Mac_Installation_-_Lich_(software) | Installing Lich on Macs]] for installation help. This process works well for Mac OS Catalina and Big Sur. If you have not updated your Mac OS yet, these instructions may work depending on your actual version. If you run into a snag, follow the contact instructions provided.

===Parallels Windows===
With the latest releases of Ruby4Lich5 installer, you can now follow the normal Windows installation for both Intel and Apple silicon based Apple computers.

To install Wrayth/WizardFE, Lich, and Ruby via Parallels you will need to do a few various steps as outlined below. Please note, the rubyw file in C:\Ruby4Lich5\X.X.X\bin may be set to run in compatibility mode for windows 7. On an ARM Mac running parallels, this may causes Wrayth scripts not to run. Turning compatibility mode off in the rubyw file could fixe this issue if it was enabled.

The following steps are to be done AFTER you've successfully installed Wrayth/WizardFE and can login normally without Lich5 on the machine. Once you've done that and can successful connect normally, then follow these steps:
# Download and install [https://github.com/elanthia-online/lich-5/releases/latest/download/Ruby4Lich5.exe Ruby4Lich5.exe Installer] and use default options presented during install
# Double click the lich.rbw file that is now located in the extracted Lich5 location you did above. Login and play as usual.

==Linux==
Pick the subsection for your distribution below. Each one installs Ruby and Lich; front ends ([[#Profanity|Profanity]] and [[#Warlock|Warlock]]) are covered once in [[#Frontends|Frontends]] at the end, since their steps are the same on every distribution.

===Chromebook & Debian variants===
<div class="mw-customtoggle-debian" style="font-size:16px;overflow:auto;color:#0000FF">[Click to Expand]</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-debian">
The following steps should install Lich for users of Debian/Chromebooks. To also install a front end such as Profanity or Warlock, see [[#Frontends|Frontends]] at the end of the Linux section.

'''Step 1.'''
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 curl libssl-dev libyaml-dev libreadline6-dev zlib1g-dev libncurses5-dev libffi-dev libgdbm6 libgdbm-dev libsqlite3-dev git unzip libcairo2-dev libgirepository1.0-dev libgtk-3-dev gobject-introspection
</pre>

{{side box|NOTE: If you are updating an existing Ruby installation rather than installing from scratch, skip steps 2, 3, and 4. Instead, update your ruby-build with the following command, and then proceed to Step 5.<pre>git -C ~/.rbenv/plugins/ruby-build pull</pre>}}

'''Step 2.'''
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>

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

'''Step 4.'''
Download the tools to let rbenv install Ruby on its own, then install Ruby 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</pre>

'''Step 5.'''
<pre>rbenv install 4.0.9 -v
rbenv global 4.0.9
</pre>

Install Lich:
<pre>
cd ~
curl -L "https://github.com/elanthia-online/lich-5/releases/latest/download/lich-5.zip" -o temp.zip && unzip temp.zip -d ./ && rm temp.zip
</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 using the <tt>Gemfile</tt> included with Lich5 by running <tt>bundle install</tt>. The Gemfile also lists developer-only gems (the <tt>development</tt> and <tt>vscode</tt> groups) that you do not need, so tell Bundler to skip them first:
<pre>
echo "gem: --no-document" > ~/.gemrc
cd ~/Lich5
bundle config set --local without 'development vscode'
bundle install
</pre>
:<small>Note: <tt>bundle install --without ...</tt> no longer works; that flag was removed from the version of Bundler that ships with Ruby 4.0. Use <tt>bundle config set</tt> as shown above.</small>
</div>

===Arch Linux & Arch-based distributions===
<div class="mw-customtoggle-arch" style="font-size:16px;overflow:auto;color:#0000FF">[Click to Expand]</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-arch">
The following steps should install Lich for users of Arch Linux and Arch-based distributions (Manjaro, EndeavourOS, etc.). To also install a front end such as Profanity or Warlock, see [[#Frontends|Frontends]] at the end of the Linux section.

Update the system and install required dependencies:
<pre>
sudo pacman -Syu
sudo pacman -S --needed base-devel openssl libyaml readline zlib ncurses libffi gdbm sqlite git unzip curl gtk3 gobject-introspection
</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 4.0.9 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 4.0.9 -v
rbenv global 4.0.9
</pre>

Install Lich:
<pre>
cd ~
curl -L "https://github.com/elanthia-online/lich-5/releases/latest/download/lich-5.zip" -o temp.zip && unzip temp.zip -d ./ && rm temp.zip
</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 using the <tt>Gemfile</tt> included with Lich5 by running <tt>bundle install</tt>. The Gemfile also lists developer-only gems (the <tt>development</tt> and <tt>vscode</tt> groups) that you do not need, so tell Bundler to skip them first:
<pre>
echo "gem: --no-document" > ~/.gemrc
cd ~/Lich5
bundle config set --local without 'development vscode'
bundle install
</pre>
:<small>Note: <tt>bundle install --without ...</tt> no longer works; that flag was removed from the version of Bundler that ships with Ruby 4.0. Use <tt>bundle config set</tt> as shown above.</small>
</div>

===Fedora===
<div class="mw-customtoggle-fedora" style="font-size:16px;overflow:auto;color:#0000FF">[Click to Expand]</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-fedora">
The following steps should install Lich for users of Fedora. To also install a front end such as Profanity or Warlock, see [[#Frontends|Frontends]] at the end of the Linux section.

Lich 5 requires Ruby 4.0 or newer. The Ruby that ships with currently supported versions of Fedora is older than that (41 uses Ruby 3.3; 42 and 43 use Ruby 3.4), so these steps install Ruby 4.0.9 with '''<tt>[https://github.com/rbenv/rbenv rbenv]</tt>''' instead of using Fedora's Ruby.

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 cairo-devel curl gcc gdbm gdbm-devel gdk-pixbuf2-devel glib2-devel \
gobject-introspection-devel gtk3-devel libyaml-devel libffi-devel make ncurses-devel openssl-devel readline-devel \
redhat-rpm-config sqlite-devel unzip zlib-devel
</pre>

{{side box|NOTE: If you are updating an existing rbenv Ruby installation rather than installing from scratch, skip step 3. Instead, update your ruby-build with the following command, and then run only the <tt>rbenv install</tt> and <tt>rbenv global</tt> lines from step 3.<pre>git -C ~/.rbenv/plugins/ruby-build pull</pre>}}

3. Install rbenv and Ruby 4.0.9:
<pre>
git clone https://github.com/rbenv/rbenv.git ~/.rbenv
echo 'export PATH="$HOME/.rbenv/bin:$PATH"' >> ~/.bashrc
echo 'eval "$(rbenv init -)"' >> ~/.bashrc
source ~/.bashrc
git clone https://github.com/rbenv/ruby-build.git ~/.rbenv/plugins/ruby-build
rbenv install 4.0.9 -v
rbenv global 4.0.9
ruby -v
</pre>
The last command should print a line starting with <tt>ruby 4.0.9</tt>. If it doesn't, close and reopen the terminal and try <tt>ruby -v</tt> again.

4. Install Lich:
<pre>
cd ~
curl -L "https://github.com/elanthia-online/lich-5/releases/latest/download/lich-5.zip" -o temp.zip && unzip temp.zip -d ./ && rm temp.zip
</pre>

5. 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 using the <tt>Gemfile</tt> included with Lich5 by running <tt>bundle install</tt>. The Gemfile also lists developer-only gems (the <tt>development</tt> and <tt>vscode</tt> groups) that you do not need, so tell Bundler to skip them first:
<pre>
echo "gem: --no-document" > ~/.gemrc
cd ~/Lich5
bundle config set --local without 'development vscode'
bundle install
</pre>
:<small>Note: <tt>bundle install --without ...</tt> no longer works; that flag was removed from the version of Bundler that ships with Ruby 4.0. Use <tt>bundle config set</tt> as shown above.</small>
</div>

===Frontends===
Finish the Lich installation for your distribution above first, then set up one of these front ends.

====Profanity====
Profanity is a terminal-based Front-End that will let you play the game (in lieu of The Wizard or Wrayth). Its gems (such as <tt>curses</tt>) are installed by the <tt>bundle install</tt> step above. Download Profanity:
<pre>
cd ~
git clone https://github.com/elanthia-online/ProfanityFE.git
</pre>

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

====Warlock====
Download Warlock from https://sproctor.github.io/warlock3/download.html, then run Lich the normal way with Ruby:
<pre{{log2|margin-right=35%}}>
ruby ~/Lich5/lich.rbw
</pre>
Use your login information with these settings to use the Lich launcher: https://github.com/sproctor/warlock3/wiki/Lich-support

=Popular Scripts=
{{#section:Lich:Script Repository|popularscripts}}

=Ecosystem Information=

* DragonRealms Variant - [https://elanthipedia.play.net/Lich_script_repository#Setup_and_Installation Setup and Install instructions]

=Lich Changelog=
<div class="mw-customtoggle-changelog" style="font-size:16px;overflow:auto;color:#0000FF">[Click to Expand]</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-changelog">
'''5.22.0'''
<PRE>
### Features (general)
* add opt-in bounded script execution guards (#1575)
* add static-only map route selection (#1577)
* bounded fput with max_resends, interrupt, resend_transient and failure symbols (#1587)
* Spell.results_regex, the lines cast waits on, exposed (#1590)
* add Events, a script-to-script notification primitive; combat emits on it (#1619)
* add deterministic hook priorities (#1621)
* Map.boundary_rooms_for(ids), the perimeter of any set of rooms (#1660)
* sticky ever_hostile? keeps Sympathy'd creatures in targets (#1665)
* --pipe -g honours the frontend flag, and --sentinel requests the origin marker (#1677)

### Features (gs)
* add trustworthy combat observation provenance (#1576)
* Lich::Gemstone::Stance, a shared stance setter (#1578)
* Lich::Stash.wield and Stash.hands put named items into hands (#1579)
* Lich::Gemstone::Mana.pulse, the MANA PULSE verb once (#1580)
* Lich::Gemstone::Bank, Currency refresh, and WEALTH parser lines (#1581)
* PSM command and results_regex readers, factored out of use (#1583)
* Lich::Gemstone::Fog, the ways home on the spell and society readers (#1584)
* Combat::Messages - non-combat message families as observer events (#1586)
* society command readers, factored out of use (#1589)
* Group.join, the follower's side of Group.add (#1591)
* emit post-commit combat recorder receipts (#1592)
* combat definition supplements from a player YAML file (#1607)
* message definitions from the player supplement file (#1608)
* creature library - abilities from session logs, limbs flags, triggers as hash of arrays (#1623)
* expose exact server creature health from crtrStatus (#1661)

### Bug Fixes (general)
* fix spec stub race breaking FFI loads, gate WindowsCredentialManager to Windows (fixes #1542) (#1573)
* setup_files uses content hash for cache freshness (#1596) (#1599)
* creatures registry housekeeping independent of Combat::Tracker (#1603)
* place effect-list.xml backups in the update snapshot folder (#1606)
* retain discovery ownership through cleanup (#1612)
* Initial Lich state update and detachable-client split GS/DR (#1617)
* bound move()'s remedy retries, record why a move failed, lift it into Lich::Common::Move (#1622)
* update puts to Lich.log (#1630)
* create detachable-client session file without --login (#1656)
* converge server_time_offset instead of resetting it every prompt (#1663)
* plain-language lich5-update messages when GitHub fails (#1687)
* Inventory.refresh waits out roundtime before sending (#1688)

### Bug Fixes (dr)
* update HOW pattern to accommodate various soul states (#1620)
* restore script halt in DRCC.get_crafting_item on missing item (#1624)
* halt script when too distracted to turn recipe book (#1625)
* equipmentmanager energy bow handling (#1662)
* report when DRC.rummage can't read a container (#1671)
* DRCI.get_item? confirms #<id> gets by the item id in hand (#1674)
* DRCT.sell_item references the item through DRCI.item_ref (#1675)
* DRCA.do_buffs filters day/night spells without mutating settings (#1680)
* DRCI.tie_item? no longer reports an empty pouch as tied (#1684)
* DRC.play_song? keeps climbing and performance songs across instrument switches (#1686)

### Bug Fixes (gs)
* Injured cache lives on the class and keys on an injury fingerprint (#1582)
* infomon - a spell's start message refreshes a refreshable timer (#1585)
* Group.broken? waits on Lich::Claim::Lock, the constant that exists (#1588)
* combat module - hunt-log audit: interrupted-swing resume, status attribution by event, spell-loss cause, live defs (#1593)
* QStrike prices MSTRIKE's own stamina cost (#1594)
* combat module - a stand-up message later in the chunk outranks an earlier knockdown crit (#1595)
* track spell cooldowns on the characters a spell locks out (#1597)
* catalog missing deity-specific strike lines for Divine Wrath (335) (#1598)
* combat module - Rysk/Dreadt log audit: Holy Weapon release model, held maneuver rolls, AoE roll attribution, live defs (#1600)
* Combat defs add thrust as a basic attack (#1615)
* preserve group state after ambiguous disband reply (#1629)
* target ridden mounts before their first crtrStatus (#1669)
* snapshot Effects registries so scripts can't break the XML parser (#1672)
</PRE>
'''5.21.0'''
<PRE>
### Features (general)
* Add --refresh-characters and --add-character CLI flags (#1504)
* add --active-session-dir to decouple Active Sessions coordination from --temp (#1520)
* add read model for the inventoryManager extended feed (#1524)
* GUI add configurable frontend registry (#1558)
* add HTTPS web-login fallback for when EAccess (7910) is unreachable (#1570)

### Features (dr)
* player-supplied custom prep/cast/invoke messages (#1528)
* opt-in cambrinth charge distribution across configured items (#1549)
* populate GameObj from INV LIST full refresh (02 of 05) (#1554)
* non-destructive upsert for INV SEARCH / category scrapes (03 of 05) (#1556)
* reconcile GameObj containers on hand pickup (04 of 05) (#1557)
* [DRCC] add shared private-forge helpers (#1560)

### Features (gs)
* creature template library - measured combat data, HP/speed censuses, messaging (#1539)

### Bug Fixes (general)
* enforce Script#pause at every blocking/mutating checkpoint (#1537)
* always report missing gems on stderr; only wait on a dialog without a tty (#1544)
* dispatch --help and --version before the GTK require (#1546)
* global_def update deprecated method calls to include caller info (#1550)
* normalize colons in Lich::Util.normalize_lookup (#1561)
* Script.log respects --log-dir/LOG_DIR override; use File.join for paths in script.rb (#1572)

### Bug Fixes (dr)
* drvariables add more data to VOL_MAP (#1536)
* pin capped skills to 34 in DRSkill.clear_mind (#1548)
* match lowercase "it's already open" when opening a container (#1553)
* normalize capitalized leading articles in inventory scrape names (01 of 05) (#1555)
* make INV LIST refresh atomic and warn on interruption (05 of 05) (#1563)
* refresh before_name/after_name on a name-preserving container move (#1564)
* do not re-add a held item as worn inventory on inv scrape (#1565)
* evict orphaned identity-index entries on a name-changing upsert (#1566)
* unpause the exact scripts safe_pause_list paused, by object (#1574)

### Bug Fixes (gs)
* Infomon xmlparser additional npc death messaging (#1540)
* correct messaging drift in 13 crit table patterns (#1547)
* combat module - event defs, observer emissions, replay-verified parsing, SQLite recorder (#1559)
</PRE>
'''5.20.1'''
<PRE>
### Bug Fixes (general)
* bound EAccess auth with a timeout so a stalled SGE backend can't hang Lich silently (#1502)
* Linux WINE and Wrayth FE detection (#1517)
* update Gemstone game-code validations (#1518)
* preserve bundled display-state tags on quiet-suppressed chunks (#1530)
* prevent a stray formatting character from appearing in Saga during quiet script output (#1532)

### Bug Fixes (dr)
* make $safe_pause_lock holder immune to pause (#1525)

### Bug Fixes (gs)
* critranks.rb tolerate nil table rows, fix reload!, index patterns … (#1522)
* combat module hardening - ordered processing, 22x faster parsing, double-count fix (#1523)
</PRE>
'''5.20.0'''
<PRE>
### Features (general)
* add concurrent runtime I/O and multi-client detach support (#1459)
* --bind-address speaks the same keywords as --detachable-client (#1461)
* GUI Launcher Improvements (#1463)
* Add supervised child script APIs (01 of 06) (#1474)
* Add forced script teardown command (06 of 06) (#1479)
* teardown and distinguishable errors for Script.run_child (#1501)

### Features (dr)
* DRCMM.moon_weapon_duration - read a moon weapon's remaining life (#1483)
* id-based creature tracking from crtrStatus + assess (#1485)
* capture room UID from <nav> tag; stop enforcing ShowRoomID; opt-in room-id placement (#1491)
* user-extensible scroll substitutions via settings (01 of 06) (#1512)
* user-extensible boxes and trash receptacles (03 of 06) (#1514)
* user-extensible summoned-weapon adjectives (04 of 06) (#1515)
* user-extensible flavor-text stripping (05 of 06) (#1516)

### Features (gs)
* gameobj add full_name matcher to type/sellable classification (#1453)

### Bug Fixes (general)
* prevent empty/partial GameObj registry reads during mid-stream refresh (#1370)
* no-op Gtk.lich_main_quit when no main loop is nested (#1464)
* correct path-flag aliases and document all path options (#1472)
* Synchronize script lifecycle transitions (02 of 06) (#1475)
* Coordinate script shutdown draining (03 of 06) (#1476)
* Harden script lifecycle ownership (05 of 06) (#1478)
* surface the underlying LoadError in dependency alerts (#1480)
* extract game-agnostic CreatureBase into lib/common (#1484)
* bound GemCheck alert dialogs with a timeout so they can't hang forever (#1488)
* identify Genie as the frontend for headless launches (#1490)
* restore detachable client disconnect notice to stdout (#1492)
* harden detachable client teardown and escape init payload (#1493)
* resolve GameObj status visibility during staged refresh (#1497)
* compact client write queue instead of ending the session (#1498)
* scrub startup credentials once login completes (#1499)
* Honor Simu-side teardown for 10 seconds (#1505)

### Bug Fixes (dr)
* resolve no-UID rooms carrying a stored UID instead of returning nil (#1467)
* equipmanager.rb - reliable ranged-weapon transitions - stow ammo after unload + verify offhand wield hand (#1468)
* common-healing.rb - DRCH.bind_wound: only dispose a dislodged item while it is in hand (#1469)
* preserve game RealID in room title (GS parity for ";display roomid title") (#1500)
* Refine need_buffs? logic for non-recast spells to correctly check cyclic spells. (#1503)
* reduce symbol-torn scale scrolls to gettable noun (#1506)
</PRE>
'''5.19.1'''
<PRE>
### Bug Fixes (general)
* lower game socket keepalive idle from 120s to 30s (#1449)
* resilient ActiveSessions ownership + shutdown watchdog (#1452)
* Quit Gtk.main cleanly (#1455)
* Refactor regex to string comparisons for ARGV options (#1456)

### Bug Fixes (gs)
* ingest newly-exposed mindState experience and roommeta room fields (#1450)
</PRE>
'''5.19.0'''
<PRE>
### Features (general)
* Add character generator support via EAccess protocol (#1384)
* Add modern script command shutdown method (#1385)
* migrate the server-stream parser from REXML to Ox, with pipe-mode benchmark harness and DR parser coverage (#1396)
* enumerate script subdirs with file glob (#1397)
* add --bind-address option to set listen socket address (#1405)
* add central method to determine lich ver (#1417)
* setup_files: support scripts/data/custom for user data overrides (#1431)
* Modify running? method to support optional exact matching of script names (#1436)
* keyword bind hosts for the detachable client (tailscale/lan/any) (#1437)
* add roomlinks/roommono toggles for room display (#1438)
* self-healing gem requires (#1439)
* various Saga FE compatibility tweaks (#1443)
* add macOS limited gem recovery (#1448)

### Features (dr)
* Capture combat position from the balance status line (#1400)
* detect scheduled shutdown and expose it on DRParser (#1409)
* xmlparser: add structured parser for the assess (combat situation) stream (#1413)
* Implement DRCA.need_buffs? method for buff checks (#1428)

### Features (gs)
* anchor Infomon parser regex unions to line start (#1391)
* creature xml additions (#1425)
* add creature template library (#1427)

### Bug Fixes (general)
* surface a failed Game.open in the connect timeout (#1408)
* bound long-session memory growth (index/hook/watchfor/buffer leaks) (#1410)
* improve and harden shutdown (#1416)
* use bundler to check for required Ruby gems (#1420)
* pin lich directory for gemfile check (#1423)
* Show CLI login ARGV for SAL connections (#1424)
* increase read timeout on idle socket to 300 seconds (#1426)
* monkeypatch gi for memoryreleaser / asyncprocessor until patched upstream (#1429)
* Mapdb sort tags by downcase and original case (#1433)
* stop locking the load path at boot; keep Gemfile.lock in sync on self-update (#1434)
* minimum Ruby 4.0 required & migrate Ruby version check (#1444)
* align --announce with --update for Ruby version (#1447)

### Bug Fixes (dr)
* BalanceValue regex to match combat status lines (#1398)
* equipmanager.rb - Fix unload weapon detection when AimTimerDialog tag is prepended (#1414)

### Bug Fixes (gs)
* global_defs update pushStream regex to include 'reserve' id (#1379)
* psms Warcry.available? correction (#1387)
* xmlparser support new field exp, climate, terrain XML feeds (#1388)
* global_defs move() update regex for standing condition (#1407)
* Currency add method to retrieve aevit event currency (#1411)
* Stash check result type before comparing regex for wear_to_inv (#1430)
</PRE>
'''5.18.0'''
<PRE>
### Features (dr)
* common-crafting add method for creating mechanisms (#1375)

### Bug Fixes (general)
* stringproc normalize CRLF | CR to LF (#1378)
* rubocop custom cop ascii only cleanup (#1382)

### Bug Fixes (dr)
* equipmanager update to assume missing items aren't worn (#1376)

### Bug Fixes (gs)
* Infomon xmlparser additional npc death messaging (#1326)
</PRE>
'''5.17.3'''
<PRE>
### Bug Fixes (general)
* Script module replace MemoryReleaser with GC.start for cleanup (#1364)
* Add sqlite busy timeout policy to core (#1365)
* Script#kill remove GC.start and add optional instrumentation (#1368)
* reorder shutdown ala MahtraDR and detect script teardown de... (#1369)
</PRE>
'''5.17.2'''
<PRE>
### Bug Fixes (general)
* harden custom repo identity, collision, and contract boundaries (#1333)
* stop SessionLifecycle before closing database on normal exit (#1334)
* harden FeatureFlags for closed db handle (#1335)
* SynchronizedSocket write resilience and zombie client elimination (#1338)
* correct RP timing issue for release notes (#1348)
* gate object cleanup in GTK queue (#1354)
* recover from cross-process zombie in ActiveSessions service (#1355)
* Improve shutdown session state handling (#1359)
* non-ascii hygeine to address rubocop errors (#1360)
* Remove debug log IO from heartbeat tick loop (#1363)

### Bug Fixes (dr)
* DRC text2num correction for thousand (#1343)

### Bug Fixes (gs)
* Overwatch add REVEALED_EXPLODES regex pattern (#1356)
* Stash add_to_bag result type check before regex compare (#1357)
</PRE>
'''5.17.1'''
<PRE>
### Bug Fixes (general)
* enable heartbeat-driven failover for ActiveSessions service owner (#1340)
* copy Gemfile and LICENSE during self-update (#1345)
* Add top-level parse_args/display_args bridge to global_defs (#1346)

### Bug Fixes (dr)
* replace undefined custom_require in check_moonwatch (#1336)
* set_stance places 100 in the correct positional slot (#1337)
* cache SlackBot users list to prevent API throttling (#1342)
* Add CORE_AUTOSTART sentinel to skip dependency.lic autostart helpers (#1344)

### Bug Fixes (gs)
* Infomon Status.cutthroat? Effect Debuff correction (#1331)
* add support for RESERVE xml in GameObj.reserve (#1341)
</PRE>
'''5.17.0'''
<PRE>
### Features (general)
* custom 3rd-party repo support for ScriptSync (#1285)
* Add get_settings, get_data, start_scripts_if_available to core (#1305)
* Add Map.apply_wayto_overrides for personal map overrides (#1306)

### Features (dr)
* Decouple SetupFiles from script-scoped echo and XML feed timing (#1304)
* Add game flags and obsolete script warnings to DRInfomon startup (#1307)

### Bug Fixes (general)
* use :__unset for --without-frontend CLI request YAML matches (#1301)
* prevent zombie server deadlock in Active Sessions accept loop (#1302)
* improve MacOS keychain system check for older OS variants (#1310)
* stub sync_all_repos to prevent leaked thread in games_spec (#1311)
* enforce beta confirmation 10s timeout (#1315)
* use send(:respond) in StatusReporter fallback path (#1316)
* ensure SessionLifecycle.stop runs on abnormal exit (#1317)
* address ActiveSessions lifecycle hot path feature-flag polling (#1325)
* catch ECONNRESET in _puts and bound walk_to retry depth (#1327)
* safeguard gtk logo.png loading (#1329)

### Bug Fixes (gs)
* Add InnCheckedOut pattern to parser (#1309)
* Claim corrections to handle mounts in room_players stream (#1324)
</PRE>
'''5.16.2'''
<PRE>
### Features (general)
* session summary store and reporting (#1247)
* add core classes, ScriptSync, and login auto-sync (#1273)
* Add active sessions API (#1274)
* Add session status CLI query (#1276)
* configurable debug log retention (#1282)

### Features (dr)
* common-healing.rb - add vitality parsing to HealthResult (#1265)

### Bug Fixes (general)
* handle auth exceptions in manual login to prevent hang on bad password (#1267)
* set SO_REUSEADDR before bind to allow immediate port reuse (#1268)
* Persistent Launcher re-enable play button post launch (#1269)
* Restore manual login behaviors to not require saved entry t... (#1270)
* log and re-raise unexpected errors in saved login auth handler (#1271)
* narrow safe_write rollback scope so cleanup failure preserves successful write (#1287)
* fix three revert bugs in SnapshotManager (#1289)
* guard nil release asset and validate before deleting lib/ (#1290)
* guard nil stable version in beta channel resolution (#1291)
* remove dead code in BranchInstaller (#1292)
* repair regression on gui button reenable from refactor (#1297)

### Bug Fixes (dr)
* common-items.rb - move pattern from failure to success block (#1262)
* buffer_room_objs missed split components with leading stream tags (#1284)
* common-items.rb - get_item_unsafe false positives via XML feed verification (#1286)
* forward vitality and dead fields in perceive_health (#1288)

### Bug Fixes (gs)
* Infomon xmlparser additional npc death messaging (#1275)
* Infomon xmlparser additional npc death messaging (#1281)
</PRE>
'''5.16.1'''
<PRE>
### Features (general)
* session summary store and reporting (#1247)
* add core classes, ScriptSync, and login auto-sync (#1273)
* Add active sessions API (#1274)
* Add session status CLI query (#1276)
* configurable debug log retention (#1282)

### Features (dr)
* common-healing.rb - add vitality parsing to HealthResult (#1265)

### Bug Fixes (general)
* handle auth exceptions in manual login to prevent hang on bad password (#1267)
* set SO_REUSEADDR before bind to allow immediate port reuse (#1268)
* Persistent Launcher re-enable play button post launch (#1269)
* Restore manual login behaviors to not require saved entry t... (#1270)
* log and re-raise unexpected errors in saved login auth handler (#1271)
* narrow safe_write rollback scope so cleanup failure preserves successful write (#1287)
* fix three revert bugs in SnapshotManager (#1289)
* guard nil release asset and validate before deleting lib/ (#1290)
* guard nil stable version in beta channel resolution (#1291)
* remove dead code in BranchInstaller (#1292)

### Bug Fixes (dr)
* common-items.rb - move pattern from failure to success block (#1262)
* buffer_room_objs missed split components with leading stream tags (#1284)
* common-items.rb - get_item_unsafe false positives via XML feed verification (#1286)
* forward vitality and dead fields in perceive_health (#1288)

### Bug Fixes (gs)
* Infomon xmlparser additional npc death messaging (#1275)
* Infomon xmlparser additional npc death messaging (#1281)
</PRE>
'''5.16.0'''
<PRE>
### Features (general)
* session summary store and reporting (#1247)
* add core classes, ScriptSync, and login auto-sync (#1273)
* Add active sessions API (#1274)
* Add session status CLI query (#1276)
* configurable debug log retention (#1282)

### Features (dr)
* common-healing.rb - add vitality parsing to HealthResult (#1265)

### Bug Fixes (general)
* handle auth exceptions in manual login to prevent hang on bad password (#1267)
* set SO_REUSEADDR before bind to allow immediate port reuse (#1268)
* Persistent Launcher re-enable play button post launch (#1269)
* Restore manual login behaviors to not require saved entry t... (#1270)
* log and re-raise unexpected errors in saved login auth handler (#1271)

### Bug Fixes (dr)
* common-items.rb - move pattern from failure to success block (#1262)
* buffer_room_objs missed split components with leading stream tags (#1284)
* common-items.rb - get_item_unsafe false positives via XML feed verification (#1286)

### Bug Fixes (gs)
* Infomon xmlparser additional npc death messaging (#1275)
* Infomon xmlparser additional npc death messaging (#1281)
</PRE>
'''5.15.1'''
<PRE>
### Bug Fixes (general)
* Mutli-launch persistent login GUI (#1245)
* Remove Windows OS CMD prompt flash (#1255)
* guard against broken pipe errors in Game._puts and send_to_client (#1260)
* add timeout safety to fput to prevent infinite hangs (#1261)

### Bug Fixes (dr)
* anchor stow success pattern to prevent fan close recovery bypass (#1254)
* add bounded recursion depth limits to 9 methods (#1257)
* stow_helper failure detection + unload_weapon ammo recovery (#1259)
</PRE>
'''5.15.0'''
<PRE>
### Features (general)
* add InstanceSettings for core Settings API access (#1233)

### Features (gs)
* Overwatch module into core (#1201)

### Bug Fixes (general)
* fix GameObj container initialization and add clear_all_containers (#1226)
* GameObj object dedupe & GC (#1234)
* script.rb show Script.kill source (#1235)
* Exit quickly on CLI authentication failure (#1237)
* suppress wine detection noise and skip when unneeded (#1244)

### Bug Fixes (dr)
* DR modules fixes and enhancements (#1232)

### Bug Fixes (gs)
* psms.rb add additional failure matches (#1238)
* Bounty parser fix regex pattern for skin retrieval task (#1242)
</PRE>
'''5.14.2'''
<PRE>
### Bug Fixes (general)
* add retry with exponential backoff for all login authentication (#1205)
* update.rb allow for bugfix betas and branch updates (#1211)

### Bug Fixes (gs)
* infomon.rb bug in _key transformation (#1216)
</PRE>
'''5.14.1'''
<PRE>
### Bug Fixes (general)
* Change server_time_offset in XMLParser to be float instead of int (#1184)
* change encodings in main.rb to wizard FE only (#1199)

### Bug Fixes (gs)
* Infomon parser.rb update Account.subscription/type (#1192)
* spell.rb add last_cast to track last time casted (#1193)
* stash.rb additional improvements with ReadyList/StowList (#1197)
* Infomon parser.rb bug in EnhanciveEnd (#1198)
</PRE>
'''5.14.0'''
<PRE>
### Features (general)
* Add Genie map cross-reference fields to the DragonRealms map data model (#1169)

### Features (dr)
* DRExpMonitor move into core lich (#1154)

### Features (gs)
* add Enhancive module for enhancive item bonus tracking (#1113)
* add QStrike module for optimal stamina-based RT reduction (#1114)

### Bug Fixes (general)
* remove strip! from settingsInfo replacement (#1161)
* map_base.rb sort JSON better (#1171)

### Bug Fixes (dr)
* logbook_item recovery when crafted item not in hand (#1175)

### Bug Fixes (gs)
* xmlparser.rb capture additional death messaging (#1158)
* stash.rb ReadyList sheath handling and update inventory checks (#1166)
</PRE>
'''5.13.6'''
<PRE>
### Bug Fixes (general)
* allow --add-account to run without yaml and dat (#1143)
* enable --login for multi-variable custom launch commands (#1144)
* update.rb pervent update if MIN_RUBY not met (#1146)
* messaging.rb return "" for xml_encode with Wizard (#1147)
* prevent closing connection on module reload (#1148)
* Allow hmr to work on global_defs.rb (#1156)

### Bug Fixes (dr)
* buffer split room obj lines and merge instead of appending closing tag to broken line (#1149)
* add buffering for multiline room players (#1151)
* add verify_script def here instead of depending on dependency (#1155)

### Bug Fixes (gs)
* infomon.rb added updated_at field to upsert_batch (#1145)
* stowlist.rb check method fix when dead (#1152)
* readylist.rb check method fix when dead (#1153)
</PRE>
'''5.13.5'''
<PRE>
### Bug Fixes (general)
* util.rb only show gem installing debug messaging if gem mis… (#1131)
* add --gs and --dr, refactor argv_options to helpers (#1133)
* fix multiple custom entries, improvements to yaml save (#1134)
* login_tab_utils.rb expand helper text show Warlock (#1135)
* update CLI for YAML security signature, add auto-convert fo… (#1136)
* remove password parameter from debug logging in all cases (#1137)
* reduce minimum GUI window footprint for non-tabbed view (#1138)
* remove double save in YAML to preserve yaml.bak integrity (#1139)

### Bug Fixes (gs)
* stash.rb additional improvements (#1132)
</PRE>
'''5.13.4'''
<PRE>
### Bug Fixes (general)
* force system gem install if RubyGems fails (#1126)
* gui_login prevent destroying window if already destroyed (#1127)
* add window size / position saves to login GUI (#1128)
* non tabbed saved entries in reduced button / font size (not… (#1129)
</PRE>
'''5.13.3'''
<PRE>
### Bug Fixes (general)
* account manager sorting GUI fix (#1123)
</PRE>
'''5.13.2'''
<PRE>
### Bug Fixes (general)
* install_gem_requirements update available gems after install (#1120)
</PRE>
'''5.13.1'''
<PRE>
### Bug Fixes (general)
* password_cipher.rb upcase account_name for key (#1118)

### Bug Fixes (dr)
* validator.rb change sleep to should_sleep named param (#1116)

### Bug Fixes (gs)
* add base stats capture from 'info full' command (#1115)
</PRE>
'''5.13.0'''
<PRE>
### Features (general)
* Refocus Frontend (#960)
* socket configurator to better guard TCPSocket (#976)
* add simplified DB maintenance (#991)
* TextStripper module support for XML, HTML, Markdown (#1055)
* Login modernization and refactor to yaml (#1063)
* Ruby Memory Releaser module (#1066)

### Features (dr)
* support meta:trashcan tag for DRCI.dispose_trash (#966)
* Add GameObj.inv support for DR items (#1080)
* DRCS allow custom adjective for summoned weapons (#1088)
* DRParser support for new exp window xml stream elements (rested exp, tdps, favors) (#1104)

### Features (gs)
* Add Armaments (Weapon, Armor, and Shield) Module (#911)
* add creature module, including Hinterwilds creatures (#1002)
* Creature module combat tracking (#1003)
* track time of last total_experience record (#1030)
* add Injured class for checking ability to perform actions (#1035)

### Bug Fixes (general)
* map dijkstra optimization (#1061)
* update.rb keep script/data file incase of error on update (#1070)
* ensure proxy path is set for non-destructive array write-th… (#1073)
* [lib][global-defs] - move update (#1079)
* GameObj force new objects ID to be string (#1087)
* xmlparser.rb gate GSL exits sending behind @send_fake_tags (#1103)
* change Hash[] pair key conversion to use to_h for Ruby 4.0 (#1108)
* move gui-login.rb to Ruby standard gui_login.rb (#1111)
* update location for currency and move game-loader.rb to Ruby standard gameloader.rb (#1112)

### Bug Fixes (dr)
* DRCA allow custom spell prep messaging (#1089)
* Update Slackbot error handling, and lnet management (#1091)
* Fix exp mods parsing for DR (#1102)
* equipmanager.rb support for custom messaging in forester's longbow (#1105)
* Fix hang in equipment manager when game doesn't respond to commands (#1110)

### Bug Fixes (gs)
* Infomon additional CHE resign regex (#1067)
* Resource tracking for sorcerer shadow essence (#1085)
* cman.rb add hamstring regex for already lying down target (#1090)
* cman.rb hamstring regex update when can't perform on target (#1092)
* Bounty parser.rb FWI guard regex update (#1096)
* currency.rb track gold (#1109)
</PRE>
'''5.12.12'''
<PRE>
Bug Fixes (general)
Update module strip markdown comments (#1056)
Vars/UserVars module fixes and corrections (#1057)
Bug Fixes (gs)
Infomon parse fix for singular currency (#1051)
</PRE>
'''5.12.11'''
<PRE>
Bug Fixes (dr)
add bput match for system updates preventing actions (#1034)
drdefs.rb npc parsing (#1038)
Fix container reference in get_item_from_eddy_portal method (#1039)
Bug Fixes (gs)
bounty location regex needs to match "under" (#1037)
</PRE>
'''5.12.10'''
<PRE>
Bug Fixes
all: games.rb catch additional error for nested single/double quotes (#1031)
dr: change keys for DR_SKILLS_DATA[:guild_skill_aliases] to be strings instead of symbols (#1032)
gs: Bounty parser for SG npcs matching (#1027)
gs: match READY/STOW items with a/an/some inside the link (#1026)
</PRE>
'''5.12.9'''
<PRE>
Bug Fixes
gs: StowList/ReadyList reset bug if non-default keys added #1019
</PRE>
'''5.12.8'''
<PRE>
Bug Fixes
all: script.rb show custom at script exit as well (#993)
all: Updated update.rb for single trunk and release please (#1001)
</PRE>
'''5.12.7'''
<PRE>
fix(all): ensure updates do not target detached proxy views #990
fix(gs): bounty parser and move fixes for sailor's grief #987
fix(gs): Infomon xmlparser.rb Ready/Stow fix for LONG before exist #988
fix(gs): gameobj.rb for Sailor's Grief ghostly/boss/guild tentacles #989
</PRE>
'''5.12.6'''
<PRE>
fix(all): settings.rb update to preserve root of derived views #975
fix(all): show custom in various script output when custom script #967
fix(dr): drparser.rb update for PlayedSubscription #983
fix(gs): include store location for ReadyList #977
fix(gs): infomon parser.rb update for ACCOUNT output varies #979
fix(gs): global_defs.rb move def update for Hive traps #980
fix(gs): activespell.rb prevent removal of RF Penalty #981
fix(gs): add .compact to input of Disk.find_by_name #982
</PRE>
'''5.12.5'''
<PRE>
fix(all): update.rb word boundary for abbreviations #971
fix(dr): equipmanager.rb Fix for changed game output. #969
fix(dr): common-arcana.rb Regalia fix for changed game output. #970
fix(dr): common-items.rb Fix for changed inventory command output #973
fix(gs): StowList missing space in capture in xmlparser.rb #963
fix(gs): stowlist.rb wait for RT when issuing check #964
fix(gs): readylist.rb wait for RT when issuing check #965
fix(gs): Bounty heirloom return msg'ing update #972
</PRE>
'''5.12.4'''
<PRE>
build(all): installer.yml use windows-2022 #950
fix(all): restore Wrayth / Wizard script execution ability #952
fix(all): database_adapter.rb error handling improvement #956
fix(dr): common-items.rb wear/remove messaging additions #949
fix(dr): games.rb - ignore UIDs for Frostbite mapping #951
fix(dr): map_dr.rb prevent inadvertent settings changes #958
fix(gs): GameObj targets for new Sailor's Grief tentacle npc #948
fix(gs): map_gs.rb remove delete_if to prevent bad settings #957
fix(gs): weapon.rb assault break if no targets #962
</PRE>
'''5.12.3'''
<PRE>
fix(all): limitedarray.rb max_size increase #946
fix(all): uservars.rb update for vars method missing #940
fix(dr): drparser.rb to set ShowRoomID to on if turned off #945
fix(gs): change namespace accessors to Ruby 2.6 compatible #944
fix(gs): infomon state reset on status prompt #943
fix(gs): Societies to check membership for various methods #942
fix(gs): standardize warcry.rb to match other PSMS #941
</PRE>
'''5.12.2'''
<PRE>
fix(gs): infomon parser.rb for profile full name matching #938
fix(gs): force PROFILE FULL to sync CHE info for infomon #937
fix(dr): Tighten checks on releasing invisibility for thieves #936
</PRE>
'''5.12.1'''
<PRE>
- fix(all): gameobj.rb - add type? method for explicit type check #928
- fix(all): messaging.rb encoding issue #933
- fix(gs): Various CMan cost corrections #932
</PRE>
'''5.12.0'''
<PRE>
- feat(all): settings.rb - proposal for sequel based Settings #591, #875, #889, #896, #927
- feat(all): util.rb add Ruby gem install helper method #861
- feat(all): messaging.rb add cmd link method #866
- refactor(all): games.rb modernization #849, #882, #924
- fix(all): add class extensions #800
- fix(all): lich.rb deprecated FE message #852
- fix(all): messaging.rb fix XML encoding for wizard and avalon #853
- fix(all): lich.rb class variable not initialized #855
- fix(all): log.rb force msg to String for regexp comparison #856
- fix(all): global_defs.rb bug in fput #864
- fix(all): messaging.rb xml_encode mono method msg #868
- fix(all): script.rb class to is_a? checks #878
- fix(all): gameobj.rb deeper lookup #885
- fix(all): messaging.rb debug not compared to falseclass #887
- fix(all): change class to is_a? checks #91-3
- fix(all): Util.issue_command allow single line captures #918
- fix(dr): drparser.rb casing for Premium status check #842
- fix(dr): map_dr.rb Don't assign UID of zero to rooms #844
- fix(dr): drparser.rb add $last_logoff tracking #851
- fix(dr): update message patterns in common-items #859
- fix(dr): add moon_visible?(moon) convenience method to common-moonmage #860
- fix(dr): exp mods output is not enclosed in preset xml tags anymore #870
- fix(dr): update.rb beta send validation for genie lich char #880
- fix(dr): Update regex and parsing for active spells #894
- fix(dr): add 'You scoop' match pattern to common-items #900
- fix(dr): add missing match patterns #901
- fix(dr): common-items: add and fix match strings #904
- fix(dr): Add missing matches for common-items #905
- fix(dr): Release Khri Vanish if Thief, when going visible #906
- fix(dr): Fix race condition when clearing and repopulating XMLData.dr_active_spells #907
- fix(dr): Fix SLS release pattern #908
- fix(dr): resolve race condition in DR crafting_magic_routine #914
- fix(dr): xmlparser.rb - Fix XMLData.dr_active_spells race condition #915
- fix(dr): xmlparser.rb - Clear out spells properly #916
- fix(dr): drparser.rb update for Platinum account status #922
- feat(gs): gameobj.rb allow for custom gameobj data #848
- feat(gs): PSMS updates, including CMan.use #865, #874, #881, #890, #899
- feat(gs): ReadyList & StowList classes for item tracking #884
- feat(gs): Breakout and Buildout Societes #919
- fix(gs): infomon parsing for CHE membership #841
- fix(gs): map_gs.rb for no UID when hexdigest used #843
- fix(gs): warcry.rb yowlp :buff to string instead of regexp #847
- fix(gs): group.rb multiple corrections #850, #869, #883
- fix(gs): Bounty parser.rb fix for HW & KF guard return #862
- fix(gs): Bounty task.rb fix for assigned? and Ruby 2.6 #863
- fix(gs): stash.rb stale sheaths recheck #867
- fix(gs): allow spell.rb casting to take a force_stance parameter #902
- fix(gs): update Infomon parsing for new ACCOUNT output format #903
- fix(gs): PSMS cost for multiple cost types & add Excoriate feat #912
- fix(gs): Feat excoriate regex correction #920
- fix(gs): weapon PSM affordable check against Glorious Momentum #926
</PRE>
'''5.11.1'''
<PRE>
- fix(all): restore @theme_state and add to CLI capability #795
- fix(all): retire gtk2 monkey patch for gtk3 #823
- fix(all): games.rb XMLData.name wait till both not NIL and not EMPTY #826
- fix(all): standardize xmlparser game instance #827
- fix(all): games.rb fix multiple single and double quote in XML #832,836,837
- fix(dr): games.rb - optional hide Room Title display of Real IDs with FLAG on #782
- chore(dr): common-moonmage - refactor of peer_telescope #783
- fix(dr): move HMR load to common before for dragonrealms #784
- fix(dr): common-crafting.rb minor edit to add "You tuck" #787
- fix(dr): common-arcana.rb - remove unecessary pause from discern code #792
- fix(dr): drparser.rb Restore Premium status checking #834
- fix(gs): migrate PSMS.name_normal to Lich::Util.normalize_name #790,833
- fix(gs): add Char.che to know current character's CHE #791
- fix(gs): FEAT and Infomon module parsing of new Covert Art feats. #796
- fix(gs): add Currency.gemstone_dust and fix redsteel mark capture #797
- fix(gs): FEAT Covert Arts colon normalization and stamina costs #799
- fix(gs): escape dash in regex for HouseCHE #824
- fix(gs): disk.rb comparison helpers #828
- fix(gs): allow for Group.disks to show self disk in array #829
- fix(gs): feat.rb Covert Arts throw poison costs 15 stam #830
- fix(gs): add missing Feat.use ability #831
- fix(gs): multiple CritRanks updates #801-822
</PRE>
'''5.11.0'''
<PRE>
- [all] - chore: Namespace & File Path Updates #713
- [all] - [argv_options.rb] bugfix: correct darkmode to work via CLI #693
- [all] - [games.rb] feat: make show Room Exits of non-StringProc/Obvious Exits toggable for all games #699
- [all] - [games.rb] feat: toggleable display of StringProcs with clickable links #751
- [all] - [gui-manual-login.rb] fix: change label to Wrayth #720
- [all] - [gui-saved-login.rb] fix: update Stormfront label #721
- [all] - [update.rb] fix: purge old LIB folder prior to update release #729
- [all] - [util.rb] bugfix: allow issue_command to use fput or put #715
- [all] - [xmlparser.rb] feat: add XMLData.room_name attribute #685
- [all] - [main.rb] fix: create session file in regular connect method #733
- [all] - [init.rb] bugfix: error for Windows DISPLAY variable #735
- [all] - [main.rb] fix: Mudlet support #736
- [all] - [wine.rb] fix: add --no-wine CLI flag prevent WINE startup
- [all] - [init.rb] fix: add --no-gtk CLI flag prevent GTK3 gem load
- [dr] - [games.rb] feat: DRinfomon and common files as core lich libraries #686
- [dr] - [games.rb] chore: add DR requires here #690
- [dr] - [games.rb] fix: add Room# display for DR #697
- [dr] - [games.rb] bugfix: Genie FE real ID#s not supported, hide by default #728
- [dr] - [drdefs.rb] bugfix: fix for Shadow Servants #710
- [dr] - [map_dr.rb] fix: cleanup and support for UIDs #719
- [dr] - [xmldata.rb] bugfix: add support for DR Room IDs #716
- [dr] - [xmlparser.rb] feat: XMLData - adding dr_active_spells #691
- [gs] - [games.rb] bugfix: support for pre/post room name txt #683
- [gs] - [group.rb] chore: update to account for hold #701
- [gs] - [resource.rb] feat: add additional tracking of covert art charges #714
- [gs] - [spell.rb] bugfix: Spell.affordable? 515 release #687
- [gs] - [stash.rb] bugfix: sheath_bags when not found #694
- [gs] - [xmlparser.rb] bugfix: missing real ID in nav #684
- [gs] - [xmlparser.rb] bugfix: Claim module obvious hiding #717
- [gs] - [sk.rb] feat: Self-Knowledge functionality in core #748
</PRE>
'''5.10.4'''
<PRE>
-o- [GS4] - [xmlparser.rb] bugfix: Simu XML breaking change RoomID #679
</PRE>
'''5.10.3'''
<PRE>
-o- [GS4] - [crit_tables] fix: CritRanks regex fixes (multiple files and changes) #671
-o- [GS4] - [spellsong.rb] fix: Correct Spellsong sync method #674
-o- [GS4] - [parser.rb] fix: thorn status regex correction #673
-o- [All] - [xmlparser.rb] fix: Split out if elif block to account for DR having multiple… #670
-o- [All] - [global_defs.rb] fix: percentconcentration #676
-o- [All] - [global_defs.rb] fix: update move failure message to handle attack and casting #667
-o- [All] - [init.rb] fix: update required ruby check messaging #669
-o- [All] - [sessionvars.rb] feat: new module SessionVars for non-persistent variable storage #666
</PRE>
'''5.10.2'''
<PRE>
-o- [DR] - [games.rb] bugfix: tweak XML rewrite section #662
-o- [GS4] - [crit_tables] bugfix: additional crit table regex corrections #663
-o- [GS4] - [ascension.rb] bugfix: add new Transcend Destiny to lookups #661
-o- [GS4] - [effects.rb] bugfix: regexp escape txt #660
-o- [GS4] - [disruption_critical_table.rb] Bugfix in regex #659
</PRE>
'''5.10.1'''
<PRE>
-o- [All] - [games.rb] bugfix: prevent race condition in games thread #656
-o- [All] - [init.rb] bugfix: address WINE variance between linux / installs #655
-o- [GS4] - [gs][stash.rb] bugfix: wear code improvement #657
</PRE>
'''5.10.0'''
<PRE>
-o- [All] - [main.rb] bugfix: correct encoding for WizardFE PR #640
-o- [All] - [games.rb] bugfix: correct logic for room detection when using CLI --start-scripts PR #639
-o- [All] - [DB_Store.rb] feat: add direct support for Simu RENAME and CHANGE PROF PR #633
-o- [All] - chore: breakout code to individual files for easier management PR #617
-o- [All] - [lich.rbw] chore: add deprecated msg to old Settings/GameSettings/CharSettings methods PR #589
-o- [All] - [lich.rbw] feat: add new --dark-mode CLI option PR #583
-o- [All] - [global_defs.rb] bugfix: monsterbold fix for additional clients PR #581
-o- [All] - [update.rb] feat: update core scripts from source on Lich5 update/install PR #579
-o- [All] - [log.rb] feat: add new Log module copied from Olib PR #577
-o- [All] - [numeric.rb] feat: add days/hours/minutes/seconds methods to numerics PR #623
-o- [All] - [messaging.rb] feat: WizardFE Voln window support #647
-o- [All] - [init.rb] bugfix: WINE entries for Linux / MacOS #649
-o- [DR] - [lich.rbw] bugfix: cleanup downstream hook exclusions PR #593
-o- [DR] - [global_defs.rb] bugfix: missing climb failure message PR #592
-o- [GS4] - [effects.rb] bugfix: show non-standard Effects in `;magic` output PR #641
-o- [GS4] - [parser.rb] bugfix: fix WARCRY duplication results / add WALL OF THORNS effect detection PR #634 / PR #637
-o- [GS4] - [critranks.rb] feat: add critical rank resolution tables and methods PR #625
-o- [GS4] - [effects.rb] bugfix: to support regex for active? & time_left PR #590
-o- [GS4] - [infomon.rb] bugfix: add implicit NPC death monitoring PR #588
-o- [GS4] - [infomon.rb] bugfix: change PSM to be stored as type.mnemonic PR #587
-o- [GS4] - [lich.rbw] bugfix: strip_xml multiline fix PR #584
-o- [GS4] - [stash.rb] bugfix: fix sack detection to use Stash.container(param) PR #578
-o- [GS4] - [spell.rb] feat: Spell.after_stance #644
-o- [GS4] - [xmlparser.rb] bugfix: for Claim module #646
-o- [GS4] - [infomon] feat: track Voln favor via RESOURCE output #648
-o- [GS4] - [gameobj.rb] feat: add Bandit hidden target API #650
</PRE>
'''5.9.2'''
<PRE>
-o- [GS4] - [group.rb] bugfix: proper leader detection from GROUP output
-o- [GS4] - [char.rb] bugfix: add back depracted Char.maxvitals with msging to switch to new Char.max_vitals methods
</PRE>
'''5.9.1'''
<PRE>
-o- [GS4] - [group.rb] bugfix: group.check syntax change
-o- [GS4] - [spell.rb] bugfix: affordable? Char.mana parenthesis logic
</PRE>
'''5.9.0'''
<PRE>
-o- [All] - feat: sqlite3 gem syntax code cleanup PR#553
-o- [All] - [lich.rbw] bugfix: remove unused Setting, GameSetting, CharSetting PR#542
-o- [All] - [lich.rbw] bugfix: scrub login key from error message popups PR#548
-o- [All] - [messaging.rb] bugfix: color mismatch WizardFE white txt PR#554
-o- [All] - [lich.rb] feat: add new Lich.deprecated method to aid in deprecating older API calls PR#523
-o- [GS4] - [char.rb] feat: log method_missing calls PR#552
-o- [GS4] - [char.rb] feat: add missing global_def related methods PR#523
-o- [GS4] - [global_defs.rb] feat: deprecate various Char module methods PR#523
-o- [GS4] - [spellsong.rb] bugfix: cache spellsong duration calc PR#551
-o- [GS4] - [effects.rb] feat: Effects module breakout PR#549
-o- [GS4] - [group.rb][disk.rb] feat: Group & Disk class PR#532
-o- [GS4] - [activespell.rb] feat: add duration change messaging, off by default, see ;help for details PR#487
</PRE>
'''5.8.1'''
<PRE>
-o- [All] - [lich.rbw] feat: add Game:Character to debug log file ouput
-o- [All] - [init.rb] feat: add milliseconds to debug filename
-o- [GS4] - [lich.rbw] bugfix: reorder parsing of $SERVERSTRING to avoid certain conflicts
-o- [GS4] - [parser.rb] bugfix: update for new Empath resource and sleep/bind messaging
-o- [GS4] - [status.rb] bugfix: bound? calmed? and sleeping? support for spellnames flag being off
-o- [GS4] - [xmlparser.rb] bugfix: additional creature dying messaging to check against XML dead not being sent
-o- [GS4] - [gameobj.rb] bugfix: remove sorcerer arms and animates from GameObj.targets
</PRE>
'''5.8.0'''
<PRE>
-o- [All] - Ruby 3.3 compatibility
-o- [All] - [lich.rbw] feat: adds .sources for up/downstream hooks
-o- [All] - [lich.rbw] bugfix: don't use WINE for custom frontends
-o- [GS4] - [char.rb] bugfix: add back Char.stance
-o- [GS4] - [claim.rb] feat: new module and associated changes to xmlparser
-o- [GS4] - [experience.rb] feat: percent experience options
-o- [GS4] - [parser.rb] bugfix: allow for negative TNL exp value
-o- [GS4] - [parser.rb] bugfix: allow hyphenated last names in character names
-o- [GS4] - [parser.rb] feat: update resource matching for new Bard service
-o- [GS4] - [stash.rb] bugfix: catch more shield removal messages
-o- [GS4] - [util.rb] bugfix: underscore issue for PSMs
</PRE>
'''5.7.0'''
<PRE>
-o- Supports Ruby 3.2 - security enhancements and huge speed improvements for regex
-o- New libraries/modules/classes: Account, HMR (Hot Module Reloading)
-o- GS4 Infomon now baked into Lich5 as a library, no more need to run standalone script
-o- New GS4 libraries/modules/classes: Ascension, Bounty, Currency, Experience, Resources, Society, Status, Warcry
-o- Updates to existing libraries/modules/classes: Armor, Util, Weapon, Spell, GameObj, Messaging
-o- Several Bugfixes for lots of things
-o- Lots of code cleanup
</PRE>
'''5.6.2'''
<PRE>
-o- Fix for XML errors
-o- Adds the DR Plat instance for Frostbite FE
-o- Adds ‘ball’ as the noun used for ‘ball and chain’
-o- Adds the movement result ‘slip in the mud and fall flat’
-o- Corrects stamina cost for the feature Dispel Magic
-o- Plus all the latest script updates from Elanthia-Online!
</PRE>
'''5.6.1'''
<PRE>
-o- Fix for XML to limit login errors (DR)
-o- Fix for XMLData.active_spells to properly register wizard 'recovery' spell cooldowns
-o- Messaging updates to remove error in Wizard FE encodings
-o- Corrects for error in detecting PSM skill changes (cman) via warrior / rogue guild lessons
-o- Deprecates LNet script from master repository
-o- Miscellaneous small bug squashing
</PRE>

'''5.6.0'''
<PRE>
-o- (DragonRealms) Support for Genie and Frostbite frontends
-o- (GemStone) Changed methods to improve ;go2 speed and reduce lich.db3 calls
-o- (GemStone) Updates to support silver_count function
-o- (Both) Changed method for updating lich ecosystem
</PRE>

'''5.5.0'''
<PRE>
-o- Support for DragonRealms
-o- Updated support for scripts like BigShot
-o- Providing the LichID and UID on Profanity
-o- Spell.force_incant, .force_channel, and .force_evoke
-o- Standardized message method for script authors
-o- Sundry small improvements / fixes and changes
-o- And the creme de la creme - a custom directory
</PRE>

'''5.4.0'''
<PRE>
-o- Simu Room IDs (formally called 'unique ID' or 'uid' for Lich) added to Map, mapDB where known, and ;go2 for navigation (courtesy Xanlin and with our thanks!) ;go2 u7120 for all you ex-GMs out there.
-o- Room titles will now display the Lich ID and / or the UID for the room based on user selections - default is on for both, and enabled / disabled via Lich.display_lichid or Lich.display_uid toggles that can be set to on / off or true / false. (;e Lich.display_lichid=true/false and ;e Lich.display_uid=true/false) You can remove that rnum from your autostart now! To gain the benefit of the UID deployment, be sure to ;repo download-mapdb
-o- REQUESTS: Drop 5 minute timeout function from Lich
-o- waitrt? and waitcastrt? will still pause activities, but will return TRUE or FALSE in keeping with the Ruby functionname? tradition (no more failing to get a weapon out due to RT from climbing!)
-o- empty_hands and fill_hands will now check to see if the character is in roundtime before trying to put away or retrieve held items
-o- Infomon received an update that keeps spell timers in sync with the information received from the server - no more need to immediately do a spell active in game to get the right times to display for various legacy scripts and ;magic after visiting the invoker or using an SK item
-o- Lich now provides a facility to get current coins on the character that is a bit more agnostic to data changes from Simu - Lich::Util.silver_count
-o- Various other small tidbits to help ease maintenance and future development
-o- PLEASE NOTE: This update is required for the newest Bigshot (released today!) and for future eloot and eherbs scripts (release RSN)
</PRE>

'''5.3.0'''
<PRE>
-o- Added support for Wrayth (renamed Stormfront) installations
-o- Converted Linux | WINE login methods to 'method 0', does not use Simu launcher
</PRE>

'''5.2.1'''
<PRE>
-o- Support for STOWing items irrespective of special item scripts
-o- Improved query support for Effects and CMans
-o- Fix Lich bug to respect the 'groupmovement' flag in game
-o- Fix Lich round time calculations (more aggressive timing)
-o- Dark Mode is now a thing
-o- Lich4 Style GUI layout available
-o- Several file location changes to support future code change efforts
</PRE>

'''5.0.19'''
<PRE>
-o- Benefit: Monks with Mental Acuity (all 3 of you) rejoice - stamina casting!
-o- Benefit: PSM3 included, no charge. No hair remaining, either!
-o- Benefit: Ok, stay seated: Some of your various SF spell duration windows may work. . . better? Yes, not perfect, but better. No pictures, please!
-o- Updated infomon that properly detects Cloak of Shadows on those pesky sorcerers, and the Raise Dead Cooldown periods for those wondrous clerics.
-o- A new update process for Lich 5 - tired of having to download that script over and over just to update? Get yourself a copy of lich5-update.lic. Note, if you already have it, you're set! If not - ;jinx script install lich5-update --repo=elanthia-online
</PRE>

'''5.0.11'''
<PRE>
-o- Updated the method used to log onto SIMU servers.
-o- Added the Animalist item specifics to Lich5's empty and fill hands routines
-o- Improved Invoker messages for Avalon and Wizard FEs (no change for SF FE)
-o- Improved cleanup and store methods when player EXIT's or QUIT's game
-o- Crafted two new methods (stash_hands and equip_hands) for future script use
-o- Some behind-the-scenes cleanup to improve maintaining the Lich5 ecosystem
-o- Add Spell Active improvements
-o- Add PSM and Ranger improvements
</PRE>
</div>

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

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

Lich:Software/Installation

2026-10-28T12:50:39Z

WHIGHTCNIGHT: update Linux instructions to 4.0.9 Ruby

{{3rd-party}}
=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 Wrayth or Wizard FE. Lich is also used by many on both MacOS and multiple Linux distributions.

=Installing the Latest Stable Release=

'''The latest stable lich version is 5.22.0 supporting Ruby 4.0 - published October 8, 2026'''

==In-Place Upgrade==

If you are on an older version of Lich 5 and want to upgrade to the most current version, you can choose to either upgrade Lich5 only or both Lich 5 and Ruby. If you're currently on Lich 4, able to check by running the command <CODE>;e echo LICH_VERSION</CODE>, go to the [[#Upgrade Installation for Lich 5 from Lich 4 (11/14/2023)|upgrade from Lich 4 section]].

For each section, please follow the directions/commands one at a time.

===Lich 5 Only===

====Lich 5.7 or newer====
# You must be running Ruby 4.0 or greater for Lich 5.19 +. If unsure, please update both (see below)!
# '''Backup existing Lich 5 folder'''
# Run this command in-game <CODE>;lich5-update --update</CODE>
# Quit and restart lich.
# Congratulations - you're now running on the latest version of Lich!

====Lich 5.6 or older====
Please proceed to updating both Ruby and Lich 5

===Both Ruby 4.0 & Lich 5===
This method is for Windows only. Linux and MacOS users, please do a Lich 5 only update and update Ruby manually via normal install/update methods for the OS.

# Logout of all characters
# '''Backup existing Lich 5 folder'''
# Uninstall existing Ruby4Lich5 installs from Programs & Features control panel, or alternatively, rename your existing Ruby4Lich5 folder to Ruby4Lich5save. (Defaults to C:\Ruby4Lich5)
# Download the latest [https://github.com/elanthia-online/lich-5/releases/latest/download/Ruby4Lich5.exe Ruby4Lich5.exe Installer]
# Run the installer and be sure to have both Ruby and Lich 5 option selected
# Congratulations - you're now running on the latest version of Lich & Ruby!

===Ruby 4.0 Only===
Use this to upgrade to the newest version of Ruby only if you're already on the latest version of Lich5 and now want to update Ruby afterwards. If you're not already on the latest version of Lich5, please use previous section steps instead.
# Logout of all instances/characters
# '''Backup existing Lich 5 folder'''
# Uninstall your existing Ruby4Lich5 install via Programs & Features (ensure it's now gone, default location was C:\Ruby4Lich5)
# Download the latest [https://github.com/elanthia-online/lich-5/releases/latest/download/Ruby4Lich5.exe Ruby4Lich5.exe Installer]
# Run the new installer and choose to only install Ruby Only
# Congratulations - you're now running on the latest version Ruby!

==Windows New Installation==

{{blue|These instructions are not for DragonRealms. [[#Ecosystem Information|For those scroll to the bottom]].}}

'''For Windows 11 / 10 / 8 / 7''' users: you can download the [https://github.com/elanthia-online/lich-5/releases/latest/download/Ruby4Lich5.exe Ruby4Lich5.exe Installer] and install everything you need automatically. Click on the '''Ruby4Lich5.exe''' and download it to your computer then double click on the executable in your default download folder. Note, a user may need to adjust their browser or security settings to allow download and installation.
If you have never played before, follow the 'New Installation' instructions. If you have played before, and have used Lich before, follow the 'Upgrade Installation' instructions.

===New Installation for Lich 5 (11/14/2023)===

# '''Please log into the game of your choice through the Simutronics website first'''. Install the launcher (not SGE), and install your FrontEnd of Choice. The Wrayth FrontEnd is presently the supported FrontEnd, but Wizard will work as well, if you are nostalgic. After you've logged in, log out and continue.
# Download and Run the [https://github.com/elanthia-online/lich-5/releases/latest/download/Ruby4Lich5.exe Ruby4Lich5.exe 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, 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.

===Upgrade Installation for Lich 5 from Lich 4 (11/14/2023)===

This option is deprecated. Lich 5 architectures are not compatible with Lich 4. Back up your existing Lich 4 folder, uninstall any existing Ruby executables, and then follow the instructions for a new install above.

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

==MacOS==
There two common options for playing Gemstone IV on a Mac is either to play natively with Avalon or to use virtualization software such as Parallels with Wrayth/WizardFE. Below are the options on how to do that.

===Native Avalon===
Players with Macs can use [[Mac_Installation_-_Lich_(software) | Installing Lich on Macs]] for installation help. This process works well for Mac OS Catalina and Big Sur. If you have not updated your Mac OS yet, these instructions may work depending on your actual version. If you run into a snag, follow the contact instructions provided.

===Parallels Windows===
With the latest releases of Ruby4Lich5 installer, you can now follow the normal Windows installation for both Intel and Apple silicon based Apple computers.

To install Wrayth/WizardFE, Lich, and Ruby via Parallels you will need to do a few various steps as outlined below. Please note, the rubyw file in C:\Ruby4Lich5\X.X.X\bin may be set to run in compatibility mode for windows 7. On an ARM Mac running parallels, this may causes Wrayth scripts not to run. Turning compatibility mode off in the rubyw file could fixe this issue if it was enabled.

The following steps are to be done AFTER you've successfully installed Wrayth/WizardFE and can login normally without Lich5 on the machine. Once you've done that and can successful connect normally, then follow these steps:
# Download and install [https://github.com/elanthia-online/lich-5/releases/latest/download/Ruby4Lich5.exe Ruby4Lich5.exe Installer] and use default options presented during install
# Double click the lich.rbw file that is now located in the extracted Lich5 location you did above. Login and play as usual.

==Linux==
Pick the subsection for your distribution below. Each one installs Ruby and Lich; front ends ([[#Profanity|Profanity]] and [[#Warlock|Warlock]]) are covered once in [[#Frontends|Frontends]] at the end, since their steps are the same on every distribution.

===Chromebook & Debian variants===
<div class="mw-customtoggle-debian" style="font-size:16px;overflow:auto;color:#0000FF">[Click to Expand]</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-debian">
The following steps should install Lich for users of Debian/Chromebooks. To also install a front end such as Profanity or Warlock, see [[#Frontends|Frontends]] at the end of the Linux section.

'''Step 1.'''
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 curl libssl-dev libyaml-dev libreadline6-dev zlib1g-dev libncurses5-dev libffi-dev libgdbm6 libgdbm-dev libsqlite3-dev git unzip libcairo2-dev libgirepository1.0-dev libgtk-3-dev gobject-introspection
</pre>

{{side box|NOTE: If you are updating an existing Ruby installation rather than installing from scratch, skip steps 2, 3, and 4. Instead, update your ruby-build with the following command, and then proceed to Step 5.<pre>git -C ~/.rbenv/plugins/ruby-build pull</pre>}}

'''Step 2.'''
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>

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

'''Step 4.'''
Download the tools to let rbenv install Ruby on its own, then install Ruby 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</pre>

'''Step 5.'''
<pre>rbenv install 4.0.9 -v
rbenv global 4.0.9
</pre>

Install Lich:
<pre>
cd ~
curl -L "https://github.com/elanthia-online/lich-5/releases/latest/download/lich-5.zip" -o temp.zip && unzip temp.zip -d ./ && rm temp.zip
</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 using the <tt>Gemfile</tt> included with Lich5 by running <tt>bundle install</tt>. The Gemfile also lists developer-only gems (the <tt>development</tt> and <tt>vscode</tt> groups) that you do not need, so tell Bundler to skip them first:
<pre>
echo "gem: --no-document" > ~/.gemrc
cd ~/Lich5
bundle config set --local without 'development vscode'
bundle install
</pre>
:<small>Note: <tt>bundle install --without ...</tt> no longer works; that flag was removed from the version of Bundler that ships with Ruby 4.0. Use <tt>bundle config set</tt> as shown above.</small>
</div>

===Arch Linux & Arch-based distributions===
<div class="mw-customtoggle-arch" style="font-size:16px;overflow:auto;color:#0000FF">[Click to Expand]</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-arch">
The following steps should install Lich for users of Arch Linux and Arch-based distributions (Manjaro, EndeavourOS, etc.). To also install a front end such as Profanity or Warlock, see [[#Frontends|Frontends]] at the end of the Linux section.

Update the system and install required dependencies:
<pre>
sudo pacman -Syu
sudo pacman -S --needed base-devel openssl libyaml readline zlib ncurses libffi gdbm sqlite git unzip curl gtk3 gobject-introspection
</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 4.0.9 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 4.0.9 -v
rbenv global 4.0.9
</pre>

Install Lich:
<pre>
cd ~
curl -L "https://github.com/elanthia-online/lich-5/releases/latest/download/lich-5.zip" -o temp.zip && unzip temp.zip -d ./ && rm temp.zip
</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 using the <tt>Gemfile</tt> included with Lich5 by running <tt>bundle install</tt>. The Gemfile also lists developer-only gems (the <tt>development</tt> and <tt>vscode</tt> groups) that you do not need, so tell Bundler to skip them first:
<pre>
echo "gem: --no-document" > ~/.gemrc
cd ~/Lich5
bundle config set --local without 'development vscode'
bundle install
</pre>
:<small>Note: <tt>bundle install --without ...</tt> no longer works; that flag was removed from the version of Bundler that ships with Ruby 4.0. Use <tt>bundle config set</tt> as shown above.</small>
</div>

===Fedora===
<div class="mw-customtoggle-fedora" style="font-size:16px;overflow:auto;color:#0000FF">[Click to Expand]</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-fedora">
The following steps should install Lich for users of Fedora. To also install a front end such as Profanity or Warlock, see [[#Frontends|Frontends]] at the end of the Linux section.

Lich 5 requires Ruby 4.0 or newer. The Ruby that ships with currently supported versions of Fedora is older than that (41 uses Ruby 3.3; 42 and 43 use Ruby 3.4), so these steps install Ruby 4.0.9 with '''<tt>[https://github.com/rbenv/rbenv rbenv]</tt>''' instead of using Fedora's Ruby.

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 cairo-devel curl gcc gdbm gdbm-devel gdk-pixbuf2-devel glib2-devel \
gobject-introspection-devel gtk3-devel libyaml-devel libffi-devel make ncurses-devel openssl-devel readline-devel \
redhat-rpm-config sqlite-devel unzip zlib-devel
</pre>

{{side box|NOTE: If you are updating an existing rbenv Ruby installation rather than installing from scratch, skip step 3. Instead, update your ruby-build with the following command, and then run only the <tt>rbenv install</tt> and <tt>rbenv global</tt> lines from step 3.<pre>git -C ~/.rbenv/plugins/ruby-build pull</pre>}}

3. Install rbenv and Ruby 4.0.9:
<pre>
git clone https://github.com/rbenv/rbenv.git ~/.rbenv
echo 'export PATH="$HOME/.rbenv/bin:$PATH"' >> ~/.bashrc
echo 'eval "$(rbenv init -)"' >> ~/.bashrc
source ~/.bashrc
git clone https://github.com/rbenv/ruby-build.git ~/.rbenv/plugins/ruby-build
rbenv install 4.0.9 -v
rbenv global 4.0.9
ruby -v
</pre>
The last command should print a line starting with <tt>ruby 4.0.9</tt>. If it doesn't, close and reopen the terminal and try <tt>ruby -v</tt> again.

4. Install Lich:
<pre>
cd ~
curl -L "https://github.com/elanthia-online/lich-5/releases/latest/download/lich-5.zip" -o temp.zip && unzip temp.zip -d ./ && rm temp.zip
</pre>

5. 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 using the <tt>Gemfile</tt> included with Lich5 by running <tt>bundle install</tt>. The Gemfile also lists developer-only gems (the <tt>development</tt> and <tt>vscode</tt> groups) that you do not need, so tell Bundler to skip them first:
<pre>
echo "gem: --no-document" > ~/.gemrc
cd ~/Lich5
bundle config set --local without 'development vscode'
bundle install
</pre>
:<small>Note: <tt>bundle install --without ...</tt> no longer works; that flag was removed from the version of Bundler that ships with Ruby 4.0. Use <tt>bundle config set</tt> as shown above.</small>
</div>

===Frontends===
Finish the Lich installation for your distribution above first, then set up one of these front ends.

====Profanity====
Profanity is a terminal-based Front-End that will let you play the game (in lieu of The Wizard or Wrayth). Its gems (such as <tt>curses</tt>) are installed by the <tt>bundle install</tt> step above. Download Profanity:
<pre>
cd ~
git clone https://github.com/elanthia-online/ProfanityFE.git
</pre>

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

====Warlock====
Download Warlock from https://sproctor.github.io/warlock3/download.html, then run Lich the normal way with Ruby:
<pre{{log2|margin-right=35%}}>
ruby ~/Lich5/lich.rbw
</pre>
Use your login information with these settings to use the Lich launcher: https://github.com/sproctor/warlock3/wiki/Lich-support

=Popular Scripts=
{{#section:Lich:Script Repository|popularscripts}}

=Ecosystem Information=

* DragonRealms Variant - [https://elanthipedia.play.net/Lich_script_repository#Setup_and_Installation Setup and Install instructions]

=Lich Changelog=
<div class="mw-customtoggle-changelog" style="font-size:16px;overflow:auto;color:#0000FF">[Click to Expand]</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-changelog">
'''5.22.0'''
<PRE>
### Features (general)
* add opt-in bounded script execution guards (#1575)
* add static-only map route selection (#1577)
* bounded fput with max_resends, interrupt, resend_transient and failure symbols (#1587)
* Spell.results_regex, the lines cast waits on, exposed (#1590)
* add Events, a script-to-script notification primitive; combat emits on it (#1619)
* add deterministic hook priorities (#1621)
* Map.boundary_rooms_for(ids), the perimeter of any set of rooms (#1660)
* sticky ever_hostile? keeps Sympathy'd creatures in targets (#1665)
* --pipe -g honours the frontend flag, and --sentinel requests the origin marker (#1677)

### Features (gs)
* add trustworthy combat observation provenance (#1576)
* Lich::Gemstone::Stance, a shared stance setter (#1578)
* Lich::Stash.wield and Stash.hands put named items into hands (#1579)
* Lich::Gemstone::Mana.pulse, the MANA PULSE verb once (#1580)
* Lich::Gemstone::Bank, Currency refresh, and WEALTH parser lines (#1581)
* PSM command and results_regex readers, factored out of use (#1583)
* Lich::Gemstone::Fog, the ways home on the spell and society readers (#1584)
* Combat::Messages - non-combat message families as observer events (#1586)
* society command readers, factored out of use (#1589)
* Group.join, the follower's side of Group.add (#1591)
* emit post-commit combat recorder receipts (#1592)
* combat definition supplements from a player YAML file (#1607)
* message definitions from the player supplement file (#1608)
* creature library - abilities from session logs, limbs flags, triggers as hash of arrays (#1623)
* expose exact server creature health from crtrStatus (#1661)

### Bug Fixes (general)
* fix spec stub race breaking FFI loads, gate WindowsCredentialManager to Windows (fixes #1542) (#1573)
* setup_files uses content hash for cache freshness (#1596) (#1599)
* creatures registry housekeeping independent of Combat::Tracker (#1603)
* place effect-list.xml backups in the update snapshot folder (#1606)
* retain discovery ownership through cleanup (#1612)
* Initial Lich state update and detachable-client split GS/DR (#1617)
* bound move()'s remedy retries, record why a move failed, lift it into Lich::Common::Move (#1622)
* update puts to Lich.log (#1630)
* create detachable-client session file without --login (#1656)
* converge server_time_offset instead of resetting it every prompt (#1663)
* plain-language lich5-update messages when GitHub fails (#1687)
* Inventory.refresh waits out roundtime before sending (#1688)

### Bug Fixes (dr)
* update HOW pattern to accommodate various soul states (#1620)
* restore script halt in DRCC.get_crafting_item on missing item (#1624)
* halt script when too distracted to turn recipe book (#1625)
* equipmentmanager energy bow handling (#1662)
* report when DRC.rummage can't read a container (#1671)
* DRCI.get_item? confirms #<id> gets by the item id in hand (#1674)
* DRCT.sell_item references the item through DRCI.item_ref (#1675)
* DRCA.do_buffs filters day/night spells without mutating settings (#1680)
* DRCI.tie_item? no longer reports an empty pouch as tied (#1684)
* DRC.play_song? keeps climbing and performance songs across instrument switches (#1686)

### Bug Fixes (gs)
* Injured cache lives on the class and keys on an injury fingerprint (#1582)
* infomon - a spell's start message refreshes a refreshable timer (#1585)
* Group.broken? waits on Lich::Claim::Lock, the constant that exists (#1588)
* combat module - hunt-log audit: interrupted-swing resume, status attribution by event, spell-loss cause, live defs (#1593)
* QStrike prices MSTRIKE's own stamina cost (#1594)
* combat module - a stand-up message later in the chunk outranks an earlier knockdown crit (#1595)
* track spell cooldowns on the characters a spell locks out (#1597)
* catalog missing deity-specific strike lines for Divine Wrath (335) (#1598)
* combat module - Rysk/Dreadt log audit: Holy Weapon release model, held maneuver rolls, AoE roll attribution, live defs (#1600)
* Combat defs add thrust as a basic attack (#1615)
* preserve group state after ambiguous disband reply (#1629)
* target ridden mounts before their first crtrStatus (#1669)
* snapshot Effects registries so scripts can't break the XML parser (#1672)
</PRE>
'''5.21.0'''
<PRE>
### Features (general)
* Add --refresh-characters and --add-character CLI flags (#1504)
* add --active-session-dir to decouple Active Sessions coordination from --temp (#1520)
* add read model for the inventoryManager extended feed (#1524)
* GUI add configurable frontend registry (#1558)
* add HTTPS web-login fallback for when EAccess (7910) is unreachable (#1570)

### Features (dr)
* player-supplied custom prep/cast/invoke messages (#1528)
* opt-in cambrinth charge distribution across configured items (#1549)
* populate GameObj from INV LIST full refresh (02 of 05) (#1554)
* non-destructive upsert for INV SEARCH / category scrapes (03 of 05) (#1556)
* reconcile GameObj containers on hand pickup (04 of 05) (#1557)
* [DRCC] add shared private-forge helpers (#1560)

### Features (gs)
* creature template library - measured combat data, HP/speed censuses, messaging (#1539)

### Bug Fixes (general)
* enforce Script#pause at every blocking/mutating checkpoint (#1537)
* always report missing gems on stderr; only wait on a dialog without a tty (#1544)
* dispatch --help and --version before the GTK require (#1546)
* global_def update deprecated method calls to include caller info (#1550)
* normalize colons in Lich::Util.normalize_lookup (#1561)
* Script.log respects --log-dir/LOG_DIR override; use File.join for paths in script.rb (#1572)

### Bug Fixes (dr)
* drvariables add more data to VOL_MAP (#1536)
* pin capped skills to 34 in DRSkill.clear_mind (#1548)
* match lowercase "it's already open" when opening a container (#1553)
* normalize capitalized leading articles in inventory scrape names (01 of 05) (#1555)
* make INV LIST refresh atomic and warn on interruption (05 of 05) (#1563)
* refresh before_name/after_name on a name-preserving container move (#1564)
* do not re-add a held item as worn inventory on inv scrape (#1565)
* evict orphaned identity-index entries on a name-changing upsert (#1566)
* unpause the exact scripts safe_pause_list paused, by object (#1574)

### Bug Fixes (gs)
* Infomon xmlparser additional npc death messaging (#1540)
* correct messaging drift in 13 crit table patterns (#1547)
* combat module - event defs, observer emissions, replay-verified parsing, SQLite recorder (#1559)
</PRE>
'''5.20.1'''
<PRE>
### Bug Fixes (general)
* bound EAccess auth with a timeout so a stalled SGE backend can't hang Lich silently (#1502)
* Linux WINE and Wrayth FE detection (#1517)
* update Gemstone game-code validations (#1518)
* preserve bundled display-state tags on quiet-suppressed chunks (#1530)
* prevent a stray formatting character from appearing in Saga during quiet script output (#1532)

### Bug Fixes (dr)
* make $safe_pause_lock holder immune to pause (#1525)

### Bug Fixes (gs)
* critranks.rb tolerate nil table rows, fix reload!, index patterns … (#1522)
* combat module hardening - ordered processing, 22x faster parsing, double-count fix (#1523)
</PRE>
'''5.20.0'''
<PRE>
### Features (general)
* add concurrent runtime I/O and multi-client detach support (#1459)
* --bind-address speaks the same keywords as --detachable-client (#1461)
* GUI Launcher Improvements (#1463)
* Add supervised child script APIs (01 of 06) (#1474)
* Add forced script teardown command (06 of 06) (#1479)
* teardown and distinguishable errors for Script.run_child (#1501)

### Features (dr)
* DRCMM.moon_weapon_duration - read a moon weapon's remaining life (#1483)
* id-based creature tracking from crtrStatus + assess (#1485)
* capture room UID from <nav> tag; stop enforcing ShowRoomID; opt-in room-id placement (#1491)
* user-extensible scroll substitutions via settings (01 of 06) (#1512)
* user-extensible boxes and trash receptacles (03 of 06) (#1514)
* user-extensible summoned-weapon adjectives (04 of 06) (#1515)
* user-extensible flavor-text stripping (05 of 06) (#1516)

### Features (gs)
* gameobj add full_name matcher to type/sellable classification (#1453)

### Bug Fixes (general)
* prevent empty/partial GameObj registry reads during mid-stream refresh (#1370)
* no-op Gtk.lich_main_quit when no main loop is nested (#1464)
* correct path-flag aliases and document all path options (#1472)
* Synchronize script lifecycle transitions (02 of 06) (#1475)
* Coordinate script shutdown draining (03 of 06) (#1476)
* Harden script lifecycle ownership (05 of 06) (#1478)
* surface the underlying LoadError in dependency alerts (#1480)
* extract game-agnostic CreatureBase into lib/common (#1484)
* bound GemCheck alert dialogs with a timeout so they can't hang forever (#1488)
* identify Genie as the frontend for headless launches (#1490)
* restore detachable client disconnect notice to stdout (#1492)
* harden detachable client teardown and escape init payload (#1493)
* resolve GameObj status visibility during staged refresh (#1497)
* compact client write queue instead of ending the session (#1498)
* scrub startup credentials once login completes (#1499)
* Honor Simu-side teardown for 10 seconds (#1505)

### Bug Fixes (dr)
* resolve no-UID rooms carrying a stored UID instead of returning nil (#1467)
* equipmanager.rb - reliable ranged-weapon transitions - stow ammo after unload + verify offhand wield hand (#1468)
* common-healing.rb - DRCH.bind_wound: only dispose a dislodged item while it is in hand (#1469)
* preserve game RealID in room title (GS parity for ";display roomid title") (#1500)
* Refine need_buffs? logic for non-recast spells to correctly check cyclic spells. (#1503)
* reduce symbol-torn scale scrolls to gettable noun (#1506)
</PRE>
'''5.19.1'''
<PRE>
### Bug Fixes (general)
* lower game socket keepalive idle from 120s to 30s (#1449)
* resilient ActiveSessions ownership + shutdown watchdog (#1452)
* Quit Gtk.main cleanly (#1455)
* Refactor regex to string comparisons for ARGV options (#1456)

### Bug Fixes (gs)
* ingest newly-exposed mindState experience and roommeta room fields (#1450)
</PRE>
'''5.19.0'''
<PRE>
### Features (general)
* Add character generator support via EAccess protocol (#1384)
* Add modern script command shutdown method (#1385)
* migrate the server-stream parser from REXML to Ox, with pipe-mode benchmark harness and DR parser coverage (#1396)
* enumerate script subdirs with file glob (#1397)
* add --bind-address option to set listen socket address (#1405)
* add central method to determine lich ver (#1417)
* setup_files: support scripts/data/custom for user data overrides (#1431)
* Modify running? method to support optional exact matching of script names (#1436)
* keyword bind hosts for the detachable client (tailscale/lan/any) (#1437)
* add roomlinks/roommono toggles for room display (#1438)
* self-healing gem requires (#1439)
* various Saga FE compatibility tweaks (#1443)
* add macOS limited gem recovery (#1448)

### Features (dr)
* Capture combat position from the balance status line (#1400)
* detect scheduled shutdown and expose it on DRParser (#1409)
* xmlparser: add structured parser for the assess (combat situation) stream (#1413)
* Implement DRCA.need_buffs? method for buff checks (#1428)

### Features (gs)
* anchor Infomon parser regex unions to line start (#1391)
* creature xml additions (#1425)
* add creature template library (#1427)

### Bug Fixes (general)
* surface a failed Game.open in the connect timeout (#1408)
* bound long-session memory growth (index/hook/watchfor/buffer leaks) (#1410)
* improve and harden shutdown (#1416)
* use bundler to check for required Ruby gems (#1420)
* pin lich directory for gemfile check (#1423)
* Show CLI login ARGV for SAL connections (#1424)
* increase read timeout on idle socket to 300 seconds (#1426)
* monkeypatch gi for memoryreleaser / asyncprocessor until patched upstream (#1429)
* Mapdb sort tags by downcase and original case (#1433)
* stop locking the load path at boot; keep Gemfile.lock in sync on self-update (#1434)
* minimum Ruby 4.0 required & migrate Ruby version check (#1444)
* align --announce with --update for Ruby version (#1447)

### Bug Fixes (dr)
* BalanceValue regex to match combat status lines (#1398)
* equipmanager.rb - Fix unload weapon detection when AimTimerDialog tag is prepended (#1414)

### Bug Fixes (gs)
* global_defs update pushStream regex to include 'reserve' id (#1379)
* psms Warcry.available? correction (#1387)
* xmlparser support new field exp, climate, terrain XML feeds (#1388)
* global_defs move() update regex for standing condition (#1407)
* Currency add method to retrieve aevit event currency (#1411)
* Stash check result type before comparing regex for wear_to_inv (#1430)
</PRE>
'''5.18.0'''
<PRE>
### Features (dr)
* common-crafting add method for creating mechanisms (#1375)

### Bug Fixes (general)
* stringproc normalize CRLF | CR to LF (#1378)
* rubocop custom cop ascii only cleanup (#1382)

### Bug Fixes (dr)
* equipmanager update to assume missing items aren't worn (#1376)

### Bug Fixes (gs)
* Infomon xmlparser additional npc death messaging (#1326)
</PRE>
'''5.17.3'''
<PRE>
### Bug Fixes (general)
* Script module replace MemoryReleaser with GC.start for cleanup (#1364)
* Add sqlite busy timeout policy to core (#1365)
* Script#kill remove GC.start and add optional instrumentation (#1368)
* reorder shutdown ala MahtraDR and detect script teardown de... (#1369)
</PRE>
'''5.17.2'''
<PRE>
### Bug Fixes (general)
* harden custom repo identity, collision, and contract boundaries (#1333)
* stop SessionLifecycle before closing database on normal exit (#1334)
* harden FeatureFlags for closed db handle (#1335)
* SynchronizedSocket write resilience and zombie client elimination (#1338)
* correct RP timing issue for release notes (#1348)
* gate object cleanup in GTK queue (#1354)
* recover from cross-process zombie in ActiveSessions service (#1355)
* Improve shutdown session state handling (#1359)
* non-ascii hygeine to address rubocop errors (#1360)
* Remove debug log IO from heartbeat tick loop (#1363)

### Bug Fixes (dr)
* DRC text2num correction for thousand (#1343)

### Bug Fixes (gs)
* Overwatch add REVEALED_EXPLODES regex pattern (#1356)
* Stash add_to_bag result type check before regex compare (#1357)
</PRE>
'''5.17.1'''
<PRE>
### Bug Fixes (general)
* enable heartbeat-driven failover for ActiveSessions service owner (#1340)
* copy Gemfile and LICENSE during self-update (#1345)
* Add top-level parse_args/display_args bridge to global_defs (#1346)

### Bug Fixes (dr)
* replace undefined custom_require in check_moonwatch (#1336)
* set_stance places 100 in the correct positional slot (#1337)
* cache SlackBot users list to prevent API throttling (#1342)
* Add CORE_AUTOSTART sentinel to skip dependency.lic autostart helpers (#1344)

### Bug Fixes (gs)
* Infomon Status.cutthroat? Effect Debuff correction (#1331)
* add support for RESERVE xml in GameObj.reserve (#1341)
</PRE>
'''5.17.0'''
<PRE>
### Features (general)
* custom 3rd-party repo support for ScriptSync (#1285)
* Add get_settings, get_data, start_scripts_if_available to core (#1305)
* Add Map.apply_wayto_overrides for personal map overrides (#1306)

### Features (dr)
* Decouple SetupFiles from script-scoped echo and XML feed timing (#1304)
* Add game flags and obsolete script warnings to DRInfomon startup (#1307)

### Bug Fixes (general)
* use :__unset for --without-frontend CLI request YAML matches (#1301)
* prevent zombie server deadlock in Active Sessions accept loop (#1302)
* improve MacOS keychain system check for older OS variants (#1310)
* stub sync_all_repos to prevent leaked thread in games_spec (#1311)
* enforce beta confirmation 10s timeout (#1315)
* use send(:respond) in StatusReporter fallback path (#1316)
* ensure SessionLifecycle.stop runs on abnormal exit (#1317)
* address ActiveSessions lifecycle hot path feature-flag polling (#1325)
* catch ECONNRESET in _puts and bound walk_to retry depth (#1327)
* safeguard gtk logo.png loading (#1329)

### Bug Fixes (gs)
* Add InnCheckedOut pattern to parser (#1309)
* Claim corrections to handle mounts in room_players stream (#1324)
</PRE>
'''5.16.2'''
<PRE>
### Features (general)
* session summary store and reporting (#1247)
* add core classes, ScriptSync, and login auto-sync (#1273)
* Add active sessions API (#1274)
* Add session status CLI query (#1276)
* configurable debug log retention (#1282)

### Features (dr)
* common-healing.rb - add vitality parsing to HealthResult (#1265)

### Bug Fixes (general)
* handle auth exceptions in manual login to prevent hang on bad password (#1267)
* set SO_REUSEADDR before bind to allow immediate port reuse (#1268)
* Persistent Launcher re-enable play button post launch (#1269)
* Restore manual login behaviors to not require saved entry t... (#1270)
* log and re-raise unexpected errors in saved login auth handler (#1271)
* narrow safe_write rollback scope so cleanup failure preserves successful write (#1287)
* fix three revert bugs in SnapshotManager (#1289)
* guard nil release asset and validate before deleting lib/ (#1290)
* guard nil stable version in beta channel resolution (#1291)
* remove dead code in BranchInstaller (#1292)
* repair regression on gui button reenable from refactor (#1297)

### Bug Fixes (dr)
* common-items.rb - move pattern from failure to success block (#1262)
* buffer_room_objs missed split components with leading stream tags (#1284)
* common-items.rb - get_item_unsafe false positives via XML feed verification (#1286)
* forward vitality and dead fields in perceive_health (#1288)

### Bug Fixes (gs)
* Infomon xmlparser additional npc death messaging (#1275)
* Infomon xmlparser additional npc death messaging (#1281)
</PRE>
'''5.16.1'''
<PRE>
### Features (general)
* session summary store and reporting (#1247)
* add core classes, ScriptSync, and login auto-sync (#1273)
* Add active sessions API (#1274)
* Add session status CLI query (#1276)
* configurable debug log retention (#1282)

### Features (dr)
* common-healing.rb - add vitality parsing to HealthResult (#1265)

### Bug Fixes (general)
* handle auth exceptions in manual login to prevent hang on bad password (#1267)
* set SO_REUSEADDR before bind to allow immediate port reuse (#1268)
* Persistent Launcher re-enable play button post launch (#1269)
* Restore manual login behaviors to not require saved entry t... (#1270)
* log and re-raise unexpected errors in saved login auth handler (#1271)
* narrow safe_write rollback scope so cleanup failure preserves successful write (#1287)
* fix three revert bugs in SnapshotManager (#1289)
* guard nil release asset and validate before deleting lib/ (#1290)
* guard nil stable version in beta channel resolution (#1291)
* remove dead code in BranchInstaller (#1292)

### Bug Fixes (dr)
* common-items.rb - move pattern from failure to success block (#1262)
* buffer_room_objs missed split components with leading stream tags (#1284)
* common-items.rb - get_item_unsafe false positives via XML feed verification (#1286)
* forward vitality and dead fields in perceive_health (#1288)

### Bug Fixes (gs)
* Infomon xmlparser additional npc death messaging (#1275)
* Infomon xmlparser additional npc death messaging (#1281)
</PRE>
'''5.16.0'''
<PRE>
### Features (general)
* session summary store and reporting (#1247)
* add core classes, ScriptSync, and login auto-sync (#1273)
* Add active sessions API (#1274)
* Add session status CLI query (#1276)
* configurable debug log retention (#1282)

### Features (dr)
* common-healing.rb - add vitality parsing to HealthResult (#1265)

### Bug Fixes (general)
* handle auth exceptions in manual login to prevent hang on bad password (#1267)
* set SO_REUSEADDR before bind to allow immediate port reuse (#1268)
* Persistent Launcher re-enable play button post launch (#1269)
* Restore manual login behaviors to not require saved entry t... (#1270)
* log and re-raise unexpected errors in saved login auth handler (#1271)

### Bug Fixes (dr)
* common-items.rb - move pattern from failure to success block (#1262)
* buffer_room_objs missed split components with leading stream tags (#1284)
* common-items.rb - get_item_unsafe false positives via XML feed verification (#1286)

### Bug Fixes (gs)
* Infomon xmlparser additional npc death messaging (#1275)
* Infomon xmlparser additional npc death messaging (#1281)
</PRE>
'''5.15.1'''
<PRE>
### Bug Fixes (general)
* Mutli-launch persistent login GUI (#1245)
* Remove Windows OS CMD prompt flash (#1255)
* guard against broken pipe errors in Game._puts and send_to_client (#1260)
* add timeout safety to fput to prevent infinite hangs (#1261)

### Bug Fixes (dr)
* anchor stow success pattern to prevent fan close recovery bypass (#1254)
* add bounded recursion depth limits to 9 methods (#1257)
* stow_helper failure detection + unload_weapon ammo recovery (#1259)
</PRE>
'''5.15.0'''
<PRE>
### Features (general)
* add InstanceSettings for core Settings API access (#1233)

### Features (gs)
* Overwatch module into core (#1201)

### Bug Fixes (general)
* fix GameObj container initialization and add clear_all_containers (#1226)
* GameObj object dedupe & GC (#1234)
* script.rb show Script.kill source (#1235)
* Exit quickly on CLI authentication failure (#1237)
* suppress wine detection noise and skip when unneeded (#1244)

### Bug Fixes (dr)
* DR modules fixes and enhancements (#1232)

### Bug Fixes (gs)
* psms.rb add additional failure matches (#1238)
* Bounty parser fix regex pattern for skin retrieval task (#1242)
</PRE>
'''5.14.2'''
<PRE>
### Bug Fixes (general)
* add retry with exponential backoff for all login authentication (#1205)
* update.rb allow for bugfix betas and branch updates (#1211)

### Bug Fixes (gs)
* infomon.rb bug in _key transformation (#1216)
</PRE>
'''5.14.1'''
<PRE>
### Bug Fixes (general)
* Change server_time_offset in XMLParser to be float instead of int (#1184)
* change encodings in main.rb to wizard FE only (#1199)

### Bug Fixes (gs)
* Infomon parser.rb update Account.subscription/type (#1192)
* spell.rb add last_cast to track last time casted (#1193)
* stash.rb additional improvements with ReadyList/StowList (#1197)
* Infomon parser.rb bug in EnhanciveEnd (#1198)
</PRE>
'''5.14.0'''
<PRE>
### Features (general)
* Add Genie map cross-reference fields to the DragonRealms map data model (#1169)

### Features (dr)
* DRExpMonitor move into core lich (#1154)

### Features (gs)
* add Enhancive module for enhancive item bonus tracking (#1113)
* add QStrike module for optimal stamina-based RT reduction (#1114)

### Bug Fixes (general)
* remove strip! from settingsInfo replacement (#1161)
* map_base.rb sort JSON better (#1171)

### Bug Fixes (dr)
* logbook_item recovery when crafted item not in hand (#1175)

### Bug Fixes (gs)
* xmlparser.rb capture additional death messaging (#1158)
* stash.rb ReadyList sheath handling and update inventory checks (#1166)
</PRE>
'''5.13.6'''
<PRE>
### Bug Fixes (general)
* allow --add-account to run without yaml and dat (#1143)
* enable --login for multi-variable custom launch commands (#1144)
* update.rb pervent update if MIN_RUBY not met (#1146)
* messaging.rb return "" for xml_encode with Wizard (#1147)
* prevent closing connection on module reload (#1148)
* Allow hmr to work on global_defs.rb (#1156)

### Bug Fixes (dr)
* buffer split room obj lines and merge instead of appending closing tag to broken line (#1149)
* add buffering for multiline room players (#1151)
* add verify_script def here instead of depending on dependency (#1155)

### Bug Fixes (gs)
* infomon.rb added updated_at field to upsert_batch (#1145)
* stowlist.rb check method fix when dead (#1152)
* readylist.rb check method fix when dead (#1153)
</PRE>
'''5.13.5'''
<PRE>
### Bug Fixes (general)
* util.rb only show gem installing debug messaging if gem mis… (#1131)
* add --gs and --dr, refactor argv_options to helpers (#1133)
* fix multiple custom entries, improvements to yaml save (#1134)
* login_tab_utils.rb expand helper text show Warlock (#1135)
* update CLI for YAML security signature, add auto-convert fo… (#1136)
* remove password parameter from debug logging in all cases (#1137)
* reduce minimum GUI window footprint for non-tabbed view (#1138)
* remove double save in YAML to preserve yaml.bak integrity (#1139)

### Bug Fixes (gs)
* stash.rb additional improvements (#1132)
</PRE>
'''5.13.4'''
<PRE>
### Bug Fixes (general)
* force system gem install if RubyGems fails (#1126)
* gui_login prevent destroying window if already destroyed (#1127)
* add window size / position saves to login GUI (#1128)
* non tabbed saved entries in reduced button / font size (not… (#1129)
</PRE>
'''5.13.3'''
<PRE>
### Bug Fixes (general)
* account manager sorting GUI fix (#1123)
</PRE>
'''5.13.2'''
<PRE>
### Bug Fixes (general)
* install_gem_requirements update available gems after install (#1120)
</PRE>
'''5.13.1'''
<PRE>
### Bug Fixes (general)
* password_cipher.rb upcase account_name for key (#1118)

### Bug Fixes (dr)
* validator.rb change sleep to should_sleep named param (#1116)

### Bug Fixes (gs)
* add base stats capture from 'info full' command (#1115)
</PRE>
'''5.13.0'''
<PRE>
### Features (general)
* Refocus Frontend (#960)
* socket configurator to better guard TCPSocket (#976)
* add simplified DB maintenance (#991)
* TextStripper module support for XML, HTML, Markdown (#1055)
* Login modernization and refactor to yaml (#1063)
* Ruby Memory Releaser module (#1066)

### Features (dr)
* support meta:trashcan tag for DRCI.dispose_trash (#966)
* Add GameObj.inv support for DR items (#1080)
* DRCS allow custom adjective for summoned weapons (#1088)
* DRParser support for new exp window xml stream elements (rested exp, tdps, favors) (#1104)

### Features (gs)
* Add Armaments (Weapon, Armor, and Shield) Module (#911)
* add creature module, including Hinterwilds creatures (#1002)
* Creature module combat tracking (#1003)
* track time of last total_experience record (#1030)
* add Injured class for checking ability to perform actions (#1035)

### Bug Fixes (general)
* map dijkstra optimization (#1061)
* update.rb keep script/data file incase of error on update (#1070)
* ensure proxy path is set for non-destructive array write-th… (#1073)
* [lib][global-defs] - move update (#1079)
* GameObj force new objects ID to be string (#1087)
* xmlparser.rb gate GSL exits sending behind @send_fake_tags (#1103)
* change Hash[] pair key conversion to use to_h for Ruby 4.0 (#1108)
* move gui-login.rb to Ruby standard gui_login.rb (#1111)
* update location for currency and move game-loader.rb to Ruby standard gameloader.rb (#1112)

### Bug Fixes (dr)
* DRCA allow custom spell prep messaging (#1089)
* Update Slackbot error handling, and lnet management (#1091)
* Fix exp mods parsing for DR (#1102)
* equipmanager.rb support for custom messaging in forester's longbow (#1105)
* Fix hang in equipment manager when game doesn't respond to commands (#1110)

### Bug Fixes (gs)
* Infomon additional CHE resign regex (#1067)
* Resource tracking for sorcerer shadow essence (#1085)
* cman.rb add hamstring regex for already lying down target (#1090)
* cman.rb hamstring regex update when can't perform on target (#1092)
* Bounty parser.rb FWI guard regex update (#1096)
* currency.rb track gold (#1109)
</PRE>
'''5.12.12'''
<PRE>
Bug Fixes (general)
Update module strip markdown comments (#1056)
Vars/UserVars module fixes and corrections (#1057)
Bug Fixes (gs)
Infomon parse fix for singular currency (#1051)
</PRE>
'''5.12.11'''
<PRE>
Bug Fixes (dr)
add bput match for system updates preventing actions (#1034)
drdefs.rb npc parsing (#1038)
Fix container reference in get_item_from_eddy_portal method (#1039)
Bug Fixes (gs)
bounty location regex needs to match "under" (#1037)
</PRE>
'''5.12.10'''
<PRE>
Bug Fixes
all: games.rb catch additional error for nested single/double quotes (#1031)
dr: change keys for DR_SKILLS_DATA[:guild_skill_aliases] to be strings instead of symbols (#1032)
gs: Bounty parser for SG npcs matching (#1027)
gs: match READY/STOW items with a/an/some inside the link (#1026)
</PRE>
'''5.12.9'''
<PRE>
Bug Fixes
gs: StowList/ReadyList reset bug if non-default keys added #1019
</PRE>
'''5.12.8'''
<PRE>
Bug Fixes
all: script.rb show custom at script exit as well (#993)
all: Updated update.rb for single trunk and release please (#1001)
</PRE>
'''5.12.7'''
<PRE>
fix(all): ensure updates do not target detached proxy views #990
fix(gs): bounty parser and move fixes for sailor's grief #987
fix(gs): Infomon xmlparser.rb Ready/Stow fix for LONG before exist #988
fix(gs): gameobj.rb for Sailor's Grief ghostly/boss/guild tentacles #989
</PRE>
'''5.12.6'''
<PRE>
fix(all): settings.rb update to preserve root of derived views #975
fix(all): show custom in various script output when custom script #967
fix(dr): drparser.rb update for PlayedSubscription #983
fix(gs): include store location for ReadyList #977
fix(gs): infomon parser.rb update for ACCOUNT output varies #979
fix(gs): global_defs.rb move def update for Hive traps #980
fix(gs): activespell.rb prevent removal of RF Penalty #981
fix(gs): add .compact to input of Disk.find_by_name #982
</PRE>
'''5.12.5'''
<PRE>
fix(all): update.rb word boundary for abbreviations #971
fix(dr): equipmanager.rb Fix for changed game output. #969
fix(dr): common-arcana.rb Regalia fix for changed game output. #970
fix(dr): common-items.rb Fix for changed inventory command output #973
fix(gs): StowList missing space in capture in xmlparser.rb #963
fix(gs): stowlist.rb wait for RT when issuing check #964
fix(gs): readylist.rb wait for RT when issuing check #965
fix(gs): Bounty heirloom return msg'ing update #972
</PRE>
'''5.12.4'''
<PRE>
build(all): installer.yml use windows-2022 #950
fix(all): restore Wrayth / Wizard script execution ability #952
fix(all): database_adapter.rb error handling improvement #956
fix(dr): common-items.rb wear/remove messaging additions #949
fix(dr): games.rb - ignore UIDs for Frostbite mapping #951
fix(dr): map_dr.rb prevent inadvertent settings changes #958
fix(gs): GameObj targets for new Sailor's Grief tentacle npc #948
fix(gs): map_gs.rb remove delete_if to prevent bad settings #957
fix(gs): weapon.rb assault break if no targets #962
</PRE>
'''5.12.3'''
<PRE>
fix(all): limitedarray.rb max_size increase #946
fix(all): uservars.rb update for vars method missing #940
fix(dr): drparser.rb to set ShowRoomID to on if turned off #945
fix(gs): change namespace accessors to Ruby 2.6 compatible #944
fix(gs): infomon state reset on status prompt #943
fix(gs): Societies to check membership for various methods #942
fix(gs): standardize warcry.rb to match other PSMS #941
</PRE>
'''5.12.2'''
<PRE>
fix(gs): infomon parser.rb for profile full name matching #938
fix(gs): force PROFILE FULL to sync CHE info for infomon #937
fix(dr): Tighten checks on releasing invisibility for thieves #936
</PRE>
'''5.12.1'''
<PRE>
- fix(all): gameobj.rb - add type? method for explicit type check #928
- fix(all): messaging.rb encoding issue #933
- fix(gs): Various CMan cost corrections #932
</PRE>
'''5.12.0'''
<PRE>
- feat(all): settings.rb - proposal for sequel based Settings #591, #875, #889, #896, #927
- feat(all): util.rb add Ruby gem install helper method #861
- feat(all): messaging.rb add cmd link method #866
- refactor(all): games.rb modernization #849, #882, #924
- fix(all): add class extensions #800
- fix(all): lich.rb deprecated FE message #852
- fix(all): messaging.rb fix XML encoding for wizard and avalon #853
- fix(all): lich.rb class variable not initialized #855
- fix(all): log.rb force msg to String for regexp comparison #856
- fix(all): global_defs.rb bug in fput #864
- fix(all): messaging.rb xml_encode mono method msg #868
- fix(all): script.rb class to is_a? checks #878
- fix(all): gameobj.rb deeper lookup #885
- fix(all): messaging.rb debug not compared to falseclass #887
- fix(all): change class to is_a? checks #91-3
- fix(all): Util.issue_command allow single line captures #918
- fix(dr): drparser.rb casing for Premium status check #842
- fix(dr): map_dr.rb Don't assign UID of zero to rooms #844
- fix(dr): drparser.rb add $last_logoff tracking #851
- fix(dr): update message patterns in common-items #859
- fix(dr): add moon_visible?(moon) convenience method to common-moonmage #860
- fix(dr): exp mods output is not enclosed in preset xml tags anymore #870
- fix(dr): update.rb beta send validation for genie lich char #880
- fix(dr): Update regex and parsing for active spells #894
- fix(dr): add 'You scoop' match pattern to common-items #900
- fix(dr): add missing match patterns #901
- fix(dr): common-items: add and fix match strings #904
- fix(dr): Add missing matches for common-items #905
- fix(dr): Release Khri Vanish if Thief, when going visible #906
- fix(dr): Fix race condition when clearing and repopulating XMLData.dr_active_spells #907
- fix(dr): Fix SLS release pattern #908
- fix(dr): resolve race condition in DR crafting_magic_routine #914
- fix(dr): xmlparser.rb - Fix XMLData.dr_active_spells race condition #915
- fix(dr): xmlparser.rb - Clear out spells properly #916
- fix(dr): drparser.rb update for Platinum account status #922
- feat(gs): gameobj.rb allow for custom gameobj data #848
- feat(gs): PSMS updates, including CMan.use #865, #874, #881, #890, #899
- feat(gs): ReadyList & StowList classes for item tracking #884
- feat(gs): Breakout and Buildout Societes #919
- fix(gs): infomon parsing for CHE membership #841
- fix(gs): map_gs.rb for no UID when hexdigest used #843
- fix(gs): warcry.rb yowlp :buff to string instead of regexp #847
- fix(gs): group.rb multiple corrections #850, #869, #883
- fix(gs): Bounty parser.rb fix for HW & KF guard return #862
- fix(gs): Bounty task.rb fix for assigned? and Ruby 2.6 #863
- fix(gs): stash.rb stale sheaths recheck #867
- fix(gs): allow spell.rb casting to take a force_stance parameter #902
- fix(gs): update Infomon parsing for new ACCOUNT output format #903
- fix(gs): PSMS cost for multiple cost types & add Excoriate feat #912
- fix(gs): Feat excoriate regex correction #920
- fix(gs): weapon PSM affordable check against Glorious Momentum #926
</PRE>
'''5.11.1'''
<PRE>
- fix(all): restore @theme_state and add to CLI capability #795
- fix(all): retire gtk2 monkey patch for gtk3 #823
- fix(all): games.rb XMLData.name wait till both not NIL and not EMPTY #826
- fix(all): standardize xmlparser game instance #827
- fix(all): games.rb fix multiple single and double quote in XML #832,836,837
- fix(dr): games.rb - optional hide Room Title display of Real IDs with FLAG on #782
- chore(dr): common-moonmage - refactor of peer_telescope #783
- fix(dr): move HMR load to common before for dragonrealms #784
- fix(dr): common-crafting.rb minor edit to add "You tuck" #787
- fix(dr): common-arcana.rb - remove unecessary pause from discern code #792
- fix(dr): drparser.rb Restore Premium status checking #834
- fix(gs): migrate PSMS.name_normal to Lich::Util.normalize_name #790,833
- fix(gs): add Char.che to know current character's CHE #791
- fix(gs): FEAT and Infomon module parsing of new Covert Art feats. #796
- fix(gs): add Currency.gemstone_dust and fix redsteel mark capture #797
- fix(gs): FEAT Covert Arts colon normalization and stamina costs #799
- fix(gs): escape dash in regex for HouseCHE #824
- fix(gs): disk.rb comparison helpers #828
- fix(gs): allow for Group.disks to show self disk in array #829
- fix(gs): feat.rb Covert Arts throw poison costs 15 stam #830
- fix(gs): add missing Feat.use ability #831
- fix(gs): multiple CritRanks updates #801-822
</PRE>
'''5.11.0'''
<PRE>
- [all] - chore: Namespace & File Path Updates #713
- [all] - [argv_options.rb] bugfix: correct darkmode to work via CLI #693
- [all] - [games.rb] feat: make show Room Exits of non-StringProc/Obvious Exits toggable for all games #699
- [all] - [games.rb] feat: toggleable display of StringProcs with clickable links #751
- [all] - [gui-manual-login.rb] fix: change label to Wrayth #720
- [all] - [gui-saved-login.rb] fix: update Stormfront label #721
- [all] - [update.rb] fix: purge old LIB folder prior to update release #729
- [all] - [util.rb] bugfix: allow issue_command to use fput or put #715
- [all] - [xmlparser.rb] feat: add XMLData.room_name attribute #685
- [all] - [main.rb] fix: create session file in regular connect method #733
- [all] - [init.rb] bugfix: error for Windows DISPLAY variable #735
- [all] - [main.rb] fix: Mudlet support #736
- [all] - [wine.rb] fix: add --no-wine CLI flag prevent WINE startup
- [all] - [init.rb] fix: add --no-gtk CLI flag prevent GTK3 gem load
- [dr] - [games.rb] feat: DRinfomon and common files as core lich libraries #686
- [dr] - [games.rb] chore: add DR requires here #690
- [dr] - [games.rb] fix: add Room# display for DR #697
- [dr] - [games.rb] bugfix: Genie FE real ID#s not supported, hide by default #728
- [dr] - [drdefs.rb] bugfix: fix for Shadow Servants #710
- [dr] - [map_dr.rb] fix: cleanup and support for UIDs #719
- [dr] - [xmldata.rb] bugfix: add support for DR Room IDs #716
- [dr] - [xmlparser.rb] feat: XMLData - adding dr_active_spells #691
- [gs] - [games.rb] bugfix: support for pre/post room name txt #683
- [gs] - [group.rb] chore: update to account for hold #701
- [gs] - [resource.rb] feat: add additional tracking of covert art charges #714
- [gs] - [spell.rb] bugfix: Spell.affordable? 515 release #687
- [gs] - [stash.rb] bugfix: sheath_bags when not found #694
- [gs] - [xmlparser.rb] bugfix: missing real ID in nav #684
- [gs] - [xmlparser.rb] bugfix: Claim module obvious hiding #717
- [gs] - [sk.rb] feat: Self-Knowledge functionality in core #748
</PRE>
'''5.10.4'''
<PRE>
-o- [GS4] - [xmlparser.rb] bugfix: Simu XML breaking change RoomID #679
</PRE>
'''5.10.3'''
<PRE>
-o- [GS4] - [crit_tables] fix: CritRanks regex fixes (multiple files and changes) #671
-o- [GS4] - [spellsong.rb] fix: Correct Spellsong sync method #674
-o- [GS4] - [parser.rb] fix: thorn status regex correction #673
-o- [All] - [xmlparser.rb] fix: Split out if elif block to account for DR having multiple… #670
-o- [All] - [global_defs.rb] fix: percentconcentration #676
-o- [All] - [global_defs.rb] fix: update move failure message to handle attack and casting #667
-o- [All] - [init.rb] fix: update required ruby check messaging #669
-o- [All] - [sessionvars.rb] feat: new module SessionVars for non-persistent variable storage #666
</PRE>
'''5.10.2'''
<PRE>
-o- [DR] - [games.rb] bugfix: tweak XML rewrite section #662
-o- [GS4] - [crit_tables] bugfix: additional crit table regex corrections #663
-o- [GS4] - [ascension.rb] bugfix: add new Transcend Destiny to lookups #661
-o- [GS4] - [effects.rb] bugfix: regexp escape txt #660
-o- [GS4] - [disruption_critical_table.rb] Bugfix in regex #659
</PRE>
'''5.10.1'''
<PRE>
-o- [All] - [games.rb] bugfix: prevent race condition in games thread #656
-o- [All] - [init.rb] bugfix: address WINE variance between linux / installs #655
-o- [GS4] - [gs][stash.rb] bugfix: wear code improvement #657
</PRE>
'''5.10.0'''
<PRE>
-o- [All] - [main.rb] bugfix: correct encoding for WizardFE PR #640
-o- [All] - [games.rb] bugfix: correct logic for room detection when using CLI --start-scripts PR #639
-o- [All] - [DB_Store.rb] feat: add direct support for Simu RENAME and CHANGE PROF PR #633
-o- [All] - chore: breakout code to individual files for easier management PR #617
-o- [All] - [lich.rbw] chore: add deprecated msg to old Settings/GameSettings/CharSettings methods PR #589
-o- [All] - [lich.rbw] feat: add new --dark-mode CLI option PR #583
-o- [All] - [global_defs.rb] bugfix: monsterbold fix for additional clients PR #581
-o- [All] - [update.rb] feat: update core scripts from source on Lich5 update/install PR #579
-o- [All] - [log.rb] feat: add new Log module copied from Olib PR #577
-o- [All] - [numeric.rb] feat: add days/hours/minutes/seconds methods to numerics PR #623
-o- [All] - [messaging.rb] feat: WizardFE Voln window support #647
-o- [All] - [init.rb] bugfix: WINE entries for Linux / MacOS #649
-o- [DR] - [lich.rbw] bugfix: cleanup downstream hook exclusions PR #593
-o- [DR] - [global_defs.rb] bugfix: missing climb failure message PR #592
-o- [GS4] - [effects.rb] bugfix: show non-standard Effects in `;magic` output PR #641
-o- [GS4] - [parser.rb] bugfix: fix WARCRY duplication results / add WALL OF THORNS effect detection PR #634 / PR #637
-o- [GS4] - [critranks.rb] feat: add critical rank resolution tables and methods PR #625
-o- [GS4] - [effects.rb] bugfix: to support regex for active? & time_left PR #590
-o- [GS4] - [infomon.rb] bugfix: add implicit NPC death monitoring PR #588
-o- [GS4] - [infomon.rb] bugfix: change PSM to be stored as type.mnemonic PR #587
-o- [GS4] - [lich.rbw] bugfix: strip_xml multiline fix PR #584
-o- [GS4] - [stash.rb] bugfix: fix sack detection to use Stash.container(param) PR #578
-o- [GS4] - [spell.rb] feat: Spell.after_stance #644
-o- [GS4] - [xmlparser.rb] bugfix: for Claim module #646
-o- [GS4] - [infomon] feat: track Voln favor via RESOURCE output #648
-o- [GS4] - [gameobj.rb] feat: add Bandit hidden target API #650
</PRE>
'''5.9.2'''
<PRE>
-o- [GS4] - [group.rb] bugfix: proper leader detection from GROUP output
-o- [GS4] - [char.rb] bugfix: add back depracted Char.maxvitals with msging to switch to new Char.max_vitals methods
</PRE>
'''5.9.1'''
<PRE>
-o- [GS4] - [group.rb] bugfix: group.check syntax change
-o- [GS4] - [spell.rb] bugfix: affordable? Char.mana parenthesis logic
</PRE>
'''5.9.0'''
<PRE>
-o- [All] - feat: sqlite3 gem syntax code cleanup PR#553
-o- [All] - [lich.rbw] bugfix: remove unused Setting, GameSetting, CharSetting PR#542
-o- [All] - [lich.rbw] bugfix: scrub login key from error message popups PR#548
-o- [All] - [messaging.rb] bugfix: color mismatch WizardFE white txt PR#554
-o- [All] - [lich.rb] feat: add new Lich.deprecated method to aid in deprecating older API calls PR#523
-o- [GS4] - [char.rb] feat: log method_missing calls PR#552
-o- [GS4] - [char.rb] feat: add missing global_def related methods PR#523
-o- [GS4] - [global_defs.rb] feat: deprecate various Char module methods PR#523
-o- [GS4] - [spellsong.rb] bugfix: cache spellsong duration calc PR#551
-o- [GS4] - [effects.rb] feat: Effects module breakout PR#549
-o- [GS4] - [group.rb][disk.rb] feat: Group & Disk class PR#532
-o- [GS4] - [activespell.rb] feat: add duration change messaging, off by default, see ;help for details PR#487
</PRE>
'''5.8.1'''
<PRE>
-o- [All] - [lich.rbw] feat: add Game:Character to debug log file ouput
-o- [All] - [init.rb] feat: add milliseconds to debug filename
-o- [GS4] - [lich.rbw] bugfix: reorder parsing of $SERVERSTRING to avoid certain conflicts
-o- [GS4] - [parser.rb] bugfix: update for new Empath resource and sleep/bind messaging
-o- [GS4] - [status.rb] bugfix: bound? calmed? and sleeping? support for spellnames flag being off
-o- [GS4] - [xmlparser.rb] bugfix: additional creature dying messaging to check against XML dead not being sent
-o- [GS4] - [gameobj.rb] bugfix: remove sorcerer arms and animates from GameObj.targets
</PRE>
'''5.8.0'''
<PRE>
-o- [All] - Ruby 3.3 compatibility
-o- [All] - [lich.rbw] feat: adds .sources for up/downstream hooks
-o- [All] - [lich.rbw] bugfix: don't use WINE for custom frontends
-o- [GS4] - [char.rb] bugfix: add back Char.stance
-o- [GS4] - [claim.rb] feat: new module and associated changes to xmlparser
-o- [GS4] - [experience.rb] feat: percent experience options
-o- [GS4] - [parser.rb] bugfix: allow for negative TNL exp value
-o- [GS4] - [parser.rb] bugfix: allow hyphenated last names in character names
-o- [GS4] - [parser.rb] feat: update resource matching for new Bard service
-o- [GS4] - [stash.rb] bugfix: catch more shield removal messages
-o- [GS4] - [util.rb] bugfix: underscore issue for PSMs
</PRE>
'''5.7.0'''
<PRE>
-o- Supports Ruby 3.2 - security enhancements and huge speed improvements for regex
-o- New libraries/modules/classes: Account, HMR (Hot Module Reloading)
-o- GS4 Infomon now baked into Lich5 as a library, no more need to run standalone script
-o- New GS4 libraries/modules/classes: Ascension, Bounty, Currency, Experience, Resources, Society, Status, Warcry
-o- Updates to existing libraries/modules/classes: Armor, Util, Weapon, Spell, GameObj, Messaging
-o- Several Bugfixes for lots of things
-o- Lots of code cleanup
</PRE>
'''5.6.2'''
<PRE>
-o- Fix for XML errors
-o- Adds the DR Plat instance for Frostbite FE
-o- Adds ‘ball’ as the noun used for ‘ball and chain’
-o- Adds the movement result ‘slip in the mud and fall flat’
-o- Corrects stamina cost for the feature Dispel Magic
-o- Plus all the latest script updates from Elanthia-Online!
</PRE>
'''5.6.1'''
<PRE>
-o- Fix for XML to limit login errors (DR)
-o- Fix for XMLData.active_spells to properly register wizard 'recovery' spell cooldowns
-o- Messaging updates to remove error in Wizard FE encodings
-o- Corrects for error in detecting PSM skill changes (cman) via warrior / rogue guild lessons
-o- Deprecates LNet script from master repository
-o- Miscellaneous small bug squashing
</PRE>

'''5.6.0'''
<PRE>
-o- (DragonRealms) Support for Genie and Frostbite frontends
-o- (GemStone) Changed methods to improve ;go2 speed and reduce lich.db3 calls
-o- (GemStone) Updates to support silver_count function
-o- (Both) Changed method for updating lich ecosystem
</PRE>

'''5.5.0'''
<PRE>
-o- Support for DragonRealms
-o- Updated support for scripts like BigShot
-o- Providing the LichID and UID on Profanity
-o- Spell.force_incant, .force_channel, and .force_evoke
-o- Standardized message method for script authors
-o- Sundry small improvements / fixes and changes
-o- And the creme de la creme - a custom directory
</PRE>

'''5.4.0'''
<PRE>
-o- Simu Room IDs (formally called 'unique ID' or 'uid' for Lich) added to Map, mapDB where known, and ;go2 for navigation (courtesy Xanlin and with our thanks!) ;go2 u7120 for all you ex-GMs out there.
-o- Room titles will now display the Lich ID and / or the UID for the room based on user selections - default is on for both, and enabled / disabled via Lich.display_lichid or Lich.display_uid toggles that can be set to on / off or true / false. (;e Lich.display_lichid=true/false and ;e Lich.display_uid=true/false) You can remove that rnum from your autostart now! To gain the benefit of the UID deployment, be sure to ;repo download-mapdb
-o- REQUESTS: Drop 5 minute timeout function from Lich
-o- waitrt? and waitcastrt? will still pause activities, but will return TRUE or FALSE in keeping with the Ruby functionname? tradition (no more failing to get a weapon out due to RT from climbing!)
-o- empty_hands and fill_hands will now check to see if the character is in roundtime before trying to put away or retrieve held items
-o- Infomon received an update that keeps spell timers in sync with the information received from the server - no more need to immediately do a spell active in game to get the right times to display for various legacy scripts and ;magic after visiting the invoker or using an SK item
-o- Lich now provides a facility to get current coins on the character that is a bit more agnostic to data changes from Simu - Lich::Util.silver_count
-o- Various other small tidbits to help ease maintenance and future development
-o- PLEASE NOTE: This update is required for the newest Bigshot (released today!) and for future eloot and eherbs scripts (release RSN)
</PRE>

'''5.3.0'''
<PRE>
-o- Added support for Wrayth (renamed Stormfront) installations
-o- Converted Linux | WINE login methods to 'method 0', does not use Simu launcher
</PRE>

'''5.2.1'''
<PRE>
-o- Support for STOWing items irrespective of special item scripts
-o- Improved query support for Effects and CMans
-o- Fix Lich bug to respect the 'groupmovement' flag in game
-o- Fix Lich round time calculations (more aggressive timing)
-o- Dark Mode is now a thing
-o- Lich4 Style GUI layout available
-o- Several file location changes to support future code change efforts
</PRE>

'''5.0.19'''
<PRE>
-o- Benefit: Monks with Mental Acuity (all 3 of you) rejoice - stamina casting!
-o- Benefit: PSM3 included, no charge. No hair remaining, either!
-o- Benefit: Ok, stay seated: Some of your various SF spell duration windows may work. . . better? Yes, not perfect, but better. No pictures, please!
-o- Updated infomon that properly detects Cloak of Shadows on those pesky sorcerers, and the Raise Dead Cooldown periods for those wondrous clerics.
-o- A new update process for Lich 5 - tired of having to download that script over and over just to update? Get yourself a copy of lich5-update.lic. Note, if you already have it, you're set! If not - ;jinx script install lich5-update --repo=elanthia-online
</PRE>

'''5.0.11'''
<PRE>
-o- Updated the method used to log onto SIMU servers.
-o- Added the Animalist item specifics to Lich5's empty and fill hands routines
-o- Improved Invoker messages for Avalon and Wizard FEs (no change for SF FE)
-o- Improved cleanup and store methods when player EXIT's or QUIT's game
-o- Crafted two new methods (stash_hands and equip_hands) for future script use
-o- Some behind-the-scenes cleanup to improve maintaining the Lich5 ecosystem
-o- Add Spell Active improvements
-o- Add PSM and Ranger improvements
</PRE>
</div>

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

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

Lich:Software/Mac Installation

2026-10-28T12:43:31Z

WHIGHTCNIGHT: update instructions to use Ruby 4.0.9

{{3rd-party}}
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.

# Install the [https://www.play.net/gs4/play/avalon-info.asp Avalon Front End] from the play.net site.
# 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>

Your system should respond with <code>Ready to brew</code>. 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 <code>Gemfile</code>) 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.

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

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

Before we begin, let's check to be sure rbenv is working properly. Enter this command in Terminal and press ENTER.

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

# <code>rbenv install 4.0.9</code>
# <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:
<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:
<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

If your version reflects 4.0.9, proceed 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 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.

# <code>cd ~/Desktop/Lich5</code>
# <code>bundle config set --local without 'development vscode'</code>
# <code>bundle install</code>

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.

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.

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

Don't care for Avalon as a front end? There's a new offering in town. Give this a look!

https://warlockfe.github.io/

Configuration for Mac (and other OS types) here:

https://github.com/sproctor/warlock3/wiki/Lich-support

==Resources==
* [[Lich scripting reference]]
* Playershops by Lich: https://ps.lichproject.org/
* Unofficial Support for Lich: http://forum.gsplayers.com/forumdisplay.php?f=104
* Popular Lich script thread: http://forum.gsplayers.com/showthread.php?81229-What-Lich-Scripts-Do-You-Regularly-Use

{{Third-Party Software}}

Category:Evermore Hollow

2026-10-22T14:28:45Z

WHIGHTCNIGHT: /* Shopping */ un-comment the 2026 list

[[Image:Ebon_Gate_The_Dark_Carnival.png|right|600px|Ebon Gate 2026 - The Dark Carnival|alt=Digital art featuring a worn carnival bathed half in shadows and moonlight, and half in sunlight. A carousel and ferris wheel are heavily featured here, amid wagons and tents, while a marionette stands to one side. Text in the upper left reads: "Ebon Gate: The Dark Carnival."]]
{{TOCright}}
'''Naidem''', the land between where those that have died but are not ready to move on, or the respective deities are not ready to claim them, reside, and is home to the village of '''Evermore Hollow'''. As of 2022, it is the new '''permanent home''' for the [[Ebon Gate Festival]].
{{CollapseAll|collapsetoggle = mw-customtoggle-2025games mw-customtoggle-2024games mw-customtoggle-2023games mw-customtoggle-2022games mw-customtoggle-flares mw-customtoggle-titles mw-customtoggle-previousruns}}
==Run Dates & Schedule==
{| class="wikitable" style="text-align: center"
! Dates
<includeonly>! Venue</includeonly>
! Storyline Schedule
! Merchants
! Live Games
! Services Schedule
! Games Schedule
! Shop Listings
! Special Offerings
! [[:Category:Harvest Luminary Festival|Luminary Festival]]
! Announcements
|-<section begin=current />
| scope="row" role="rowheader" style="white-space: nowrap" | '''Oct 9 - Nov 3, 2026''' <includeonly>|| [[Evermore Hollow]]</includeonly> || 10/12 - 10/15<br>10/26 - 10/31 || Noon on 10/16 through to Midnight on 10/20 || 10/21 - 10/22: Seynne's Games<br>10/24 - 10/25: [[Evermore Hollow/live games#Game Descriptions|Live Games]] || [[Ebon Gate Festival/services 2026|Services]] || [[Evermore Hollow/live games#2026 Schedule|Live Games & GHOUL]] || [[Evermore Hollow/shop listing 2026 part 1|Shop List, part 1]]<br>[[Evermore Hollow/shop listing 2026 part 2|Shop List, part 2]]<br>[[Evermore Hollow/shop listing 2026 part 3|Shop List, part 3]] || [[Ebon Gate Treasure Trove/2026|Treasure Trove]], [[Ebon Gate Festival/2026 auction|Auction]] || 10/31 - 11/3 || [[Ebon Gate Festival/saved posts 2026|Announcements]]<section end=current />
|}

===Previous Schedule===
<small>The below schedule was based on the prime/ platinum instance split.</small>
{| class="wikitable mw-collapsible mw-collapsed" id="mw-customcollapsible-previousruns" style="text-align: center"
|+ style="white-space:nowrap; text-align: left" | For a list of previous run dates, shop lists, special offerings, and saved posts, click <span class="mw-customtoggle-previousruns" role="link" style="color:#0000ff">here</span>.
|-
! scope="col" rowspan="2" | Dates
<includeonly>! scope="col" rowspan="2" | Venue</includeonly>
! scope="col" rowspan="2" | Storyline Schedule
! scope="colgroup" colspan="2" | Merchant Week
! scope="colgroup" colspan="2" | Live Games Week
! scope="colgroup" colspan="2" | Services Schedule

! scope="col" rowspan="2" | Games Schedule
! scope="col" rowspan="2" | Shop Listings
! scope="col" rowspan="2" | Special Offerings
! scope="col" rowspan="2" | Announcements
|-
! scope="col" | Prime
! scope="col" | Plat
! scope="col" | Prime
! scope="col" | Plat
! scope="col" | Prime
! scope="col" | Plat

|-<section begin=oldschedule />
| scope="row" role="rowheader" style="white-space: nowrap" | '''Oct 10 - Nov 2, 2025''' <includeonly>|| [[Evermore Hollow]]</includeonly> || 10/12 - 10/16 <br> 10/24 - 10/31 || 10/17 - 10/24 || || 10/24 - 10/26 || || [[Ebon Gate Festival/services 2025#Prime|Services]] || <includeonly>||colspan="2" | - </includeonly>|| [[Evermore Hollow/live games#2025|Live Games & GHOUL]] ||[[Evermore Hollow/shop listing 2025 part 1|Shop List, part 1]]<br>[[Evermore Hollow/shop listing 2025 part 2|Shop List, part 2]]<br>[[Evermore Hollow/shop listing 2025 part 3|Shop List, part 3]] || [[Ebon Gate Treasure Trove/2025|Treasure Trove]], [[Ebon Gate Festival/2025 auction|Auction]] || [[Ebon Gate Festival/saved posts 2025|Announcements]]
|-
| scope="row" role="rowheader" style="white-space: nowrap" | '''Oct 4 - Nov 3, 2024'''<includeonly>|| [[Evermore Hollow]] </includeonly>|| 10/4 - 10/11 & 10/25 - 10/29 || 10/18 - 10/25 || 10/11- 10/18 || 10/11 - 10/18 || 10/4 - 10/11 || [[Ebon Gate Festival/services 2024#Prime|Prime Services]] || [[Ebon Gate Festival/services 2024#Plat|Plat Services]]<includeonly>||colspan="2" | - </includeonly>|| [[Evermore Hollow/live games#2024|Live Games & GHOUL]] ||[[Evermore Hollow/shop listing 2024 part 1|Shop List, part 1]]<br>[[Evermore Hollow/shop listing 2024 part 2|Shop List, part 2]] || [[Ebon Gate Treasure Trove/2024|Treasure Trove]] || [[Ebon Gate Festival/saved posts 2024|Announcements]]
|-
| scope="row" role="rowheader" style="white-space: nowrap" | '''Sept 29 - Oct 31, 2023'''<includeonly>|| [[Evermore Hollow]] </includeonly>|| 9/29 - 10/6 & 10/22 - 10/27<br> || 10/13 - 10/20 || 10/6 - 10/13 || 10/6 - 10/13 || 9/29 - 10/6 || [[Ebon Gate Festival/services 2023#Prime|Prime Services]] || [[Ebon Gate Festival/services 2023#Plat|Plat Services]]<includeonly>||colspan="2" | - </includeonly>|| [[Evermore Hollow/live games#2023|Live Games & GHOUL]] || [[Evermore Hollow/shop listing 2023|Shop Listing]] || [[Ebon Gate Treasure Trove/2023|Treasure Trove]] || [[Ebon Gate Festival/saved posts 2023|Announcements]]
|-
| scope="row" role="rowheader" style="white-space: nowrap" | '''Sept 30 - Oct 30, 2022'''<includeonly>|| [[Evermore Hollow]] </includeonly>|| || 10/14 - 10/21 || 10/7 - 10/14 || 10/7 - 10/14 || 9/30 - 10/7 || [[Ebon Gate Festival/services 2022#Prime|Prime Services]] || [[Ebon Gate Festival/services 2022#Plat|Plat Services]]<includeonly>|| 10/29 || 10/30 </includeonly>|| [[Evermore Hollow/live games#2022|Live Games & GHOUL]] || [[Evermore Hollow/shop listing 2022|Shop Listing]] || [[Ebon Gate Treasure Trove/2022|Treasure Trove]] || [[Ebon Gate Festival/announcements 2022|Announcements]]<section end=oldschedule />
|}

==Activities==
<section begin=activities /><includeonly>* '''[[Evermore Hollow]]'''</includeonly>
<noinclude>*</noinclude><includeonly>**</includeonly>'''Automated Games''' - entries purchased with [[SimuCoin]]s. Each offers the ability to earn [[soul shard]]s.
<noinclude>**</noinclude><includeonly>***</includeonly>'''[[Trick-or-Treat]]''' - '''Returning in 2022''' to Evermore Hollow, Trick-or-Treat allows participants to obtain a variety of prizes. Cost for entry is 100 SimuCoins.
<noinclude>**</noinclude><includeonly>***</includeonly>'''[[Herb Hunt]]''' - '''New in 2022''', the Herb Hunt allows participants the chance to wander the Gardens of Bittermere woods in search of a toadshade, similar to the [[Fox Hunt]] at [[Rumor Woods]]. Lucky winners may even find a new [[Mandrake pet]] to take home. Cost for entry is 100 SimuCoins.
<noinclude>**</noinclude><includeonly>***</includeonly>'''[[Arena of the Abyss]]''' - '''Returning in 2022''' to Evermore Hollow. Entrants face five undead creatures, one a time, and when complete, prizes are awarded, including a chance at [[necrotic ring]]. Cost for entry is 10 SimuCoins.
<noinclude>**</noinclude><includeonly>***</includeonly>'''[[Undergrowth of Bittermere Woods]]''' - '''Premiering 2024''' to Evermore Hollow. Entrants can complete 1 witch task, and when complete, prizes are awarded, including a chance at [[Lightweaver's Ocarina]]. Cost for entry is 10 SimuCoins.
<noinclude>**</noinclude><includeonly>***</includeonly>'''[[Sonreeva]]''' - '''New in 2022''' to Evermore Hollow, alternatively known as '''Newcropolis'''. More information coming soon. Cost for entry is 10 SimuCoins.
<noinclude>*</noinclude><includeonly>**</includeonly>'''[[Evermore Hollow/live games|Live Games]]''' - accessible with a merchant pass. To view the schedule, click '''[[:Category:Evermore Hollow#Live Games and GHOUL Schedules|here]]'''. '''Note:''' All times listed in EDT.
<noinclude>*</noinclude><includeonly>**</includeonly>'''[[Spook Contest]]''' - '''New in 2022''', join the contest by visiting the Spectral Waifling at the Spookorium to get started. Top five winners at the end of Ebon Gate will receive special titles.
<noinclude>*</noinclude><includeonly>**</includeonly>'''[[Fishing]]''' - '''Returning in 2022''' to Evermore Hollow. As in previous years, participants can throw a line into the water and win various '''[[Evermore Hollow/fishing prizes|prizes]]''', including new '''Death Announcement Customizations'''. Cost will be 50 soul shards per entry.<section end=activities />

===Live Games and [[GHOUL]] Schedules===
* '''[[Evermore Hollow/live games|2026 Live Games]]'''
{{#section:Evermore Hollow/live games 2026|schedule}}
* <span class="mw-customtoggle-2025games" role="link" style="color:#0000ff">'''2025 Live Games'''</span>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-2025games">{{#section:Evermore Hollow/live games|2025}}</div>
* <span class="mw-customtoggle-2024games" role="link" style="color:#0000ff">'''2024 Live Games'''</span>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-2024games">{{#section:Evermore Hollow/live games|2024}}</div>
* <span class="mw-customtoggle-2023games" role="link" style="color:#0000ff">'''2023 Live Games'''</span>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-2023games">{{#section:Evermore Hollow/live games|2023}}</div>
* <span class="mw-customtoggle-2022games" role="link" style="color:#0000ff">'''2022 Live Games'''</span>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-2022games">{{#section:Evermore Hollow/live games|2022}}</div>

==Features==
===[[Currency]]===
<section begin=currency /><includeonly>
* '''Evermore Hollow'''
:</includeonly>The featured currency for <includeonly>'''[[</includeonly>Evermore Hollow<includeonly>]]'''</includeonly> is [[soul shard]]s which are used to purchase goods and services from the various shops. They can be earned through participation in the various available activities.<section end=currency />

===Shopping===
Shopping is available on the grounds, with new items introduced for sale each year.<section begin=shoppinglists />
* <includeonly>'''Evermore Hollow''' shopping</includeonly><noinclude>Shopping</noinclude> lists by year:
** <big>'''[[Evermore Hollow/shop listing 2026 part 1|2026 shop listing - part 1]] & [[Evermore Hollow/shop listing 2026 part 2|part 2]] & [[Evermore Hollow/shop listing 2026 part 3|part 3]] - Current List'''</big>
** [[Evermore Hollow/shop listing 2025 part 1|2025 shop listing - part 1]] & [[Evermore Hollow/shop listing 2025 part 2|part 2]] & [[Evermore Hollow/shop listing 2025 part 3|part 3]]
** [[Evermore Hollow/shop listing 2024 part 1|2024 shop listing - part 1]] & [[Evermore Hollow/shop listing 2024 part 2|part 2]]
** [[Evermore Hollow/shop listing 2023|2023 shop listing]]
** [[Evermore Hollow/shop listing 2022|2022 shop listing]]<section end=shoppinglists />

===[[Ebon Gate Treasure Trove|Treasure Trove]]===
Introduced in 2019 to the [[:Category:Ebon Gate Festival|Ebon Gate festival]], Evermore Hollow will feature its own [[Ebon Gate Treasure Trove|Treasure Trove]] raffle area similar to the one found at [[:Category:Duskruin|Duskruin]].<section begin=treasuretrove />
* <includeonly>'''Evermore Hollow''' </includeonly>Treasure Trove lists by year:
** <big>'''[[Ebon Gate Treasure Trove/2026|2026 raffle list]] - Current List'''</big>
** [[Ebon Gate Treasure Trove/2025|2025 raffle list]]
** [[Ebon Gate Treasure Trove/2024|2024 raffle list]]
** [[Ebon Gate Treasure Trove/2023|2023 raffle list]]
** [[Ebon Gate Treasure Trove/2022|2022 raffle list]]<section end=treasuretrove />

===[[:Category:Ebon Gate Festival auctions|Auctions]]===
Evermore Hollow occasionally hosts grand auction events.
<section begin=auctions />* 2026 Auction
* [[Ebon Gate Festival/2025 auction|2025 Auction]]<section end=auctions />
{{#section:Category:Caligos Isle|eve}} '''''- Discontinued after 2022.'''''

===Merchant Work and Raffles===
Merchant week during the festival features many merchants and raffles available to those with a merchant pass.<section begin=merchants /><includeonly>
* '''Evermore Hollow''' announced services and raffles:</includeonly>

<noinclude>*</noinclude><includeonly>**</includeonly>[[Ebon Gate Festival/services 2025|2025 announced services and raffles]]
<noinclude>*</noinclude><includeonly>**</includeonly>[[Ebon Gate Festival/services 2024|2024 announced services and raffles]]
<noinclude>*</noinclude><includeonly>**</includeonly>[[Ebon Gate Festival/services 2023|2023 announced services and raffles]]
<noinclude>*</noinclude><includeonly>**</includeonly>[[Ebon Gate Festival/services 2022|2022 announced services and raffles]]<section end=merchants />

===Automated Services===
Automated services are those that can be performed without merchant intervention and are done through [[NPC]] interactions.<section begin=automated />
* '''Incanter''' - Returning once again to charge [[Intricately painted tin carousel|carousels]], the incanter can be found wandering the grounds.
* '''[[EHShop:Quinton Manse|Quinton Manse]]''' - '''New in 2022''', Quinton Manse features NPCs capable of performing much sought after services. [[Custom flare messaging|Custom flare certificates]] will be sold here, as well.
** '''[[Fusion Shaman]]''' - Have a great enhancive on a not-so-great item? Tokens found in [[Arena of the Abyss]] grant access to his services, and from there, you can select which enhancive property to convert to a tier 2 [[fusion orb]]. He can be found in the '''Parlor'''.
** '''[[Dabbler]]''' - '''New to Evermore Hollow''', the dabbler can automatically remove properties from equipment, similar to [[Duskruin]]. He can be found in the '''Eastern Nook'''.
** '''[[Gilded locus|Half-elf Traveler]]''' - Get a locus or upgrade one you currently have. She can be found at the '''Garden Fountain'''.
** '''Study''' - [[:Category:Automated Unlocking Certificates|Unlock certificates]] of items previously sold can be purchased here.
** '''Sylinar''' - '''Returning in 2022''', Sylinar is hiding out in the '''Garden''' and will be offering the same services he had before, with some improvements:
*** '''[[Enhancive services#Permanence|Pemanence]]''': make a crumbly enhancive persist - 10,000 soul shards
*** '''[[Enhancive services#Max Charge Pool Increase|Charge Pool Increase]]''': increase the total charge pool of an enhancive by 10 charges or 10%, whichever is greater - 4,000 soul shards
*** '''[[Enhancive services#Recharging|Recharging]]''': Recharge an enhancive item by 10 charges up to the item's maximum - 4,000 soul shards
*** '''[[Enhancive services#Removal|Removal]]''': Remove a single enhancive property from an item - 10,000 soul shards
*** '''[[Enhancive services#Swapping|Swapping]]''' - Swap enhancives between the listed categories - 10,000 soul shards/''20,000 soul shards for Aura (to or from)''{{#section:Enhancive services|swap}}
** '''[[Ebon Gate auto flarer|Auto-flarer]]''' - Debuting in 2018 at [[Caligos Isle]], the auto-flarer grants flares, both scripted and not, to eligible items when presented with an appropriate token and payment. He can be found in the '''Western Nook'''. For a list of eligible [[flares]], click <span class="mw-customtoggle-flares" role="link" style="color:#0000ff">'''here'''</span>.
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-flares">{{#section:Ebon Gate auto flarer|autoflarer}}</div>
* '''[[EHShop:Antiquarian Manor|Antiquarian Manor]]''' - '''New in 2022'''. Turn your hoards of stashed away alter fodder into items easily stored in the '''[[Antiquarian's Apparatus]]''' to cut down on storage woes.
** '''[[PERM-ifier|Permifier]]''' - The permifier returns to permify [[PERM-ifier#Applicable Items|applicable items]] for soul shards in the Garden.<section end=automated />

===Unique Gems===
To see a list of unique gems exclusive to Evermore Hollow, click '''[[Evermore Hollow/list of gems|here]]'''.

==Storyline Information==
<section begin=storyline /><includeonly>* '''Evermore Hollow'''</includeonly>
<noinclude>*</noinclude><includeonly>**</includeonly>[[Denizens of Naidem|Denizens of Naidem]] (2022 introduction)
<noinclude>*</noinclude><includeonly>**</includeonly>[[:Category:The Vistix's Last Bride|The Last Bride of the Vistix]] (2023)
<noinclude>*</noinclude><includeonly>**</includeonly>[[:Category:The Ivsenra's Fate|The Ivsenra's Fate]] (2024)
<noinclude>*</noinclude><includeonly>**</includeonly>[[:Category:SPECTRE and SHADOW Conference|SPECTRE and SHADOW Conference]] (2024, 2025, 2026)
<noinclude>*</noinclude><includeonly>**</includeonly>[[:Category:Weavers of Arachne|Weavers of Arachne]] (2025)
<noinclude>*</noinclude><includeonly>**</includeonly>[[:category:Of Masks and Marionettes|Of Masks and Marionettes]] (2026)<section end="storyline" />

==Quest Information==
Opening in 2022, Evermore Hollow offers a quest to obtain the '''[[shadowy leatherbound guidebook|Guidebook to the Unliving]]'''. <section begin=quest />
* '''[[Welcome to Evermore Hollow]]''' - This quest serves as an introduction to Evermore Hollow allows anyone to obtain the Guidebook to the Unliving. The original quest was updated in 2026 to utilize the {{boldmono|[[Verb:QUEST|QUEST]]}} system.

===Guidebook===
This [[shadowy leatherbound guidebook|Guidebook]] starts you on your adventures in Naidem by giving you small tasks to complete. Each task unlocks a new chapter in your Guidebook that is designed to ease your transition into this new realm. '''''Note:''' Regardless of if you’ve completed the quest, each portal leading to a merchant’s workroom has been equipped with a Monster Bold display of what the merchant is working on, when they started, and how long they will be working.''

Completing every quest fully unlocks the Guidebook and provides the following:
* Detailed chapters of about each area in Bittermere Woods, Ember Orchard, Evermore Hollow, Gleyminn Anni River, and Graveyard Temporalis.
* Your book now becomes a guide to working merchants during Service Week.
* Your book now tells you what each merchant is working on and when they started.
* Your book now becomes a guide to all currently running raffles.
* Your book now teleports you to the shop of a working merchant (PnC only).<section end=quest />

==Additional Information==
===Key Locations===
<section begin=keyloc /><includeonly>* '''Evermore Hollow Key Locations'''</includeonly><noinclude>
====Quest-Related====
</noinclude>
<includeonly>:</includeonly>
{| class="wikitable alternating" width=30%<includeonly>
|+ style="text-align: left" | '''Quest-Related'''</includeonly>
! scope="col" | Quest Type
! scope="col" | Room Name
! scope="col" | Lich Room Number
! scope="col" | Room ID
|-
| scope="row" role="rowheader" | Newcropolis || Sonreeva, Mausoleum || 32213 || 8083347
|-
| scope="row" role="rowheader" | Spook Pin || Town Hall, Spookorium || 31813 || 8084003
|-
| scope="row" role="rowheader" | Guidebook Quest || Town Hall, Hallway || 32200 || 8084004
|-
|}
<noinclude>
====Games====
</noinclude>
<includeonly>:</includeonly>
{| class="wikitable alternating" width=30%<includeonly>
|+ style="text-align: left" | '''Games'''</includeonly>
! scope="col" | Game
! scope="col" | Room Name
! scope="col" | Lich Room Number
! scope="col" | Room ID
|-
| scope="row" role="rowheader" | [[Trick or Treat]] || Endeltime Estates, Neighborhood || 31980 || 8086199
|-
| scope="row" role="rowheader" | [[Herb Hunt]] || The Garden Shack || 31978 || 8086350
|-
| scope="row" role="rowheader" | [[Arena of the Abyss]] || Arena of the Abyss, Influx || 28549 || 8225001
|-
| scope="row" role="rowheader" | [[Undergrowth of Bittermere Woods]] || Bittermere Woods || || 8083284
|}
<noinclude>
====Fishing====
</noinclude>
<includeonly>:</includeonly>
{| class="wikitable alternating" width=30%<includeonly>
|+ style="text-align: left" | '''Fishing'''</includeonly>
! scope="col" | Fishing Location
! scope="col" | Fishing Area Name
! scope="col" | Lich Room Number
! scope-"col" | Room ID
|-
| scope="row" role="rowheader" | Gleyminn Anni River, Island || Stream of Reflections || 31834 || 8083431
|-
| scope="row" role="rowheader" | Gleyminn Anni River, Shore || Moss Pond || 32073 || 8083432
|-
| scope="row" role="rowheader" | Gleyminn Anni River, Rocky Path || Misty Waters || 31846 || 8083429
|-
| scope="row" role="rowheader" | Gleyminn Anni River, Shore || Mold Marsh || 32074 || 8083430
|-
|}
<noinclude>
====Nodes====
</noinclude>
<includeonly>:</includeonly>
{| class="wikitable alternating" width=80%<includeonly>
|+ style="text-align: left" | '''Nodes'''</includeonly>
! scope="col" | Room Name
! scope="col" | Lich Room Number
! scope="col" | Room ID
! scope="col" | Node Type
|-
| scope="row" role="rowheader" | [Evermore Hollow, Jester's Court] || 31567 || u8083006 || earth
|-
| scope="row" role="rowheader" | [Evermore Hollow, Fallen Court] || 31561 || u8083007|| earth
|-
| scope="row" role="rowheader" | [Evermore Hollow, Fate's Fire] || 31591 || u8083010|| earth
|-
| scope="row" role="rowheader" | [Evermore Hollow, Nature's Glade] || 31571 || u8083008|| earth
|-
| scope="row" role="rowheader" | [Evermore Hollow, Noble Guardian] || 31603 || u8083009|| earth
|-
| scope="row" role="rowheader" | [Fate's Barrow] || 31771 || u8083137|| earth
|-
| scope="row" role="rowheader" | [Bittermere Woods, Convergence] || 31660 || u8083262|| earth
|-
| scope="row" role="rowheader" | [Bittermere Woods] || ||u8083286|| earth
|-
| scope="row" role="rowheader" | [Evermore Hollow, Outer Circle] || || u8083030 || super
|-
| scope="row" role="rowheader" | [Evermore Hollow, Outer Circle] || || u8083017 || super
|-
| scope="row" role="rowheader" | [The Wayward Soul Chapel] || || u8083362 || super
|}
<noinclude>

====Automated Services====
</noinclude>
<includeonly>:</includeonly>
{| class="wikitable alternating" width=80%<includeonly>
|+ style="text-align: left" | '''AutomatedServices'''</includeonly>
! scope="col" | Service
! scope="col" | Room Name
! scope="col" | Lich Room Number
! scope="col" | Room ID
|-
| scope="row" role="rowheader" | Bank || [Otherworldly Wealth, Lobby] || 31775 || 8084062
|-
| scope="row" role="rowheader" | Enhancive Swap || [Quinton Manse, Hedged Garden] || 32076 || 8084687
|-
| scope="row" role="rowheader" | Flare Additions || [Quinton Manse, Western Nook] || 31773 || 8084686
|-
| scope="row" role="rowheader" | Gem Pile || [Antiquarian Manor, Showroom] || 31755|| 8084696
|-
| scope="row" role="rowheader" | [[Gilded locus]] || [Quinton Manse, Garden Fountain] || || 8084689
|-
| scope="row" role="rowheader" | Permifier || [Antiquarian Manor, Garden] || 31606 || 8084692
|-
| scope="row" role="rowheader" | Game Prizes for Soul Shards Gjenganger || [Gavelsdown Hall, Sitting Room] || 31574 || 8084015
|-
| scope="row" role="rowheader" | Wishing Well || [Bittermere Woods, Convergence] || 31660 || 8083262
|-
|}<section end=keyloc />

===Souvenir===
{{addmetext}}

===Pricing===
<section begin=pricing /><includeonly>* '''Evermore Hollow'''</includeonly>
<includeonly>:</includeonly>{| class="wikitable"
! scope="col" | Activity
! scope="col" | Item(s)
! scope="col" | Cost
! scope="col" | Length
! scope="col" | Applicability
|-
| scope="row" role="rowheader" | Merchant Pass || Ebon Gate service pass || 3000 [[SimuCoin]]s|| Event Duration<sup><small>&dagger;</small></sup> || Character <br> 10 Characters for Platinum
|-
| scope="row" role="rowheader" | [[Arena of the Abyss]]<br>[[Sonreeva]] || an enruned stone cube* || 10 SimuCoins || 5 rounds or death/surrender || Per Entry
|-
| scope="rowgroup" role="rowheader" | [[Undergrowth of Bittermere Woods]] || an enruned stone cube* || 10 SimuCoins || 1 task || Per Entry
|-
| scope="rowgroup" rowspan="6" role="rowheader" | [[Trick-or-Treat]]<br>[[Herb Hunt]] || a gilded copper barrel key (1 entry) || 100 SimuCoins || rowspan="6" | 10 "treats" || rowspan="6" | Per Entry
|-
| a gilded ivory barrel key (10 entries) || 1000 SimuCoins
|-
| a gilded silver barrel key (25 entries) || 2500 SimuCoins
|-
| a gilded laje barrel key (50 entries) || 5000 SimuCoins
|-
| a gilded alum barrel key (100 entries) || 10000 SimuCoins
|-
| a gilded vaalin barrel key (250 entries) || 25000 SimuCoins
|-
| scope="row" role="rowheader" | [[Fishing]] || style="text-align: center" | - ||50 [[soul shard]]s || Fish is caught or person leaves area || Per Entry
|}
<includeonly>:</includeonly><small><sup>&dagger;</sup> The merchant event is scheduled to be 7 days in each instance (Prime and Plat) as noted in the schedule, but the pass is set up for the duration of the event to cover any mishaps or re-scheduling.<br>
<includeonly>:</includeonly><nowiki>*</nowiki> The base item is the same, however "an enruned stone cube" is available in 1, 10, 50, 100, and 250 count entries.</small><section end=pricing />
<section begin=refunds />
<noinclude>=</noinclude>==Refund Policy==<noinclude>=</noinclude>
{{:Pay events refund policy}}<section end=refunds />

===[[Title System|Titles]]===
Titles have been made available for contest winners.
<section begin=egtitles />
{| <noinclude>class="mw-collapsible mw-collapsed" id="mw-customcollapsible-titles"
|+ style="white-space:nowrap; text-align:left;" | To view the lists of potential titles, click <span class="mw-customtoggle-titles" role="link" style="color:#0000ff">'''here'''</span>.</noinclude>
|-
| scope="row" role="rowheader" | '''Contest Titles''' 
|-
| {{#section:Event titles|ebongate}}
|}<section end=egtitles />

===Announcements and Teasers===
<section begin=announcements /><includeonly>* '''Evermore Hollow'''</includeonly>
<noinclude>*</noinclude><includeonly>**</includeonly><big>'''[[Ebon Gate Festival/saved posts 2026|2026 announcements]] - Current List'''</big>
<noinclude>*</noinclude><includeonly>**</includeonly>[[Ebon Gate Festival/saved posts 2025|2025 announcements]]
<noinclude>*</noinclude><includeonly>**</includeonly>[[Ebon Gate Festival/saved posts 2024|2024 announcements]]
<noinclude>*</noinclude><includeonly>**</includeonly>[[Ebon Gate Festival/saved posts 2023|2023 announcements]]
<noinclude>*</noinclude><includeonly>**</includeonly>[[Ebon Gate Festival/announcements 2022|2022 announcements]]<section end=announcements />

===[[TownCrier]] Articles===
<section begin=towncrier /><includeonly>* '''Evermore Hollow'''</includeonly>
<noinclude>*</noinclude><includeonly>**</includeonly>[[The Ebon Gate FAQ for Evermore Hollow]]
<noinclude>*</noinclude><includeonly>**</includeonly>[[Ebon Gate 2024 Quick Reference Shop Index]]
<noinclude>*</noinclude><includeonly>**</includeonly>[[Ebon Gate Teasers Archive by The TownCrier/2024|TownCrier list of teasers - 2024]]
<noinclude>*</noinclude><includeonly>**</includeonly>[[Ebon Gate 2024 Buyer's Choice]]
<noinclude>*</noinclude><includeonly>**</includeonly>[[Ebon Gate 2023 Quick Reference Shop Index]]
<noinclude>*</noinclude><includeonly>**</includeonly>[[Ebon Gate Teasers Archive by The TownCrier/2023|TownCrier list of teasers - 2023]]
<noinclude>*</noinclude><includeonly>**</includeonly>[[Ebon Gate 2023 Buyer's Choice]]
<noinclude>*</noinclude><includeonly>**</includeonly>[[Ebon Gate Teasers Archive by The TownCrier/2022|TownCrier list of teasers - 2022]]
<noinclude>*</noinclude><includeonly>**</includeonly>[[Ebon Gate 2022 Buyer's Choice]]
<noinclude>*</noinclude><includeonly>**</includeonly>[[Ebon Gate 2022 Quick Reference Shop Index]]<section end=towncrier />

===Player-Created Content===
* [[An Illustrated Guide to Elanthian Flora - Naidem]] by [[Alisaire (prime)|Alisaire Frey]]

===Artwork Archive===
* [[:Category:Evermore Hollow artwork#Yearly Promotional Artwork|Promotional Artwork]]
* [[:Category:Evermore Hollow artwork##Maps|Player-created Maps]]

[[Category:Ebon Gate Festival]]

User talk:WHIGHTCNIGHT/EG Fishing

2026-10-20T15:07:51Z

WHIGHTCNIGHT: add permission

I give full authorization to [[User:HORIBU1]] to edit/modify/do whatever to my user, player, and talk pages of mine as well as any subpages created in the future on said page types [[User:WHIGHTCNIGHT|WHIGHTCNIGHT]] ([[User talk:WHIGHTCNIGHT|talk]]) 10:07, 20 October 2026 (CDT)

==Article/Edits at Risk for Deletion==
This article is missing a statement that permission was granted by the account holder for another user to create or edit articles for their user page.

For more information, see [[Gswiki:Policy]], specifically Policy #4. This information will need to be added within the timeframe stated on the article banner or it will be deleted or reverted to an earlier version. Do not remove the <nowiki>{{moddelete}}</nowiki> template from this article. Another moderator or I will remove that template after updates have been reviewed to ensure that they meet [[Gswiki:Policy]] requirements. [[User:HOST-GSKEBECHET|HOST-GSKEBECHET]] ([[User talk:HOST-GSKEBECHET|talk]]) 08:36, 20 October 2026 (CDT)

User talk:WHIGHTCNIGHT

2026-10-20T15:07:18Z

WHIGHTCNIGHT: add permission

Hello! I tried to email you at your play.net and got a bounce back. Thanks for helping with the EG shops :) [[User:VANKRASN39|VANKRASN39]] ([[User talk:VANKRASN39|talk]]) 22:54, 16 October 2015 (CDT)

I give full authorization to [[User:HORIBU1]] to edit/modify/do whatever to my user, player, and talk pages of mine as well as any subpages created in the future on said page types [[User:WHIGHTCNIGHT|WHIGHTCNIGHT]] ([[User talk:WHIGHTCNIGHT|talk]]) 10:07, 20 October 2026 (CDT)

== Article/Edits at Risk for Deletion ==

Hi there, WHIGHTCNIGHT. In reviewing some of the recent updates, I saw another user, HORIBU1, created and made edits to [[User:WHIGHTCNIGHT/EG Fishing]], which is a subarticle of your user page.

There is no indication on the article's Discussion/Talk tab that you gave any other account permission to create or edit your user page or any subpages on your behalf. [[Gswiki:Policy]] prohibits users from editing user pages unless the account is theirs or they have been given permission by that account holder to make those edits. If you did give permission to another account to edit your user page, you will need to indicate this by clearly stating it on the subarticle's Discussion/Talk tab, [[User talk:WHIGHTCNIGHT/EG Fishing]], that you have given permission to any accounts do so. Simply noting that in the edit reason for an article is not enough for Gswiki:Policy. Alternatively, the other user can put that information on the discussion page on your behalf. When adding that information, please make sure to add <nowiki>~~~~</nowiki> at the end of your comments, which will automatically add a "signature" with your user name, plus the date and time of when your edit was made.

If you are HORIBU1's account holder and are using multiple accounts to edit a user page, you will still need to include that permissions statement; this needs to be done for each subarticle edited by more than one account. Alternatively, those accounts with permission to edit can add that information on your behalf. Edits made prior to July, 2023, are grandfathered into an earlier version of Gswiki:Policy for character pages and will not be reverted or deleted.

'''If that information is not added within 7 days, the edits made by another account to your user page will be deleted from the wiki.''' Please do not remove the <nowiki>{{moddelete}}</nowiki> template from any flagged user page. Another moderator or I will remove that template after any updates have been reviewed to ensure that they meet [[Gswiki:Policy]] requirements. If you have any questions about this process or need more information about the updated policy for editing user pages, please reach out to the wiki team on the Gemstone [https://discord.com/channels/226045346399256576/1061330227843833926 Discord forum's wiki thread]. Thank you for understanding. [[User:HOST-GSKEBECHET|HOST-GSKEBECHET]] ([[User talk:HOST-GSKEBECHET|talk]]) 08:36, 20 October 2026 (CDT)

Lich:Script Bigshot

2026-03-17T15:41:30Z

WHIGHTCNIGHT: /* Command Checks */

{{3rd-party}}
Bigshot is a fully automated hunting script for GemStone IV. It handles combat routines, movement to and from hunting areas, target selection, and attack execution.
AFK scripting on any server other than Shattered is a violation of game policy.
{{TOCright| limit=2}}
==Changelog==
*[[Script Bigshot/Changelog|Script Bigshot Changelog]]
==About Bigshot==
===What Does Bigshot Do?===

Using a series of menus and command inputs, Bigshot lets you create a modular, customizable, and fully automated hunting script. With just a few clicks and tweaks, you can go from scripting rats to the Rift.

===How Do I Get It?===

Grab it from the repository: <CODE>;repository download Bigshot</CODE>

===How Do I Make It Go?===
Initial setup is accessed through <CODE>;bigshot setup</CODE>. This opens a configuration window with several tabs for setting up your hunting routine.

As with most scripts, the SETUP command opens a graphical user interface. Use <CODE>;bigshot setup</CODE> to open the dialog. The window contains the following tabs:
* '''Profile''' - Save and load profile configurations. Profiles are saved to your <CODE>\Lich5\data\<GSServer>\<charname>\bigshot_profiles</CODE> directory (e.g., <CODE>\Lich5\data\GSIV\Rinualdo\bigshot_profiles</CODE>). Note: if you previously used Bigshot, the file location has changed from the old <CODE>\Lich5\scripts\bigshot_profiles</CODE> folder. You can copy/paste your old profiles to the new location.
* '''Resting''' - Configure your resting routine, rest location, and conditions that trigger resting.
* '''Hunting''' - Create a hunting map using boundaries, set your starting room, configure attack/wander stances, and define pre-hunt behavior.
* '''Attacking''' - Configure ambush aiming, flee conditions, bless behavior, weapon reactions, and similar combat flags.
* '''Commands''' - Define your valid targets and associated attack routines. See sample routines below.
* '''Boon Creatures''' - Configure how Bigshot handles boss/boon creatures on a per-ability basis (fight, ignore, or flee).
* '''Misc''' - UAC options, MSTRIKE options, ammo/wand configuration, and MA grouping settings.
* '''Monitoring''' - Interaction monitoring, deadman's switch, depart behavior, and debug options.

Each tab is covered in detail further on.

===Other Commands===
Beyond the setup GUI, Bigshot has several command-line options:
* <CODE>;bigshot quick</CODE> - A special hunting mode that kills everything in your current room, then quits. It will not wander or attempt to rest. Uses its own separate hunting commands and targets (configured on the Commands tab).
* <CODE>;bigshot head</CODE> / <CODE>;bigshot tail</CODE> - Multi-account hunting on a single computer. All characters must be set up for the same hunting area. Following characters run <CODE>;bigshot tail</CODE>, then the leader runs <CODE>;bigshot head</CODE>. The leader can optionally specify the expected group size, e.g., <CODE>;bigshot head 3</CODE>. Head and tail can be started in any order.
* <CODE>;bigshot display</CODE> - Shows all your current settings.
* <CODE>;bigshot reset</CODE> - Resets your targetable and untargetable lists. Useful if Bigshot will not target something it should.
* <CODE>;bigshot ranger</CODE> or <CODE>;bigshot companion</CODE> - Resets the ranger companion setting so you can reconfigure it. Use this when you change your companion.
* <CODE>;bigshot profile save <name></CODE> - Saves a profile in YAML format to your character's profile folder. Also accessible via the Profiles tab.
* <CODE>;bigshot profile load <name></CODE> - Loads a profile from your character's profile folder. Also accessible via the Profiles tab.
* <CODE>;bigshot single</CODE> - Executes a single hunting routine, returns to your resting location, and then exits.
* <CODE>;bigshot list</CODE> - Displays all initialized variable values (useful for troubleshooting).
* <CODE>;bigshot test <method> <args></CODE> - Runs a specific internal method for testing purposes.
* <CODE>;bigshot <creature></CODE> - Any input that does not match the above commands defaults to ranger tracking (e.g., <CODE>;bigshot single giant rat</CODE> will track and hunt a giant rat).

==The Profile Tab==
* '''Load Profile''' - Load an existing saved profile. The dropdown will be empty if no profiles have been saved yet.
* '''Current Profile''' - Displays the name of the currently loaded profile.
* '''Save Profile''' - Enter any name for your profile and click Save. Once saved, the profile will appear in the Load Profile dropdown.
* '''Notes''' - A freeform text area for any notes you want to associate with the profile.

==The Resting Tab==
This tab controls where and how Bigshot rests between hunts. During rest mode, Bigshot checks your mind state, hit points, wound status, mana, and spirit. Once all conditions defined in the "Should Hunt?" section are met, Bigshot leaves rest mode and begins a new hunt.

===Where to Rest===
* '''room id''' - The room Bigshot returns to for resting. Uses room numbers from Map/Go2. Supports both Lich IDs and SimuIDs (prefix SimuIDs with "u", e.g., <CODE>228</CODE> for Town Square Central or <CODE>u7120</CODE>).
* '''return waypoints''' - Optional intermediate room IDs that Bigshot will pass through when returning to rest. Separate multiple waypoints with commas.
* '''pre-rest commands''' - Commands executed before entering rest mode. Example: <CODE>shea, wear shield, sit, stance offensive, rest</CODE>. This will sheathe your weapon, wear your shield, sit down, enter offensive stance, and use the REST verb. You can also call scripts here using the <CODE>script</CODE> prefix, e.g., <CODE>script go2 place</CODE>.
* '''active resting scripts''' - Scripts that run upon entering rest mode for between-hunt tasks such as selling loot, spelling up, or healing. Example: <CODE>eloot sell, waggle, eherbs</CODE>. This will sell via eloot, spell up via waggle, then use herbs from your PACK to heal wounds.
* '''Fog Option''' - Determines how Bigshot returns to rest. Options include:
** '''None''' - Walk normally (no teleportation).
** '''130''' - Uses [[Spirit Guide (130)]] first; falls back to Symbol of Return if it fails.
** '''Symbol of Return''' - Uses Voln [[Symbol of Return]] first; falls back to 130 if it fails.
** '''Traveler's Song (1020)''' - Attempts [[Traveler's Song (1020)]] once, then continues.
** '''Familiar Gate (930)''' - Attempts [[Familiar Gate (930)]] to summon a portal and walk through it. Will perform a mana pulse if not enough mana is detected.
** '''Sigil of Escape''' - Uses [[Sigil of Escape]].
** '''Custom''' - Allows a comma-separated list of custom commands to perform.
* '''Fog ONLY if wounded or encumbered''' - When checked, Bigshot will only use the fog option if you are actually wounded or encumbered. Otherwise it walks normally.
* '''Fog twice from the Rift''' - When checked, Bigshot will double-cast the fog spell when returning from the Rift (useful since the Rift requires two uses to escape).

===Should Rest?===
Bigshot evaluates these conditions to decide when to leave a hunt and return to rest.
* '''when percent mind >='''
** Triggers resting when your mind has reached this threshold. Generally set to 100 (fried). Default is 100.
* '''and extra kills >='''
** The number of additional monsters to kill after reaching your "when percent mind" threshold and after LTE boosts are used. Set to 0 to rest immediately upon reaching the mind threshold.
* '''and used lte boosts >='''
** The number of LTE (Long-Term Experience) boosts Bigshot will attempt to use after reaching the mind threshold. Set to 0 to skip LTE boosts entirely.
* '''or percent mana <='''
** Forces Bigshot to rest when your mana percentage is at or below this value. Can be set to 0, but leaving a small buffer is useful (e.g., for Unlock (406) to open the WL Graveyard gate). If you encounter an "OOM" error, try setting this to 1.
* '''or percent encumbrance >='''
** Forces Bigshot to rest when your encumbrance reaches or exceeds this percentage.
* '''or wounded eval'''
** Allows you to set a Ruby evaluation expression to determine if you are too wounded to continue. Can trigger on bleeding, specific wound levels, inability to cast, scars, and more.

The following is a wounded evaluation that will rest whenever you have any level II wounds:
<PRE>XMLData.injuries.any?{|key,value| value["wound"] > 1} || Char.percent_health <= 70</PRE>
The following is a wound evaluation that will take you home if you can no longer cast (bleeding, nerves, level 2 head/eyes, bad scars, etc.):
<PRE>bleeding? || Char.percent_health <= 25 || [Wounds.head, Scars.head, Wounds.leftEye, Scars.leftEye, Wounds.rightEye, Scars.rightEye, Wounds.nsys, Scars.nsys].max > 1 || [Wounds.leftArm, Wounds.leftHand, Wounds.rightArm, Wounds.rightHand, Scars.leftArm, Scars.leftHand, Scars.rightArm, Scars.rightHand].max > 2 || ([Wounds.leftArm, Wounds.leftHand, Scars.leftArm, Scars.leftHand].max + [Wounds.rightArm, Wounds.rightHand, Scars.rightArm, Scars.rightHand].max) >= 3</PRE>
The following can be appended to either wound evaluation above to also rest upon having popped muscles:
<PRE>|| Effects::Debuffs.active?("Overexerted")</PRE>

* '''when creeping dread >='''
** Forces Bigshot to rest when your creeping dread level reaches or exceeds this value.
* '''when crushing dread >='''
** Forces Bigshot to rest when your crushing dread level reaches or exceeds this value.
* '''Wall of Thorns Poison'''
** Forces Bigshot to rest when you are affected by Wall of Thorns poison.
* '''Confusion Debuff'''
** Forces Bigshot to rest when you are affected by the non-dispellable Confusion debuff.
* '''Box in hand'''
** Forces Bigshot to rest if looting leaves a box in your hand.

==The Hunting Tab==
This tab controls when and where Bigshot hunts, any pre-hunt preparation, and the map boundaries for wandering.

===The Hunting Map===
Your hunting map consists of '''Boundaries''' (rooms Bigshot will never enter) and a '''Starting Room''' (the first room Bigshot moves to when a hunt begins). These function similarly to the boundaries in the ;Wander script, but are stored in Bigshot's own configuration files.

* '''starting room ID''' - The first room Bigshot travels to when beginning a hunt. Set this to any room within your boundaries.
* '''boundary rooms''' - Rooms that act as walls. Bigshot will never enter a boundary room.

<PRE>X-X-B - A - 0 - 0 - 0
| |
X-X-X</PRE>

In the diagram above, "B" is a boundary room and "A" is outside the hunting area. Rooms marked "0" are the huntable area. Bigshot will wander freely among the "0" rooms but never cross into "B" or "A".

Boundary room IDs are separated by commas. Some popular examples:

'''Rift Boundaries:'''
<PRE>
Plane 1: 2635, 12101, 12208
Plane 2: 2605, 2635, 12093
Plane 3: 2635, 12089, 12152
Plane 4: 12122, 12207, 12235
Plane 5: 2579
North Scatter: 12151, 12254, 12256, 12249, 12247, 12241
South Scatter: 12151, 12219, 12217, 12233, 12237, 12239
</PRE>

'''Maaghara Boundaries:'''
<PRE>9734</PRE>

'''Confluence Boundaries:'''
<PRE>2300, 3519, 228, 188, 1932, 10855, 3668, 1438, 1005</PRE>

Imagine a hunting area that is a six-room square. To enter this square, you must GO DOORWAY from room A. You would set room A (outside the square, before the doorway) as a boundary. Then set room B (just inside the square) as the starting room. Bigshot will move to room B and wander within the bounded area until your "Should Rest?" conditions are met.

* '''rally point rooms''' - Optional intermediate room IDs Bigshot will pass through on the way to the hunting area. Separate multiple rooms with commas.

===Hunting Settings===
* '''wait before wandering to another room''' - Time in seconds Bigshot waits before leaving a room to look for creatures. Default is 0.3. Set to 0 for fastest (but spammy) movement.
* '''attack stance''' - The stance Bigshot switches to when issuing attack commands. Bigshot remains in defensive stance until an attack is triggered, then stances to your specified attack stance. Recognizes all game stances from Offensive through Defensive.
* '''wander stance''' - The stance Bigshot uses while moving between rooms. Defaults to Defensive.
* '''stand up stance''' - The stance Bigshot enters when standing up after being knocked down. Defaults to Defensive.
* '''pre-hunt commands''' - Commands executed before Bigshot uses Go2 to travel to your starting room. Example: <CODE>gird, stance defensive</CODE>. This ensures your weapon is readied and you are in defensive stance before traveling. Use this line for short-lived combat spells like 1605 (Arm of the Arkati).
* '''active hunting scripts''' - Scripts that run while Bigshot is in hunt mode. Use these for complex behaviors that Bigshot does not natively support (e.g., keeping certain spells active or executing CMANs based on conditions).
* '''society abilities/spells/cmans''' - Abilities Bigshot keeps active during a hunt. Enter numerical designations separated by commas. For example, entering <CODE>506</CODE> keeps Haste up, recasting whenever it wears off. Hover over this field in the GUI for a list of supported values. Supported options include spells that can be ignored by rapidfire cooldown: e.g., <CODE>515 (ignore)</CODE> or <CODE>rapidfire (ignore)</CODE>.
* '''loot script''' - The script Bigshot calls to loot your kills (e.g., <CODE>eloot</CODE>). Make sure the loot script is properly configured via its own SETUP command, or Bigshot may error.
* '''wracking spirit >=''' - If your spirit is greater than or equal to this value, Bigshot will WRACK for mana. Setting it to 6 will wrack down to 5 spirit. Only functions when the wracking checkbox is enabled.
* '''Use sign of wracking/sigil of power''' - Checkbox to enable wracking.
* '''Check for favor before using Voln symbols''' - Checkbox to verify you have sufficient favor before casting Voln society symbols.
* '''Priority hunt''' - When enabled, Bigshot targets creatures in the order listed in your valid targets field. If a higher-priority creature enters the room, Bigshot switches to it. When using <CODE>;bigshot quick</CODE>, quickhunt targets take priority, followed by any remaining targets in room order.
* '''Delay looting''' - Delays the looting of creatures in a room.
* '''Defensive stance before looting''' - Switches to defensive stance before looting begins.
* '''Pull players to feet''' - Attempts to pull players to their feet when passing them.
* '''Stop for dead players''' - Pauses Bigshot if you encounter a dead player.
* '''Troubadour's Rally''' - Enables the use of Troubadour's Rally during hunts.
* '''Sneaky Sneaky''' - Sneak around while moving through the hunting area.

===Should Hunt?===
Bigshot evaluates these conditions to determine if you are ready to begin a hunt from rest.
* '''when percent mind <='''
** Setting this to 51 will wait until "Clear". Setting it to 65 will wait until "Muddled".
* '''and percent mana >='''
** The percentage of your maximum mana that must be present before hunting. Setting below 50 results in short hunts if you cast frequently. Generally set to 95 or higher.
* '''and CHECK spirit >='''
** Bigshot checks that your current spirit value is at least this amount. Make sure this is high enough that Bigshot will not immediately hunt after DEPARTing if you have the "Depart / re-run" option enabled on the Monitoring tab.
* '''and percent stamina >='''
** The percentage of your maximum stamina that must be present before hunting. Useful for melee-heavy builds that rely on stamina for CMANs and MSTRIKEs.

==The Attacking Tab==
This tab controls aiming, flee conditions, and various combat behavior toggles.

* '''Ambush aiming locations (head, etc)''' - The order Bigshot aims when ambushing. Default is head, right leg, left leg, chest. Bigshot cycles through these and skips locations that are too injured or unreachable.
* '''Archery aiming locations (head, etc)''' - The order Bigshot aims when using archery attacks. Loops through your aiming list.
* '''flee if enemy count is >''' - Flees the room if the total number of enemies exceeds this value. Set to 1 to engage only single targets.
* '''...but don't count these''' - Bigshot ignores these monsters when evaluating flee count. Useful when low-level monsters are mixed into your hunting area.
* '''...and always flee from''' - Bigshot immediately flees from these monsters. Useful when your hunting area has higher-level or dangerous monsters mixed in.
* '''flee from environment message''' - Bigshot flees whenever the game sends a message matching this text (uses XML regex matching).
* '''wait before wandering to another room''' - Time in seconds before moving to a new room. Default is 0.3. Set to 0 to move instantly (can be spammy for others in the area).
* '''Approach lone targets only''' - Forces Bigshot to only begin combat against creatures that are alone in a room.
* '''Bless weapon?''' - Performs a Consecrate (1604), then a Cleric Bless or Voln Bless on any weapon that loses its bless during hunting. If unable to bless during hunting, Bigshot returns to the rest area and quits.
* '''Activate weapon reactions''' - Initiates reactive strikes when the opportunity presents itself.
* '''Flee from clouds''' - Flees from cloud spells such as 125 (Call Lightning/Ominous Cloud), 1704 (Stun Cloud), and 1713 (Death Cloud).
* '''Flee from vines''' - Flees from vine spells such as 610 (Tangle Weed).
* '''Flee from webs''' - Flees from webs.
* '''Flee from voids''' - Flees from voids.

==Commands Tab==
This is the core of Bigshot — where you define your attack routines.

===Hunting Commands===
* '''hunting commands (a)''' - The primary commands Bigshot executes when in a room with a valid target. Commands are separated by commas. Bigshot recognizes most hunting verbs; unrecognized commands are sent directly as-is via fput. The following are recognized hunting commands:
** '''kill''' - Attacks using the KILL verb.
** '''incant <spell number>''' - Casts the specified spell with INCANT. Automatically stances into offensive for bolt and stance-sensitive spells. You can CHANNEL via <CODE>INCANT SET CHANNEL <spell></CODE> (a standard GSIV verb) or by setting <CODE>SET ChannelIncant ON</CODE>, which will CHANNEL an INCanted spell if you are in a stance higher than neutral.
** '''channel <spell number>''' - Channels the specified spell at the target. Requires a stance higher than neutral to have effect.
** '''<spell number>''' - Casts the specified spell using PREPARE and CAST.
** '''wand''' - Gets a wand from your specified container and WAVEs it at the target.
** '''wandolier''' - Similar to wand, but designed for wandoliers. Gets a wand from the fresh wand container and waves it; rubs the container if no wands are found. Default waves in offensive stance. Use <CODE>wandolier defensive</CODE> to wave in a different stance.
** '''fire''' - Gets ammunition from your specified container and FIREs at the target. Aims based on Archery aiming settings on the Attacking tab.
** '''aim <location>''' - Aims at the specified body location.
** '''ambush''' - Uses the AMBUSH verb to attack, aiming based on Attacking tab settings. Can also aim dynamically: <CODE>ambush head</CODE> overrides default settings for that attack.
** '''wait <time>''' - Stance dances by going into Defensive stance for the specified time (in seconds). Bigshot will exit early if the target swings or casts, then evaluate the rest of the attack routine from your attack stance.
** '''mstrike''' - Executes MSTRIKE based on cooldown and stamina. Has its own options page under the Misc tab. Can also be used with UAC: <CODE>mstrike punch</CODE>.
** '''berserk''' - Executes the BERSERK verb and waits until it fades.
** '''throw''' - Empties hands, attempts throw, then retrieves the items you emptied.
** '''weed/kweed''' - Casts 610 at the target. Using <CODE>kweed</CODE> forces EVOKE 610, ensuring the damage version.
** '''curse <type>''' - Preps 715 and uses the specified curse type. Valid types: Clumsy, Weakness, Darkness, Itch, Hex, Pox, Nightmare, Star. Skips "curse star" if the buff is already active.
** '''unarmed <type>''' - Uses the Bigshot UAC routine. Valid types: punch, jab, kick, grapple. The routine uses appropriate attacks to rank up and applies MSTRIKE based on MSTRIKE options. Example: <CODE>unarmed jab</CODE>.
** '''smite''' - Performs an [[Order of Voln]] [[Kai's_Smite|Smite]] on the target until successful.
** '''leech''' - Performs a [[Mana Leech (516)]] on the target if cooldown is under 15 minutes.
** '''script <script name>''' - Executes a specified custom attack script.
** '''hide''' - Repeatedly attempts to hide until successful or gives up.
** '''sleep <nostance>''' - Pauses Bigshot for the specified number of seconds. Example: <CODE>sleep 10</CODE> or <CODE>sleep 10 nostance</CODE>. Useful for timed hunting, e.g., <CODE>410, sleep 15</CODE> will E-wave, then wait 15 seconds before re-evaluating.
** '''stance <stance>''' - Changes stance. Example: <CODE>stance defensive</CODE>.
** '''nudgeweapons''' - Moves all weapons on the ground to an adjacent room. Useful for casting Implosion (720).
** '''force <cmd> until <endroll>''' - Repeats a command until a desired endroll is achieved. Example: <CODE>force incant 1002 until 101</CODE>. Only works for standard swings/spells/CMANs.
** '''eachtarget <cmd>''' - Issues the command against each valid target in the room.
** '''efury <fire|cold>''' - Casts Earthen Fury (917) on the target and waits for the DOT to end or 12 seconds to pass.
** '''caststop <spell>''' - Casts the spell and immediately stops it after casting.
** '''wield <noun> <left|right>''' - Wields a new item in the specified hand and stores the current item.
** '''store''' - Stores items in left, right, or both hands (only if something is in those hands).
** '''tether <recast>''' - Casts 706 with built-in wait logic. The optional <CODE>recast</CODE> flag will auto-recast 706 on creature death and transfer DOTs to a new target.
** '''unravel <spell>''' - Casts 1013 (Song of Unravelling). Optionally specify a spell number to target against the creature.
** '''depress''' - Casts 1015 (Song of Depression) with built-in logic.
** '''phase''' - Force-casts 704 (Phase) using PREP/CAST, required for NPC targeting to convert non-corporeal to corporeal undead.

===Additional Command Sets===
* '''hunting commands (b) through (j)''' - Additional attack routines tied to creature flags. When you flag a creature in your valid targets (e.g., <CODE>niirsha(b)</CODE>), Bigshot uses the matching command set. This allows different attack strategies for different creature types.
* '''fried hunting commands''' - Commands executed specifically when your mind is fried. Useful in group hunting where you still want to contribute.
* '''quick hunting commands''' - Commands executed when using <CODE>;bigshot quick</CODE>.
* '''valid targets''' - The monsters you are hunting. Bigshot works best with creature NOUNs (e.g., <CODE>ogre</CODE> instead of <CODE>a large ogre</CODE>). Use commas to separate multiple targets: <CODE>manticore, thrak</CODE>. If left blank, Bigshot will target everything in the room. Supports regex for advanced matching.
* '''quickhunt targets''' - Designated targets for the <CODE>;bigshot quick</CODE> option.

===PSM3 Integration===
Bigshot supports weapon/shield skills and warcries. Assaults wait until they finish or are interrupted. The following are recognized PSM3 commands:

'''Assaults''' (wait until completed/interrupted):
* barrage, flurry, fury, gthrusts, pummel, thrash
* fury can specify a default attack: <CODE>fury punch</CODE> or <CODE>fury kick</CODE> (defaults to jab)

'''Setups''' (execute on cooldown — pair with prone/stun/root checks):
* charge, cripple, dizzyingswing, pindown, twinhammer

'''AOE''' (execute on cooldown — limit with mob checks):
* clash, cyclone, pulverize, volley, wblade, whirlwind

'''Warcries:'''
* '''shout''' - Performs warcry Shout. Must use a command check or it will shout every loop: <CODE>shout(!shout)</CODE> or <CODE>shout(buff10 s25)</CODE>
* '''yowlp''' - Performs warcry Yowlp. Must use a command check: <CODE>yowlp(!yowlp)</CODE> or <CODE>yowlp(buff10 s10)</CODE>
* '''holler''' - Performs warcry Holler, taunting all mobs. Example: <CODE>holler(s60)</CODE>
* '''bellow, growl, cry''' - Offensive warcries. Use with <CODE>target</CODE> for single target or <CODE>all</CODE> for AOE.

'''Shield Skills:'''
* shield bash, shield charge, shield pin, shield push, shield strike, shield trample, shield throw

'''Combat Maneuvers:'''
* '''surge''' - Keeps Surge of Strength active. <CODE>surge</CODE> or <CODE>surge(surge)</CODE> casts even on cooldown; <CODE>surge(!surge)</CODE> only casts when not on cooldown.
* '''bearhug, bullrush, coupdegrace, cpress, cutthroat, dirtkick, disarm, dislodge, divert, eviscerate, exsanguinate, eyepoke, feint, footstomp, garrote, gkick, hamstring, haymaker, headbutt, kifocus, kneebash, leapattack, mblow, mug, nosetweak, sattack, sblow, scleave, shroud, spunch, sthieve, subdue, sunder, sweep, swiftkick, tackle, templeshot, throatchop, trip, truestrike, vaultkick'''
* '''dislodge <location>''' - Dislodge from the specified location: <CODE>dislodge eye neck</CODE>
* '''stomp''' - Performs a stomp attack. Channels 909 if not already active. You can also add 909 to the society abilities field to keep it active.
* '''dhurl''' - Hurls your weapon and recovers it. Works with weapon bonding auto-return and the RECOVER verb.
* '''assume <aspect> <aspect/evoke>''' - Cycles between two aspects, or evokes a single aspect. Also works in the society abilities box: <CODE>650 <aspect> <aspect/evoke></CODE>
* '''briar <weapon>''' - Activates the AS buff on briar weapons. Tracks weapon charge and uses on cooldown.
* '''stance perfection''' - Put 10, 20, 30, etc. in your attack stance box to take advantage of stance perfection.
* '''chastise, excoriate''' - Performs the FEAT if available and affordable.
* '''rebuke''' - Performs Righteous Rebuke.
* '''scourge''' - Performs Ardor of the Scourge.
* '''momentum''' - Performs Glorious Momentum.

===Gemstone Activation===
To use a gemstone-activated ability, use <CODE>jewel <mnemonic></CODE>. Bigshot automatically avoids usage if the ability is on cooldown. Supported gemstone mnemonics:
* bloodboil - Blood Boil
* spellblade - Spellblade's Fury
* arcascend - Arcanist's Ascendancy
* geospite - Geomancer's Spite
* forceofwill - Force of Will
* arcaneintensity - Arcane Intensity
* arcaneopus - Arcane Opus
* bloodsiphon - Blood Siphon
* bloodwell - Blood Wellspring
* epossess - Evanescent Possession
* manawellspring - Mana Wellspring
* spiritwell - Spirit Wellspring
* stamwell - Stamina Wellspring
* terrortribute - Terror's Tribute
* arcblade - Arcanist's Blade
* arcwill - Arcanist's Will
* imaerabalm - Imaera's Balm
* reckless - Reckless Precision
* unearthchains - Unearthly Chains
* witchhunt - Witchhunter's Ascendancy
* manashield - Mana Shield
* arcaneaegis - Arcane Aegis

You may need to run '''SKILLS FULL''', '''CMAN INFO''', '''WEAPON INFO''', or '''SHIELD INFO''' if you have recently changed training or if skills are being skipped.

===Additional Options===
* '''haste''' or '''506''' - Placing this in front of any command casts 506 (Haste) before executing the command. Only casts if Haste is not currently active or has less than 3 seconds remaining.
<PRE>wait 10, haste kill (x3)</PRE>
* '''slayer''' or '''240''' - Placing this in front of any command casts 240 before executing. Will not recast if already active.
<PRE>slayer 302 (x99)</PRE>

===Command Checks===
Command checks let you add conditions to any command. The format is:
<CODE>COMMAND (CHECKS)(REPETITIONS)</CODE>

Example: <CODE>hamstring (mob1 prone)(x2)</CODE>. The (x#) repetition must be in a separate set of parentheses. Note that (xx) is shorthand for (x5), not unlimited.

Checks can be combined inside a single set of parentheses with spaces between them. Example: <CODE>kill(m20 s5 e20)</CODE>

Each check also has an inverse — prefix with <CODE>!</CODE> to negate. Example: <CODE>kill(!m20 !s5 !e20)</CODE>

====Resource and Status Checks====
* '''s#''' - Requires at least # stamina.
* '''m#''' - Requires at least # mana.
* '''h#''' - Requires health to be at or above #% (percentage, not fixed).
* '''v#''' - Requires at least # spirit.
* '''e#''' - Requires encumbrance percentage to be at or below #.
* '''essence#''' - Requires at least # Shadow Essence (Sorcerer).

====Creature Checks====
* '''mob#''' - Requires at least # NPCs in the room. Only useful for 2 or more creatures.
<PRE>To further clarify the mob# implementation:
1 mob, mob2: 1 IS less than 2 — attack does NOT proceed.
2 mobs, mob2: 2 IS NOT less than 2 — attack CAN proceed.
1 mob, !mob2: 1 IS NOT more than 2 — attack CAN proceed.
2 mobs, !mob2: 2 IS NOT more than 2 — attack CAN proceed.
3 mobs, !mob2: 3 IS more than 2 — attack does NOT proceed.</PRE>
* '''valid#''' - Like mob#, but only counts valid targets you are actively targeting in current settings.
* '''tier#''' - Checks your current UAC tier (1, 2, 3). Performs the command if your tier is equal to or greater than #. <CODE>(!tier3)</CODE> skips the command at tier 3.
* '''prone''' - Checks that the target is NOT sleeping, webbed, stunned, kneeling, sitting, lying down, prone, frozen, or held in place. Performs the command if none of those apply.
* '''frozen''' - Similar to prone but broken out separately. Useful for archers against non-corporeal creatures that deflect ranged attacks. Corporeal creatures that are stunned will break this check.
* '''undead''' - Performs the command if the target is undead.
* '''flying''' - Performs the command if the target is flying.
* '''rooted''' - Performs the command if the target is rooted.
* '''noncorporeal''' - Performs the command if the NPC is [[noncorporeal|non-corporeal]] undead.
* '''ancient''' - Checks for grizzled/ancient creatures.

====Self Checks====
* '''hidden''' - Performs the command if you are currently hidden.
* '''poison''' - Performs the command if you are currently poisoned.
* '''disease''' - Performs the command if you are currently diseased.
* '''pcs''' - Performs the command if there are PCs in the room that are not in your group.
* '''outside''' - Performs the command if the room is outdoors.
* '''splashy''' - Checks if the room is "splashy" (wet) via Room.tags. Useful for avoiding lightning attacks in wet rooms.

====Timing Checks====
* '''once''' - Performs the command once per target. Resets on room change.
* '''room''' - Performs the command once per room. Resets on room change.

====Buff Checks====
* '''barrage''' - Checks for the Enhanced Dexterity buff from Barrage.
* '''fury''' - Checks for the Enhanced Constitution buff from Fury.
* '''flurry''' - Checks for the Slashing Strikes buff from Flurry.
* '''pummel''' - Checks for the Concussive Blows buff from Pummel.
* '''thrash''' - Checks for the Forceful Blows buff from Thrash.
* '''vigor''' - Checks for the Tangleweed Vigor buff.
* '''reflex''' - Checks for the Arcane Reflex buff from Nature's Touch.
* '''tailwind''' - Checks for the Tailwind buff from Breeze.
* '''shout''' - Checks for the Empowered buff from Shout.
* '''yowlp''' - Checks for Yertie's Yowlp buff from Yowlp.
* '''holler''' - Checks for Horland's Holler buff from Holler.
* '''voidweaver''' - Checks for the Voidweaver buff from Implosion (720).
* '''justice''' - Checks for charges of Swift Justice. <CODE>(justice)</CODE> acts with charges; <CODE>(!justice)</CODE> acts with no charges.
* '''surge''' - Checks for Surge of Strength buff.
* '''rebuke''' - Checks for Righteous Rebuke buff.
* '''scourge''' - Checks for Ardor of the Scourge buff.
* '''momentum''' - Checks for Glorious Momentum buff.
* '''coupdegrace''' - Checks for the Empowered buff from Coup de Grace.
* '''animate''' - Checks for whether you have an animate present.
* '''buffXX''' - Fires the ability when the buff duration is <= XX seconds. Supported for barrage, bearhug, coupdegrace, fury, flurry, pummel, thrash, shout, yowlp, garrote.
* '''censer''' - Attempts to cast 320 before your command, checking mana and cooldown. Examples: <CODE>309(censer)</CODE>, <CODE>335(censer mob3)</CODE>, <CODE>attack(censer)</CODE>
** If the command is a spell, censer only casts if you have mana for both 320 and the spell.
** If the command is not a spell, censer only checks you have enough mana for 320.

====Effects Checks====
* '''ES"Effect to Track"''' - Checks if the Effects::Spells effect is active
* '''EB"Effect to Track"''' - Checks if the Effects::Buffs effect is active
* '''EC"Effect to Track"''' - Checks if the Effects::Cooldowns effect is active
* '''ED"Effect to Track"''' - Checks if the Effects::Debuffs effect is active

===Example Attack Routines===
<PRE>wait 10, kill (x3)</PRE>
Waits 10 seconds for the monster to swing or cast, then counter-attacks from your specified attack stance. Swings three times, then goes back to defensive and waits again.

<PRE>wait 15, incant 505, incant 903 (xx)</PRE>
Waits 15 seconds, then INCants 505 (Hand of Tonis) to knock down or stun the target. Follows up with repeated casts of 903 (Minor Water) until the target is dead (up to 5 times).

<PRE>stance defensive and incant 1615, kill (x100)</PRE>
Casts 1615 (Divine Strike) from defensive stance, then uses KILL continuously until the target is dead or 100 swings (whichever comes first).

<PRE>force feint until 101, kill (x2)</PRE>
Uses FEINT against the target until a successful endroll, then hits twice before trying FEINT again.

<PRE>stance defensive and hide, ambush left leg</PRE>
Hides from defensive stance, then ambushes the target's left leg. Repeats (hides again) after roundtime.

<PRE>incant 720(m50), incant 708, incant 702 channel(xx)</PRE>
Casts 720 (Implosion) if you have 50+ mana, then INCants 708 (Limb Disruption) at the default aim location, then channels 702 (Mana Disruption) up to 5 times or until dead.

<PRE>prep 708, cast at left leg / prep 708 channel at left leg, incant 719 (m50)(x1), incant 702 (xx)</PRE>
Prepares 708 and CASTs at the left leg. The second variant prepares and CHANNELs at the left leg. Then casts 719 (Dark Catalyst) once if 50+ mana. Finally, INCants 702 until the creature is dead.

<PRE>wait 30, unarmed punch</PRE>
Waits 30 seconds or until the target attacks, then begins UAC combat using Punch to tier up.

<PRE>shield charge (s15 prone), ambush, mstrike</PRE>
Shield charges the target if you have 15+ stamina and the target is NOT prone. Then ambushes based on Attacking tab settings (cycling through configured aim locations). Then MSTRIKEs — focused if below the creature threshold, unfocused if at or above it. Use <CODE>mstrike target</CODE> to always focus, or set unfocused threshold very high.

<PRE>bellow all, wblade(mob3), flurry(!flurry), attack</PRE>
AOE bellows, then Whirling Blade if 3+ targets. Flurries if the Slashing Strikes buff is not active. Falls back to basic attack.

<PRE>holler, shield throw(mob3), flurry, thrash, attack</PRE>
Taunts with Holler, Shield Throws if 3+ targets, Flurries on cooldown, Thrashes on cooldown, and attacks as a fallback.

<PRE>shroud(s35 !hidden mob2), divert (s25 hidden mob2), ambush(hidden), flurry, attack</PRE>
If 2+ mobs: hides with Shroud (35 stamina, not already hidden), then Diverts one target (25 stamina, must be hidden). Ambushes if hidden, Flurries on cooldown, attacks as fallback.

<PRE>surge(!surge), bullrush, bearhug, pummel, attack</PRE>
Keeps Surge active (casting only when not on cooldown). Bullrush to apply vulnerable, Bearhug (faster on vulnerable targets), Pummel on cooldown, attack as fallback.

<PRE>surge, shout(buff10), shield strike, pummel(buff60), attack(x2)</PRE>
Keeps Surge active (casting even during cooldown for 60 stamina). Shouts when less than 11 seconds remain on the buff. Shield Strikes, Pummels once per minute, finishes with 2 attacks.

<PRE>pindown(mob4), volley(mob2), weed(!vigor !reflex), barrage(!barrage), incant 616 (m16 reflex), fire</PRE>
Pin Down if 4+ targets, Volley if 2+ targets. Tangleweed if missing Vigor and Reflex buffs. Barrage if missing Enhanced Dexterity. Spike Thorn (616) if 16+ mana and Arcane Reflex is active. Fire as fallback.

===Hunting Target Examples===
All examples below work for both "valid targets" and "quickhunt targets."

A simple target list using default commands (a) for each creature:
<PRE>crazed zombie, niirsha, sacristan spirit</PRE>

Using different command sets per creature — (a) for zombies and spirits, (b) for niirsha:
<PRE>crazed zombie(a), niirsha(b), sacristan spirit(a)</PRE>

Including [[:Category:Boss creatures|Boss Creature]] variations as valid targets using regex:
<PRE>(?:adroit |afflicted |apt |barbed |belligerent |blurry |canny |combative |dazzling |deft |diseased |drab |dreary |ethereal |flashy |flexile |flickering |flinty |frenzied |ghastly |ghostly |gleaming |glittering |glorious |glowing |grotesque |hardy |illustrious |indistinct |keen |lanky |luminous |lustrous |muculent |nebulous |oozing |pestilent |radiant |raging |ready |resolute |robust |rune-covered |shadowy |shielded |shifting |shimmering |shining |sickly green |sinuous |slimy |sparkling |spindly |spiny |stalwart |steadfast |stout |tattooed |tenebrous |tough |twinkling |unflinching |unyielding |wavering |wispy )?crazed zombie, niirsha, sacristan spirit</PRE>

Advanced regex for Grimswarm hunting with different commands per class:
<PRE>
(?:seasoned |grizzled |battle-scarred |weathered |veteran |hulking |haggard )?Grimswarm (?:giant|troll|orc) (?:dissembler|sorcerer|sorceress|warlock|witch)(a)
(?:seasoned |grizzled |battle-scarred |weathered |veteran |hulking |haggard )?Grimswarm (?:giant|troll|orc) (?:barbarian|blackguard|fighter|marauder|soldier|warrior)(b)
(?:seasoned |grizzled |battle-scarred |weathered |veteran |hulking |haggard )?Grimswarm (?:giant|troll|orc) (?:adept|archmage|elementalist|mage|warmage)(c)
(?:seasoned |grizzled |battle-scarred |weathered |veteran |hulking |haggard )?Grimswarm (?:giant|troll|orc) (?:hunter|huntmaster|huntmistress|ranger)(d)
(?:seasoned )?(?:dwarven|elven|halfling|erithian|human|giantman|half-krolvin|gnomish|half-elven) (?:thief|rogue|bandit|mugger|outlaw|highwayman|marauder|brigand|thug|robber)(e)
(?:shopkeeper|innkeeper|bartender|patrol leader|bandit lord|bandit lady|gypsy queen|gypsy king|guard captain|wall captain|drill sergeant|stable hostler|dungeon master|master torturer|butler|cook|
knight captain|foreign dignitary|royal prince|royal princess|royal jester|royal emperor|royal empress)(f)
</PRE>

To target everything in the room: <CODE>(?:.*)</CODE>

==Boon Creatures Tab==
Boss creatures (also called the Boss Creature System) upgrades newly created creatures into bosses, minibosses, or packs. Upgraded creatures have their level and basic stats boosted, and are granted a number of special abilities called '''boons''', which are denoted by a special adjective in the creature's name. Players have alternatively called these "glam critters," "gifted creatures," or "boosted critters."

Additional details are available on the GemStone Wiki: [https://gswiki.play.net/Category:Boss_creatures Category:Boss creatures]

The Boon Creatures tab provides granular control over how Bigshot handles each boon ability. Bigshot uses the ASSESS verb to identify which boons a creature has, then checks your configuration to decide how to respond.

===How It Works===
For each boon ability, you can choose one of three actions:
* '''Common''' - Treat as a normal target and fight it. Uses your hunting commands to kill. Still requires proper valid target matching to engage. This is also the default behavior if no selection is made.
* '''Ignore''' - Skip this creature entirely; do not engage it.
* '''Flee''' - Immediately flee from the room when this boon type is detected.

===Master Toggle===
At the top of the tab is an '''All Boon Creatures''' section with Common, Ignore, and Flee checkboxes. These act as master toggles — checking one will set every individual boon ability across all groups to that action. If all individual items are already set to the same action and you uncheck the "All" toggle, everything gets unchecked.

===Boon Groups===
The individual boon abilities are organized into four collapsible groups, each with its own group-level toggle row ("Entire Group") and individual per-ability rows:

====Immunity====
Boons that make the creature resistant or immune to certain damage types or effects.
{| class="wikitable"
! Boon !! Adjectives !! Notes
|-
| Crit Death Immune || resolute, unflinching || Similar to constructs or golems
|-
| Damage Padding || flinty, tough ||
|-
| Elem Negation || sparkling, shining || Absorbs elemental magic attacks
|-
| Magic Resistance || rune-covered, tattooed || Reduces magic damage by 50%
|-
| Physical Negation || indistinct, nebulous || Physical damage resist shield
|-
| Stun Immune || steadfast, unyielding ||
|}

====Offensive====
Boons that enhance the creature's offensive capabilities.
{| class="wikitable"
! Boon !! Adjectives !! Notes
|-
| Boosted Offense || combative, belligerent ||
|-
| Cheat Death || glorious, illustrious || Raises self after death
|-
| Counter Attack || apt, ready || SMR counter-attack
|-
| Crit Weighting || shimmering, gleaming ||
|-
| Dmg Weighting || barbed, spiny ||
|-
| Dispelling || dazzling, flashy || Spirit Dispel (119) and Elem Dispel (417)
|-
| Elemental Flares || glittering ||
|-
| Frenzy || raging, frenzied ||
|-
| Mind Blast || canny, keen ||
|-
| Parting Shot || dreary, drab || Deals damage one last time upon death
|-
| Poisonous || sickly green, oozing || SMR poison gas cloud
|}

====Defensive====
Boons that enhance the creature's defensive capabilities.
{| class="wikitable"
! Boon !! Adjectives !! Notes
|-
| Blink || flickering, wavering || Temporary phase ability
|-
| Bolt Shield || shielded ||
|-
| Boosted Defense || sinuous, flexile || High damage padding (+12 CER)
|-
| Confuse || blurry, shifting || May give hard RT for casting at them
|-
| Crit Padding || stout, hardy ||
|}

====Stats / Misc====
Boons that affect the creature's stats, resistances, or grant miscellaneous special abilities.
{| class="wikitable"
! Boon !! Adjectives !! Notes
|-
| Boosted HP || robust, stalwart ||
|-
| Boosted Mana || luminous, lustrous ||
|-
| Diseased || pestilent, afflicted, diseased ||
|-
| Extra Spells - Elem || glowing ||
|-
| Extra Spells - Spirit || radiant ||
|-
| Extra Spells - Other || twinkling ||
|-
| Ethereal || ethereal, wispy, ghostly || Noncorporeal undead. No Sheer Fear.
|-
| Jack of All Trades || adroit, deft ||
|-
| Regeneration || slimy, muculent || Similar to Troll's Blood (1125)
|-
| Soul Stealing || tenebrous, shadowy || May possess 1204, 1601, and 1712
|-
| Terrifying || ghastly, grotesque || Pre-attack SMR can force player into defensive
|-
| Weaken || spindly, lanky || Weaker creature than normal
|}

===Usage Tips===
* If you are a melee character who struggles with '''Stun Immune''' or '''Crit Death Immune''' creatures, set those to Ignore or Flee while leaving others on Common.
* Casters may want to Flee from '''Dispelling''' and '''Magic Resistance''' boons.
* '''Weaken''' is actually beneficial — the creature is weaker than normal, so leaving it on Common is usually best.
* '''Cheat Death''' creatures will revive after dying; consider Ignore if your build cannot handle killing them twice.
* The configuration is saved per profile, so you can have different boon strategies for different hunting areas.

== Misc Tab==
Various specialized configuration options.

===UAC Options===
Options for configuring Unarmed Combat (UAC):
* '''Tier 3 Attack''' - The attack used when you have reached "excellent" positioning. Options: jab, punch, grapple, or kick.
* '''Aim at location (head, etc)''' - Used for aimed UAC combat, which requires ambush training to be effective. Leave blank if you do not want to aim.
* '''MSTRIKE when creatures equal or greater''' - How many creatures must be present before using MSTRIKE during UAC.
* '''Use Voln SMITE?''' - Will perform a Voln SMITE on [[Non-corporeal]] undead.

'''Quick Setup:''' Bigshot only requires minimal configuration for UAC to work well:
# '''UAC options:''' Set your '''Tier 3 Attack''' (jab, punch, grapple, or kick).
# '''Commands tab:''' Set your '''hunting commands (a)''' to '''unarmed jab'''.

Important notes about UAC in Bigshot:
* <CODE>unarmed jab</CODE> can be replaced with any UAC attack type (e.g., <CODE>unarmed punch</CODE>).
* UAC follow-up strikes take priority over the base or Tier 3 attack.
* Tier 3 attacks are only used when positioning is "excellent".
* There is almost no reason to use anything other than <CODE>unarmed jab</CODE> as the hunting command and either <CODE>grapple</CODE> or <CODE>kick</CODE> as the Tier 3 attack.

===MSTRIKE Options===
Options for when and how MSTRIKE should be used:
* '''MSTRIKE during cooldown stamina requirement''' - How much stamina you need before Bigshot will MSTRIKE during the MSTRIKE cooldown period. Be careful setting this too low, as it can pop your muscles. Leave blank to use your max stamina.
* '''QUICKSTRIKE stamina requirement''' - Stamina required for using QUICKSTRIKE during the MSTRIKE routine.
* '''Unfocused MSTRIKE when creatures equal or greater''' - Number of creatures in the room before Bigshot uses an unfocused (AOE) MSTRIKE instead of a focused one. Default is 2.
* '''MSTRIKE during cooldown''' - Toggle to allow MSTRIKEing during the cooldown period.
* '''Use QUICKSTRIKE for MSTRIKE''' - Toggle to use QUICKSTRIKE instead of normal MSTRIKE.

===Ammo/Wands===
Settings for ammunition and wand management. If your attack routine uses FIRE or WAND verbs, these fields must be configured or Bigshot will hang.

* '''find ammo in this container''' - The container holding your ammunition (quiver, backpack, etc.). Leave BLANK if using FIRE without retrieving ammo (post-Archery 2020 Update).
* '''use this ammo type''' - The noun of your ammo type. Leave BLANK to use FIRE without retrieving ammo. Be precise with the noun — Bigshot is sensitive to exact naming here.
* '''fresh wand container''' - The container Bigshot checks for fresh wands to WAVE.
* '''dead wand container''' - The container where Bigshot deposits used-up wands.
* '''use this wand type''' - The specific wand type(s) to use. Bigshot only pulls these for WAVEing. Separate multiple types with commas. Example: <CODE>aquamarine wand, bloodwood wand</CODE>
* '''Hide while waiting to pick up ammo''' - Bigshot will hide when gathering spent arrows and bolts.
* '''Use wands when out of mana''' - When out of mana, Bigshot pulls the specified wand type, stances to your attack stance, and WAVEs at valid targets until out of wands or resting conditions are met.

===MA Grouping===
Multi-account grouping options:
* '''Looter name''' - The name of the character designated as the looter in Head/Tail configuration.
* '''No-looting list''' - Comma-separated list of characters who should never be assigned looting duty.
* '''Random looting''' - Distributes looting randomly based on encumbrance rather than assigning a fixed looter.
* '''Leader final loot''' - Allows the leader to perform a final loot pass before leaving a room.
* '''Travel TO hunting grounds independently''' - When enabled, group members travel to the hunting area on their own rather than as a group. Bigshot will disband the group and force GROUP OPEN after disbanding.
* '''Travel FROM hunting grounds independently''' - When enabled, group members return from the hunting area on their own.
* '''Stop for dead group members''' - Pauses the group if a follower dies during a hunt.

==Monitoring Tab==
Options for safety, interaction monitoring, and debugging.

* '''Monitor interaction''' - Pops up a window whenever Bigshot detects that someone or something is trying to interact with you. Customizable monitor strings and safe strings can be configured.
* '''Engage deadman's switch''' - Forces Bigshot to quit GemStone IV when your character drops below 40% health, allowing you to log back on and assess the situation manually.
* '''Depart/rerun if dead''' - Forces a DEPART (waking up in the Temple with low spirit), then restarts Bigshot for a fresh hunt. Make sure your "CHECK spirit >=" value in Should Hunt? is set high enough to recover before the next hunt.
* '''Quiet followers''' - Followers wait until the leader finishes both actions and resting scripts before beginning their own.
* '''Ignore disk objects''' - Ignores disk objects when evaluating room claims and other checks.

===Debugging===
Bigshot provides detailed debug options for troubleshooting. Use these commands in-game:
<pre{{log2}}>
+---------------------------------------------------------------------------+
| Bigshot Debug Help v5.11.4 |
+---------------------------------------------------------------------------+
| Debug options have changed to be more helpful. |
+--------------------------------------+------------------------------------+
| ;bigshot debug file | Toggles logging to a file <on/off> |
| ;bigshot debug all <true/false> | Toggles true/false all the things |
| ;bigshot debug check | Lists current debug settings |
| ;bigshot debug combat <true/false> | Combat and Creature Status |
| ;bigshot debug commands <true/false> | Attacking and Casting Commands |
| ;bigshot debug status <true/false> | Status Checks of your Character |
| ;bigshot debug system <true/false> | System processes |
| | |
| Options can be combined: |
| ;bigshot debug combat commands status <true/false> |
+---------------------------------------------------------------------------+
</pre>

Debug log files are stored in your Lich5 logs directory under <CODE>debug/<Game>-<CharacterName>/bigshot.log</CODE> and rotate daily.

==Ingame Screenshot==
<gallery perrow="4">
File:bigshot-1.PNG|Profiles
File:bigshot-2.PNG|Resting
File:bigshot-3.PNG|Hunting
File:bigshot-4.PNG|Attacking
File:bigshot-5.PNG|Commands
File:bigshot-6.PNG|Misc
File:bigshot-7.PNG|Monitoring
</gallery>

==Reference==
* Info originally taken from http://forum.gsplayers.com/showthread.php?t=57651

{{Third-Party Software}}
{{top}}

Lich:Script Bigshot

2026-03-17T15:40:02Z

WHIGHTCNIGHT: /* Command Checks */ header changes

{{3rd-party}}
Bigshot is a fully automated hunting script for GemStone IV. It handles combat routines, movement to and from hunting areas, target selection, and attack execution.
AFK scripting on any server other than Shattered is a violation of game policy.
{{TOCright| limit=2}}
==Changelog==
*[[Script Bigshot/Changelog|Script Bigshot Changelog]]
==About Bigshot==
===What Does Bigshot Do?===

Using a series of menus and command inputs, Bigshot lets you create a modular, customizable, and fully automated hunting script. With just a few clicks and tweaks, you can go from scripting rats to the Rift.

===How Do I Get It?===

Grab it from the repository: <CODE>;repository download Bigshot</CODE>

===How Do I Make It Go?===
Initial setup is accessed through <CODE>;bigshot setup</CODE>. This opens a configuration window with several tabs for setting up your hunting routine.

As with most scripts, the SETUP command opens a graphical user interface. Use <CODE>;bigshot setup</CODE> to open the dialog. The window contains the following tabs:
* '''Profile''' - Save and load profile configurations. Profiles are saved to your <CODE>\Lich5\data\<GSServer>\<charname>\bigshot_profiles</CODE> directory (e.g., <CODE>\Lich5\data\GSIV\Rinualdo\bigshot_profiles</CODE>). Note: if you previously used Bigshot, the file location has changed from the old <CODE>\Lich5\scripts\bigshot_profiles</CODE> folder. You can copy/paste your old profiles to the new location.
* '''Resting''' - Configure your resting routine, rest location, and conditions that trigger resting.
* '''Hunting''' - Create a hunting map using boundaries, set your starting room, configure attack/wander stances, and define pre-hunt behavior.
* '''Attacking''' - Configure ambush aiming, flee conditions, bless behavior, weapon reactions, and similar combat flags.
* '''Commands''' - Define your valid targets and associated attack routines. See sample routines below.
* '''Boon Creatures''' - Configure how Bigshot handles boss/boon creatures on a per-ability basis (fight, ignore, or flee).
* '''Misc''' - UAC options, MSTRIKE options, ammo/wand configuration, and MA grouping settings.
* '''Monitoring''' - Interaction monitoring, deadman's switch, depart behavior, and debug options.

Each tab is covered in detail further on.

===Other Commands===
Beyond the setup GUI, Bigshot has several command-line options:
* <CODE>;bigshot quick</CODE> - A special hunting mode that kills everything in your current room, then quits. It will not wander or attempt to rest. Uses its own separate hunting commands and targets (configured on the Commands tab).
* <CODE>;bigshot head</CODE> / <CODE>;bigshot tail</CODE> - Multi-account hunting on a single computer. All characters must be set up for the same hunting area. Following characters run <CODE>;bigshot tail</CODE>, then the leader runs <CODE>;bigshot head</CODE>. The leader can optionally specify the expected group size, e.g., <CODE>;bigshot head 3</CODE>. Head and tail can be started in any order.
* <CODE>;bigshot display</CODE> - Shows all your current settings.
* <CODE>;bigshot reset</CODE> - Resets your targetable and untargetable lists. Useful if Bigshot will not target something it should.
* <CODE>;bigshot ranger</CODE> or <CODE>;bigshot companion</CODE> - Resets the ranger companion setting so you can reconfigure it. Use this when you change your companion.
* <CODE>;bigshot profile save <name></CODE> - Saves a profile in YAML format to your character's profile folder. Also accessible via the Profiles tab.
* <CODE>;bigshot profile load <name></CODE> - Loads a profile from your character's profile folder. Also accessible via the Profiles tab.
* <CODE>;bigshot single</CODE> - Executes a single hunting routine, returns to your resting location, and then exits.
* <CODE>;bigshot list</CODE> - Displays all initialized variable values (useful for troubleshooting).
* <CODE>;bigshot test <method> <args></CODE> - Runs a specific internal method for testing purposes.
* <CODE>;bigshot <creature></CODE> - Any input that does not match the above commands defaults to ranger tracking (e.g., <CODE>;bigshot single giant rat</CODE> will track and hunt a giant rat).

==The Profile Tab==
* '''Load Profile''' - Load an existing saved profile. The dropdown will be empty if no profiles have been saved yet.
* '''Current Profile''' - Displays the name of the currently loaded profile.
* '''Save Profile''' - Enter any name for your profile and click Save. Once saved, the profile will appear in the Load Profile dropdown.
* '''Notes''' - A freeform text area for any notes you want to associate with the profile.

==The Resting Tab==
This tab controls where and how Bigshot rests between hunts. During rest mode, Bigshot checks your mind state, hit points, wound status, mana, and spirit. Once all conditions defined in the "Should Hunt?" section are met, Bigshot leaves rest mode and begins a new hunt.

===Where to Rest===
* '''room id''' - The room Bigshot returns to for resting. Uses room numbers from Map/Go2. Supports both Lich IDs and SimuIDs (prefix SimuIDs with "u", e.g., <CODE>228</CODE> for Town Square Central or <CODE>u7120</CODE>).
* '''return waypoints''' - Optional intermediate room IDs that Bigshot will pass through when returning to rest. Separate multiple waypoints with commas.
* '''pre-rest commands''' - Commands executed before entering rest mode. Example: <CODE>shea, wear shield, sit, stance offensive, rest</CODE>. This will sheathe your weapon, wear your shield, sit down, enter offensive stance, and use the REST verb. You can also call scripts here using the <CODE>script</CODE> prefix, e.g., <CODE>script go2 place</CODE>.
* '''active resting scripts''' - Scripts that run upon entering rest mode for between-hunt tasks such as selling loot, spelling up, or healing. Example: <CODE>eloot sell, waggle, eherbs</CODE>. This will sell via eloot, spell up via waggle, then use herbs from your PACK to heal wounds.
* '''Fog Option''' - Determines how Bigshot returns to rest. Options include:
** '''None''' - Walk normally (no teleportation).
** '''130''' - Uses [[Spirit Guide (130)]] first; falls back to Symbol of Return if it fails.
** '''Symbol of Return''' - Uses Voln [[Symbol of Return]] first; falls back to 130 if it fails.
** '''Traveler's Song (1020)''' - Attempts [[Traveler's Song (1020)]] once, then continues.
** '''Familiar Gate (930)''' - Attempts [[Familiar Gate (930)]] to summon a portal and walk through it. Will perform a mana pulse if not enough mana is detected.
** '''Sigil of Escape''' - Uses [[Sigil of Escape]].
** '''Custom''' - Allows a comma-separated list of custom commands to perform.
* '''Fog ONLY if wounded or encumbered''' - When checked, Bigshot will only use the fog option if you are actually wounded or encumbered. Otherwise it walks normally.
* '''Fog twice from the Rift''' - When checked, Bigshot will double-cast the fog spell when returning from the Rift (useful since the Rift requires two uses to escape).

===Should Rest?===
Bigshot evaluates these conditions to decide when to leave a hunt and return to rest.
* '''when percent mind >='''
** Triggers resting when your mind has reached this threshold. Generally set to 100 (fried). Default is 100.
* '''and extra kills >='''
** The number of additional monsters to kill after reaching your "when percent mind" threshold and after LTE boosts are used. Set to 0 to rest immediately upon reaching the mind threshold.
* '''and used lte boosts >='''
** The number of LTE (Long-Term Experience) boosts Bigshot will attempt to use after reaching the mind threshold. Set to 0 to skip LTE boosts entirely.
* '''or percent mana <='''
** Forces Bigshot to rest when your mana percentage is at or below this value. Can be set to 0, but leaving a small buffer is useful (e.g., for Unlock (406) to open the WL Graveyard gate). If you encounter an "OOM" error, try setting this to 1.
* '''or percent encumbrance >='''
** Forces Bigshot to rest when your encumbrance reaches or exceeds this percentage.
* '''or wounded eval'''
** Allows you to set a Ruby evaluation expression to determine if you are too wounded to continue. Can trigger on bleeding, specific wound levels, inability to cast, scars, and more.

The following is a wounded evaluation that will rest whenever you have any level II wounds:
<PRE>XMLData.injuries.any?{|key,value| value["wound"] > 1} || Char.percent_health <= 70</PRE>
The following is a wound evaluation that will take you home if you can no longer cast (bleeding, nerves, level 2 head/eyes, bad scars, etc.):
<PRE>bleeding? || Char.percent_health <= 25 || [Wounds.head, Scars.head, Wounds.leftEye, Scars.leftEye, Wounds.rightEye, Scars.rightEye, Wounds.nsys, Scars.nsys].max > 1 || [Wounds.leftArm, Wounds.leftHand, Wounds.rightArm, Wounds.rightHand, Scars.leftArm, Scars.leftHand, Scars.rightArm, Scars.rightHand].max > 2 || ([Wounds.leftArm, Wounds.leftHand, Scars.leftArm, Scars.leftHand].max + [Wounds.rightArm, Wounds.rightHand, Scars.rightArm, Scars.rightHand].max) >= 3</PRE>
The following can be appended to either wound evaluation above to also rest upon having popped muscles:
<PRE>|| Effects::Debuffs.active?("Overexerted")</PRE>

* '''when creeping dread >='''
** Forces Bigshot to rest when your creeping dread level reaches or exceeds this value.
* '''when crushing dread >='''
** Forces Bigshot to rest when your crushing dread level reaches or exceeds this value.
* '''Wall of Thorns Poison'''
** Forces Bigshot to rest when you are affected by Wall of Thorns poison.
* '''Confusion Debuff'''
** Forces Bigshot to rest when you are affected by the non-dispellable Confusion debuff.
* '''Box in hand'''
** Forces Bigshot to rest if looting leaves a box in your hand.

==The Hunting Tab==
This tab controls when and where Bigshot hunts, any pre-hunt preparation, and the map boundaries for wandering.

===The Hunting Map===
Your hunting map consists of '''Boundaries''' (rooms Bigshot will never enter) and a '''Starting Room''' (the first room Bigshot moves to when a hunt begins). These function similarly to the boundaries in the ;Wander script, but are stored in Bigshot's own configuration files.

* '''starting room ID''' - The first room Bigshot travels to when beginning a hunt. Set this to any room within your boundaries.
* '''boundary rooms''' - Rooms that act as walls. Bigshot will never enter a boundary room.

<PRE>X-X-B - A - 0 - 0 - 0
| |
X-X-X</PRE>

In the diagram above, "B" is a boundary room and "A" is outside the hunting area. Rooms marked "0" are the huntable area. Bigshot will wander freely among the "0" rooms but never cross into "B" or "A".

Boundary room IDs are separated by commas. Some popular examples:

'''Rift Boundaries:'''
<PRE>
Plane 1: 2635, 12101, 12208
Plane 2: 2605, 2635, 12093
Plane 3: 2635, 12089, 12152
Plane 4: 12122, 12207, 12235
Plane 5: 2579
North Scatter: 12151, 12254, 12256, 12249, 12247, 12241
South Scatter: 12151, 12219, 12217, 12233, 12237, 12239
</PRE>

'''Maaghara Boundaries:'''
<PRE>9734</PRE>

'''Confluence Boundaries:'''
<PRE>2300, 3519, 228, 188, 1932, 10855, 3668, 1438, 1005</PRE>

Imagine a hunting area that is a six-room square. To enter this square, you must GO DOORWAY from room A. You would set room A (outside the square, before the doorway) as a boundary. Then set room B (just inside the square) as the starting room. Bigshot will move to room B and wander within the bounded area until your "Should Rest?" conditions are met.

* '''rally point rooms''' - Optional intermediate room IDs Bigshot will pass through on the way to the hunting area. Separate multiple rooms with commas.

===Hunting Settings===
* '''wait before wandering to another room''' - Time in seconds Bigshot waits before leaving a room to look for creatures. Default is 0.3. Set to 0 for fastest (but spammy) movement.
* '''attack stance''' - The stance Bigshot switches to when issuing attack commands. Bigshot remains in defensive stance until an attack is triggered, then stances to your specified attack stance. Recognizes all game stances from Offensive through Defensive.
* '''wander stance''' - The stance Bigshot uses while moving between rooms. Defaults to Defensive.
* '''stand up stance''' - The stance Bigshot enters when standing up after being knocked down. Defaults to Defensive.
* '''pre-hunt commands''' - Commands executed before Bigshot uses Go2 to travel to your starting room. Example: <CODE>gird, stance defensive</CODE>. This ensures your weapon is readied and you are in defensive stance before traveling. Use this line for short-lived combat spells like 1605 (Arm of the Arkati).
* '''active hunting scripts''' - Scripts that run while Bigshot is in hunt mode. Use these for complex behaviors that Bigshot does not natively support (e.g., keeping certain spells active or executing CMANs based on conditions).
* '''society abilities/spells/cmans''' - Abilities Bigshot keeps active during a hunt. Enter numerical designations separated by commas. For example, entering <CODE>506</CODE> keeps Haste up, recasting whenever it wears off. Hover over this field in the GUI for a list of supported values. Supported options include spells that can be ignored by rapidfire cooldown: e.g., <CODE>515 (ignore)</CODE> or <CODE>rapidfire (ignore)</CODE>.
* '''loot script''' - The script Bigshot calls to loot your kills (e.g., <CODE>eloot</CODE>). Make sure the loot script is properly configured via its own SETUP command, or Bigshot may error.
* '''wracking spirit >=''' - If your spirit is greater than or equal to this value, Bigshot will WRACK for mana. Setting it to 6 will wrack down to 5 spirit. Only functions when the wracking checkbox is enabled.
* '''Use sign of wracking/sigil of power''' - Checkbox to enable wracking.
* '''Check for favor before using Voln symbols''' - Checkbox to verify you have sufficient favor before casting Voln society symbols.
* '''Priority hunt''' - When enabled, Bigshot targets creatures in the order listed in your valid targets field. If a higher-priority creature enters the room, Bigshot switches to it. When using <CODE>;bigshot quick</CODE>, quickhunt targets take priority, followed by any remaining targets in room order.
* '''Delay looting''' - Delays the looting of creatures in a room.
* '''Defensive stance before looting''' - Switches to defensive stance before looting begins.
* '''Pull players to feet''' - Attempts to pull players to their feet when passing them.
* '''Stop for dead players''' - Pauses Bigshot if you encounter a dead player.
* '''Troubadour's Rally''' - Enables the use of Troubadour's Rally during hunts.
* '''Sneaky Sneaky''' - Sneak around while moving through the hunting area.

===Should Hunt?===
Bigshot evaluates these conditions to determine if you are ready to begin a hunt from rest.
* '''when percent mind <='''
** Setting this to 51 will wait until "Clear". Setting it to 65 will wait until "Muddled".
* '''and percent mana >='''
** The percentage of your maximum mana that must be present before hunting. Setting below 50 results in short hunts if you cast frequently. Generally set to 95 or higher.
* '''and CHECK spirit >='''
** Bigshot checks that your current spirit value is at least this amount. Make sure this is high enough that Bigshot will not immediately hunt after DEPARTing if you have the "Depart / re-run" option enabled on the Monitoring tab.
* '''and percent stamina >='''
** The percentage of your maximum stamina that must be present before hunting. Useful for melee-heavy builds that rely on stamina for CMANs and MSTRIKEs.

==The Attacking Tab==
This tab controls aiming, flee conditions, and various combat behavior toggles.

* '''Ambush aiming locations (head, etc)''' - The order Bigshot aims when ambushing. Default is head, right leg, left leg, chest. Bigshot cycles through these and skips locations that are too injured or unreachable.
* '''Archery aiming locations (head, etc)''' - The order Bigshot aims when using archery attacks. Loops through your aiming list.
* '''flee if enemy count is >''' - Flees the room if the total number of enemies exceeds this value. Set to 1 to engage only single targets.
* '''...but don't count these''' - Bigshot ignores these monsters when evaluating flee count. Useful when low-level monsters are mixed into your hunting area.
* '''...and always flee from''' - Bigshot immediately flees from these monsters. Useful when your hunting area has higher-level or dangerous monsters mixed in.
* '''flee from environment message''' - Bigshot flees whenever the game sends a message matching this text (uses XML regex matching).
* '''wait before wandering to another room''' - Time in seconds before moving to a new room. Default is 0.3. Set to 0 to move instantly (can be spammy for others in the area).
* '''Approach lone targets only''' - Forces Bigshot to only begin combat against creatures that are alone in a room.
* '''Bless weapon?''' - Performs a Consecrate (1604), then a Cleric Bless or Voln Bless on any weapon that loses its bless during hunting. If unable to bless during hunting, Bigshot returns to the rest area and quits.
* '''Activate weapon reactions''' - Initiates reactive strikes when the opportunity presents itself.
* '''Flee from clouds''' - Flees from cloud spells such as 125 (Call Lightning/Ominous Cloud), 1704 (Stun Cloud), and 1713 (Death Cloud).
* '''Flee from vines''' - Flees from vine spells such as 610 (Tangle Weed).
* '''Flee from webs''' - Flees from webs.
* '''Flee from voids''' - Flees from voids.

==Commands Tab==
This is the core of Bigshot — where you define your attack routines.

===Hunting Commands===
* '''hunting commands (a)''' - The primary commands Bigshot executes when in a room with a valid target. Commands are separated by commas. Bigshot recognizes most hunting verbs; unrecognized commands are sent directly as-is via fput. The following are recognized hunting commands:
** '''kill''' - Attacks using the KILL verb.
** '''incant <spell number>''' - Casts the specified spell with INCANT. Automatically stances into offensive for bolt and stance-sensitive spells. You can CHANNEL via <CODE>INCANT SET CHANNEL <spell></CODE> (a standard GSIV verb) or by setting <CODE>SET ChannelIncant ON</CODE>, which will CHANNEL an INCanted spell if you are in a stance higher than neutral.
** '''channel <spell number>''' - Channels the specified spell at the target. Requires a stance higher than neutral to have effect.
** '''<spell number>''' - Casts the specified spell using PREPARE and CAST.
** '''wand''' - Gets a wand from your specified container and WAVEs it at the target.
** '''wandolier''' - Similar to wand, but designed for wandoliers. Gets a wand from the fresh wand container and waves it; rubs the container if no wands are found. Default waves in offensive stance. Use <CODE>wandolier defensive</CODE> to wave in a different stance.
** '''fire''' - Gets ammunition from your specified container and FIREs at the target. Aims based on Archery aiming settings on the Attacking tab.
** '''aim <location>''' - Aims at the specified body location.
** '''ambush''' - Uses the AMBUSH verb to attack, aiming based on Attacking tab settings. Can also aim dynamically: <CODE>ambush head</CODE> overrides default settings for that attack.
** '''wait <time>''' - Stance dances by going into Defensive stance for the specified time (in seconds). Bigshot will exit early if the target swings or casts, then evaluate the rest of the attack routine from your attack stance.
** '''mstrike''' - Executes MSTRIKE based on cooldown and stamina. Has its own options page under the Misc tab. Can also be used with UAC: <CODE>mstrike punch</CODE>.
** '''berserk''' - Executes the BERSERK verb and waits until it fades.
** '''throw''' - Empties hands, attempts throw, then retrieves the items you emptied.
** '''weed/kweed''' - Casts 610 at the target. Using <CODE>kweed</CODE> forces EVOKE 610, ensuring the damage version.
** '''curse <type>''' - Preps 715 and uses the specified curse type. Valid types: Clumsy, Weakness, Darkness, Itch, Hex, Pox, Nightmare, Star. Skips "curse star" if the buff is already active.
** '''unarmed <type>''' - Uses the Bigshot UAC routine. Valid types: punch, jab, kick, grapple. The routine uses appropriate attacks to rank up and applies MSTRIKE based on MSTRIKE options. Example: <CODE>unarmed jab</CODE>.
** '''smite''' - Performs an [[Order of Voln]] [[Kai's_Smite|Smite]] on the target until successful.
** '''leech''' - Performs a [[Mana Leech (516)]] on the target if cooldown is under 15 minutes.
** '''script <script name>''' - Executes a specified custom attack script.
** '''hide''' - Repeatedly attempts to hide until successful or gives up.
** '''sleep <nostance>''' - Pauses Bigshot for the specified number of seconds. Example: <CODE>sleep 10</CODE> or <CODE>sleep 10 nostance</CODE>. Useful for timed hunting, e.g., <CODE>410, sleep 15</CODE> will E-wave, then wait 15 seconds before re-evaluating.
** '''stance <stance>''' - Changes stance. Example: <CODE>stance defensive</CODE>.
** '''nudgeweapons''' - Moves all weapons on the ground to an adjacent room. Useful for casting Implosion (720).
** '''force <cmd> until <endroll>''' - Repeats a command until a desired endroll is achieved. Example: <CODE>force incant 1002 until 101</CODE>. Only works for standard swings/spells/CMANs.
** '''eachtarget <cmd>''' - Issues the command against each valid target in the room.
** '''efury <fire|cold>''' - Casts Earthen Fury (917) on the target and waits for the DOT to end or 12 seconds to pass.
** '''caststop <spell>''' - Casts the spell and immediately stops it after casting.
** '''wield <noun> <left|right>''' - Wields a new item in the specified hand and stores the current item.
** '''store''' - Stores items in left, right, or both hands (only if something is in those hands).
** '''tether <recast>''' - Casts 706 with built-in wait logic. The optional <CODE>recast</CODE> flag will auto-recast 706 on creature death and transfer DOTs to a new target.
** '''unravel <spell>''' - Casts 1013 (Song of Unravelling). Optionally specify a spell number to target against the creature.
** '''depress''' - Casts 1015 (Song of Depression) with built-in logic.
** '''phase''' - Force-casts 704 (Phase) using PREP/CAST, required for NPC targeting to convert non-corporeal to corporeal undead.

===Additional Command Sets===
* '''hunting commands (b) through (j)''' - Additional attack routines tied to creature flags. When you flag a creature in your valid targets (e.g., <CODE>niirsha(b)</CODE>), Bigshot uses the matching command set. This allows different attack strategies for different creature types.
* '''fried hunting commands''' - Commands executed specifically when your mind is fried. Useful in group hunting where you still want to contribute.
* '''quick hunting commands''' - Commands executed when using <CODE>;bigshot quick</CODE>.
* '''valid targets''' - The monsters you are hunting. Bigshot works best with creature NOUNs (e.g., <CODE>ogre</CODE> instead of <CODE>a large ogre</CODE>). Use commas to separate multiple targets: <CODE>manticore, thrak</CODE>. If left blank, Bigshot will target everything in the room. Supports regex for advanced matching.
* '''quickhunt targets''' - Designated targets for the <CODE>;bigshot quick</CODE> option.

===PSM3 Integration===
Bigshot supports weapon/shield skills and warcries. Assaults wait until they finish or are interrupted. The following are recognized PSM3 commands:

'''Assaults''' (wait until completed/interrupted):
* barrage, flurry, fury, gthrusts, pummel, thrash
* fury can specify a default attack: <CODE>fury punch</CODE> or <CODE>fury kick</CODE> (defaults to jab)

'''Setups''' (execute on cooldown — pair with prone/stun/root checks):
* charge, cripple, dizzyingswing, pindown, twinhammer

'''AOE''' (execute on cooldown — limit with mob checks):
* clash, cyclone, pulverize, volley, wblade, whirlwind

'''Warcries:'''
* '''shout''' - Performs warcry Shout. Must use a command check or it will shout every loop: <CODE>shout(!shout)</CODE> or <CODE>shout(buff10 s25)</CODE>
* '''yowlp''' - Performs warcry Yowlp. Must use a command check: <CODE>yowlp(!yowlp)</CODE> or <CODE>yowlp(buff10 s10)</CODE>
* '''holler''' - Performs warcry Holler, taunting all mobs. Example: <CODE>holler(s60)</CODE>
* '''bellow, growl, cry''' - Offensive warcries. Use with <CODE>target</CODE> for single target or <CODE>all</CODE> for AOE.

'''Shield Skills:'''
* shield bash, shield charge, shield pin, shield push, shield strike, shield trample, shield throw

'''Combat Maneuvers:'''
* '''surge''' - Keeps Surge of Strength active. <CODE>surge</CODE> or <CODE>surge(surge)</CODE> casts even on cooldown; <CODE>surge(!surge)</CODE> only casts when not on cooldown.
* '''bearhug, bullrush, coupdegrace, cpress, cutthroat, dirtkick, disarm, dislodge, divert, eviscerate, exsanguinate, eyepoke, feint, footstomp, garrote, gkick, hamstring, haymaker, headbutt, kifocus, kneebash, leapattack, mblow, mug, nosetweak, sattack, sblow, scleave, shroud, spunch, sthieve, subdue, sunder, sweep, swiftkick, tackle, templeshot, throatchop, trip, truestrike, vaultkick'''
* '''dislodge <location>''' - Dislodge from the specified location: <CODE>dislodge eye neck</CODE>
* '''stomp''' - Performs a stomp attack. Channels 909 if not already active. You can also add 909 to the society abilities field to keep it active.
* '''dhurl''' - Hurls your weapon and recovers it. Works with weapon bonding auto-return and the RECOVER verb.
* '''assume <aspect> <aspect/evoke>''' - Cycles between two aspects, or evokes a single aspect. Also works in the society abilities box: <CODE>650 <aspect> <aspect/evoke></CODE>
* '''briar <weapon>''' - Activates the AS buff on briar weapons. Tracks weapon charge and uses on cooldown.
* '''stance perfection''' - Put 10, 20, 30, etc. in your attack stance box to take advantage of stance perfection.
* '''chastise, excoriate''' - Performs the FEAT if available and affordable.
* '''rebuke''' - Performs Righteous Rebuke.
* '''scourge''' - Performs Ardor of the Scourge.
* '''momentum''' - Performs Glorious Momentum.

===Gemstone Activation===
To use a gemstone-activated ability, use <CODE>jewel <mnemonic></CODE>. Bigshot automatically avoids usage if the ability is on cooldown. Supported gemstone mnemonics:
* bloodboil - Blood Boil
* spellblade - Spellblade's Fury
* arcascend - Arcanist's Ascendancy
* geospite - Geomancer's Spite
* forceofwill - Force of Will
* arcaneintensity - Arcane Intensity
* arcaneopus - Arcane Opus
* bloodsiphon - Blood Siphon
* bloodwell - Blood Wellspring
* epossess - Evanescent Possession
* manawellspring - Mana Wellspring
* spiritwell - Spirit Wellspring
* stamwell - Stamina Wellspring
* terrortribute - Terror's Tribute
* arcblade - Arcanist's Blade
* arcwill - Arcanist's Will
* imaerabalm - Imaera's Balm
* reckless - Reckless Precision
* unearthchains - Unearthly Chains
* witchhunt - Witchhunter's Ascendancy
* manashield - Mana Shield
* arcaneaegis - Arcane Aegis

You may need to run '''SKILLS FULL''', '''CMAN INFO''', '''WEAPON INFO''', or '''SHIELD INFO''' if you have recently changed training or if skills are being skipped.

===Additional Options===
* '''haste''' or '''506''' - Placing this in front of any command casts 506 (Haste) before executing the command. Only casts if Haste is not currently active or has less than 3 seconds remaining.
<PRE>wait 10, haste kill (x3)</PRE>
* '''slayer''' or '''240''' - Placing this in front of any command casts 240 before executing. Will not recast if already active.
<PRE>slayer 302 (x99)</PRE>

===Command Checks===
Command checks let you add conditions to any command. The format is:
<CODE>COMMAND (CHECKS)(REPETITIONS)</CODE>

Example: <CODE>hamstring (mob1 prone)(x2)</CODE>. The (x#) repetition must be in a separate set of parentheses. Note that (xx) is shorthand for (x5), not unlimited.

Checks can be combined inside a single set of parentheses with spaces between them. Example: <CODE>kill(m20 s5 e20)</CODE>

Each check also has an inverse — prefix with <CODE>!</CODE> to negate. Example: <CODE>kill(!m20 !s5 !e20)</CODE>

====Resource and Status Checks:====
* '''s#''' - Requires at least # stamina.
* '''m#''' - Requires at least # mana.
* '''h#''' - Requires health to be at or above #% (percentage, not fixed).
* '''v#''' - Requires at least # spirit.
* '''e#''' - Requires encumbrance percentage to be at or below #.
* '''essence#''' - Requires at least # Shadow Essence (Sorcerer).

====Creature Checks:====
* '''mob#''' - Requires at least # NPCs in the room. Only useful for 2 or more creatures.
<PRE>To further clarify the mob# implementation:
1 mob, mob2: 1 IS less than 2 — attack does NOT proceed.
2 mobs, mob2: 2 IS NOT less than 2 — attack CAN proceed.
1 mob, !mob2: 1 IS NOT more than 2 — attack CAN proceed.
2 mobs, !mob2: 2 IS NOT more than 2 — attack CAN proceed.
3 mobs, !mob2: 3 IS more than 2 — attack does NOT proceed.</PRE>
* '''valid#''' - Like mob#, but only counts valid targets you are actively targeting in current settings.
* '''tier#''' - Checks your current UAC tier (1, 2, 3). Performs the command if your tier is equal to or greater than #. <CODE>(!tier3)</CODE> skips the command at tier 3.
* '''prone''' - Checks that the target is NOT sleeping, webbed, stunned, kneeling, sitting, lying down, prone, frozen, or held in place. Performs the command if none of those apply.
* '''frozen''' - Similar to prone but broken out separately. Useful for archers against non-corporeal creatures that deflect ranged attacks. Corporeal creatures that are stunned will break this check.
* '''undead''' - Performs the command if the target is undead.
* '''flying''' - Performs the command if the target is flying.
* '''rooted''' - Performs the command if the target is rooted.
* '''noncorporeal''' - Performs the command if the NPC is [[noncorporeal|non-corporeal]] undead.
* '''ancient''' - Checks for grizzled/ancient creatures.

====Self Checks:====
* '''hidden''' - Performs the command if you are currently hidden.
* '''poison''' - Performs the command if you are currently poisoned.
* '''disease''' - Performs the command if you are currently diseased.
* '''pcs''' - Performs the command if there are PCs in the room that are not in your group.
* '''outside''' - Performs the command if the room is outdoors.
* '''splashy''' - Checks if the room is "splashy" (wet) via Room.tags. Useful for avoiding lightning attacks in wet rooms.

====Timing Checks:====
* '''once''' - Performs the command once per target. Resets on room change.
* '''room''' - Performs the command once per room. Resets on room change.

====Buff Checks:====
* '''barrage''' - Checks for the Enhanced Dexterity buff from Barrage.
* '''fury''' - Checks for the Enhanced Constitution buff from Fury.
* '''flurry''' - Checks for the Slashing Strikes buff from Flurry.
* '''pummel''' - Checks for the Concussive Blows buff from Pummel.
* '''thrash''' - Checks for the Forceful Blows buff from Thrash.
* '''vigor''' - Checks for the Tangleweed Vigor buff.
* '''reflex''' - Checks for the Arcane Reflex buff from Nature's Touch.
* '''tailwind''' - Checks for the Tailwind buff from Breeze.
* '''shout''' - Checks for the Empowered buff from Shout.
* '''yowlp''' - Checks for Yertie's Yowlp buff from Yowlp.
* '''holler''' - Checks for Horland's Holler buff from Holler.
* '''voidweaver''' - Checks for the Voidweaver buff from Implosion (720).
* '''justice''' - Checks for charges of Swift Justice. <CODE>(justice)</CODE> acts with charges; <CODE>(!justice)</CODE> acts with no charges.
* '''surge''' - Checks for Surge of Strength buff.
* '''rebuke''' - Checks for Righteous Rebuke buff.
* '''scourge''' - Checks for Ardor of the Scourge buff.
* '''momentum''' - Checks for Glorious Momentum buff.
* '''coupdegrace''' - Checks for the Empowered buff from Coup de Grace.
* '''animate''' - Checks for whether you have an animate present.
* '''buffXX''' - Fires the ability when the buff duration is <= XX seconds. Supported for barrage, bearhug, coupdegrace, fury, flurry, pummel, thrash, shout, yowlp, garrote.
* '''censer''' - Attempts to cast 320 before your command, checking mana and cooldown. Examples: <CODE>309(censer)</CODE>, <CODE>335(censer mob3)</CODE>, <CODE>attack(censer)</CODE>
** If the command is a spell, censer only casts if you have mana for both 320 and the spell.
** If the command is not a spell, censer only checks you have enough mana for 320.

====Effects Checks:====
* '''ES"Effect to Track"''' - Checks if the Effects::Spells effect is active
* '''EB"Effect to Track"''' - Checks if the Effects::Buffs effect is active
* '''EC"Effect to Track"''' - Checks if the Effects::Cooldowns effect is active
* '''ED"Effect to Track"''' - Checks if the Effects::Debuffs effect is active

===Example Attack Routines===
<PRE>wait 10, kill (x3)</PRE>
Waits 10 seconds for the monster to swing or cast, then counter-attacks from your specified attack stance. Swings three times, then goes back to defensive and waits again.

<PRE>wait 15, incant 505, incant 903 (xx)</PRE>
Waits 15 seconds, then INCants 505 (Hand of Tonis) to knock down or stun the target. Follows up with repeated casts of 903 (Minor Water) until the target is dead (up to 5 times).

<PRE>stance defensive and incant 1615, kill (x100)</PRE>
Casts 1615 (Divine Strike) from defensive stance, then uses KILL continuously until the target is dead or 100 swings (whichever comes first).

<PRE>force feint until 101, kill (x2)</PRE>
Uses FEINT against the target until a successful endroll, then hits twice before trying FEINT again.

<PRE>stance defensive and hide, ambush left leg</PRE>
Hides from defensive stance, then ambushes the target's left leg. Repeats (hides again) after roundtime.

<PRE>incant 720(m50), incant 708, incant 702 channel(xx)</PRE>
Casts 720 (Implosion) if you have 50+ mana, then INCants 708 (Limb Disruption) at the default aim location, then channels 702 (Mana Disruption) up to 5 times or until dead.

<PRE>prep 708, cast at left leg / prep 708 channel at left leg, incant 719 (m50)(x1), incant 702 (xx)</PRE>
Prepares 708 and CASTs at the left leg. The second variant prepares and CHANNELs at the left leg. Then casts 719 (Dark Catalyst) once if 50+ mana. Finally, INCants 702 until the creature is dead.

<PRE>wait 30, unarmed punch</PRE>
Waits 30 seconds or until the target attacks, then begins UAC combat using Punch to tier up.

<PRE>shield charge (s15 prone), ambush, mstrike</PRE>
Shield charges the target if you have 15+ stamina and the target is NOT prone. Then ambushes based on Attacking tab settings (cycling through configured aim locations). Then MSTRIKEs — focused if below the creature threshold, unfocused if at or above it. Use <CODE>mstrike target</CODE> to always focus, or set unfocused threshold very high.

<PRE>bellow all, wblade(mob3), flurry(!flurry), attack</PRE>
AOE bellows, then Whirling Blade if 3+ targets. Flurries if the Slashing Strikes buff is not active. Falls back to basic attack.

<PRE>holler, shield throw(mob3), flurry, thrash, attack</PRE>
Taunts with Holler, Shield Throws if 3+ targets, Flurries on cooldown, Thrashes on cooldown, and attacks as a fallback.

<PRE>shroud(s35 !hidden mob2), divert (s25 hidden mob2), ambush(hidden), flurry, attack</PRE>
If 2+ mobs: hides with Shroud (35 stamina, not already hidden), then Diverts one target (25 stamina, must be hidden). Ambushes if hidden, Flurries on cooldown, attacks as fallback.

<PRE>surge(!surge), bullrush, bearhug, pummel, attack</PRE>
Keeps Surge active (casting only when not on cooldown). Bullrush to apply vulnerable, Bearhug (faster on vulnerable targets), Pummel on cooldown, attack as fallback.

<PRE>surge, shout(buff10), shield strike, pummel(buff60), attack(x2)</PRE>
Keeps Surge active (casting even during cooldown for 60 stamina). Shouts when less than 11 seconds remain on the buff. Shield Strikes, Pummels once per minute, finishes with 2 attacks.

<PRE>pindown(mob4), volley(mob2), weed(!vigor !reflex), barrage(!barrage), incant 616 (m16 reflex), fire</PRE>
Pin Down if 4+ targets, Volley if 2+ targets. Tangleweed if missing Vigor and Reflex buffs. Barrage if missing Enhanced Dexterity. Spike Thorn (616) if 16+ mana and Arcane Reflex is active. Fire as fallback.

===Hunting Target Examples===
All examples below work for both "valid targets" and "quickhunt targets."

A simple target list using default commands (a) for each creature:
<PRE>crazed zombie, niirsha, sacristan spirit</PRE>

Using different command sets per creature — (a) for zombies and spirits, (b) for niirsha:
<PRE>crazed zombie(a), niirsha(b), sacristan spirit(a)</PRE>

Including [[:Category:Boss creatures|Boss Creature]] variations as valid targets using regex:
<PRE>(?:adroit |afflicted |apt |barbed |belligerent |blurry |canny |combative |dazzling |deft |diseased |drab |dreary |ethereal |flashy |flexile |flickering |flinty |frenzied |ghastly |ghostly |gleaming |glittering |glorious |glowing |grotesque |hardy |illustrious |indistinct |keen |lanky |luminous |lustrous |muculent |nebulous |oozing |pestilent |radiant |raging |ready |resolute |robust |rune-covered |shadowy |shielded |shifting |shimmering |shining |sickly green |sinuous |slimy |sparkling |spindly |spiny |stalwart |steadfast |stout |tattooed |tenebrous |tough |twinkling |unflinching |unyielding |wavering |wispy )?crazed zombie, niirsha, sacristan spirit</PRE>

Advanced regex for Grimswarm hunting with different commands per class:
<PRE>
(?:seasoned |grizzled |battle-scarred |weathered |veteran |hulking |haggard )?Grimswarm (?:giant|troll|orc) (?:dissembler|sorcerer|sorceress|warlock|witch)(a)
(?:seasoned |grizzled |battle-scarred |weathered |veteran |hulking |haggard )?Grimswarm (?:giant|troll|orc) (?:barbarian|blackguard|fighter|marauder|soldier|warrior)(b)
(?:seasoned |grizzled |battle-scarred |weathered |veteran |hulking |haggard )?Grimswarm (?:giant|troll|orc) (?:adept|archmage|elementalist|mage|warmage)(c)
(?:seasoned |grizzled |battle-scarred |weathered |veteran |hulking |haggard )?Grimswarm (?:giant|troll|orc) (?:hunter|huntmaster|huntmistress|ranger)(d)
(?:seasoned )?(?:dwarven|elven|halfling|erithian|human|giantman|half-krolvin|gnomish|half-elven) (?:thief|rogue|bandit|mugger|outlaw|highwayman|marauder|brigand|thug|robber)(e)
(?:shopkeeper|innkeeper|bartender|patrol leader|bandit lord|bandit lady|gypsy queen|gypsy king|guard captain|wall captain|drill sergeant|stable hostler|dungeon master|master torturer|butler|cook|
knight captain|foreign dignitary|royal prince|royal princess|royal jester|royal emperor|royal empress)(f)
</PRE>

To target everything in the room: <CODE>(?:.*)</CODE>

==Boon Creatures Tab==
Boss creatures (also called the Boss Creature System) upgrades newly created creatures into bosses, minibosses, or packs. Upgraded creatures have their level and basic stats boosted, and are granted a number of special abilities called '''boons''', which are denoted by a special adjective in the creature's name. Players have alternatively called these "glam critters," "gifted creatures," or "boosted critters."

Additional details are available on the GemStone Wiki: [https://gswiki.play.net/Category:Boss_creatures Category:Boss creatures]

The Boon Creatures tab provides granular control over how Bigshot handles each boon ability. Bigshot uses the ASSESS verb to identify which boons a creature has, then checks your configuration to decide how to respond.

===How It Works===
For each boon ability, you can choose one of three actions:
* '''Common''' - Treat as a normal target and fight it. Uses your hunting commands to kill. Still requires proper valid target matching to engage. This is also the default behavior if no selection is made.
* '''Ignore''' - Skip this creature entirely; do not engage it.
* '''Flee''' - Immediately flee from the room when this boon type is detected.

===Master Toggle===
At the top of the tab is an '''All Boon Creatures''' section with Common, Ignore, and Flee checkboxes. These act as master toggles — checking one will set every individual boon ability across all groups to that action. If all individual items are already set to the same action and you uncheck the "All" toggle, everything gets unchecked.

===Boon Groups===
The individual boon abilities are organized into four collapsible groups, each with its own group-level toggle row ("Entire Group") and individual per-ability rows:

====Immunity====
Boons that make the creature resistant or immune to certain damage types or effects.
{| class="wikitable"
! Boon !! Adjectives !! Notes
|-
| Crit Death Immune || resolute, unflinching || Similar to constructs or golems
|-
| Damage Padding || flinty, tough ||
|-
| Elem Negation || sparkling, shining || Absorbs elemental magic attacks
|-
| Magic Resistance || rune-covered, tattooed || Reduces magic damage by 50%
|-
| Physical Negation || indistinct, nebulous || Physical damage resist shield
|-
| Stun Immune || steadfast, unyielding ||
|}

====Offensive====
Boons that enhance the creature's offensive capabilities.
{| class="wikitable"
! Boon !! Adjectives !! Notes
|-
| Boosted Offense || combative, belligerent ||
|-
| Cheat Death || glorious, illustrious || Raises self after death
|-
| Counter Attack || apt, ready || SMR counter-attack
|-
| Crit Weighting || shimmering, gleaming ||
|-
| Dmg Weighting || barbed, spiny ||
|-
| Dispelling || dazzling, flashy || Spirit Dispel (119) and Elem Dispel (417)
|-
| Elemental Flares || glittering ||
|-
| Frenzy || raging, frenzied ||
|-
| Mind Blast || canny, keen ||
|-
| Parting Shot || dreary, drab || Deals damage one last time upon death
|-
| Poisonous || sickly green, oozing || SMR poison gas cloud
|}

====Defensive====
Boons that enhance the creature's defensive capabilities.
{| class="wikitable"
! Boon !! Adjectives !! Notes
|-
| Blink || flickering, wavering || Temporary phase ability
|-
| Bolt Shield || shielded ||
|-
| Boosted Defense || sinuous, flexile || High damage padding (+12 CER)
|-
| Confuse || blurry, shifting || May give hard RT for casting at them
|-
| Crit Padding || stout, hardy ||
|}

====Stats / Misc====
Boons that affect the creature's stats, resistances, or grant miscellaneous special abilities.
{| class="wikitable"
! Boon !! Adjectives !! Notes
|-
| Boosted HP || robust, stalwart ||
|-
| Boosted Mana || luminous, lustrous ||
|-
| Diseased || pestilent, afflicted, diseased ||
|-
| Extra Spells - Elem || glowing ||
|-
| Extra Spells - Spirit || radiant ||
|-
| Extra Spells - Other || twinkling ||
|-
| Ethereal || ethereal, wispy, ghostly || Noncorporeal undead. No Sheer Fear.
|-
| Jack of All Trades || adroit, deft ||
|-
| Regeneration || slimy, muculent || Similar to Troll's Blood (1125)
|-
| Soul Stealing || tenebrous, shadowy || May possess 1204, 1601, and 1712
|-
| Terrifying || ghastly, grotesque || Pre-attack SMR can force player into defensive
|-
| Weaken || spindly, lanky || Weaker creature than normal
|}

===Usage Tips===
* If you are a melee character who struggles with '''Stun Immune''' or '''Crit Death Immune''' creatures, set those to Ignore or Flee while leaving others on Common.
* Casters may want to Flee from '''Dispelling''' and '''Magic Resistance''' boons.
* '''Weaken''' is actually beneficial — the creature is weaker than normal, so leaving it on Common is usually best.
* '''Cheat Death''' creatures will revive after dying; consider Ignore if your build cannot handle killing them twice.
* The configuration is saved per profile, so you can have different boon strategies for different hunting areas.

== Misc Tab==
Various specialized configuration options.

===UAC Options===
Options for configuring Unarmed Combat (UAC):
* '''Tier 3 Attack''' - The attack used when you have reached "excellent" positioning. Options: jab, punch, grapple, or kick.
* '''Aim at location (head, etc)''' - Used for aimed UAC combat, which requires ambush training to be effective. Leave blank if you do not want to aim.
* '''MSTRIKE when creatures equal or greater''' - How many creatures must be present before using MSTRIKE during UAC.
* '''Use Voln SMITE?''' - Will perform a Voln SMITE on [[Non-corporeal]] undead.

'''Quick Setup:''' Bigshot only requires minimal configuration for UAC to work well:
# '''UAC options:''' Set your '''Tier 3 Attack''' (jab, punch, grapple, or kick).
# '''Commands tab:''' Set your '''hunting commands (a)''' to '''unarmed jab'''.

Important notes about UAC in Bigshot:
* <CODE>unarmed jab</CODE> can be replaced with any UAC attack type (e.g., <CODE>unarmed punch</CODE>).
* UAC follow-up strikes take priority over the base or Tier 3 attack.
* Tier 3 attacks are only used when positioning is "excellent".
* There is almost no reason to use anything other than <CODE>unarmed jab</CODE> as the hunting command and either <CODE>grapple</CODE> or <CODE>kick</CODE> as the Tier 3 attack.

===MSTRIKE Options===
Options for when and how MSTRIKE should be used:
* '''MSTRIKE during cooldown stamina requirement''' - How much stamina you need before Bigshot will MSTRIKE during the MSTRIKE cooldown period. Be careful setting this too low, as it can pop your muscles. Leave blank to use your max stamina.
* '''QUICKSTRIKE stamina requirement''' - Stamina required for using QUICKSTRIKE during the MSTRIKE routine.
* '''Unfocused MSTRIKE when creatures equal or greater''' - Number of creatures in the room before Bigshot uses an unfocused (AOE) MSTRIKE instead of a focused one. Default is 2.
* '''MSTRIKE during cooldown''' - Toggle to allow MSTRIKEing during the cooldown period.
* '''Use QUICKSTRIKE for MSTRIKE''' - Toggle to use QUICKSTRIKE instead of normal MSTRIKE.

===Ammo/Wands===
Settings for ammunition and wand management. If your attack routine uses FIRE or WAND verbs, these fields must be configured or Bigshot will hang.

* '''find ammo in this container''' - The container holding your ammunition (quiver, backpack, etc.). Leave BLANK if using FIRE without retrieving ammo (post-Archery 2020 Update).
* '''use this ammo type''' - The noun of your ammo type. Leave BLANK to use FIRE without retrieving ammo. Be precise with the noun — Bigshot is sensitive to exact naming here.
* '''fresh wand container''' - The container Bigshot checks for fresh wands to WAVE.
* '''dead wand container''' - The container where Bigshot deposits used-up wands.
* '''use this wand type''' - The specific wand type(s) to use. Bigshot only pulls these for WAVEing. Separate multiple types with commas. Example: <CODE>aquamarine wand, bloodwood wand</CODE>
* '''Hide while waiting to pick up ammo''' - Bigshot will hide when gathering spent arrows and bolts.
* '''Use wands when out of mana''' - When out of mana, Bigshot pulls the specified wand type, stances to your attack stance, and WAVEs at valid targets until out of wands or resting conditions are met.

===MA Grouping===
Multi-account grouping options:
* '''Looter name''' - The name of the character designated as the looter in Head/Tail configuration.
* '''No-looting list''' - Comma-separated list of characters who should never be assigned looting duty.
* '''Random looting''' - Distributes looting randomly based on encumbrance rather than assigning a fixed looter.
* '''Leader final loot''' - Allows the leader to perform a final loot pass before leaving a room.
* '''Travel TO hunting grounds independently''' - When enabled, group members travel to the hunting area on their own rather than as a group. Bigshot will disband the group and force GROUP OPEN after disbanding.
* '''Travel FROM hunting grounds independently''' - When enabled, group members return from the hunting area on their own.
* '''Stop for dead group members''' - Pauses the group if a follower dies during a hunt.

==Monitoring Tab==
Options for safety, interaction monitoring, and debugging.

* '''Monitor interaction''' - Pops up a window whenever Bigshot detects that someone or something is trying to interact with you. Customizable monitor strings and safe strings can be configured.
* '''Engage deadman's switch''' - Forces Bigshot to quit GemStone IV when your character drops below 40% health, allowing you to log back on and assess the situation manually.
* '''Depart/rerun if dead''' - Forces a DEPART (waking up in the Temple with low spirit), then restarts Bigshot for a fresh hunt. Make sure your "CHECK spirit >=" value in Should Hunt? is set high enough to recover before the next hunt.
* '''Quiet followers''' - Followers wait until the leader finishes both actions and resting scripts before beginning their own.
* '''Ignore disk objects''' - Ignores disk objects when evaluating room claims and other checks.

===Debugging===
Bigshot provides detailed debug options for troubleshooting. Use these commands in-game:
<pre{{log2}}>
+---------------------------------------------------------------------------+
| Bigshot Debug Help v5.11.4 |
+---------------------------------------------------------------------------+
| Debug options have changed to be more helpful. |
+--------------------------------------+------------------------------------+
| ;bigshot debug file | Toggles logging to a file <on/off> |
| ;bigshot debug all <true/false> | Toggles true/false all the things |
| ;bigshot debug check | Lists current debug settings |
| ;bigshot debug combat <true/false> | Combat and Creature Status |
| ;bigshot debug commands <true/false> | Attacking and Casting Commands |
| ;bigshot debug status <true/false> | Status Checks of your Character |
| ;bigshot debug system <true/false> | System processes |
| | |
| Options can be combined: |
| ;bigshot debug combat commands status <true/false> |
+---------------------------------------------------------------------------+
</pre>

Debug log files are stored in your Lich5 logs directory under <CODE>debug/<Game>-<CharacterName>/bigshot.log</CODE> and rotate daily.

==Ingame Screenshot==
<gallery perrow="4">
File:bigshot-1.PNG|Profiles
File:bigshot-2.PNG|Resting
File:bigshot-3.PNG|Hunting
File:bigshot-4.PNG|Attacking
File:bigshot-5.PNG|Commands
File:bigshot-6.PNG|Misc
File:bigshot-7.PNG|Monitoring
</gallery>

==Reference==
* Info originally taken from http://forum.gsplayers.com/showthread.php?t=57651

{{Third-Party Software}}
{{top}}

Lich:Software/Installation

2026-01-30T21:38:17Z

WHIGHTCNIGHT: /* Fedora */ use bundle install instead of individual gem install

Lich:Software/Installation

2026-01-30T21:36:46Z

WHIGHTCNIGHT: /* Arch Linux & Arch-based distributions */ update to use BUNDLE INSTALL instead of individual gems

Lich:Software/Installation

2026-01-30T21:36:03Z

WHIGHTCNIGHT: /* Chromebook & Debian variants */ update to use BUNDLE INSTALL instead of individual gems

Lich:Software/Installation

2026-01-15T17:05:56Z

WHIGHTCNIGHT: /* Lich 5 Only */ update Lich5 only directions

Sailor's Grief

2025-12-11T15:45:31Z

WHIGHTCNIGHT: change to redirect to actual main content page

#REDIRECT [[:Category:Sailor's Grief creatures]]

File:Tysong Wiki.jpg

2025-10-27T19:53:37Z

WHIGHTCNIGHT:

Tysong's official SimuCon portrait, by Josh Stover

Lich:Script Ebounty

2025-09-08T16:05:33Z

WHIGHTCNIGHT: /* Changelog */ updated to 1.7.2

{{3rd-party}}
Ebounty is management script for handling Bounties from the [[Adventurer's Guild]].
Afk scripting on any server but Shattered is in violation of game policy.

==What Does Ebounty Do?==

Ebounty will handle the management for Adventurer's Guild tasks. It utilizes a primary workflow of
<PRE>Find acceptable tasks. If acceptable task can not be found, execute the default Bigshot routine. If a task is available, execute the task and then turn in if not saturated. When bounty timer is up, grab a new task. Repeat. </PRE>

==How Do I Get It?==

Eloot can be downloaded via <CODE>;repo download ebounty</CODE>

As a script in active development and with the constant state of changes in the game, it is recommended to set ebountyand all Elanthia-Online scripts to auto-update via <CODE>;repo set-updatable ebounty</CODE>

==How Do I Make it GO!?==
Initial setup is accessed through ;ebounty setup. There you will see a configuration window with various tabs to configure for your guild tasks. Presently Ebounty is designed to utilize [[Bigshot]] for it's attack related parameters, and will run a bigshot routine when there is no available active bounty.
'''Bigshot profiles need to be configured inside Bigshot before they can be utilized in Ebounty'''.

As with most scripts, using a SETUP command will open a graphical user interface for configuring the script. Use ;ebounty setup to open this dialog. This will open a window with the following tabs:
* General - This is where you tell ebounty what type of bounties you are looking for and any task limits.
* Escort - Set up your escort and location preferences
* Profiles - Exclusions and which creatures you do/do not which to hunt.

==The General Tab==
===Bounty Types===
* Bounty Types - This is where you will define which bounty types you wish. Enabling the checkboxes will tell ebounty which types of bounties you wish to get and which ones to drop.
Ebounty will use ;echild for children tasks and ;ego2 for escort tasks.

===Task Limits===
* Task Limits - Here you can define maximum number of tasks you want to accept

===Misc===
* Rest when mind full - Will perform a bigshot attack, based on your default profile, and then return to your resting location once your mind is full. If disabled, ebounty will keep killing creatures until the bounty is or other rest condition like injury or mana are met.
* Run one bounty and quit - Ebounty will run a single bounty until successful and then quit.
* Use Vouchers - Ebounty will use advguild vouchers until a desired bounty type has been met
* Rest at random nodes in town - Will find a random [[supernode]] in town for resting
* Just the Basics- Will only get/drop tasks and not perform any other bounty related routines
* Selling script - Which script you want to sell. No arguments needed. Default is Eloot
* Healing script - Which healing script you want when injured. No arguments needed. Default is Eherb
* Resting Room - Define where you want to rest between activities.

==The Escort Tab==
Here you can define your travel preferences and which destinations to/from.

==The Profiles Tab==
This is the area to tell Ebounty how to hunt

===Creature Exclusions===
* Input a list of creature nouns that you do not wish to perform any tasks for and then click ''add''.

===Profiles===
The heart of ebounty combat routines. ''Only Kill Bounty Creatures'' option is available if you only want to kill the creatures listed in the Creature Name field and ignore other creatures in the bigshot profile.
* Gem/Default profile - This is the default bigshot profile that Ebounty will utilize when there's no acceptable bounty to initiate. Ebounty will run bigshot using the parameters established in the profile for hunting, skinning, resting, etc... until the bigshot is resting and the bounty timer is available. See workflow screenshot.
* Bandits profile - Ebounty will attempt to locate where bandits are based in game location and then attack based on profile settings.
* Creatures - Associate a profile for one or more creature names. User can separate creatures by commas or each creature on a separate line. The pulldown will grab all bigshot profiles in the Bigshot profiles folder.
'''Creature names must match exactly in the Creature Names field and there must be a routine for that creature in the Associated Profile. Ebounty will not function for combat without these two items being correct.'''
If a creature is not listed in exclusions and no available Creature Name can be located, Ebounty will return to the resting spot and kill itself.
* Incorrect <CODE>executioner</CODE>

* Correct <CODE>triton executioner</CODE>

==Planned work and known issues==

* Grouping: Not presently supported but planned

* Hoarding: Basics work but we'll likely need to clean up ;shoard and rerelease it to fully support hoarding. That's going to be quite a bit of work

==Ingame Screenshot==
<gallery perrow="4">
File:ebounty-1.PNG|General
File:ebounty-2.PNG|Escort
File:ebounty-3.PNG|Profiles
</gallery>

==Changelog==
<span class="mw-customtoggle-mychangelog" style="color:#0000ff">Click to expand</span>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-mychangelog">
v1.7.2 (2025-09-08)
- change requirement to 5.12.5 due to heirloom text change
v1.7.1 (2025-09-07)
- bugfix for change in Heirloom return messaging
v1.7.0 (2025-09-05)
- add option to select boost bounty type
v1.6.5 (2025-08-15)
- bugfix for stowing herbs
v1.6.4 (2025-08-05)
- remove version check for bigshot
v1.6.3 (2025-08-03)
- bugfix mana check when changing aspect while 650 is active
- bugfix for hiding is 608 doesn't work
v1.6.2 (2025-04-21)
- bugfix for NPCs not populating quickly upon room entry with large amount of other characters
v1.6.1 (2025-04-21)
- bugfix for HW bounty turnin
v1.6.0 (2025-03-29)
- remove custom bounty and use Lich Bounty API
- remove custom issue_command to Lich::Util.issue_command
- remove depreciated code
- update references of ego2 to escortgo2
v1.5.6 (2025-03-27)
- bugfix for set_eval not adding additional skins to skinning bounty amount
v1.5.5 (2025-03-19)
- remove deprecated Lich calls
v1.5.4 (2025-03-10)
- another bugfix for bundled skins
v1.5.3 (2025-03-08)
- bugfix when counting bundled skins
v1.5.2 (2025-02-09)
- bugfix when only foraging and needing healed
v1.5.1 (2025-01-07)
- bugfix for forage turn-in
v1.5.0 (2024-12-24)
- added buffing option when resting
- added using a script to handling resting location
- added option to rest at nearest table
- added remove bounty if heirloom item gets lost
- bugfix for bounty eval not setting EBounty.data.complete_mind
- bugfix for ask_guard in HW
v1.4.5 (2024-11-26)
- added option to use the bigshot setting for a resting location
- bugfix for profile dropdown sorting
- bugfix stop script from looping if started without child in room
v1.4.4 (2024-11-22)
- bugfix in should_hunt
v1.4.3 (2024-11-18)
- missing criteria in should_hunt?
- bugfix in wait_for_bounty
- removed EBounty.data.wait - no longer used
v1.4.2 (2024-11-16)
- bugfix for when to rest
v1.4.1 (2024-11-07)
- will continue hunting after bounty complete until Bigshot Should Rest? is met
- bugfix in setup - prevent toggling both Rest when mind is full and Keep Hunting
- bug fix for should_hunt? spamming an experience check
- bug fix for should_hunt? exp_pause incorrectly included
v1.4.0 (2024-08-23)
- expanded resting options
- added optional death recovery support
- added spinbutton for room delay for bandit bounties
- asks the alchemist in HW for bounties instead of the tavernkeeper since he keeps moving
- bugfix in gem bounty running hording script with parameters
- bugfix in bandit hunting variables
- removed script change log before v1.3.0 - full log: https://gswiki.play.net/Lich:Script_Ebounty
v1.3.11 (2024-09-24)
- fix to allow for CLI foraging without setting Gem/Default profile
v1.3.10 (2024-08-19)
- bugfix for ask_guard response
v1.3.9 (2024-08-14)
- logic fix when once_and_done is set and rejected bounty not exiting (but going out to hunt instead)
v1.3.8 (2024-07-12)
- add timer to not spam INFO during should_hunt? method
v1.3.7 (2024-07-08)
- add quiet info command to should_hunt? method to refresh stats
v1.3.6 (2024-06-23)
- update ebounty fog routine to match bigshot
v1.3.5 (2024-05-15)
- add exit if gembounty complete but using eloot sell excludes gems
v1.3.4 (2024-05-01)
- Change Char.prof to Stats.prof
v1.3.3 (2024-04-13)
- bug in escort task acceptance
v1.3.2 (2024-04-09)
- bug in forage for 1011 song of peace usage
v1.3.1 (2024-04-01)
- updated keep_hunting not to run in bigshot bounty mode. Also, added better messaging for why
- updated wiki changelog
- removed change log before v1.1.14 - full log: https://gswiki.play.net/Lich:Script_Ebounty
v1.3.0 (2024-03-17)
- added exclusion options for individual gems and locations
- added help section
- bugfix for UI title
- removed shattered specific actions not referenced in UI (requesting spells and healing in the nexus)
v1.2.2 (2024-03-03)
- bugfix for gem hoarding scripts that handle selling gems
v1.2.1 (2024-02-25)
- bugfix for condition where ebounty may be repeatedly invoke eherbs
v1.2.0 (2024-02-09)
- added toggle to skip healing
- added individual script options for rescue, escort, and hording
v1.1.37 (2024-01-08)
- add option to HIDE back for no-magic rooms if enabled to hide.
v1.1.36 (2024-01-06)
- remove forced HIDE for foraging put in by error.
v1.1.35 (2024-01-02)
- added check for nomagic tag before casting spells.
v1.1.34 (2023-11-16)
- bugfix in location check for foraging
v1.1.33 (2023-11-10)
- bugfix to stop trying to hand in herbs if completed
- added check for having enough herbs for turnin
v1.1.32 (2023-10-13)
- update hunting settings to use bigshot fried setting instead of setting to 100
v1.1.31 (2023-09-27)
- bugfix when asking taskmaster for bounty in crowded room
v1.1.30 (2023-09-26)
- bugfix for closing containers
v1.1.29 (2023-09-23)
- bugfix to initialize settings when using stand alone foraging
v1.1.28 (2023-09-23)
- bugfix for checking if 604 is active
v1.1.27 (2023-09-17)
- bugfix for CLI foraging exiting when "just the basics" option toggled true
- bugfix for black void check when foraging
v1.1.26 (2023-09-09)
- bugfix for CLI setting values to true/false with Ruby 3.2
v1.1.25 (2023-07-10)
- bugfix for HW guard
- bugfix for Ta'Vaalor guards
- bugfix for rejecting heirloom taskers
- turn portals off for escorts
v1.1.24 (2023-07-10)
- bugfix for HW taskmaster
v1.1.23 (2023-07-05)
- keep silvers based on eloot setting
v1.1.22 (2023-06-19)
- changed the resting room to default to your bigshot profile
- should recognize the correct town to turn in bounties
v1.1.22 (2023-06-11)
- removed need to set a resting room
v1.1.21 (2023-06-11)
- bugfix for missing category in tasks
v1.1.20 (2023-06-04)
- prep for new Lich 5.7.0 infomon.lic & effect-list.xml change
v1.1.19 (2023-05-21)
- bugfix for string error when finding rooms
- bugfix for heirloom turnin
- added support to wait for shattered healbot
v1.1.18 (2023-05-21)
- bugfix for escort tasks
v1.1.17 (2023-05-17)
- added missing escort locations
- bugfix for foraging using an heirloom setting
- bugfix for CLI herb gathering
v1.1.16 (2023-04-22)
- bugfix for RR purser
v1.1.15 (2023-04-11)
- bugfix bandit bounty locations
- bugfix in dangerous creature regex
v1.1.14 (2023-04-11)
- bugfix for CLI
- switched bounty_check to use Bounty API regex
- moved 213 into loop during foraging so it checks each time in case the spell wears off
- removed list of alternate foraging herb commands. Instead using in-game bounty xml for correct forage syntax
- added option to hunt with default profile instead of exiting when no profile found
v1.1.13 (2023-03-16)
- added sigil of resolve to foraging
- added flag righthand for heirloom search bounties
- replace script.vars with Script.current.vars
- run loot script only if loot at end of hunt
- added strip for extra spaced in herb bounties
- added check for right hand flag to make sure it gets turned off
v1.1.12 (2023-03-16)
- bugfix in rescue task regex
- changed bundle measuring to not be silent to prevent unintented screen scroll
v1.1.11 (2023-03-05)
- bugfix in string literal
v1.1.10 (2023-03-05)
- reverted string literal changes back
- fixed bug in child bounty
v1.1.9 (2023-03-05)
- reverted string literal changes
v1.1.8 (2023-03-04)
- added herb exclusions, rubocop fixes
v1.1.7 (2023-03-02)
- bug fix depositing silver
v1.1.6 (2023-02-28)
- fixed looting script from running in town
v1.1.5 (2023-02-28)
- fixed regex error in herb task location
v1.1.4 (2023-02-23)
- fixed regex error in targeting
v1.1.3 (2023-02-23)
- Added check for npcs in heirloom search
v1.1.2 (2023-02-04)
- added support for keeping silvers
v1.1.1 (2023-02-01)
- bug fix for foraging spells (waitcastrt? for assume yierka)
- rearranged post-hunt sequence to mimic bigshot functionality.
-fixed forage/heirloom search using empty_hands
v1.1.0 (2023-01-27)
- added pre and post hunt commands and scripts for foraging, heirloom search, and escorts
- added bad room entries for bandits that will accept UID's
- added spell support for heirloom search bounties
- added 1035 to foraging and heirloom searching
- think I finally squashed the repeating Song of Peace bug
v1.0.32 (2023-01-26)
- bugfix for heirloom searching
v1.0.31 (2023-01-24)
- reordered casting of song of peace during foraging and stopping it when done.
- added a double check for heirloom searching
v1.0.30 (2023-01-23)
- fix bad Widowmaker Rd room#
v1.0.29 (2023-01-23)
- fix bugfix in variable list from v1.0.29
v1.0.28 (2023-01-23)
- added herbalist to Mist Harbor
v1.0.27 (2023-01-22)
- refreshed spell active before casting foraging helper spells
- add check for silver deposit after bounty turn-in
- fixed bug in bundled skin eval
v1.0.26 (2023-01-21)
- fixed bug in herb turnin when caught in RT
- fixed prep-hunt command to run scripts consistent with bigshot functionality
v1.0.25 (2023-01-19)
- Fix badlist rooms and add bad logging road rooms
v1.0.24 (2023-01-19)
- Correct another typo in herb finding method
v1.0.23 (2023-01-16)
- Correct typo in herb finding method
v1.0.22 (2023-01-12)
- Change EBounty.data.location_start to use nearest instead of first in list
v1.0.21 (2023-01-02)
- typo in bug fix
v1.0.20 (2023-01-02)
-bug fix moves minor sanct outside foraging loop to stop it spamming
v1.0.19 (2023-01-01)
-bug fix to stop voucher use when bounty boost is active
v1.0.18 (2023-01-01)
- added bounty boost to available options
- added foraging enhancements - see foraging tab on ui
- changed the herb searching routine to try and eliminate false positives/negatives
- updated infomon and spell-list version requirements to support 650 tracking
- added CLI herb foraging independent of bounty - ;ebounty forage "<type of herb>" <number to find>
v1.0.17 (2022-12-27)
- ensuring following scripts are stopped before starting ebounty: go2, echild, ego2, bigshot
v1.0.16 (2022-12-22)
- typo fix for the bugfix for herbalist rooms using UID's
v1.0.15 (2022-12-22)
- bugfix for herbalist rooms using UID's
v1.0.14 (2022-12-20)
- updated herbalist rooms to use UID's for instance compatibility
v1.0.13 (2022-12-19)
- add regex for opening an item
v1.0.12 (2022-12-15)
- made resting room a required parameter
- consolidated odd herb names
v1.0.11 (2022-12-12)
- foraging name match fix
v1.0.10 (2022-12-11)
- fixed foraging herb matching bug
v1.0.9 (2022-12-09)
- bug fix for checkbounty not populating quickly
v1.0.8 (2022-12-06)
- moved post hunt routine to after forage turn-in to avoid trashing foraged item
- bug fix for foraging in the red forest
v1.0.7 (2022-12-05)
- bug fix for hunting sequence resting
v1.0.6 (2022-12-5)
- fixed bug in rescue bounty sequencing.
v1.0.5 (2022-12-3)
- bugfix for bounty_eval
- various foraging name corrections
- pre/post hunting bigshot routines (from default profile) added to escort bounties
v1.0.4 (2022-11-30)
- bug fix on container opening
- adjusted hunting sequence due to bigshot bounty_eval changing
- set bounty_eval to empty string on exit
- updated required versions to Lich 5.6.2, Bigshot 4.13.12, and Infomon 1.18.16
- regex fix for completed task
v1.0.3 (2022-11-28)
- changed container method to use "inventory container" instead of GameObj.inv
v1.0.2 (2022-11-27)
- Fix to targeting not using bigshot routines
v1.0.1 (2022-11-26)
- hedgehog sack messaging
- fixed herb names
- support for Bigshot fogging options
- child bounty fail bug
- Fix for grizzled targeting when user only kills bounty creatures
v1.0.0 (2022-05-18)
- initial framework and ui
</div>

==Reference==

{{Third-Party Software}}

Lich:Script Eloot

2025-09-08T16:05:02Z

WHIGHTCNIGHT: /* Changelog */ updated to 2.4.10

{{3rd-party}}
Eloot is an automatic looting script in [[lich]] that is the spiritual predessory, and borrows heavily from concepts in [[sloot]]. Eloot is actively maintained by the Elanthia-Online team. As with all scripts that deal with inventory management, it is '''Highly''' recommend to mark and register every item you value until you understand how eloot will handle your inventory, and it is not recommended to be wearing any gem hoarding containers until you can verify your eloot settings and behavior.

==What does it do?==
Eloot will gather loot from a killed monster or room, place that loot into the defined containers including overflow containers. It will not gather specific loot types you define,skin creatures, will drop boxes off at the locksmith pool or town locksmith if you desire, and will sell loot that meets the criteria and deposit coins. Eloot settings are saved per character per instance, in your lich5 data folder. Ex lich-5\data\eloot\GSIV\Rinualdo.yaml. If you wish to keep eloot settings across more than one char, you can copy and paste this file and rename the .yaml to each character you have.

==How do I get it?==
Eloot can be downloaded via <CODE>;repo download eloot</CODE>.

As a script in active development and with the constant state of changes in the game, it is recommended to set eloot and all Elanthia-Online scripts to auto-update via <CODE>;repo set-updatable eloot</CODE>

Eloot scans your inventory each time lost, so adding ;autostart add --global eloot start to your lich autostart can populate the information it needs at the start of your gaming session.

==How does it work?==
Eloot operates off in game [[STOW]] settings where a user can define one or multiple containers for loot. [[STOW]] settings need to be configured in game or eloot will not function. Eloot does not utilize User.vars like [[Sloot]] does.
Eloot allows the user to define a variety of loot and selling conditions. You can access the configuration via ;eloot setup

==The Looting Tab==
The looting tab allows the user to define what items you want eloot to pick up. Item categorization is based on lich's gameobj-data.xml file. When no exclusions are defined and all available loot on the ground meets the relevant criteria, eloot will use the in game verb loot room, which the game engine gathers and places items based on your stow settings
* '''Loot Types'''
** Allows the user to tell eloot what things to loot. Of note, this is based on lich classification so some items may fit multiple categories. For example, a weapon may be both a weapon, magical, valuable, and uncommon.
* '''Other Settings'''
**A variety of switches for eloot configuration. Supports Coin Hands and a switch is provided for eloot to keep a lot in the yaml file for items that eloot is unable to loot.
* '''Overflow containers'''
**These are containers the user defines when the default stow containers are full. Of note, these should not be your default or box containers. For example, if your default container is a cloak and your box container is a backpack, then you would not designate either as overflow for boxes, but instead would pick satchel and knapsack as your primary and secondary overflow.
*'''Never Loot'''
** Items to never loot. Black ora, urglaes are popular exclusions for non clerics.
*'''Always Loot'''
**Always loot these items, no matter what other settings contain
*'''Creature exclusions'''
** If there is a creature you do not want to loot, such as one that can injur you when searching.
*'''Unlootable'''
** Note, sometimes due to player interaction, an item can be classified as unlootable. For example, if there is an uncut diamond on the ground and you run eloot, then another group or group member loots that diamond before eloot finishes, eloot may attempt to classify that as an unlootable item and will not try to loot again. You can check this location to see what items eloot was unable to loot previously.
==The Selling Tab==
* '''Sell Types'''
**Which items you want eloot to sell. '''MARK EVERYTHING IMPORTANT'''
* '''Only Sell from these STOW containers'''
**If you have a STOW container you want eloot not to sell from, you would remove it here. Testing beforehand is highly recommended.
* '''Exclusions'''
**If you want eloot not to sell any items supported by nouns or regex here
* '''Keep Scrolls'''
**Allows a defined list of spell numbers that eloot will not attempt to sell. Requires the appropriate training in reading scrolls to determine if a scroll contains the defined spells. Supports vibrant scrolls by doing 401v or 401 vibrant.
* '''Appraisals'''
**If enabled, eloot will attempt to appraise the designated categories to determine if they meet the Gemshop and Pawnshop limits established. This is useful for determining enhancive items that may require futher player inspection. Eloot will not attempt to resell items above these thresholds during the current session and will provide a notification to the user. If the current session is closed, eloot will attempt again on the next session.
* '''Locksmithing'''
**Allows the user to define which, if any, locksmithing component to use and allows the user to set a preconfigured tip as an actual silver amount or as a tip percentage.
* '''Other Settings'''
**Allows the user to define if they want collectiables deposited to the town collection location, to sell in FWI and if they want gold rings delivered to the chronomaster. 1212/1205/650 are options as well for those who can cast.

==The Skinning Tab==
* '''Settings'''
**Fill in the appropriate switches if you want eloot to skin, if you want it to keel and or use ranger spell 604 or Sunfist's Sigil of Resolve
* '''Skin Weapons'''
**Eloot needs to know what your skin weapon is and what container it is contained in. If your creature list requires a blunt weapon to skin, these also need to be filled out
* '''Skinning Exclusions'''
**Any creatures you do not want eloot to attempt to skin

==Ingame Screenshot==
<gallery perrow="4">
File:eloot-1.PNG|Looting
File:eloot-2.PNG|Selling
File:eloot-3.PNG|Skinning
</gallery>

==Changelog==
<span class="mw-customtoggle-mychangelog" style="color:#0000ff">Click to expand</span>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-mychangelog">
v2.4.10 (2025-09-06)
- rework box contents check to store box instead of pausing
- bugfix for looting coins on the ground
v2.4.9 (2025-09-05)
- bugfix in regex for use_coin_hand method
v2.4.8 (2025-08-30)
- bugfix for setting ELoot.data.coin_bag_full to false when empty.
v2.4.7 (2025-08-15)
- if debug to file enabled, allow for when started with a parameter (sell/pool/etc)
v2.4.6 (2025-08-12)
- fix encumbered after box opening by depositing silvers in process_boxes
v2.4.5 (2025-07-22)
- bugfix for default locksmith_withdrawl_amount
v2.4.4 (2025-07-16)
- allow customizable locksmith tip amount withdrawal
- typo correction in bulk sell gem method
- force clean overflow containers from sell_container list
- utilize File.join for save/load
- bugfix in pool_return to allow up to 2 seconds for GameObj right/left hand to populate
- remove Unicode characters in formula explanation for scaled box tipping (non-logic change) / Warlock
v2.4.3 (2025-07-15)
- bugfix for town locksmith regex to open box after return being too generic
v2.4.2 (2025-07-09)
- bugfix for silver withdrawals failing on f2p accounts with low bank balances
v2.4.1 (2025-06-05)
- bugfix for unable to lighten load during pool return and no silvers to deposit to allow more boxes to be returned
- bugfix for box loot to deposit coins if too many coins on yourself to be able to loot coins from box
- change class checks to is_a? checks
v2.4.0 (2025-05-21)
- add CLI option to skin only
- fix regex for sellable/type/sell CLI to make = optional to match help text
v2.3.12 (2025-05-10)
- fix for Pinefar banker withdraw/deposit
- fix for disk/container contents being nil prior to storing an item
v2.3.11 (2025-05-05)
- fix find_boxes to now clear sacks found with boxes from sacks_full
- bugfix in regex for pool parameters to match help text
- general sanitation of GTK values on load and close of GTK window
- bugfix in incremental tipping display chart
- bugfix in locksmith_pool_count due to truncated results list returning incorrect list of boxes unopened
- correctly display incremental tipping chart starting at base 0
v2.3.10 (2025-04-28)
- bugfix in locksmith_tip to ensure numerics incase of string values saved in yaml
v2.3.9 (2025-04-27)
- bugfix add coin bag full msg'ing to regex
v2.3.8 (2025-04-22)
- bugfix for older Ruby 2.6 users and Bounty.task.assigned?
v2.3.7 (2025-03-27)
- add ;eloot pool return to options
- bugfix for Rift talons gem hoarding
- bugfix in get_regex to support hidden dagger harness
- bugfix in check_type for hoarding HW hyphenated gem names
- bugfix for locker reset while hoarding
- bugfix in wait_for_disk logic
- bugfix for spinbutton
- add additional in_region boundaries and convert to UID lookup
- bugfix for note deposit when using urchin guide and bounties
v2.3.6 (2025-03-15)
- typo for horde to hoard
- bugfix to deposit local note if selling in FWI
- bugfix in gem name standardization
- remove deprecated percentstance & percentencumbrance calls
- bugfix to not timeout on creatures that get ressurrected
- bugfix on find_weapons_ready_list
- bugfix in looting gemstone jewels if both hands currently used
- bugfix in validate_setup when toggling on/off skinning
v2.3.5 (2025-03-14)
- additional updates to put_regex and get_regex
- bugfix to not Regexp escape loot_keep
v2.3.4 (2025-03-11)
- bugfix for spin buttons not saving properly
- add debug for loot method
v2.3.2 (2025-03-10)
- update to appraise method
- fix for monsterbold gemstone jewel drop msging at feet
v2.3.1 (2025-03-09)
- add space for regex_at_feet
v2.3.0 (2025-03-09)
- add support for gambling kits
- update for gemstones
- bugfix when ELoot.data.settings[:loot_keep] is nil
- bugfix when emptying jars to add to empty jar count
- bugfix in store_item when gem hoarding
- bugfix for weapon displayer
- bugfix for container_contents
- broke up the set_inventory method into smaller sections
- bugfix add daybringer put_regex match
- bugfix for swordbelts and neck sheaths
v2.2.3 (2025-03-03)
- added support for Lock & Key gameobj types to loot_special and loot_regular
- bugfix in Bounty.task usage for gem/skin
v2.2.2 (2025-02-28)
- bugfix in Region.in_region for HW/Cold River
v2.2.1 (2025-02-26)
- bugfix in check_bounty_gems using furrier instead of gemshop
- bugfix for neck sheath containers not populating contents
v2.2.0 (2025-02-20)
- updated required lich version to 5.8.0
- added support for house lockers
- added additional container content checks
- added check for selling bounty items in the correct town
- misc improvements to UI functionality
v2.1.6 (2025-02-10)
- bugfix for selling boxtraps
- modified hording bugfix to be more comprehensive. Was failing on an end of line condition
- bugfix for standard account gem inventory
v2.1.5 (2025-02-07)
- bugfix for hoarding inventory when using a family vault
v2.1.4 (2025-01-25
- rework coin bag logic to reduce excessive inspect calls
v2.1.3 (2025-01-24)
- bugfix in incrimental tipping
v2.1.2 (2025-01-23)
- added support for looting/selling locksmith traps
- bugfix for breakdown calc
v2.1.1 (2025-01-23)
- add support for keeping vibrant scrolls. Enter the scroll number (Ex:101v or 101 vibrant) in the Keep Scrolls section
- add box detail to selling output
- added support for looting/selling locksmith traps
v2.1.0 (2025-01-13)
- added option to output debug information to file
v2.0.10 (2025-01-11)
- bugfix for box inhand and full locksmith pool
v2.0.9 (2025-01-01)
- bugfix for locksmith pool box list
v2.0.8 (2024-12-21)
- additional error checking for looting to avoid false pauses
- removed get_lines method and combined it with get_command
- add custom vine name
- bugfix in loot_regular method when looting a box and default container is full
v2.0.7 (2024-12-12)
- add HW uncommon loot to loot_specials method
- update reject loot method for 335 Deity effects
- added automatic data reload if new version downloaded
v2.0.6 (2024-12-06)
- temporarily disable raiding from house lockers
- bugfix in account type comparison
- bugfix for running results report when nothing to report
v2.0.5 (2024-12-06)
- bugfix for house lockers check
- bugfix for thinking bags were full when actually stunned.
v2.0.4 (2024-12-01)
- temporarily disable hording for house lockers
- bugfix to hording regex when creating inventory
v2.0.3 (2024-11-23)
- will try to selling clothing at the gemshop first, then the pawnshop if applicable
- bugfix in put_regex
- bugfix in store_item
v2.0.2 (2024-11-20)
- bugfix in single_loot method
- bugfix in hording process
- bugfix for urchin guide
v2.0.1 (2024-11-12)
- bugfix to only buff for selling if something to sell
- bugfix to exit if insufficient funds at bank
v2.0.0 (2024-09-04)
- support for hording gems and alchemy ingredients
- support for in-between script to run. This runs between finishing the pool and before selling. Usecase: totems, hording, supplies, whatever
- addition of CLI selling options: sellable, type, and itemized
- disk usage tracking improvements
- incremental tipping added for locksmith pool
- added appraisal container to store items appraised over limit.
- added crumble messaging for the bowels
- bugfix for selling in HW
- bugfix for closed coin bag
- bugfix for favor_left skinning
- bugfix for silver_deposit if keeper_silvers returns a note
- bugfix for coin hand bank deposit
- changes to UI
- bugfix for coin bag capacity check
- bugfix for shattered urchin usage
- bugfix for 1205 Glamour
- updated changelog on wiki
- removed changelog in script before 1.6.20
v1.6.36 (2024-08-16)
- pause script instead of exit when failing to empty container
v1.6.35 (2024-08-10)
- fix for emptying container but failing due to full bag
v1.6.34 (2024-08-07)
- bugfix for box_in_hand method
v1.6.33 (2024-07-25)
- add additional get_regex for READY WEAPON
v1.6.32 (2024-07-20)
- box_in_hand method updated to process both hands.
v1.6.31 (2024-06-30)
- add toggle for coin hand closing to be optional after selling
v1.6.30 (2024-06-28)
- fix for coin hand not closing after selling routine
v1.6.28 (2024-05-01)
- Change bad Char.methods to Stats.method
v1.6.27 (2024-04-28)
- add additional disk noun bassinet
v1.6.26 (2024-04-24)
- fix for GST and F2P accounts
- fix for disk noun regex word boundary
v1.6.25 (2024-04-24)
- handle all the new custom disk nouns
v1.6.24 (2024-04-05)
- update change_stance to use percentstance instead of checkstance
- add support for CMAN STANCE in change_stance
v1.6.23 (2024-04-05)
- additional open/close messaging for squelching
- reduce Lich::Util.quiet_command_xml timeout from default 5 to 2 seconds
v1.6.22 (2024-03-29)
- fix for Frozen Bramble creatures requiring left hand to be empty in order to loot.
v1.6.21 (2024-03-26)
- add messaging for valence weapons
v1.6.20 (2024-03-16)
- added use of trash verb
- (F2P) withdraw a note when the max bank account balance is reached
- fix to not "Share silvers" from the allotment of "Keep Silvers"
- fix to locksmith rooms without trashcans
v1.6.19 (2024-03-13)
- fix to not sell bounty items in FWI when selling disabled for that type
v1.6.18 (2024-03-08)
- fix for bulk selling skins when bundles are worth to much to sell via bulk sell
v1.6.17 (2024-02-25)
- withdraw exact amount if using flat tipping for locksmith pool
v1.6.16 (2024-01-29)
- bugfix in break_rocks method
v1.6.15 (2023-12-17)
- added breakable looting and selling options for Hive items (released 12/17/2023)
- added word boundary check for notes
- bugfix for urchin guild at locksmith pool in Hinterwilds
v1.6.14 (2023-12-04)
- fix bug in coin bag. It needed a free hand
- incorporated urchin guide support for shattered and plat (prime already supported)
- typo in gem selling method
v1.6.13 (2023-11-27)
- changed unknown response at locksmith to put item in container and keep going instead of exiting
v1.6.12 (2023-11-24)
- update get_regex for unique messaging
v1.6.11 (2023-11-19)
- check to make sure box is locked when using locksmith
v1.6.10 (2023-11-03)
- bugfix to use eonake gauntlet with correct hand
- bugfix for sewer rat sack
- support for coin bags
- add 'sling' to get_regex
- add check for Gtk gem
- fix typo in return_hands method
- add look messaging for modular neck sheath
v1.6.9 (2023-11-02)
- check mapdb and xmldata for trashcan searching fallback logic
v1.6.8 (2023-09-21)
- added support to sell when a box is in hand
v1.6.7 (2023-09-21)
- Bugfix for matching change in wealth output.
v1.6.6 (2023-09-10)
- bugfix to deposit silvers for ;eloot pool deposit.
v1.6.5 (2023-09-05)
- bugfix for the bugfix for calling deposit when nothing to do.
v1.6.4 (2023-09-05)
- bugfix for skinning routine not excluding from creature exclude list
- bugfix for calling deposit when nothing to do.
v1.6.3 (2023-08-24)
- update for dropping boxes (shattered only) to include both hands
- excluded shimmering orbs from sell list
- bugfix for excluding items
- added method to get script version from only one location
- misc variable adjustments in Data class
v1.6.2 (2023-08-14)
- added regex for GEF weapon retrieval
v1.6.1 (2023-08-03)
- extended support for fossil charm (ground coins)
v1.6.0 (2023-07-31)
- added support for fossil charm
v1.5.37 (2023-07-19)
- switched Lich::Util.silver_count for using 'wealth quiet'
v1.5.36 (2023-06-23)
- fix for assume lion to check for 25 mana if 650 already active
- fix for assume lion to check for proper cooldown number
v1.5.35 (2023-06-11)
- change to 650 implementation
v1.5.34 (2023-06-08)
- bugfix for looting coins in a box when encumbered
v1.5.33 (2023-06-04)
- prep for new Lich 5.7.0 infomon.lic change
v1.5.32 (2023-05-12)
- reworked method for cursed items to support eonake gauntlets
v1.5.31 (2023-04-12)
- bugfix for never loot section not working correctly with regex
v1.5.30 (2023-04-07)
- split drag method to wear and drag and added RT check for wearing containers after bulk sell.
v1.5.29 (2023-04-04)
- added regex for pirate harnesses
v1.5.28 (2023-03-30)
- bugfix for trashcans
v1.5.27 (2023-03-30)
- additional find_trash method changes to utilize meta:trashcan
v1.5.26 (2023-03-30)
- added "wastebin" to list of trashcans
v1.5.25 (2023-03-25)
- another try at finding the trashcan
v1.5.24 (2023-03-23)
- added additional trashcan identification if no room description available
v1.5.23 (2023-03-22)
- added open regex for container
v1.5.22 (2023-03-08)
- bugfix for updating setting on nil for Ruby v3
v1.5.21 (2023-03-06)
- bugfix for bag_loot method
v1.5.20 (2023-02-25)
- bugfix for scroll selling in setup
v1.5.19 (2023-02-22)
- added toggle for unlootable tracking
v1.5.18 (2023-02-07)
- added additional error checking for autoclose bags
v1.5.17 (2023-02-01)
- added support for Assume Aspect - Lion (650)
v1.5.16 (2023-01-31)
- added child to unlootable list
v1.5.15 (2023-01-30)
- bug fix for wait_for_disk method
v1.5.14 (2023-01-22)
- added support for plinite looting
v1.5.13 (2023-01-22)
- add RT check to retrieving weapon/shield after looting
- added support to not sell alchemy items: ;eloot sell alchemy_mode
v1.5.12 (2023-01-17)
- add check to prevent trying to loot something that's not yours
v1.5.11 (2023-01-13)
- add extra output to eloot test (disk and full containers)
v1.5.10 (2022-12-23)
- fixed location bug for locksmithing in KF
v1.5.9 (2022-12-05)
- added unlootable list to the UI (bottom of loot tab)
- bugfix for trying to put loot in full container
v1.5.8 (2022-12-05)
- added word boundary checks for container setup
- bug fix for phased box's
v1.5.7 (2022-11-27)
- removed custom quiet command to use Lich command instead
- fixed bug if encumbered at the locksmith and can't get the box out of the disk
- fixed bug for ice elemental looting
v1.5.6 (2022-11-11)
- added an "Always Loot" list
- added support for auto closing bags
- bug fix for handling reliquaries
- bug fix for skinning without a designated skinning tool
v1.5.5 (2022-11-03)
-bugfix for unlootable tracking
v1.5.4 (2022-11-01)
- bugfix for silver totals
v1.5.3 (2022-10-31)
- added check for unlootable items
v1.5.2 (2022-10-29)
- added muck and cloud to unlootable list
v1.5.1 (2022-10-28)
- bugfix for terminal-table silver breakdown
v1.5.0 (2022-10-09)
- removed dependancy on separate UI file and associated code
- cleaned up inventory & looting logic
- added support to always check the locksmith pool
- fixed bug that was looting cursed items in boxes
- added validation check for setup
- silver summary at end of selling using terminal-table
- archived change log before 1.4.0
- adds CLI interface to update settings
v1.4.22 (2022-09-25)
- bug fix for cursed items in boxes
v1.4.21 (2022-09-23)
- added support for hidden skin sheathes
- bug fix for crumbly bandit bandanas
- locksmith pool functionality added: over encumbered coin deposit and box drop off only option
- fixed bug in track_full_sacks default setting
- fixed bug when trying to do initial load when in RT
- added small delay to ;eloot start
v1.4.20
- bug fix for cursed items and some crumbly ones
v1.4.19
- fixed looting logic when its flagged as two items with one not wanted (eg. uncommon & clothing). It will pick up the item to prevent valuable items getting left behind
- additional error checking for empty box's in containers
- additional error checking for looting
- added support to use left hand for looting
- added support for users who don't sell with eloot (full container tracking)
- added secondary overflow container
- moved UI check only when loading or setup
v1.4.18
- follow-up typo fix for default crumbly list
v1.4.17
- add rough leather quiver to the default crumbly items
v1.4.16 (2022-08-23)
- fixed typo in overflow setting
v1.4.15 (2022-08-23)
- changed regex for scabbards again
v1.4.14 (2022-08-19)
- will sell bounty items in original town if selling in FWI
- added regex for custom scabbard
- reworked data loading, should be faster now
- changed the container identification to skip non-worn containers (helps with getting the correct skinning sheath)
v1.4.13
- empty gold, silver, mithril boxes if selling them
- fixed trying to loot gangplank
- fix for stancing with verbose turned on
v1.4.12
- fixed duplicate container saving
- fixed bug in box looting that wasn't recognizing box found armor/weapons
v1.4.11 (2022-08-02)
- added support for looting coins on the ground
v1.4.10 (2022-07-28)
- more edits for locksmithpool not recognizing worker
v1.4.9 (2022-07-28)
- another edit to the locksmith pool
v1.4.8 (2022-07-20)
- close sacks function had a bug preventing it from working
- additional changes for the load delay in locksmith pool
v1.4.7 (2022-07-09)
- fix for object load delay in locksmith pool
v1.4.6 (2022-07-09)
- added option to deposit coins/notes without sell routine
- fixed bug in empty box selling causing it to duplicate
v1.4.5
- performance improvement in selling and storing items
- added logic to address having a box in hand at start of sell routine.
- added support to loot a box in hand then exit - ;eloot box
v1.4.4
- added skin matching for alchemically ruined skins
v1.4.3
- added support for skinning rotting chimera's when they have scorpion tails
v1.4.2 (2022-06-15)
- bug fix in blunt skinning
v1.4.1 (2022-06-15)
- bug fix for disks
v1.4.0 (2022-06-10)
- added support for shroud and glamour
- added check in valid loot routine to exclude disks
</div>

==Reference==

{{Third-Party Software}}

Lich:Script Bigshot

2025-09-08T16:04:35Z

WHIGHTCNIGHT: /* Command Checks */ add coupdegrace

{{3rd-party}}
Bigshot is designed to handle combat routines, including moving to and from hunting areas, defining creatures to hunt and accompanying attack routines
Afk scripting on any server but Shattered is in violation of game policy.
{{TOCright| limit=2}}
==Changelog==
*[[Script Bigshot/Changelog|Script Bigshot Changelog]]
==About Bigshot==
===What Does Bigshot Do?===

Using a series of menus and commands inputs, Bigshot lets a user create a modular, customizable and fully automated hunting script. With just a few clicks and tweaks, you can go from scripting Rats to the Rift.

===How Do I Get It?===

Grab it from the Repository: ;repository download Bigshot

===How Do I Make it GO!?===
Initial setup is accessed through ;bigshot setup. There you will see a configuration window with various tabs to setup for your hunting routine.

As with most scripts, using a SETUP command will open a graphical user interface for configuring the script. Use ;bigshot setup to open this dialog. This will open a window with the following tabs:
* Profile - This is where you save/load your profile information. Profiles are saved to your \Lich5\data\<GSServer\<charname>\bigshot_profiles directory. Eg, \Lich5\data\GSIV\Rinualdo\bigshot_profiles (note, if you've previously used bigshot, the file location has changed. The previous location was in your \Lich5\scripts\bigshot_profiles folder. You can copy/paste
* Resting - Set up your resting routine and location.
* Hunting - Create a hunting map by adding BOUNDARIES, define your attack stance and any pre hunt information
* Attacking - configuration for ambushing, bless, reactions, and similar flags
* Commands - Where you define your valid targets and associated attack routines. See sample routines below.
* Misc tab - Various config options

We will take a closer look at each of these individually further on.

There is also several other commands you can do for more functionality.
* ;bigshot quick - Special hunting mode that kills everything in the room your in and quits bigshot. Wont wander at all, and wont attempt to rest. Has its own hunting commands and hunting targets.
* ;bigshot head/tail - This is for Multi-Account hunting. It only works for a single computer. Every character needs to be setup for the hunting area your going to. You start it by having your following characters join your head character. The following characters need to be running bigshot with ;bigshot tail. Once that happens, have the leader of the group do ;Bigshot head. They will then procede to hunt in the area you have setup.
* ;bigshot display - Shows all your current settings.
* ;bigshot reset - Resets all your targetable and untargetable lists. Useful if you find bigshot won't targets something it should.
* ;bigshot ranger or ;bigshot companion - Resets ranger companion setting so you can set it again. Used when you change your companion.
* ;bigshot profile save <name here> - Saves a profile in YAML format in your character's profile folder. Also accessible via the Profiles tab in the setup menu.
* ;bigshot profile load <name here> - Loads a profile from your character's profile folder. Also accessible via the Profiles tab in the setup menu.
* ;bigshot single - When used solo, will execute a single hunting routine, return to your resting location and then exit
* ;bigshot <options> <creature> - example: ;bigshot single giant rat - Will activate ranger tracking of a creature. Anything input besides the above commands will default to "track <input>".

==The Profile Tab==
* Load Profile - will load an existing profile. Nothing will be available if no previous profiles are saved
* Current Profile - shows the existing profile if a new one is loaded.
* Save profile - Valid profile information for future ebounty script support
Save Current Settings - tell Bigshot what you want your profile to be named. Any name will work here. Once a profile is saved, will show up in the Load Profile menu.

==The Resting Tab==
Short and sweet, here is where we setup our resting routines. During REST mode, Bigshot uses the EXP command and checks your mind, hit points, wound status, mana and spirit. Once all of these values are at the specified Should_hunt? settings, Bigshot leaves REST mode and begins a HUNT.

* room id: - This is the room that Bigshot will return to for resting. Use Room Numbers from Map/Go2. Support both LichIDs and SimuIDs with a u, for example, 228 for Town Square Central or u7120.
* pre-rest commands: - These commands run before entering REST mode. An example routine is: 'shea, wear shield, sit, stance offensive, rest'. This will sheath your weapon, wear your shield, sit, enter offensives stance and use the REST verb.
* active resting scripts: - Active resting scripts are scripts that will be run upon entering REST mode. These scripts should be things that you do after a hunt: get healed, empty your bags, spell up. An example list is: 'eloot sell, waggle, eherbs'. This will use eloot to sell according to the options set with eloot. After selling, it will use Waggle to spell you up according to however Waggle is setup. Finally, eherbs will check your PACK and use herbs stored there to heal whatever wounds you have.
* Fog Option: - Uses [[Spirit Guide (130)]], Voln [[Symbol of Return]], [[Traveler's Song (1020)]], [[Sigil of Escape]], [[Familiar Gate (930)]] or Custom when heading back to rest. Setting it to None does nothing. Setting it to 130 will cause it to use 130 first then if that fails symbol of return. Symbol of return will use that first, then 130 if that fails. Setting to Traveler's Song will attempt once and continue. Setting to Familiar Gate will attempt to summon a portal once and walk through it. Will perform a mana pulse if not enough mana is detected. Custom option allows for comma separated list of commands to perform.
* Should Rest?
Bigshot evaluates these conditions and, when they are met, will go to your resting room set on the Resting tab and execute any resting scripts you have set.
* '''when percent mind >='''
** Rests when your mind has reached this threshold. Generally, set this to 100 to rest when fried.
* '''and extra kills >='''
** The number of extra monsters to kill after reaching your `when percent mind` threshold and after LTE boosts used
* '''and used lte boosts >='''
** The number of LTE boosts it will attempt to use after reaching your `when percent mind` threshold
* '''or percentmana <='''
** Forces Bigshot to rest when your percentage of mana is at or below this threshold.
** This can be set to 0, but leaving a bit in the tank can be good if you have to use 406 (Unlock) to open the WL Graveyard gate. 11/17/24: If you run into an error that calls to an "OOM" message, try setting this to 1.
* '''or percentencumbrance >='''
** Forces Bigshot to rest when you have reached a given level of encumbrance.
* '''or wounded eval'''
** Allows you to set an evaluation phrase to determine if you are too wounded to continue hunting. Wound evaluations can send you home on nearly any wounded condition of your choice: bleeding, level 2 wound, can't cast, too many scars etc.

The following is a wounded evaluation that will rest whenever you have any level II wounds:
<PRE>XMLData.injuries.any?{|key,value| value["wound"] > 1} || Char.percent_health <= 70</PRE>
The following is a wound evaluation that will take you home if you can not cast anymore (nerves, level 2 head/eyes, bad scars etc.):
<PRE>bleeding? || Char.percent_health <= 25 || [Wounds.head, Scars.head, Wounds.leftEye, Scars.leftEye, Wounds.rightEye, Scars.rightEye, Wounds.nsys, Scars.nsys].max > 1 || [Wounds.leftArm, Wounds.leftHand, Wounds.rightArm, Wounds.rightHand, Scars.leftArm, Scars.leftHand, Scars.rightArm, Scars.rightHand].max > 2 || ([Wounds.leftArm, Wounds.leftHand, Scars.leftArm, Scars.leftHand].max > 0 && [Wounds.rightArm, Wounds.rightHand, Scars.leftArm, Scars.leftHand].max > 0)</PRE>
The following can be added to one of the above wound evaluations to also rest upon having popped muscles:
<PRE>|| Effects::Debuffs.active?("Overexerted")</PRE>

* '''when creeping dread >='''
** Forces Bigshot to rest when your creeping dread is at or below this threshold.
* '''when crushing dread >='''
** Forces Bigshot to rest when your crushing dread is at or below this threshold.
* '''Wall of Thorns Poison'''
** Forces Bigshot to rest when you are affected by Wall of Thorns Poison.
* '''Confusion Debuff'''
** Forces Bigshot to rest when you are affected by the non-dispellable Confusion Debuff.

==The Hunting Tab==
This is where you will tell bigshot when to hunt, any commands or society abilities to use prior to hunting, and where on the map you want to hunt.
===The Hunting Map===
Your hunting map is a series of Boundaries - rooms that Bigshot will not enter - and a Start room - the first room that Bigshot moves to when a hunt starts. These function very similarly to the boundaries in the ;Wander script, but are stored in Bigshot's configuration files and not in a character cache as with ;Wander. Here you also configure when to hunt
* starting room ID: - This is the first room that Bigshot goes to when hunting. You may set this to any room within the Boundaries that you set with the second option.
* boundary rooms: - Boundary rooms are walls. Bigshot will not enter a Boundary room!

<PRE>X-X-B - A - 0 - 0 - 0
| |
X-X-X</PRE>

The proper syntax for boundary rooms are separated by commas
Some popular Rift boundaries as an example
<PRE>
Plane 1: 2635, 12101, 12208
Plane 2: 2605, 2635, 12093
Plane 3: 2635, 12089, 12152
Plane 4: 12122, 12207, 12235
Plane 5: 2579
North Scatter: 12151, 12254, 12256, 12249, 12247, 12241
South Scatter: 12151, 12219, 12217, 12233, 12237, 12239
</PRE>

For Maaghara boundaries, you can use
<PRE>
9734
</PRE>

Confluence boundaries:<pre>
2300, 3519, 228, 188, 1932, 10855, 3668, 1438, 1005
</pre>

Imagine a hunting area that is a six room square. To enter this square, one must GO DOORWAY from room A. You would set the room outside of the square - ie room A - before you GO DOORWAY, as a boundary. Then, you would set room B to the Starting Room. From there, Bigshot will move to room B and then wander around inside the Boundary - ie the square hunting area - until it your '''Should_rest?''' conditions are met.

* Wait before wandering to another room: - Time you wait before leaving a room to find some creatures. Default is 0.3 seconds. Set to 0 for fastest (spammy) movement.

* attack stance: - Specify what stance you want to attack from. Bigshot will remain in Stance Defensive until an attack command is issued, whereupon it will stance to your Attack Stance and execute your Attacking routine. Bigshot recognizes all stances from the game, Offensive ->-> Defensive.
* pre-hunt commands: - These commands will be executed before Bigshot uses Go2 to travel to your hunt's Starting Room. As an example: 'gird, stance defensive'. This will ensure that you have readied your weapon and are in Defensive stance before traveling. Set short lived combat spells like 1605 (Arm of the Arkati) to be cast in this line.
* active hunting scripts: - Active hunting scripts are scripts that will run while Bigshot is in Hunt mode. Many of these scripts have been made obsolete by the next option. Clever scripters have written some nice scripts that will keep certain spells up, execute cmans based on conditions etc. If you need a complex action to run while Hunting that Bigshot does not have the capacity for, an active hunting script may be called for.
* society abilities/spells/cmans: - Bigshot can be asked to keep certain abilities up at all times during a hunt. Hovering your mouse over this field will display a list of cmans and society abilities specified by their numerical designations. Spells may also be added here. Separate all values by commas. For example, entering '506' will keep the spell Haste up during Hunts, casting whenever it has worn off.
* loot script - Bigshot will call a loot script to loot your kills for you. eloot is commonly scripts used here. Be sure to use the SETUP command on whatever loot script you use, as if it is not configured properly, Bigshot will likely error.
* wracking spirit >= - Setting a value here will WRACK for mana if your spirit is greater than or equal to the value specified. Setting 6, for example, will WRACK down to 5 spirit. This will ONLY function if you have the 'Use sign of wracking/sigil of power' box checked.
* Use sign of wracking/sigil of power - checkbox to enable the use of wracking
* Priority hunt - checkbox to enable the use of the priority system for hunting. This allows you to change targets based on the order listed in valid targets/quickhunt targets. For example, your hunting thunder trolls, wind witches, and puma. Your valid target order is wind witch, thunder troll, puma. Your currently attacking a puma, when a thunder troll walks in. You will switch to the attacking the thunder troll because its before the puma in the valid targets list. After killing the thunder troll, you go back to the puma, only to have a wind witch walk into your room. You will again switch to the wind witch because its in front of the puma. Hope you get the idea. When using the ;bigshot quick option, it will base the order of targets by your quickhunt targets first, then the order of the targets in the room that don't match any of your quickhunt targets. Example, bandits are in your quickhunt targets. You type ;bigshot quick when you get ambushed in the room. Currently in the room is a large ogre and three bandits. The order of targets will be the bandits first, then the large ogre.
* Delay looting - delays looting of creatures in a room.
* Pull players to feet - attempt to pull players to their feet upon passing them in a room
* Stop for dead players - checkbox will pause bigshot if you encounter a dead player
* Sneaky Sneaky - sneak around while out in the hunting area

===Should hunt ===
Bigshot evaluates the conditions set on this tab to determine if you are ready to hunt or not.
* '''when percent mind <='''
** Setting this to 51 will rest until Cleared. Setting at 65 will wait until Muddled.
* '''and percent mana>='''
** Determines the percent total of your maximum mana that must be present before hunting
** Setting below 50 will result in quick, uneventful hunts if you cast much. Generally, this is set at 95 or higher.
* '''and CHECKspirit >='''
** Bigshot will check to see that your current Spirit value is higher than what is listed here.
** Make sure that you have this set high enough that Bigshot won't hunt immediately after DEPARTing if you have Depart / re-run Bigshot checked on the General tab.

==The Attacking Tab==
* Ambush aiming locations (head, etc): - Allows you to specify what order you aim for ambush. Default is head, right leg, left leg, chest.
* Archery aiming locations (head, etc): - Allows you to specify what order you aim for archery. Loops through your aiming locations once you hit the area your aiming at.
* flee if enemy count is > - Flees the room if the total number of enemies in the room exceeds the value. Set this to 1 if you want to engage single targets.
* ...but don't count these: - Bigshot will ignore monsters specified in this line when eveluating if it should flee based on how many monsters are in the room. Useful for when you are hunting in an area with extremely low level monsters mixed in with your targets.
* ...and always flee from: - Bigshot will always flee from the specified monster as soon as possible. Extremely useful if your hunting area has higher level and/or extremely dangerous monsters mixed in with your intented target(s).
* flee from environment message: - Will flee whenever anything you put in here gets sent from the game. (XML regex matching)
* Wait before wandering to another room: - time you spend before moving to a new room. Default is 0.3 seconds. You can set it to 0 to move instantly. Tends to be spammy for anyone in the same hunting area.
* Approach lone targets only - Forces Bigshot to only begin combats against creatures that are alone.
* Bless weapon? - Performs a Consecrate (1604), then a Cleric Bless or Voln Bless on whatever weapon loses its bless during hunting. If you can't bless your weapon while hunting will return you to your rest area and quit the script.
* Flee from boon - Enabling this check box will force Bigshot to flee from all boon/gifted/boss creatures (available in [https://github.com/elanthia-online/scripts/pull/449/commits/afade49e25dd6042c30b6d62fec4d65376667f80 v4.3.0])
* Activate weapon reactions - Will initiate reactive strikes when the opportunity presents itself
* Flee from clouds - Enabling this check box will force Bigshot to flee from Cloud spells such as 125(Call Lightning with its Ominous Cloud), 1704 (Stun Cloud) and 1713 (Death Cloud)
* Flee from vines - Enabling this check box will force Bigshot to flee from Vine spell such as 610(Tangle Weed)
* Flee from webs - Enabling this check box will force Bigshot to flee from webs.
* Flee from voids- Enabling this check box will force Bigshot to flee from voids.

==Commands Tab==
The true guts of Bigshot, this is where you specify your Attack Routine.
* hunting commands - These are the commands that Bigshot will evaluate (ie execute) when it is in the room with a valid target (one that you specified in your Hunting section. These commands are separated by a comma. Bigshot recognizes most hunting verbs and, failing that, will use an fput command (a direct entry method) and just execute the commands directly as written. The following are a list of usable hunting commands:
** kill - Attacks using the KILL verb.
** incant <spell number> - Casts the specified spell with the INCANT verb. This will automatically stance into offensive for bolt and other stance-sensitive spells. A caster may CHANNEL the spell using [[INCANT (verb)]] to INCANT SET CHANNEL <spell> (a standard GSIV verb, not part of Lich). Alternatively, a caster may CHANNEL spells by using the SET verb (a standard GSIV verb, not part of Lich) to SET ChannelIncant ON. This will CHANNEL an INCANTed spell if the caster is in a stance higher than neutral.
** channel <spell number> - Channels the specified spell at the target. This requires a stance higher than neutral to have any effect.
** <Spell Number> - Casts the specified spell with the PREPARE and CAST verbs.
** wand - As in, <CODE>wand target</CODE>. Gets a wand from the specified storage and WAVES it at the target.
** wandolier - Similiar to wand, but uses wandoliers. Gets a wand from the fresh wand container and waves it, rubs container if no wands found. Default waves in offensive. Can change via <CODE>wandolier defensive</CODE> to wave in a different stance
** fire - As in, <CODE>fire target</CODE>. Gets ammunition from the specified storage and FIREs it at the target. Will attempt to aim based on settings on hunting tab.
*** The above listed commands should be used with the (x#) syntax. For example, <CODE>kill target (x3)</CODE> will swing three times at the target before re-evaluating the attack routine. If the (xx) variable is used, Bigshot will continue using the specified attack command up to five (5) times. Example: <CODE>903 target (xx)</CODE> will continue to cast 903 at the target (5) times before restarting the attack routine or until it is dead. If you want to ensure the routine does not restart, using a sufficiently large number should suffice (e.g. x100). Bigshot may also be set to only execute a command based on how much mana or stamina you currently have. For mana, use the (m##) command. <CODE>920 target (m50)</CODE> will only cast 920 (Implosion) if you have 50 or more mana. Similarly, <CODE>cman feint target (s10)</CODE> will only execute the combat maneuver Feint on the target if you have 10 or more stamina. The command syntax is used as a separate call and wrapped in separate parenthesis, as in (m50 s20)(x2).
** aim <location> - Aims at the specified location.
** ambush - Uses the AMBUSH verb to attack. Will aim based on settings in Hunting tab. Also will aim dynamically, "Ambush head" would aim at the head, overwriting any settings or defaults for that attack.
** wait <time> - Bigshot may Stance Dance by using the WAIT command. Bigshot will go into and stay in Stance Defensive until the specified time is over OR the target swings / casts, whereupon it will evaluate the rest of the Attack Routine, changing into your specified attack stance.
** mstrike - As in, <CODE>mstrike target</CODE>. Mstrike depending on mstrike cooldown and stamina. Has its own option page. Can also be used with UAC, "mstrike punch".
** berserk - Executes the BERSERK verb and stands by until it fades.
** throw - Empties hands, Attempts throw, get the stuff you emptied.
** weed/kweed - Casts 610 at target. Using "kweed" as your command will force evoke 610 ensuring the damage version
** curse <curse> - Clumsy/Weakness/Darkness/Itch/Hex/Pox/Nightmare/Star - will prep 715 and use curse command as defined. Will skip "curse star" if buff is up.
** unarmed - Uses the Bigshot UAC routine. Routine will attack with appropriate attacks to rank up and use mstrike based on mstrike options page. Usage "unarmed (punch|jab|kick|grapple)".
** smite - Performs an [[Order of Voln]] [[Kai's_Smite|Smite]] on target until successful.
** leech - Performs a [[Mana Leech (516)]] on target if cooldown is under 15 minutes.
** script <script name> - Executes a specified custom attack script.
** hide - Continue hiding until you're actually hidden. Or it's tired of trying.
** sleep - As in, <CODE>sleep 10</CODE>. Pause bigshot. Useful with fried hunting commands such as: <CODE>410, sleep 15</CODE> will E-wave then wait 15 seconds and e-wave again if there are valid targets.
** stance - As in, <CODE>stance defense</CODE>. Change stances.
** nudgeweapons - Move all weapons on the ground to an adjacent room. Useful for casting Implosion (720).
** force <cmd> until <endroll> - As in, <CODE>force incant 1002 until 101</CODE>. Continue issuing a command until a desired endroll. Only works for normal looking swings/spells/cmans.
** eachtarget <cmd> - issues command to each valid target in room
** efury <fire|cold> - casts Earthern Fury (917) on the target and waits for DOT to end or 12secs to pass
** caststop <spell> - casts the spell and then immediately stops it after casting
** wield <noun> <left|right> - weilds new noun and stores the hand given to put new noun item in
** store - store left, right or both, but only if something is in those hands
** tether <recast> - casts 706 with built-in logic to wait, can also do recast to auto-recast 706 on creature death and DOTs transfer
** unravel <spell> - casts 1013 Song of Unravelling with an optional spell to target against creature
** depress - casts 1015 Song of Depression with some some built in logic
** phase - force CASTs 704 Phase due to needing to prep/cast for usage on NPC targets
* hunting commands (b) - Attack routines set up for a monster flagged (b) in the Hunting section.
* hunting commands (c) - Attack routines set up for a monster flagged (c) in the Hunting section.
* hunting commands (d) - Attack routines set up for a monster flagged (d) in the Hunting section.
* hunting commands (e) - Attack routines set up for a monster flagged (e) in the Hunting section.
* hunting commands (f) - Attack routines set up for a monster flagged (f) in the Hunting section.
* hunting commands (g) - Attack routines set up for a monster flagged (g) in the Hunting section.
* hunting commands (h) - Attack routines set up for a monster flagged (h) in the Hunting section.
* hunting commands (i) - Attack routines set up for a monster flagged (i) in the Hunting section.
* hunting commands (j) - Attack routines set up for a monster flagged (j) in the Hunting section.
* fried hunting commands - Commands executed specifically when fried. Useful when hunting in a group.
* quick hunting commands - Commands executed specifically when using ;bigshot quick.
* valid targets: - These are the monsters you are hunting. Bigshot will most easily recognize monsters based on the NOUNs or their name. For example, 'a large ogre' can be targeted with just 'ogre'. Using longer descriptors can be troublesome, and you should copy a monster's name directly from the game front end to avoid troubles. You can use multiple entries separated by commas. For example: 'manticore, thrak' will kill manticores and thraks.
* quickhunt targets: - These are monsters you have designated attacks for when your using the ;bigshot quick option for hunting.

===PSM3 Integration===
* hunting commands - Bigshot now supports weapon/shield skills and warcries. Assaults will wait until they finish or are interuppted. These commands are separated by a comma. The following are a list of usable hunting commands:
** barrage, flurry, fury, gthrusts, pummel, thrash - Assaults will wait until attacks are completed/interrupted.
** fury - You can specify the default attack fury will use. Will jab if not specified: fury punch or fury kick
** charge, cripple, dizzyingswing, pindown, twinhammer - Setups will execute on cooldown so make sure to check for prone/stun/root/ect.
** clash, cyclone, pulverize, volley, wblade, whirlwind - AOE will execute on cooldown, limit with check volley(mob3).
** shout - Will perform warcry shout. Must use a command check or it will shout every loop: shout(!shout),shout(buff10 s25)
** yowlp - Will perform warcry yowlp. Must use a command check or it will yowlp every loop: yowlp(!yowlp), yowlp(buff10 s10)
** holler - Will perform warcry holler every loop taunting all the mobs. holler(s60)
** bellow, growl, cry - Offensive warcries can be used with target for single target or all for aoe.
** shield bash, shield charge, shield pin, shield push, shield strike, shield trample, shield throw
** surge - Will keep surge of strength up. surge or surge(surge) will cast even on cooldown, surge(!surge) will only cast when not on cooldown.
** bearhug, bullrush, coupdegrace, cpress, cutthroat, dirtkick, disarm, dislodge, divert, eviscerate, exsanguinate, eyepoke, feint, footstomp, garrote, gkick, hamstring, haymaker, headbutt, kifocus, kneebash, leapattack, mblow, mug, nosetweak, sattack, sblow, scleave, shroud, spunch, sthieve, subdue, sunder, sweep, swiftkick, tackle, templeshot, throatchop, trip, truestrike, vaultkick
** dislodge <location> - Dislodge from location specified: dislodge eye neck
** stomp - Will perform a stomp attack. Channels 909 if not active. Can also add 909 to society abilities to keep it active.
** dhurl - Hurl your weapon and recovers it. Works with weapon bonding auto return and the recover verb.
** assume <aspect> <aspect/evoke> - Will cycle between two aspects, or evoke a single aspect. Also works in society ability box. "650 <aspect> <aspect/evoke>"
** briar <weapon> - activate the AS buff on briar weapons. Tracks weapon charge and uses on cooldown.
** stance perfection - Put 10, 20, 30, ect in your attack stance box to take advantage of stance perfection.
** chastise, excoriate - Will perform FEAT if available and affordable

You may need to '''SKILLS FULL/CMAN INFO/WEAPON INFO/SHIELD INFO''' if you've recently changed training or skills are being outright skipped.

===Additional Options===
*haste or 506 - Placing this in front of any command will cause you to cast 506 before doing that command. It only casts if it isn't currently up or has less than 3 seconds left on its timer.
<PRE>wait 10, haste kill (x3)</PRE>
*slayer or 240 - Placing this in front of any command will cause you to cast 240 before doing that command. It will not recast if it's already active.
<PRE>slayer 302 (x99)</PRE>

===Command Checks===

Commands need to use the following format:
<CODE>COMMAND (CHECKS)(REPETITIONS)</CODE>

So <CODE>hamstring (mob1 prone)(x2)</CODE> Any (x#) needs to be separate. Also (xx) is not unlimited and is just short for (x5).

Additional checks you can add to any command to customize the attack to your desired scenario.
Each check below can be used by itself or with any other check. Put them inside () with a space between each additional check. Example - Kill(m20 s5 e20)
<p>Each of these also has an inverse or opposite.
Just put a ! in front of the command. Example - Kill(!m20 !s5 !e20)
*s# - Checks that you have the required stamina
*m# - Checks that you have the required mana
*h# - Checks that you have the required health but based on a percentage instead of fixed number
*v# - Checks that you have the required spirit
*e# - Checks that your encumbrance percentage is at or below
*tier# - Checks for your current UAC tier (1,2,3). Performs command if UAC Tier is equal or greater.
*mob# - Checks for the number of npcs in room. Performs command if npcs in room is equal to or more than number specified. Only use for 2 or more creatures in the room
<PRE>To further clarify the mob# implimentation
1 mob, mob2, 1 IS less than 2, attack should not proceed.
2 mob, mob2, 2 IS NOT less than 2, attack can proceed
1 mob, !mob2, 1 IS NOT more than 2, attack can proceed
2 mob, !mob2, 2 IS NOT more than 2, attack can proceed
3 mob, !mob2, 3 IS more than 2, attack should not proceed</PRE>
*once - Performs the command once on a specified target, resets on room change
*room - Performs the command once in a room only, resets on room change
*prone - Checks to see if target is not sleeping|webbed|stunned|kneeling|sitting|lying down|prone|frozen|held in place. Performs command if target status is not one of the previous.
*frozen - Same usage as prone. Broke out of prone check for archers against non-corporeal creatures that deflect ranged. Corporeal creatures can be stunned and will break this check.
*undead - Checks to see if target is undead. Performed command if target is undead.
*flying - Checks to see if target is flying. Performed command if target is flying.
*rooted - Checks to see if the target is rooted. Performed command if target is rooted.
*hidden - Checks to see if you're currently hidden.
*poison - Checks to see if you're currently poisoned.
*disease - Checks to see if you're currently diseased.
*noncorporeal - Checks to see if NPC is [[noncorporeal|non-corporeal]] undead
*pcs - Checks to see if there are any PCS in room that are also not in your group
*outside - Checks to see if the room you are in is outside
*barrage - Checks for the Enhanced Dexterity buff from Barrage.
*fury - Checks for the Enhanced Constitution buff from Fury.
*flurry - Checks for the Slashing Strikes buff from Flurry.
*pummel - Checks for the Concussive Blows buff from Pummel.
*thrash - Checks for the Forceful Blows buff from Thrash.
*vigor - Checks for the Tangleweed Vigor buff from Tangleweed.
*reflex - Checks for the Arcane Reflex buff from Nature's Touch.
*tailwind - Checks for Tailwind buff from Breeze. (tailwind) (!tailwind)
*shout - Checks for the Empowered buff from Shout.
*yowlp - Checks for the Yertie's Yowlp buff from Yowlp.
*holler - Checks for the Horland's Holler buff from Holler.
*voidweaver - checks for the Voidweaver buff from Implosion(720)
*justice - Checks for charges of Swift Justice. (justice) do skill with charges (!justice) do skill with no charges
*buffXX - Fire ability when buff duration is <= XX. Supported for barrage,bearhug,coupdegrace,fury,flurry,pummel,thrash,shout,yowlp
*tier# - Perform action if you are at the corresponding tier. (!tier3) don't do it if you are at tier3. (tier2) do it if you are tier2
*censer - Attempt to cast 320 before your command checking mana and cooldown. 309(censer), 335(censer mob3), attack(censer)
*ancient - Checks for grizzled/ancient creatures
*animate - Checks for if you have an animate present or not
*rebuke - Checks for Righteous Rebuke buff
*scourge - Checks for Ardor of the Scourge buff
*momentum - Checks for Glorious Momentum buff
*coupdegrace - Checks for Empowered buff.
**If command is a spell, will only cast censer if you have the mana for censer and the spell you intend.
**If command is not a spell, will only check you have enough mana for the censer.

===Example Attack Routines===
<PRE>wait 10, kill (x3)</PRE>

Waits 10 seconds for the monster to swing or cast and then immediately counter attacks from the specified attack stance set in the Hunting tab. Swings a total of three times before going into Defensive stance and waiting 10 seconds again.

<PRE>wait 15, incant 505, incant 903 (xx)</PRE>

Waits 15 seconds before INCANTing 505 (Hand of Tonis), hopefully knocking down or stunning the target. Following this, Bigshot casts 903 (minor water) repeatedly until the target is dead (up to 5 times).

<PRE>stance defensive and incant 1615, kill (x100)</PRE>

Casts 1615 (Divine Strike) at the target from Defensive stance, possibly forcing the target to kneel. Then, uses the kill verb to swing continuously until the target is dead or 100 times..whichever happens first.

<PRE>force feint until 101, kill (x2)</PRE>

Uses the Combat Maneuver FEINT against the target until a successful end roll and then hits the target twice before trying to FEINT again.

<PRE>stance defensive and hide, ambush left leg</PRE>

Hides from Defensive stance and then ambushes that the target's left leg. Once round-time is up, repeats (ie HIDES again from defensive stance).

<PRE>incant 720(m50), incant 708, incant 702 channel(xx)</PRE>

Casts 720 (Implosion) at the target if your character has 50 or more mana. Then, INCANTs 708 (Limb Disruption) at the target, using the default AIM location (if set). Finally, casts 702 (Mana Disruption) at the target up to (5) times or until it is dead.

<PRE>prep 708, cast at left leg / prep 708 channel at left leg, incant 719 (m50)(x1), incant 702 (xx)</PRE>

Prepares 708 (Limb Disruption) and CASTs it at the target's left leg. The second prepares the same spell and then CHANNELs it at the target's left leg. It will then cast 719 (Dark Catalyst) if there is at least 50 mana, and will only cast one time. The last will incant 702 until the creature is dead.

<PRE>wait 30, unarmed punch</PRE>

Waits 30 seconds or until your target attacks. Begins attacked with UAC combat using Punch to tier up.

<PRE>shield charge (s15 prone), ambush, mstrike</PRE>

Will shield charge the target if your character has 15 or more stamina and the target is NOT prone.

The second command will then ambush based on the settings in the "Attacking" Tab - in this case a custom order of head, neck, right leg, back was given so Bigshot will first try to Ambush the head unless the head is too injured or the head cannot be reached followed by the neck then right leg then back.

Bigshot will then focus mstrike the target unless the creature count is equal to or greater than the setting in the MSTRIKE Tab, in which case it will open mstrike instead. If you put "mstrike target", Bigshot will always focused mstrike regardless of the settings in the MSTRIKE Tab. Alternatively, you can set the "Unfocused MSTRIKE when creatures equal or greater" to a large number, to always focus your mstrikes (or set it to 1 to always open mstrike).

<PRE>bellow all, wblade(mob3), flurry(!flurry), attack</PRE>

Will aoe bellow, then whirling blade if there are at least 3 targets. The third command will flurry if you don't have the slashing strikes buff. Finally it will attack and continue to attack until one of the previous attacks become available.

<PRE>holler, shield throw(mob3), flurry, thrash, attack</PRE>

Will open up with a taunt from holler, then shield throw if there are at least 3 targets. Third command will flurry on cooldown. Fourth will thrash on cooldown. Finally we will attack if everything else ends up on cooldown or we run out of stamina.

<PRE>shroud(s35 !hidden mob2), divert (s25 hidden mob2), ambush(hidden), flurry, attack</PRE>

If there is more than one mob, it will hide with shroud and divert one of the targets. Third command will ambush if hidden. Fourth will flurry on cooldown followed up with attack to finish anything off.

<PRE>surge(!surge), bullrush, bearhug, pummel, attack</PRE>

Will cast surge when not on cooldown, and bullrush to bust up and apply vulnerable, then bearhug which is faster if target is vulnerable. Third we will pummel on cooldown and attack when nothing else is available.

<PRE>surge, shout(buff10), shield strike, pummel(buff60), attack(x2)</PRE>

Will keep surge active, casting during cooldown for 60 stamina. Next it will shout and refresh shout when there is less than 11 seconds left on the duration. Third it will shield strike followed up with a pummel once every minute. It will finish off with 2 attacks.

<PRE>pindown(mob4), volley(mob2), weed(!vigor !reflex), barrage(!barrage), incant 616 (m16 reflex), fire</PRE>

Will open up with pin down if there are at least 4 targets, then will volley if there are at least 2 targets. The third command will cast tangleweed if you do not have the tangleweed vigor buff or the arcane reflex buff. Our fourth command will barrage unless we have the enhanced dexterity buff from barage. Fifth we will cast a 1 second spike thorn if we do have 16 mana and do have the arcane reflex buff. Finally we will fire until one of our other commands become available.

===Hunting Target Examples===
All of the examples below will work for both the 'valid targets' and 'quickhunt targets' entries.
* A hunting option only using the default command (a) for each creature in an area:
<pre>crazed zombie, niirsha, sacristan spirit</pre>
* A hunting option using custom hunt commands depending on the creature. In this case it will use command (a) for a [[crazed zombie]] and a [[sacristan spirit]], while using (b) for a [[niirsha]]:
<pre>crazed zombie(a), niirsha(b), sacristan spirit(a)</pre>
* A hunting option that will include the [[:Category:Boss creatures|Boss Creatures]] variations as valid targets:
<pre>(?:adroit |afflicted |apt |barbed |belligerent |blurry |canny |combative |dazzling |deft |diseased |drab |dreary |ethereal |flashy |flexile |flickering |flinty |frenzied |ghastly |ghostly |gleaming |glittering |glorious |glowing |grotesque |hardy |illustrious |indistinct |keen |lanky |luminous |lustrous |muculent |nebulous |oozing |pestilent |radiant |raging |ready |resolute |robust |rune-covered |shadowy |shielded |shifting |shimmering |shining |sickly green |sinuous |slimy |sparkling |spindly |spiny |stalwart |steadfast |stout |tattooed |tenebrous |tough |twinkling |unflinching |unyielding |wavering |wispy )?crazed zombie, niirsha, sacristan spirit</pre>
* Some additional advanced options for identifying valid targets:
<pre>
(?:seasoned |grizzled |battle-scarred |weathered |veteran |hulking |haggard )?Grimswarm (?:giant|troll|orc) (?:dissembler|sorcerer|sorceress|warlock|witch)(a)
(?:seasoned |grizzled |battle-scarred |weathered |veteran |hulking |haggard )?Grimswarm (?:giant|troll|orc) (?:barbarian|blackguard|fighter|marauder|soldier|warrior)(b)
(?:seasoned |grizzled |battle-scarred |weathered |veteran |hulking |haggard )?Grimswarm (?:giant|troll|orc) (?:adept|archmage|elementalist|mage|warmage)(c)
(?:seasoned |grizzled |battle-scarred |weathered |veteran |hulking |haggard )?Grimswarm (?:giant|troll|orc) (?:hunter|huntmaster|huntmistress|ranger)(d)
(?:seasoned )?(?:dwarven|elven|halfling|erithian|human|giantman|half-krolvin|gnomish|half-elven) (?:thief|rogue|bandit|mugger|outlaw|highwayman|marauder|brigand|thug|robber)(e)
(?:shopkeeper|innkeeper|bartender|patrol leader|bandit lord|bandit lady|gypsy queen|gypsy king|guard captain|wall captain|drill sergeant|stable hostler|dungeon master|master torturer|butler|cook|
knight captain|foreign dignitary|royal prince|royal princess|royal jester|royal emperor|royal empress)(f)
</pre>
* To attack everything in the room <code>(?:.*)</code>

== Misc Tab==
Various specialized config options

===UAC Options===
The various options for configuring how UAC works:
* '''Tier 3 Attack'''
** The attack used when you have reached excellent in the UAC tier
** Options are jab, punch, grapple, or kick
* '''Aim at location (head, etc)'''
** Used for aimed UAC Combat, which requires ambush training to be effective
** Leave blank when you don't want to aim.
* '''MSTRIKE when creatures equal or greater'''
** Determines how many creatures must be present before using MSTRIKE
* '''Use Voln SMITE?'''
** Will perform a Voln SMITE on [[Non-corporeal]] undead

Frequently, people have trouble setting up Bigshot to work with Unarmed Combat. Bigshot only requires minimal configuration to ensure UAC works well.
#UAC tab: Input your '''Tier 3 Attack''' (jab, punch, grapple, or kick)
#Commands tab: Input your '''hunting commands(a)''' option as '''unarmed jab'''

Important notes to keep in mind on how UAC works in Bigshot:
* The hunting option '''unarmed jab''' can be replaced by any UAC attack type (e.g. '''unarmed punch''')
* UAC follow up strikes will be selected over the base or tier 3 attack
* Tier 3 attacks will be used only when positioning is excellent

There is almost no reason to ever use anything other than '''unarmed jab'' as the hunting command, and either '''grapple''' or '''kick''' as the Tier 3 attack.

===MSTRIKE Options===
MSTRIKE attack now has options for when it should be used.
* '''MSTRIKE during cooldown stamina requirement'''
** Allows you to specify how much stamina you want before it will MSTRIKE during the MSTRIKE Cooldown
** Be careful when setting this too low as it can pop your muscles
** Leave blank for it to use your max stamina.
* '''QUICKSTRIKE stamina requirement'''
** Like above but instead for using QUICKSTRIKE during the MSTRIKE routine.
* '''Unfocused MSTRIKE when creatures equal or greater'''
** Number of creatures in room before you do an unfocused mstrike. Default is 2.
* '''MSTRIKE during cooldown'''
**Toggle for MSTRIKEing during its cooldown period
* '''Use QUICKSTRIKE for MSTRIKE'''
** Toggle for using QUICKSTRIKE when you MSTRIKE

===Ammo/Wands===
Here you find the settings to tell Bigshot where you keep all of your nifty wands and bolts and arrows. If your attack routine involves FIRE or WAND verbs, these fields must be set lest Bigshot hang up.
* find ammo in this container: - Leave BLANK if having Bigshot use FIRE without getting ammo out (Archery 2020 Update). Rather self explanatory, this field holds the location of your ammunition storage, be it a wand harness, a quiver or just your backpack.
* use this ammo type: - Leave BLANK to have Bigshot use FIRE without getting any ammo (Archery 2020 Update). Again, like specifying monsters, Bigshot is most sensative about the NOUNs that you use here. If you
* fresh wand container: - Bigshot looks in this container to find fesh wands to WAVE.
* dead wand container: - ...And then will deposit the used up wands in this container.
* use this wand type: - Here you specify which particular wand type you want to use. Bigshot will then pull only these kinds for WAVEing. Can have multiple types listed. Seperate each one with a comma. Example: "aquamarine wand, bloodwood wand, etc"
* Hide while waiting to pick up ammo - Checking this box will have Bigshot hide when gathering up your spent arrows and bolts.
* Use wands when out of mana - Bigshot will pull whatever wand you have specified in the use this wand type field and automatically stance to your attacking stance and WAVE your wand at valid targets until you are out of wands OR hit your resting conditions.

===MA Grouping===
* Enter the name of the looter in Head/Tail configuration

==Monitoring Tab==
* Monitor interaction - Running scripts automates most functions and happens rather mechanically. Most anyone can tell if you are scripting just by watching you. Checking this box will pop up a window whenever Bigshot thinks that someone or something is trying to interact with you.
* Engage deadman's switch - Selecting this option will force Bigshot to quit Gemstone IV when your character is at less than 40% health, allowing you to log back on and assess the situation manually later.
* Depart/rerun if dead - Enabling this option will force a DEPART, causing your character to wake up in the Temple with low spirit. Following this, Bigshot will re-start, starting a fresh hunt. If you do not have a Check Spirit value set in your Should_hunt? tab, you will start hunting without recuperating lost stats.
* Quiet followers - Followers will wait until leader is done with both actions and resting scripts to begin using their own.

===Debugging:===
<pre{{log2}}>
+---------------------------------------------------------------------------+
| Bigshot Debug Help v5.8.5 |
+---------------------------------------------------------------------------+
| Debug options have changed to be more helpful. |
+--------------------------------------+------------------------------------+
| ;bigshot debug file | Toggles logging to a file <on/off> |
| ;bigshot debug all <true/false> | Toggles true/false all the things |
| ;bigshot debug check | Lists current debug settings |
| ;bigshot debug combat <true/false> | Combat and Creature Status |
| ;bigshot debug commands <true/false> | Attacking and Casting Commands |
| ;bigshot debug status <true/false> | Status Checks of your Character |
| ;bigshot debug system <true/false> | System processes |
| | |
| Options can be combined: |
| ;bigshot debug combat commands status <true/false> |
+---------------------------------------------------------------------------+
</pre>

==Ingame Screenshot==
<gallery perrow="4">
File:bigshot-1.PNG|Profiles
File:bigshot-2.PNG|Resting
File:bigshot-3.PNG|Hunting
File:bigshot-4.PNG|Attacking
File:bigshot-5.PNG|Commands
File:bigshot-6.PNG|Misc
File:bigshot-7.PNG|Monitoring
</gallery>

==Reference==
* Info originally taken from http://forum.gsplayers.com/showthread.php?t=57651

{{Third-Party Software}}
{{top}}

Lich:Script Bigshot/Changelog

2025-09-08T16:02:13Z

WHIGHTCNIGHT: /* Change Log */ updated to 5.9.5

{{3rd-party}}
== Change Log ==

<pre{{log2|background=none|border=none|margin-left=none|margin-right=none|font-size=93%}}>
v5.9.5 (2025-07-22)
- remove companion_check calls as no longer needed with migration to GameObj.targets for valid creatures
- add check_disks param to bigclaim? method
- add claim check to attack_break and need_to_loot (ignoring disk check)
- add coupdegrace buff check and command check
- increase bs_move timeout from 2 to 5
v5.9.4 (2025-07-08)
- bugfix for leader final loot to only work if claim is true
v5.9.3 (2025-07-02)
- bugfix for shield bash if using CMan instead of shield
- bugfix for FORCE cmd to stop checking older lines if it found a proper attack messaging but failed the match
- bugfix for cmd_tether to end if link is broken
v5.9.2 (2025-06-30)
- bugfix in cmd_tether potential npc logic
v5.9.1 (2025-06-27)
- Fix for head/tails bs_wander groupcheck logic
v5.9.0 (2025-04-03)
- Convert over to use Group and Claim modules from core Lich5
- bugfix in cmd_assaults for confusion
- add additional logic to cmd_unravel for creature gone/dead
- bugfix in bs_put for bleedthru numbers merged with wait time (EXP output: Level: 100...wait 1 seconds.)
- bugfix in creeping_dread typo name
- attempts as head to pull tail members to feet if not standing prior to returning to resting
- adds cmd_depress for 1015/Song of Depression usage
- adds cmd_phase for 704/Phase to purpose prep/cast with NPC as target due to special use of changing non-corp to corp undead
- adds final room loot option for leader in head/tail
- add disarm weapon to cmd_cman
- bugfix break PSM loop early if not affordable after wait messaging
- cleanup class detection logic to use is_a? logic instead
- bugfix in cmd_force to search newest msg to oldest via reget reversing
- add Feat support for Chastise & Excoriate
- add Righteous Rebuke command check (rebuke)
- add Ardor of the Scourge command check (scourge)
- add Glorious Momentum command check (momentum)
- fix depart monitor to use ewaggle instead of waggle
- fix clean value setting for rest_till_exp & rest_till_mana
v5.8.5 (2025-03-28)
- bugfix for follower resting commands use running a script
- add cooldown detection to cmd_spell and 140/919/211/215/219/1619/1650
v5.8.4 (2025-03-19)
- remove deprecated calls
v5.8.3 (2025-03-10)
- bugfix in run_script to use exact naming of script that was started
v5.8.2 (2025-02-26)
- bugfix in run_script needing EXACT match for Script.running? check. Script.start is not exact. Causing issues
- bugfix in command_check split_check
v5.8.1 (2025-02-26)
- add garrote command to buffXX command check validity for Enh. Agility buff
- add garrote command check for active buff check
- cleanup command check regex to simplify
v5.8.0 (2025-02-20)
- add custom fog option
- option to force resting if looting leaves a box in your hand
- enable pre-rest commands to call scripts eg. script go2 place
- bugfix in tether command
- add ancient & !ancient command checks for grizzled/ancient creatures
- add animate & !animate command checks for if you have an animate present or not
- change command_checks to lamdas for optimization
v5.7.10 (2025-02-18)
- add option for cmd_tether to recast upon death and transfer of dots
v5.7.9 (2025-02-15)
- fix stand() to not stand if casting 608 and kneeling with a crossbow in hand
v5.7.8 (2025-02-11)
- update $bigshot_status to utilize :ready instead of :hunting when clear to hunt
- update $bigshot_status to :hunting when arrived in do_hunt() and actually starts hunting
v5.7.7 (2025-02-10)
- bugfix in cmd_curse due to custom prep/curse logic
v5.7.6 (2025-02-08)
- bugfix where claims was including characters disk
v5.7.5 (2025-01-30)
- bugfix in resting method for fog_return
v5.7.4 (2025-01-22)
- adjust loop delay for efury and tether
v5.7.3 (2025-01-20)
- added command tether to have spell 706 wait until completion
- update to efury command
- fix for constant redefinition Ruby warnings
v5.7.2 (2025-01-15)
- added implosion(720) cooldown
- added check for voidwalker buff from 720
v5.7.1 (2025-01-13)
- added client input into debug file
v5.7.0 (2025-01-12)
- added debug logging to file
v5.6.11 (2025-01-02)
- added cmd_rapid for rapidfire/515 usage
- added rapid/!rapid command check for current rapidfire buff
- bugfix for room claim with disks if SET DESCRIPTION is off
v5.6.10 (2024-12-22)
- added optional stand-up stance selection
- bugfix for surge in cmd_surge and command_check
- bugfix for burst in command_check
v5.6.9 (2024-12-09)
- bugfix for group members in room claim
- bugfix for weapon reactions to be done in @HUNTING_STANCE
v5.6.8 (2024-12-06)
- additional regex for rooted debuff
- bugfix for leader waiting to regroup during rest cycle
v5.6.7 (2024-12-06)
- bugfix for follower not attacking
- add cmd_wandolier (using fresh wand container and wand name)
v5.6.6 (2024-12-02)
- typo in load_settings: 'maxstamina' should be maxstamina
v5.6.5 (2024-11-23)
- added test method, usage: ;bigshot test <method> <arg1> <arg2> etc.
- added ;bigshot list to display initialized values
- bugfix for out of mana default not an integer
- update to check_required_values
- update to load_settings
- bugfix to allow follower to sit when resting
- bugfix updating spin button settings
- $rest_reason wasn't being reset before next hunt
- bugfix in profile sorting
- bugfix for leader to wait for wounded follower
- bugfix unnecessary groupcheck in pre_hunt method
v5.6.4 (2024-11-18)
- bugfix for ready_to_hunt stamina check when set to 100
v5.6.3 (2024-11-14)
- bugfix for the command check when rooted
v5.6.2 (2024-11-13
- prevent UAC from trying to kick when rooted
v5.6.1 (2024-11-13)
- bugfix in bandit tracking
- bugfix in loot() method
- add msg in class BSAreaRooms if open boundary
v5.6.0 (2024-09-11)
- new room claim process inspired by ;overwatch and Lich::Claim
- additional targeting for bandits
- bugfix on confusion status to confused
v5.5.0 (2024-08-24)
- rework of debug messaging
- removed duplicate calls to methods
- once command update for force
- updated check_required_values for integer Use
- set defaults for integer settings
- support for worn items with wield command
v5.4.5 (2024-08-20)
- update spinButton to save properly when manually entered
v5.4.4 (2024-08-19)
- remove unused GUI elements
v5.4.3 (2024-08-19)
- updated wander wait to a spin button
- bugfix for missing id on lte_boost
- update OOM spin button to allow for negatives
- updated OOM check for negative values
v5.4.2 (2024-08-17)
- bugfix in cmd_spell to set Spell's @@after_stance to prevent forced stance dancing when hunting_stance is offensive
v5.4.1 (2024-08-14)
- room command check logic correction
v5.4.0 (2024-08-07)
- UI updates
- Notes section added on profiles tab
- percent_stamina added as a should_hunt? parameter
- wander stance added
v5.3.17 (2024-08-05)
- added 506/celerity check
- fix for hunt_monitor not working for followers
v5.3.16 (2024-08-04)
- fix for ROOM being missed in command_check regex
v5.3.15 (2024-07-25)
- add ROOM command check, Performs the command a single time only per room, clears on room change
v5.3.14 (2024-07-24)
- bugfix for reset_variables
v5.3.13 (2024-07-19)
- bugfix for head/tail random looting
- bugfix for smite tracking in a group
v5.3.12 (2024-07-13)
- update profile_current and save_profile_name when using CLI profile load/save
- bugfix ready_to_rest? should_rest lambda logic
v5.3.11 (2024-06-20)
- fix to break from cmd_assault command on cooldown if loop repeated
v5.3.10 (2024-06-15)
- added support for Seanette's Shout in Society/Abilities/Spells/Cmans section of the hunting tab
v5.3.9 (2024-05-29)
- add additional missing cmd_assault regex matching
v5.3.8 (2024-05-18)
- remove superfluous check for escorts, not needed since they are not valid targets
v5.3.7 (2024-05-01)
- fix for Char.prof/Char.level to Stats.prof/Stats.level
v5.3.6 (2024-04-28)
- add additional custom disk noun
v5.3.5 (2024-04-24)
- handle all the new custom disk nouns
v5.3.4 (2024-03-29)
- fix to add Tangle Weed (610) status of "entangled" to the PRONE regex
- fix for kweed command to use EVOKE instead of stancing
v5.3.3 (2024-03-15)
- fix for cmd_briar to use MEASURE instead of LOOK due to gamefeed issue with extended show descriptions
- fix for cmd_briar to support UCS worn gear and two weapon combat
v5.3.2 (2024-03-12)
- bugfix in check_required_values
v5.3.1 (2024-03-11)
- bugfix for UIDs in boundary rooms and new boundary return outside of hunting area feature
- added cmd_curse command for Sorcerer spell Curse 715
- added cmd_store command to store left, right or both, but only if something is in those hands
v5.3.0 (2023-11-29)
- added boundary return if character ends up outside hunting area
- added option to double cast on fog options when returning from the Rift
- added support for warcry holler buff
- fixed bug in stand method when command is an array
- fixed command to standardize to downcase
- fixed bug in head/tail looting where the leader wasn't waiting for the follower to loot
- removed $bigshot_briar in favor of Spell[9105]
- added toggle to check for favor before using voln symbol on hunting tab
- expanded need_to_loot method for 1108 kills
- added escape for temporal rift
- added eachtarget command that attacks each creature in the room eg. (eachtarget force incant 917 until 101 (once), incant 903 (x10))
- removed change log comments before 5.0.0 and updated wiki
v5.2.2 (2023-11-21)
- bugfix causing bs_wander to delay 0.5 seconds longer than needed
- added Roa'ter and Ooze escape check in bs_wander
v5.2.1 (2023-11-15)
- add new efury, caststop, and wield cmd
- redo unravel/barddispel cmd
v5.2.0 (2023-10-02)
- general adjustment to group hunting
- additions to group looting for exclude individuals as well as allowing for changing looter based on encumbrance
- changes to try and prevent leaving stray bandits
- update to prevent targeting 709 arms
- allows multiple rally rooms just separate with commas
- added multiple return room waypoints
- added support for ranger tracking. Usage ;bigshot <options> <creature> example: ;bigshot single giant rat
v5.1.10 (2023-09-28)
- bugfix for ;bigshot quick occassionally stopping when another character enters the room
- changed BIGSHOT_VERSION variable to pull version from title block
- bugfix for display output
v5.1.9 (2023-09-24)
- fix to debug variable being hard set at launch to false.
- add CLI debug option to toggle debug value between true/false.
v5.1.8 (2023-09-18)
- add acid & steam to incant 518 allowances in cmd_spell
v5.1.7 (2023-09-16)
- bugfix wracking not considering active COL signs
- added RT check for wand method
v5.1.6 (2023-09-12)
- bugfix for cmd_force when target has 115
v5.1.5 (2023-08-30)
- bugfix for calling escape_rooms for tail
v5.1.4 (2023-08-30)
- bugfix for Roa'ter and Ooze escape for head/tail
v5.1.3 (2023-08-26)
- add 335/Divine Wrath cooldown check in cmd_spell to not cast
- change cmd_spell to use Spell.force_incant for incanted spells instead of bs_put
v5.1.2 (2023-08-21)
- fix incorrect regex match for mighty blow
v5.1.1 (2023-08-14)
- fix missing regex match for censer command check
v5.1.0 (2023-08-07)
- add ooze_escape for getting out of Ooze, Innards in HW.
v5.0.0 (2023-7-19)
- move method spell_is_selfcast? inside Bigshot class
- corrected deadmans typo
- moved Setup class outside main Bigshot block
- renamed various methods to snake case
- removed changlog notes older than 4.17.0 and updated changelog on wiki
- bugfix for bearhug complete_regex and in the command check
- retry RT commands for warrior and rogue guild cmans
- added rooted to status check
- bugfix in check_target_vitals
- bugfix in cast_signs undefined method `=~' for false:FalseClass
v4.17.6 (2023-07-11)
- will perform one final loot call if OOM, bounty complete, dread, or fried before resting
- bugfix in cast signs for KS+Mental Acuity Monk
v4.17.5 (2023-07-05)
- Added support for MA hunting single loop
v4.17.4 (2023-06-29)
- Expanded UCS followup attack tracking to work with PSM attacks.
- Added UCS tier command checks tier3, !tier3, ect.
v4.17.3 (2023-06-24)
- Added support for sneaking while hunting.
v4.17.2 (2023-06-21)
- Added missing regex for fury completion.
v4.17.1 (2023-06-13)
- Reconfigure assume aspect
- Removed check that could cause nerves to get blown.
- Added cman ki focus
v4.17.0 (2023-06-04)
- Skip infomon.lic check if on newer Lich versions
v4.16.3 (2023-05-20)
- Update for groupcheck to strip XML from $grouplist
v4.16.2 (2023-05-19)
- Update for GROUP output display
v4.16.1 (2023-05-16)
- Add burst of swiftness
v4.16.0 (2023-04-06)
- Add bard command unravel to dispel and stop
- Add bard command barddispel to dispel single spell from target
- Add once command check to perform a command one time on a specific target only. Resets on room change.
- bugfix for barrange and using bolts
v4.15.6 (2023-04-04)
- Add cman sbash to cmans as was missing
v4.15.5 (2023-03-15)
- Rubocop cleanup
- replace script.vars with Script.current.vars
v4.15.4 (2023-03-13)
- add additional missing 709 arms to exclude for NPCs check
v4.15.3 (2023-03-02)
- bugfix for cmd_shields
v4.15.2 (2023-03-01)
- bugfix to allow cmd_weapons to work if using more than base Mnemonic
- bugfix to allow cmd_shields to work if using more than base Mnemonic
- bugfix to allow cmd_cmans to work if using more than base Mnemonic
- bugfix to allow cmd_bearhug to work if using more than base Mnemonic
- bugfix to allow cmd_rogue_cmans to work if using more than base Mnemonic
v4.15.1 (2023-02-18)
- initial bugfix(s) for Ruby 3.x compliance
- fix for exiting cmd_force if command check fails on cmd
v4.15.0 (2023-02-18)
- add tonis/1035 command
- bugfix to not try to pull dead people up
v4.14.8 (2023-02-11)
- moved bounty check to after looting to avoid excessive game feed
v4.14.7 (2023-02-09)
- added missing room claim check
v4.14.6 (2023-02-06)
- fix head/tail issues with claim
- cleaned up also here detection
- cleaned up cast_signs to not spam song status for bards
v4.14.5 (2023-02-03)
- regex fix for hunt monitor claim_room
- fix in bs_wander method for 'approach lone target only'
v4.14.4 (2023-02-02)
- fix second target aquisition to use valid_targets?
- fix odd issue that would cause you to loot existing corpses in specific scenarios.
v4.14.3 (2023-02-01)
- fixed bigshot quick group room claim
- fixed regex to prevent attacks from removing people from claim
v4.14.2 (2023-01-31)
- updates to room claim system ;e UserVars.show_claim = true/false to echo when room is claimed.
v4.14.1 (2023-01-28)
- bugfix for GTK display if old settings contained integer for certain fields
- bugfix to allow cmd_assault to work if using more than Mnemonic (ie fury punch)
- add new regex result for cmd_cmans for sattack
- remove spam/unspam as waitrt?/waitcastrt? updated in Lich5 to be faster by default
v4.14.0 (2023-01-25)
- add new slayer command for 240
- fix for wander_wait to use should_flee?
v4.13.18 (2023-01-24)
- introduced room claim system to prevent poaching.
v4.13.17 (2023-01-23)
- move wander_wait to prevent poaching
v4.13.16 (2023-01-21)
- added support to rest for debuffs: Wall of Thorn Poison, Confusion, Creeping Dread, and Crushing Dread
v4.13.15 (2023-01-12)
- Add 1650 cooldown check for cast_signs
v4.13.14 (2023-01-12)
- add bounty check while resting and in bounty mode
v4.13.13 (2022-12-03)
- add bounty check while resting and in bounty mode
v4.13.12 (2022-12-01)
- reset bounty_eval when bounty complete
v4.13.11
- bounty mode will only exit if bounty is complete or child present
v4.13.10 (2022-11-30)
- bug fix for comparison of bonded weapon return
v4.13.9 (2022-11-30)
- bug fix for extra kills not being in monsterbold
v4.13.8 (2022-11-18)
- convert directory lookups to File.join to prevent OS pathname issues
- bug fix for poaching on rally_point and starting room
- bug fix for cmd_assume
- fix for cmd_hide using bs_put instead of fput
- bug fix to create UserVars.op on first run
- remove message() override color and update calls to use yellow to retain previous coloring
v4.13.7 (2022-11-14)
- bugfix for overkill hunting
v4.13.6 (2022-11-10)
- rearranged command tab for clarity
- removed profile checkboxes for ebounty, not needed
- added bounty_eval to support bounty mode and ebounty completion
v4.13.5 (2022-11-7)
- bug fix for MA looter
v4.13.4 (2022-11-7)
- bug fix for split, buff, and other checks
v4.13.3 (2022-11-7)
- bug fix for censure command
v4.13.2 (2022-11-5)
- added support to designate a looter for head/tail operations: See Misc tab
- added check for ...wait issue on routines
- reorganized the commands a little more to help with troubleshooting
v4.13.1 (2022-11-03)
Typo fixes in cman regex
v4.13.0 (2022-11-03)
Added profile support to UI
***************************
Changed file save location
/scripts/bigshot_profiles to Lich5/data/GSIV/<charname>/bigshot_profiles.
Lich5/data/GSIV/Rinualdo/bigshot_profiles as an example.
Existing profiles will need to be resaved or migrated over.
***************************
Added standard Lich messaging functionality
Reorganized UI menu and locations
Code cleanup.
Support for future (RSN) ebounty script
Fix to allow 640 blocked attacks to work for wait_for_attack
Fix to only account for renewal mana if bard and have renewal costs
Support for uid's for hunting and resting
Fix for percent_mind to more accurately gauge current mind full status
v4.12.12 (2022-10-28)
Fix for waitcastrt? before commands unless command can be executed during castrt
Fix for quickhunt targets when given an attack routine
v4.12.11 (2022-09-18)
Fixed calls to kill hunting scripts started with args
v4.12.10 (2022-08-21)
Added tumbleweed to list of tangleweed nouns
v4.12.9 (2022-08-08)
Bugfix for 9625/burst of swiftness
v4.12.8 (2022-08-07)
Added support for Burst of Swiftness. 9625 in society box.
Added kneeling command check (k) (!k)
Will no longer attempt to stand when hidden and kneeling.
v4.12.7 (2022-07-27)
Added checkbox to opt out of mstrike on unarmed combat.
v4.12.6 (2022-07-24)
Gave frozen it's own command check
Expanded support for dislodge firing only on specific locations.
Commented out ammo gathering.
v4.12.5 (2022-07-21)
Fixed shield bash to work for both shield and cman skills.
1040 now has a checkbox to auto shout if you or group member could benefit.
Will no longer pull kneeling people to their feet.
Will no longer attempt to pull the dead to their feet.
v4.12.4 (2022-07-01)
Add command check for tailwind.
Fixed briar command with briar weapon in off hand of twc.
Fixed bigshot quick standing around waiting for mana.
v4.12.3 (2022-07-01)
Add check to deadman's switch to only work in Shattered.
v4.12.2 (2022-06-08)
Add checks for Divergence cooldown spells for hunting tab abilities/spells/cmans
Changed boon detection to look at gameobj-data.xml TYPE instead of hardcoded name adjective check
v4.12.1 (2022-06-01)
Add SSR to force results check
Add additional weed/kweed for Tangle Weed 610
Adjusted hunt logic to prevent fleeing when someone enters.
v4.12.0 (2022-05-24)
Update various GameObj.npcs to use GameObj.targets
Add familiar gate(930) as a fog option
Add cmd_leech to cast Mana Leech/516
Fix for spell cleave cman to not attempt if on cooldown
v4.11.4 (2022-05-20)
Fix for cmd_ambush to switch to attack if not hidden
Update flee_message tooltip to state uses XML feed not plain text
v4.11.3 (2022-05-01)
Fixed dhurl with the new aim messaging
Adjusted location of waitrt in command checks
Changed do_hunt() to use no_players() instead of no_players_hunt() to prevent poaching in first room of the hunt.
v4.11.2 (2022-04-29)
Added a waitrt? to cmd_spell routine.
v4.11.1 (2022-04-23)
Fixed bug with cast_signs() assuming bards are always singing.
Cleaned up RoaterEscape(), it will now open containers to look for dagger type weapon.
Roater's and Rift Crawlers are pretty much identical in this aspect. No changes needed to work for both.
Added waitrt? to command checks to prevent check from clearing while in rt from previous move.
v4.11.0 (2022-04-15)
Adjusted hide to specify number of attempts to try and hide if failing: hide 2
Added Swift Justice tracking command check: (justice) (!justice) to use skill when swift justice has charges or has no charges.
v4.10.1 (2022-04-04)
Update consecrate to not return from hunt if blessing a sanctified weapon
v4.10.0 (2022-04-02)
Fixed pummel buff check from crushing blows to concussive blows.
Added stomp command for Tremors.
v4.9.0 (2022-03-24)
Added support for briar weapons. Will check for buff and check status of weapons charge.
Added support for assume aspect. Will alternate between aspects or evoke for one aspect.
Added support for cman stance perfection. Put 10,20,30,ect in attack stance box.
Fixed dhurl command knowing weapon auto returned from bond.
v4.8.7 (2022-03-12)
Fixed mstrike cooldown and debuff checks.
Added Barkskin cooldown support. Add 605 to your society abilities box.
Added song renewal mana cost check to cast_signs()
Fix for animated slushes registering as animates
Added (censer) command check to attempt a 320 before the command.
Added hurl command. Will hurl and recover item.
Fix familiar check to not cause familiar to return
v4.8.6 (2022-03-10)
Fixed conflict with 1040 and warcry shout. Simply '1040' to use 1040 not shout 1040.
Fixed missing msg from bullrush and forced prone check for bullrush/twin weapon.
Update for disk detection of group members
v4.8.5 (2022-03-10)
Added attempt mana pulse on 130 fog option if not enough mana
v4.8.4 (2022-03-08)
Fixed 9605 in society box, integrated surge in hunting commands.
Added command switch to refresh buffs based on duration.
v4.8.3 (2022-03-08)
Fixed global variable call for standing
v4.8.2 (2022-03-08)
Added version check for Infomon due to new Effects/Cmans
v4.8.1 (2022-03-08)
Added version check for Lich due to new Effects/Cmans
v4.8.0 (2022-03-07)
Integrated weapon/shield/cman skills and warcries.
barrage(!barrage) will only barrage if you don't have the buff
bellow all, will aoe bellow vs bellow target, will single target bellow
v4.7.7 (2022-03-02)
Add option to Stop for Deaders on Hunting tab
When enabled, bigshot will PAUSE when it encounters a dead player
v4.7.6 (2022-03-02)
Updated Fog options to include Sigil of Escape
v4.7.5 (2022-02-02)
Updated needs bless logic to to remove false positives (most cases)
v4.7.4 (2022-01-29)
Updated target logic to ignore sorcerer animates.
Updated loot subroutine to flag looting active - prevent BS from forcing stand
v4.7.3 (2022-01-25)
Updated bless routines to current text and provide option to continue hunt.
Disabled default startup sound value. Uncomment print "\a" unless $bigshot_quick if function is desired.
v4.7.2 (2021-12-14)
Updated GTK version detection for proper display in dark-mode
v4.7.1 (2021-12-12)
Adding bigshot single run mode accessed via ;bigshot single
v4.7.0 (2021-08-11)
-Updated group and event namespace to prevent future conflicts
-Consolidated Changelog and updated it on the GS wiki
v4.6.0 (2021-08-06)
-Separated bigshot_monitor to only run while hunting (to resolve lag in very active rooms)
-Added initial automatic weapon reactions
v4.5.0 (2021-06-25)
-Add fog only if encumbered or injured checkbox
v4.4.0 (2021-06-25)
-Add flee from voids option to general tab
v4.3.4 (2021-05-29)
-Updated UAC mstrike to always use tier3 for auto-tiering
v4.3.3 (2021-05-12)
-Revise GTK3 check to be more compatible with older versions of GTK that don't support Gtk::Version calls
v4.3.2 (2021-05-02)
-Updated Etheral Censer to be used in signs based on the cooldown refreshes
v4.3.1 (2021-04-30)
-Added regex for stance changing when using STANCE VERBOSE
v4.3.0 (2021-04-13)
-Add flee from boon/boss/glamour mobs checkbox on attacking tab
v4.2.4 (2021-03-02)
-Fix cast roundtime regex match for chan
v4.2.3 (2021-02-10)
-Fixes cman's to be usable with the force until option.
v4.2.2 (2021-01-19)
-Fix for certain values getting set when opening GUI, overwriting own settings
v4.2.1 (2021-01-12)
-Fixed stand() def to not stand if xbow kneel/fire
-Update buffer check for SMR result txt
v4.2.0 (2021-01-03)
-Removed 1617 from forced stance change
-Added customizable interaction monitoring panel
v4.1.1 (2020-12-31)
-Added cleanup from selfcast check in bigshot PR #374
-Included v3.93 updates
-Added loot room option when no loot script is defined
-Migrated v3 changelog to gswiki
-Updated Version Control
v4.1 (2020-12-31)
-Added GTK2/GTK3 dual logic for compatability
v4.0 (2020-08-13)
-Fix for ambush (Head/Neck/Eyes), no longer get stuck ambushing a head/neck over and over
-Archery Updates
Change aim location based on target actual status
BUGFIX:Aiming should now actually function as intended when switching targets
--TODO!Crossbows should now work with Bigshot, see pre-fire commands for details
-Group logic changes
Followers can now stay in the resting area and wait to run scripts/commands until leader is done
To do this, have the leader disband before running their scripts. With quiet followers selected
Followers attempt to not execute scripts/actions until the leader is in the rest area with them (regardless of disband)
Quiet Followers can be toggled off (not recommended)
Followers will now wait to cast signs until hunt is about to begin
Leader will no longer begin hunt until all followers are present and ready to go
--TODO!Leader will wait at rallypoint for entire group to arrive before moving to hunt starting room
If this feature is selected, the leader will not wait to hunt when at hunt starting room after rallypoint check
BUGFIX:Fix for fatal recursion cause by obvious hiding players
--TODO!Group should move more intelligently when seeking leader if group is broken
BUGFIX:Group will now be more responsive to commands
-Major UCS updates
BUGFIX:Will now use Tier 3 attack when tiered up to 3 and no follow up available for everything, not just jab
BUGFIX:Updates to UCS Mstrike, should no longer do open mstrikes when at or below threshhold instead of targetted mstrike
UCS mstrike threshold merged with MStrike tab threshold
--Still to be done: Per creature tier ups
-Bigshot now has the ability to turn some individual checks on and off
Functionality allows for custom hunting scripts to be built using Bigshot logic
Added ability to send custom "fput" to Group
Added ability to send custom "client_put" to Group
v3.92 (2020-07-08)
-Added LTE support for followers, overkill support for followers, & fried hunting commands for followers
v3.91 (2020-06-16)
-Added longterm boost usage option
v3.90 (2020-05-19)
-Minor fix to add a delay to 130/sym of return/1020 return option case in RT
v3.89 (2020-03-28)
-Crude fix for archery update, BLANK out your ammo & ammo container setting to NOT attempt to get ammo any longer
v3.88 (2020-03-28)
-Fixed a bug with obvious_hiding_player detection (Probably, at least)
-Fixed a bug with poaching when other players are present
-Cleaned out changelog history after updating wiki
-Re-organized global variables and requires statements (alphabetized)
-Added a sleep between resting_commands and hunting_prep_commands to prevent issues
-Replaced all pause commands with sleep
-Updated all sleep commands to follow proper syntax
v3.87 (2020-19-11)
-Added overkill counter for extra killed monsters
-Tooltip updates
-Formatting changes to make script more easily read
v3.86 (2020-03-11)
-Added outside & !outside command checks
v3.85 (2020-02-28)
-Resolved `block in setup` error when running setup in Fedora
v3.84 (2020-02-15)
-Fix a bug with "obvious hiding" players detection
v3.83 (2020-02-13)
-Added check for "obvious hiding" players (SET ObviousHiding ON)
v3.82 (2020-02-02)
-Added a v & !v command checks for checking spirit
-Possible fix for FOG_RETURN not loading when doing ;bigshot setup properly
-Added ;bigshot profile support
;bigshot profile load <name here, no spaces>
;bigshot profile save <name here, no spaces>
Allows saving of bigshot profiles as YAML files, saved in your LICH\scripts\bigshot_profiles folder
v3.81 (2019-09-06)
-Fix for wands with extra descriptors in hand vs grab name
-Add 1020 as an option for fleeing
v3.80 (2019-08-01)
-Exit cleanly from bounty mode
-Don't count regenerating troll kings when deciding if there's enough enemies to flee
-Treat intense shimmering circles like clouds when deciding to flee
-Don't require Gtk if $bigshot_headless is defined
v3.79 (2019-05-25)
-Removed 309 from hardcoded selfcast list
v3.78 (2019-05-10)
-Missed a few settings for flying
v3.77 (2019-05-10)
-Added flying/!flying as command checks for attacks
v3.76 (2018-07-04)
-Fixed INCANT command to respect Spell.stance setting
v3.75 (2018-07-02)
-Fix ;bigshot bounty
-Don't flee from your own group even if they're not hunting
v3.74 (2018-04-30)
-Added water as option for cmd_spell extra variable
v3.73 (2018-04-22)
-Add flee from webs option
-Add 917 to not stance offensive if using incant
v3.72 (2017-10-10)
-Fix bug in berserk
v3.71 (2017-10-08)
-Attack line now recognizes "wand" by itself
-Fix GameObjAdd autostart
v3.70 (2017-09-28)
-Fix download loop of GameObjAdd.lic
v3.69 (2016-09-20)
-Wont stance offensive for the spell 703 anymore
-Fixes for delayed looting
-option to pull players to there feet, Defaults to on
-Only pulls the player to there feet if their is an aggressive npc in the room with them
v3.68 (2016-09-14)
-option to stance defensive before looting if not all the creatures in room are dead
-wracking option now will use "Symbol of Mana" for voln peoples :)
-Performs the bless routine if needed when you wander or go to rest now
-Added a delayed looting option
-skips looting when creature still alive in the room or its been less than 15 seconds since the last creature died
-Will now try to escape from the inside of a roa'ter if you get swallowed
v3.67 (2016-08-31)
-Optimization for priority checks, wont run that section of code so often anymore.
-Manual aiming for unarmed combat routine. Command is "unarmed <punch/kick/grapple/jab> <aim location>"
-Will swap to the default aiming when you can't reach what your aiming at or its already missing.
v3.66 (2016-08-29)
-Only checks for group members if there are other pcs in the room
-Won't loot in the Duskruin Arena anymore
v3.65 (2016-08-28)
-Fixes for targeting, fleeing, and priority targeting
-This should let bigshot work in the duskruin arena
v3.64 (2016-08-23)
-Changed Celerity option to only recast if you have less than 3 seconds left
-Changed so it doesn't change into your attacking stance before casting
-Changed Fog return option to be an option pulldown instead of a checkbox, defaults to None
v3.63 (2016-08-23)
-Added option to use Celerity (506) for any command.
-Will cast if you dont have it on you or you have less than 6 seconds or so left on haste.
-Just add haste or 506 to the front of any command you want it to be cast before.
-example: "506 kill target" or "haste kill target(x3),525(pcs)"
v3.62 (2016-08-23)
-UAC Mstrike no longer will ignore the number of creatures in the room in some instances.
-Option to flee the room when player-defined message from the game happen
-Check the Attacking tab for box to input your text
-Fixed issue with bigshot not targeting "do not count these" targets
-Fixed issue with force command until # not working correctly
v3.61 (2016-08-15)
-Fix for new fogging option triggering at weird times.
v3.60 (2016-08-15)
-Fix for ;bigshot quick not working correctly when you dont have any quickhunt targets.
-Option to use Spirit Guide (130) or Voln Symbol of Return when going to rest. Option is on Rest Tab.
v3.59 (2016-08-13)
-To prevent me having to duplicate code, Bigshot will now download GameObjAdd.lic and make it autostart
-Spells should no longer target npcs when they are meant to target you. Let me know if something happens otherwise.
v3.58 (2016-08-07)
-companions and familiars should now be excluded from fleeing and targeting stuff
-companions and familiars count for poaching checks now just like a disk does
-this check only works for solo hunters, group bigshot hunters will ignore this
-Ambushers that are part of your group should no longer trigger the poaching routine
-Bigshot will on first run for a Ranger with a companion set your companion to a variable.
-You can reset this variable with ;bigshot ranger or ;bigshot companion
v3.57 (2016-08-04)
-Bigshot won't consider arms(709) and demons(725) as room creatures for targeting or fleeing purposes
-Priority should now ignore some NPCs when it does its calculations
v3.56 (2016-08-02)
-Think I have all the Reim mobs handled
-Fix for Multi-account hunting...oops
-other minor tweaks
v3.55 (2016-07-31)
-Target tracking for Aura of the Arkati (1614). Wont cast again on something that is affected.
-More Reim creatures added, Still missing creatures from the gypsy camp probably, celestial types
-New Command check: noncorporeal - Will see if current creature is non-corporeal undead
-New Command check: pcs - Will check for other non-grouped players in the room
v3.54 (2016-07-30)
-REIM! Quick update for some support for reim creatures
-Smite tracks individual mobs now, So if you switch creatures before killing it, will smite the new one
-Fixed the lag issue
v3.53 (2016-07-29)
-Incant should now work for any incant combination
-Bless can now bless two weapons that lose bless in same attack
v3.52 (2016-07-27)
-Changed variable tracking to be downstream hook instead of exec script
-Please let me know if anything doesn't work like it did in the previous versions
-Tracking added for Corrupt Essence (703), will no longer repeatedly cast and waste that precious mana
-You can also cast it open as "incant 703 open"
-Added flee from vines option to first tab of ;bigshot setup
v3.51 (2016-07-25)
-Special coding for 1700. Wont stance offensive for "incant 1700", Will stance offensive for "incant 1700 evoke"
-Fix for ;Bigshot quick not working when your quickhunt targets was empty
v3.50 (2016-07-24)
-Untargetable and Targetable lists now use the name instead of noun. Option to clear these so they can start fresh using ;bigshot reset. This will fix the issue for being unable to target guards in warcamps.
-Targetable and Untargetable are now listed in ;bigshot display
-Fix for Head/Tail Routine. Head wasn't waiting for the tail members to join bigshot group.
v3.49 (2016-07-24)
-Updated berserk to use Spell.cast functionality, should now use STOP BERSERK when no alive mobs in the room.
-Command check added for poison and disease
-Fixed some options that were out of place, oops
-Tail should now use scripts when performing pre-hunt commands
-Head should wait for tails to be out of RT before heading to rest now
-Incant should no longer fry your nerves when you dont have enough mana.
-Changed incant to use wands when you dont have enough mana.
-Also checks your target before incanting, so you always target the correct creature
-Changed wand routine to be able to use multiple wand types, "use this wand type" now takes comma seperated wands "use this wand type" example: "aquamarine wand, bloodwood wand, etc"
-Changed incant, spell and wand routines to return to attack stance option instead of stance defensive.
-Fixed bug with bless routine, maybe
-Option to use Voln SMITE in UAC routine now, instead of always doing it.
v3.48 (2016-07-20)
-Added Consecrate(1604) to bless routine
-Quickhunt targets code update and fixes
-Made bless work with identical weapons
v3.47 (2016-07-19)
-fix for blessing weapons
v3.46 (2016-07-19)
-now tries to pull someone to their feet when they are lying down/kneeling/etc.
-Rewrote the bless option to bless anything that runs out of a bless.
-Now located on Attacking Tab as a checkbox
-Returns you to your resting area if you can't bless things.
-Added a priority targeting option to hunting tab.
-Will switch target based on the order of your valid targets, whenever its attacking.
-Added Quickhunt targets, These always are first in terms of priority (Quickhunt targets, room targets)
-You can use the (a)|(b)|(etc) in here instead of just the Quickhunt routine every time.
v3.45 (2016-07-09)
-better code for checking for an escort, less error prone now (:
-fixed rare issue with ambusher jumping out of hiding just as go to move and it screwing up bigshot
-UAC Bless option changed so that you can leave it blank and it wont stop hunting. Has tooltip explaining different options.
v3.44 (2016-07-01)
-Fix for the fix for the fix!!
-Added a check for spell 608 to skip if already hidden
-Added hidden and !hidden a command check, hidden only works when your hiding, !hidden when your not hiding
v3.43 (2016-07-01)
-Fix for the Fix :(
v3.42 (2016-06-30)
-Fix for mob command check due to recent change
-Optimized the escort npc check
v3.41 (2016-06-30)
-Fixed Head/Tail bigshot hunting
V3.40 (2016-06-30)
-Mstrike will now cast 1107 and 1607 when appropriate
-Quick Hunting mode tweaked so that it works when your in a group, or in a room that isn't mapped
-added inverse command checks, put a ! in front of the command check, i.e kill(!h60)
-Doesn't count escorts anymore for NPC checks
V3.39 (2016-06-26)
-Quick Hunting mode added - Just start bigshot with the variable quick - ;bigshot quick
-Quick Mode overrides your currently setup targets and targets the current room npcs
-Wandering, Fleeing and Resting is disabled
-Bigshot exits when no NPCS found in room
-Uses Quick Hunting Commands
-Supports up to 10 (A-J) different attack routines now.
-Moved all the attack routines to new tab, Commands
-Moved few options to the attacking tab
v3.38 (2016-06-25)
-added command check for target not being prone or target being undead
-current checks are mana/stamina/health(percentage)/encumbrance/unarmed tiering/mobs in room/target not prone/target undead
-m/s/h/e/tier/mob/prone/undead respectively
-Prone means target is sleeping|webbed|stunned|kneeling|sitting|lying down|prone|frozen|held in place
v3.37 (2016-06-24)
-can now have two or more checks for a command. i.e kill(mob3 s20 h80) 3 mobs in room, stamina is above 20, health is above 80%
-must all be inside the () and seperated with a space
-current checks are mana/stamina/health(percentage)/encumbrance/unarmed tiering/mobs in room
-m/s/h/e/tier/mob respectively
v3.36 (2016-06-23)
-Added option for adjusting wander time between rooms (Found on Hunting Map Tab)
v3.35 (2016-06-14)
-Added option for attacks to only trigger when certain number of creatures are in the room.
-Just add (mob#) to the attack you want to do
-Fixes for unarmed combat getting stalled
-Now attempts to soothe (1205) when appropriate
v3.34 (2016-06-08)
-Added aiming for archery to the Hunting tab in setup.
-Will change location once you stick the place your aiming at, looping until the creature is dead
-Made gathering ammo a bit more specific about what its grabbing and where its putting it.
-Also works with bolts and darts now if you gathered things to the ground.
v3.33 (2016-06-06)
-Fix for creatures leaving room and script getting stuck (Hopefully)
-Fix for loot script activating during roundtime
-Fix for issue with targeting using creatures name or noun
v3.32 (2016-06-02)
-Changed aiming for UAC to continue until if finds something you can hit or just hits them like normal
-Added Voln Smite to command, use Smite in your hunting commands
-Rewrote Ambush again! Now has the option to pick locations you want to ambush at on the hunting page
-Also supports it from the hunting command i.e. "ambush head"
-If left blank without picking any options in setup will default to Head, Right Leg, Left Leg, Chest
v3.31 (2016-06-02)
-Changed up the ambush command so it ambushes what you said to ambush first, then attempts right leg, left leg, then chest
-Added an option to trigger the mstrike during UAC combat, other MSTRIKE options apply
-Few fixes to MSTRIKE routine, now checks number of creatures in room as an equal or greater
-Fixed bug caused when doing commands like "stance for and kill target"

Edits by Hazado: (2016-06-01)
V3.3 (2016-06-01)
-Added UAC combat! Start it with hunting command "unarmed punch/jab/kick/grapple"
-Added options for UAC in setup
-Added options for MSTRIKEing in setup
-Rewrote MSTRIKE routine
-can now check mana/stamina/health(percentage)/encumbrance/unarmed tiering inside the hunting commands
-Changed wander routine to hit every room in area instead of random wandering

Edits by Zhiart: (2016-03-25)
-Added new ambush command for legging a critter and then go for the head as long as they are prone (Code by SashaFierce)

v3.2 (2/27/2016)
-Added changes to fix incant loot issues (might work)
-Added ability to detect renaming of bigshot without destroying exec scripts
-Converted exec scripts to strings to allow =>quiet

Edits by Kalros: (2015-11-2015)
v3.1
-Fixed Disk poaching.
-Fixed First room poaching.
-Removed group poaching logic.
-Ambush detection via Exec Script. It will leave the room if it detects an ambush line.
-Rewrote and updated wander targeting sections. Fixes some target related bugs.
-Moved WAIT command to exec to prevent line buffer issues and make more responsive

3.0 (2015-05-30):
stop trying to attack monsters that aren't in the room (wild guess, untested)
bumped version up from 2.12052012 to 3.0, because 2.12052012 is a stupid version format
added message to trust script
</pre>

Lich:Software/Installation

2025-09-08T16:01:02Z

WHIGHTCNIGHT: /* Lich Changelog */ updated to 5.12.5

Lich:Software/Installation

2025-09-08T16:00:14Z

WHIGHTCNIGHT: /* Installing the Latest Stable Release */ update to Lich 5.12.5

Lich:Software/Installation

2025-08-14T17:53:52Z

WHIGHTCNIGHT: /* Lich Changelog */ add changelog for 5.12.4

Lich:Software/Installation

2025-08-14T17:53:15Z

WHIGHTCNIGHT: /* Chromebook & Debian variants */ update to 3.4.5 ruby

Lich:Script Bigshot

2025-08-11T16:19:02Z

WHIGHTCNIGHT: /* Hunting Target Examples */ fix formating of sections

{{3rd-party}}
Bigshot is designed to handle combat routines, including moving to and from hunting areas, defining creatures to hunt and accompanying attack routines
Afk scripting on any server but Shattered is in violation of game policy.
{{TOCright| limit=2}}
==Changelog==
*[[Script Bigshot/Changelog|Script Bigshot Changelog]]
==About Bigshot==
===What Does Bigshot Do?===

Using a series of menus and commands inputs, Bigshot lets a user create a modular, customizable and fully automated hunting script. With just a few clicks and tweaks, you can go from scripting Rats to the Rift.

===How Do I Get It?===

Grab it from the Repository: ;repository download Bigshot

===How Do I Make it GO!?===
Initial setup is accessed through ;bigshot setup. There you will see a configuration window with various tabs to setup for your hunting routine.

As with most scripts, using a SETUP command will open a graphical user interface for configuring the script. Use ;bigshot setup to open this dialog. This will open a window with the following tabs:
* Profile - This is where you save/load your profile information. Profiles are saved to your \Lich5\data\<GSServer\<charname>\bigshot_profiles directory. Eg, \Lich5\data\GSIV\Rinualdo\bigshot_profiles (note, if you've previously used bigshot, the file location has changed. The previous location was in your \Lich5\scripts\bigshot_profiles folder. You can copy/paste
* Resting - Set up your resting routine and location.
* Hunting - Create a hunting map by adding BOUNDARIES, define your attack stance and any pre hunt information
* Attacking - configuration for ambushing, bless, reactions, and similar flags
* Commands - Where you define your valid targets and associated attack routines. See sample routines below.
* Misc tab - Various config options

We will take a closer look at each of these individually further on.

There is also several other commands you can do for more functionality.
* ;bigshot quick - Special hunting mode that kills everything in the room your in and quits bigshot. Wont wander at all, and wont attempt to rest. Has its own hunting commands and hunting targets.
* ;bigshot head/tail - This is for Multi-Account hunting. It only works for a single computer. Every character needs to be setup for the hunting area your going to. You start it by having your following characters join your head character. The following characters need to be running bigshot with ;bigshot tail. Once that happens, have the leader of the group do ;Bigshot head. They will then procede to hunt in the area you have setup.
* ;bigshot display - Shows all your current settings.
* ;bigshot reset - Resets all your targetable and untargetable lists. Useful if you find bigshot won't targets something it should.
* ;bigshot ranger or ;bigshot companion - Resets ranger companion setting so you can set it again. Used when you change your companion.
* ;bigshot profile save <name here> - Saves a profile in YAML format in your character's profile folder. Also accessible via the Profiles tab in the setup menu.
* ;bigshot profile load <name here> - Loads a profile from your character's profile folder. Also accessible via the Profiles tab in the setup menu.
* ;bigshot single - When used solo, will execute a single hunting routine, return to your resting location and then exit
* ;bigshot <options> <creature> - example: ;bigshot single giant rat - Will activate ranger tracking of a creature. Anything input besides the above commands will default to "track <input>".

==The Profile Tab==
* Load Profile - will load an existing profile. Nothing will be available if no previous profiles are saved
* Current Profile - shows the existing profile if a new one is loaded.
* Save profile - Valid profile information for future ebounty script support
Save Current Settings - tell Bigshot what you want your profile to be named. Any name will work here. Once a profile is saved, will show up in the Load Profile menu.

==The Resting Tab==
Short and sweet, here is where we setup our resting routines. During REST mode, Bigshot uses the EXP command and checks your mind, hit points, wound status, mana and spirit. Once all of these values are at the specified Should_hunt? settings, Bigshot leaves REST mode and begins a HUNT.

* room id: - This is the room that Bigshot will return to for resting. Use Room Numbers from Map/Go2. Support both LichIDs and SimuIDs with a u, for example, 228 for Town Square Central or u7120.
* pre-rest commands: - These commands run before entering REST mode. An example routine is: 'shea, wear shield, sit, stance offensive, rest'. This will sheath your weapon, wear your shield, sit, enter offensives stance and use the REST verb.
* active resting scripts: - Active resting scripts are scripts that will be run upon entering REST mode. These scripts should be things that you do after a hunt: get healed, empty your bags, spell up. An example list is: 'eloot sell, waggle, eherbs'. This will use eloot to sell according to the options set with eloot. After selling, it will use Waggle to spell you up according to however Waggle is setup. Finally, eherbs will check your PACK and use herbs stored there to heal whatever wounds you have.
* Fog Option: - Uses [[Spirit Guide (130)]], Voln [[Symbol of Return]], [[Traveler's Song (1020)]], [[Sigil of Escape]], [[Familiar Gate (930)]] or Custom when heading back to rest. Setting it to None does nothing. Setting it to 130 will cause it to use 130 first then if that fails symbol of return. Symbol of return will use that first, then 130 if that fails. Setting to Traveler's Song will attempt once and continue. Setting to Familiar Gate will attempt to summon a portal once and walk through it. Will perform a mana pulse if not enough mana is detected. Custom option allows for comma separated list of commands to perform.
* Should Rest?
Bigshot evaluates these conditions and, when they are met, will go to your resting room set on the Resting tab and execute any resting scripts you have set.
* '''when percent mind >='''
** Rests when your mind has reached this threshold. Generally, set this to 100 to rest when fried.
* '''and extra kills >='''
** The number of extra monsters to kill after reaching your `when percent mind` threshold and after LTE boosts used
* '''and used lte boosts >='''
** The number of LTE boosts it will attempt to use after reaching your `when percent mind` threshold
* '''or percentmana <='''
** Forces Bigshot to rest when your percentage of mana is at or below this threshold.
** This can be set to 0, but leaving a bit in the tank can be good if you have to use 406 (Unlock) to open the WL Graveyard gate. 11/17/24: If you run into an error that calls to an "OOM" message, try setting this to 1.
* '''or percentencumbrance >='''
** Forces Bigshot to rest when you have reached a given level of encumbrance.
* '''or wounded eval'''
** Allows you to set an evaluation phrase to determine if you are too wounded to continue hunting. Wound evaluations can send you home on nearly any wounded condition of your choice: bleeding, level 2 wound, can't cast, too many scars etc.

The following is a wounded evaluation that will rest whenever you have any level II wounds:
<PRE>XMLData.injuries.any?{|key,value| value["wound"] > 1} || Char.percent_health <= 70</PRE>
The following is a wound evaluation that will take you home if you can not cast anymore (nerves, level 2 head/eyes, bad scars etc.):
<PRE>bleeding? || Char.percent_health <= 25 || [Wounds.head, Scars.head, Wounds.leftEye, Scars.leftEye, Wounds.rightEye, Scars.rightEye, Wounds.nsys, Scars.nsys].max > 1 || [Wounds.leftArm, Wounds.leftHand, Wounds.rightArm, Wounds.rightHand, Scars.leftArm, Scars.leftHand, Scars.rightArm, Scars.rightHand].max > 2 || ([Wounds.leftArm, Wounds.leftHand, Scars.leftArm, Scars.leftHand].max > 0 && [Wounds.rightArm, Wounds.rightHand, Scars.leftArm, Scars.leftHand].max > 0)</PRE>
The following can be added to one of the above wound evaluations to also rest upon having popped muscles:
<PRE>|| Effects::Debuffs.active?("Overexerted")</PRE>

* '''when creeping dread >='''
** Forces Bigshot to rest when your creeping dread is at or below this threshold.
* '''when crushing dread >='''
** Forces Bigshot to rest when your crushing dread is at or below this threshold.
* '''Wall of Thorns Poison'''
** Forces Bigshot to rest when you are affected by Wall of Thorns Poison.
* '''Confusion Debuff'''
** Forces Bigshot to rest when you are affected by the non-dispellable Confusion Debuff.

==The Hunting Tab==
This is where you will tell bigshot when to hunt, any commands or society abilities to use prior to hunting, and where on the map you want to hunt.
===The Hunting Map===
Your hunting map is a series of Boundaries - rooms that Bigshot will not enter - and a Start room - the first room that Bigshot moves to when a hunt starts. These function very similarly to the boundaries in the ;Wander script, but are stored in Bigshot's configuration files and not in a character cache as with ;Wander. Here you also configure when to hunt
* starting room ID: - This is the first room that Bigshot goes to when hunting. You may set this to any room within the Boundaries that you set with the second option.
* boundary rooms: - Boundary rooms are walls. Bigshot will not enter a Boundary room!

<PRE>X-X-B - A - 0 - 0 - 0
| |
X-X-X</PRE>

The proper syntax for boundary rooms are separated by commas
Some popular Rift boundaries as an example
<PRE>
Plane 1: 2635, 12101, 12208
Plane 2: 2605, 2635, 12093
Plane 3: 2635, 12089, 12152
Plane 4: 12122, 12207, 12235
Plane 5: 2579
North Scatter: 12151, 12254, 12256, 12249, 12247, 12241
South Scatter: 12151, 12219, 12217, 12233, 12237, 12239
</PRE>

For Maaghara boundaries, you can use
<PRE>
9734
</PRE>

Confluence boundaries:<pre>
2300, 3519, 228, 188, 1932, 10855, 3668, 1438, 1005
</pre>

Imagine a hunting area that is a six room square. To enter this square, one must GO DOORWAY from room A. You would set the room outside of the square - ie room A - before you GO DOORWAY, as a boundary. Then, you would set room B to the Starting Room. From there, Bigshot will move to room B and then wander around inside the Boundary - ie the square hunting area - until it your '''Should_rest?''' conditions are met.

* Wait before wandering to another room: - Time you wait before leaving a room to find some creatures. Default is 0.3 seconds. Set to 0 for fastest (spammy) movement.

* attack stance: - Specify what stance you want to attack from. Bigshot will remain in Stance Defensive until an attack command is issued, whereupon it will stance to your Attack Stance and execute your Attacking routine. Bigshot recognizes all stances from the game, Offensive ->-> Defensive.
* pre-hunt commands: - These commands will be executed before Bigshot uses Go2 to travel to your hunt's Starting Room. As an example: 'gird, stance defensive'. This will ensure that you have readied your weapon and are in Defensive stance before traveling. Set short lived combat spells like 1605 (Arm of the Arkati) to be cast in this line.
* active hunting scripts: - Active hunting scripts are scripts that will run while Bigshot is in Hunt mode. Many of these scripts have been made obsolete by the next option. Clever scripters have written some nice scripts that will keep certain spells up, execute cmans based on conditions etc. If you need a complex action to run while Hunting that Bigshot does not have the capacity for, an active hunting script may be called for.
* society abilities/spells/cmans: - Bigshot can be asked to keep certain abilities up at all times during a hunt. Hovering your mouse over this field will display a list of cmans and society abilities specified by their numerical designations. Spells may also be added here. Separate all values by commas. For example, entering '506' will keep the spell Haste up during Hunts, casting whenever it has worn off.
* loot script - Bigshot will call a loot script to loot your kills for you. eloot is commonly scripts used here. Be sure to use the SETUP command on whatever loot script you use, as if it is not configured properly, Bigshot will likely error.
* wracking spirit >= - Setting a value here will WRACK for mana if your spirit is greater than or equal to the value specified. Setting 6, for example, will WRACK down to 5 spirit. This will ONLY function if you have the 'Use sign of wracking/sigil of power' box checked.
* Use sign of wracking/sigil of power - checkbox to enable the use of wracking
* Priority hunt - checkbox to enable the use of the priority system for hunting. This allows you to change targets based on the order listed in valid targets/quickhunt targets. For example, your hunting thunder trolls, wind witches, and puma. Your valid target order is wind witch, thunder troll, puma. Your currently attacking a puma, when a thunder troll walks in. You will switch to the attacking the thunder troll because its before the puma in the valid targets list. After killing the thunder troll, you go back to the puma, only to have a wind witch walk into your room. You will again switch to the wind witch because its in front of the puma. Hope you get the idea. When using the ;bigshot quick option, it will base the order of targets by your quickhunt targets first, then the order of the targets in the room that don't match any of your quickhunt targets. Example, bandits are in your quickhunt targets. You type ;bigshot quick when you get ambushed in the room. Currently in the room is a large ogre and three bandits. The order of targets will be the bandits first, then the large ogre.
* Delay looting - delays looting of creatures in a room.
* Pull players to feet - attempt to pull players to their feet upon passing them in a room
* Stop for dead players - checkbox will pause bigshot if you encounter a dead player
* Sneaky Sneaky - sneak around while out in the hunting area

===Should hunt ===
Bigshot evaluates the conditions set on this tab to determine if you are ready to hunt or not.
* '''when percent mind <='''
** Setting this to 51 will rest until Cleared. Setting at 65 will wait until Muddled.
* '''and percent mana>='''
** Determines the percent total of your maximum mana that must be present before hunting
** Setting below 50 will result in quick, uneventful hunts if you cast much. Generally, this is set at 95 or higher.
* '''and CHECKspirit >='''
** Bigshot will check to see that your current Spirit value is higher than what is listed here.
** Make sure that you have this set high enough that Bigshot won't hunt immediately after DEPARTing if you have Depart / re-run Bigshot checked on the General tab.

==The Attacking Tab==
* Ambush aiming locations (head, etc): - Allows you to specify what order you aim for ambush. Default is head, right leg, left leg, chest.
* Archery aiming locations (head, etc): - Allows you to specify what order you aim for archery. Loops through your aiming locations once you hit the area your aiming at.
* flee if enemy count is > - Flees the room if the total number of enemies in the room exceeds the value. Set this to 1 if you want to engage single targets.
* ...but don't count these: - Bigshot will ignore monsters specified in this line when eveluating if it should flee based on how many monsters are in the room. Useful for when you are hunting in an area with extremely low level monsters mixed in with your targets.
* ...and always flee from: - Bigshot will always flee from the specified monster as soon as possible. Extremely useful if your hunting area has higher level and/or extremely dangerous monsters mixed in with your intented target(s).
* flee from environment message: - Will flee whenever anything you put in here gets sent from the game. (XML regex matching)
* Wait before wandering to another room: - time you spend before moving to a new room. Default is 0.3 seconds. You can set it to 0 to move instantly. Tends to be spammy for anyone in the same hunting area.
* Approach lone targets only - Forces Bigshot to only begin combats against creatures that are alone.
* Bless weapon? - Performs a Consecrate (1604), then a Cleric Bless or Voln Bless on whatever weapon loses its bless during hunting. If you can't bless your weapon while hunting will return you to your rest area and quit the script.
* Flee from boon - Enabling this check box will force Bigshot to flee from all boon/gifted/boss creatures (available in [https://github.com/elanthia-online/scripts/pull/449/commits/afade49e25dd6042c30b6d62fec4d65376667f80 v4.3.0])
* Activate weapon reactions - Will initiate reactive strikes when the opportunity presents itself
* Flee from clouds - Enabling this check box will force Bigshot to flee from Cloud spells such as 125(Call Lightning with its Ominous Cloud), 1704 (Stun Cloud) and 1713 (Death Cloud)
* Flee from vines - Enabling this check box will force Bigshot to flee from Vine spell such as 610(Tangle Weed)
* Flee from webs - Enabling this check box will force Bigshot to flee from webs.
* Flee from voids- Enabling this check box will force Bigshot to flee from voids.

==Commands Tab==
The true guts of Bigshot, this is where you specify your Attack Routine.
* hunting commands - These are the commands that Bigshot will evaluate (ie execute) when it is in the room with a valid target (one that you specified in your Hunting section. These commands are separated by a comma. Bigshot recognizes most hunting verbs and, failing that, will use an fput command (a direct entry method) and just execute the commands directly as written. The following are a list of usable hunting commands:
** kill - Attacks using the KILL verb.
** incant <spell number> - Casts the specified spell with the INCANT verb. This will automatically stance into offensive for bolt and other stance-sensitive spells. A caster may CHANNEL the spell using [[INCANT (verb)]] to INCANT SET CHANNEL <spell> (a standard GSIV verb, not part of Lich). Alternatively, a caster may CHANNEL spells by using the SET verb (a standard GSIV verb, not part of Lich) to SET ChannelIncant ON. This will CHANNEL an INCANTed spell if the caster is in a stance higher than neutral.
** channel <spell number> - Channels the specified spell at the target. This requires a stance higher than neutral to have any effect.
** <Spell Number> - Casts the specified spell with the PREPARE and CAST verbs.
** wand - As in, <CODE>wand target</CODE>. Gets a wand from the specified storage and WAVES it at the target.
** wandolier - Similiar to wand, but uses wandoliers. Gets a wand from the fresh wand container and waves it, rubs container if no wands found. Default waves in offensive. Can change via <CODE>wandolier defensive</CODE> to wave in a different stance
** fire - As in, <CODE>fire target</CODE>. Gets ammunition from the specified storage and FIREs it at the target. Will attempt to aim based on settings on hunting tab.
*** The above listed commands should be used with the (x#) syntax. For example, <CODE>kill target (x3)</CODE> will swing three times at the target before re-evaluating the attack routine. If the (xx) variable is used, Bigshot will continue using the specified attack command up to five (5) times. Example: <CODE>903 target (xx)</CODE> will continue to cast 903 at the target (5) times before restarting the attack routine or until it is dead. If you want to ensure the routine does not restart, using a sufficiently large number should suffice (e.g. x100). Bigshot may also be set to only execute a command based on how much mana or stamina you currently have. For mana, use the (m##) command. <CODE>920 target (m50)</CODE> will only cast 920 (Implosion) if you have 50 or more mana. Similarly, <CODE>cman feint target (s10)</CODE> will only execute the combat maneuver Feint on the target if you have 10 or more stamina. The command syntax is used as a separate call and wrapped in separate parenthesis, as in (m50 s20)(x2).
** aim <location> - Aims at the specified location.
** ambush - Uses the AMBUSH verb to attack. Will aim based on settings in Hunting tab. Also will aim dynamically, "Ambush head" would aim at the head, overwriting any settings or defaults for that attack.
** wait <time> - Bigshot may Stance Dance by using the WAIT command. Bigshot will go into and stay in Stance Defensive until the specified time is over OR the target swings / casts, whereupon it will evaluate the rest of the Attack Routine, changing into your specified attack stance.
** mstrike - As in, <CODE>mstrike target</CODE>. Mstrike depending on mstrike cooldown and stamina. Has its own option page. Can also be used with UAC, "mstrike punch".
** berserk - Executes the BERSERK verb and stands by until it fades.
** throw - Empties hands, Attempts throw, get the stuff you emptied.
** weed/kweed - Casts 610 at target. Using "kweed" as your command will force evoke 610 ensuring the damage version
** curse <curse> - Clumsy/Weakness/Darkness/Itch/Hex/Pox/Nightmare/Star - will prep 715 and use curse command as defined. Will skip "curse star" if buff is up.
** unarmed - Uses the Bigshot UAC routine. Routine will attack with appropriate attacks to rank up and use mstrike based on mstrike options page. Usage "unarmed (punch|jab|kick|grapple)".
** smite - Performs an [[Order of Voln]] [[Kai's_Smite|Smite]] on target until successful.
** leech - Performs a [[Mana Leech (516)]] on target if cooldown is under 15 minutes.
** script <script name> - Executes a specified custom attack script.
** hide - Continue hiding until you're actually hidden. Or it's tired of trying.
** sleep - As in, <CODE>sleep 10</CODE>. Pause bigshot. Useful with fried hunting commands such as: <CODE>410, sleep 15</CODE> will E-wave then wait 15 seconds and e-wave again if there are valid targets.
** stance - As in, <CODE>stance defense</CODE>. Change stances.
** nudgeweapons - Move all weapons on the ground to an adjacent room. Useful for casting Implosion (720).
** force <cmd> until <endroll> - As in, <CODE>force incant 1002 until 101</CODE>. Continue issuing a command until a desired endroll. Only works for normal looking swings/spells/cmans.
** eachtarget <cmd> - issues command to each valid target in room
** efury <fire|cold> - casts Earthern Fury (917) on the target and waits for DOT to end or 12secs to pass
** caststop <spell> - casts the spell and then immediately stops it after casting
** wield <noun> <left|right> - weilds new noun and stores the hand given to put new noun item in
** store - store left, right or both, but only if something is in those hands
** tether <recast> - casts 706 with built-in logic to wait, can also do recast to auto-recast 706 on creature death and DOTs transfer
** unravel <spell> - casts 1013 Song of Unravelling with an optional spell to target against creature
** depress - casts 1015 Song of Depression with some some built in logic
** phase - force CASTs 704 Phase due to needing to prep/cast for usage on NPC targets
* hunting commands (b) - Attack routines set up for a monster flagged (b) in the Hunting section.
* hunting commands (c) - Attack routines set up for a monster flagged (c) in the Hunting section.
* hunting commands (d) - Attack routines set up for a monster flagged (d) in the Hunting section.
* hunting commands (e) - Attack routines set up for a monster flagged (e) in the Hunting section.
* hunting commands (f) - Attack routines set up for a monster flagged (f) in the Hunting section.
* hunting commands (g) - Attack routines set up for a monster flagged (g) in the Hunting section.
* hunting commands (h) - Attack routines set up for a monster flagged (h) in the Hunting section.
* hunting commands (i) - Attack routines set up for a monster flagged (i) in the Hunting section.
* hunting commands (j) - Attack routines set up for a monster flagged (j) in the Hunting section.
* fried hunting commands - Commands executed specifically when fried. Useful when hunting in a group.
* quick hunting commands - Commands executed specifically when using ;bigshot quick.
* valid targets: - These are the monsters you are hunting. Bigshot will most easily recognize monsters based on the NOUNs or their name. For example, 'a large ogre' can be targeted with just 'ogre'. Using longer descriptors can be troublesome, and you should copy a monster's name directly from the game front end to avoid troubles. You can use multiple entries separated by commas. For example: 'manticore, thrak' will kill manticores and thraks.
* quickhunt targets: - These are monsters you have designated attacks for when your using the ;bigshot quick option for hunting.

===PSM3 Integration===
* hunting commands - Bigshot now supports weapon/shield skills and warcries. Assaults will wait until they finish or are interuppted. These commands are separated by a comma. The following are a list of usable hunting commands:
** barrage, flurry, fury, gthrusts, pummel, thrash - Assaults will wait until attacks are completed/interrupted.
** fury - You can specify the default attack fury will use. Will jab if not specified: fury punch or fury kick
** charge, cripple, dizzyingswing, pindown, twinhammer - Setups will execute on cooldown so make sure to check for prone/stun/root/ect.
** clash, cyclone, pulverize, volley, wblade, whirlwind - AOE will execute on cooldown, limit with check volley(mob3).
** shout - Will perform warcry shout. Must use a command check or it will shout every loop: shout(!shout),shout(buff10 s25)
** yowlp - Will perform warcry yowlp. Must use a command check or it will yowlp every loop: yowlp(!yowlp), yowlp(buff10 s10)
** holler - Will perform warcry holler every loop taunting all the mobs. holler(s60)
** bellow, growl, cry - Offensive warcries can be used with target for single target or all for aoe.
** shield bash, shield charge, shield pin, shield push, shield strike, shield trample, shield throw
** surge - Will keep surge of strength up. surge or surge(surge) will cast even on cooldown, surge(!surge) will only cast when not on cooldown.
** bearhug, bullrush, coupdegrace, cpress, cutthroat, dirtkick, disarm, dislodge, divert, eviscerate, exsanguinate, eyepoke, feint, footstomp, garrote, gkick, hamstring, haymaker, headbutt, kifocus, kneebash, leapattack, mblow, mug, nosetweak, sattack, sblow, scleave, shroud, spunch, sthieve, subdue, sunder, sweep, swiftkick, tackle, templeshot, throatchop, trip, truestrike, vaultkick
** dislodge <location> - Dislodge from location specified: dislodge eye neck
** stomp - Will perform a stomp attack. Channels 909 if not active. Can also add 909 to society abilities to keep it active.
** dhurl - Hurl your weapon and recovers it. Works with weapon bonding auto return and the recover verb.
** assume <aspect> <aspect/evoke> - Will cycle between two aspects, or evoke a single aspect. Also works in society ability box. "650 <aspect> <aspect/evoke>"
** briar <weapon> - activate the AS buff on briar weapons. Tracks weapon charge and uses on cooldown.
** stance perfection - Put 10, 20, 30, ect in your attack stance box to take advantage of stance perfection.
** chastise, excoriate - Will perform FEAT if available and affordable

You may need to '''SKILLS FULL/CMAN INFO/WEAPON INFO/SHIELD INFO''' if you've recently changed training or skills are being outright skipped.

===Additional Options===
*haste or 506 - Placing this in front of any command will cause you to cast 506 before doing that command. It only casts if it isn't currently up or has less than 3 seconds left on its timer.
<PRE>wait 10, haste kill (x3)</PRE>
*slayer or 240 - Placing this in front of any command will cause you to cast 240 before doing that command. It will not recast if it's already active.
<PRE>slayer 302 (x99)</PRE>

===Command Checks===

Commands need to use the following format:
<CODE>COMMAND (CHECKS)(REPETITIONS)</CODE>

So <CODE>hamstring (mob1 prone)(x2)</CODE> Any (x#) needs to be separate. Also (xx) is not unlimited and is just short for (x5).

Additional checks you can add to any command to customize the attack to your desired scenario.
Each check below can be used by itself or with any other check. Put them inside () with a space between each additional check. Example - Kill(m20 s5 e20)
<p>Each of these also has an inverse or opposite.
Just put a ! in front of the command. Example - Kill(!m20 !s5 !e20)
*s# - Checks that you have the required stamina
*m# - Checks that you have the required mana
*h# - Checks that you have the required health but based on a percentage instead of fixed number
*v# - Checks that you have the required spirit
*e# - Checks that your encumbrance percentage is at or below
*tier# - Checks for your current UAC tier (1,2,3). Performs command if UAC Tier is equal or greater.
*mob# - Checks for the number of npcs in room. Performs command if npcs in room is equal to or more than number specified. Only use for 2 or more creatures in the room
<PRE>To further clarify the mob# implimentation
1 mob, mob2, 1 IS less than 2, attack should not proceed.
2 mob, mob2, 2 IS NOT less than 2, attack can proceed
1 mob, !mob2, 1 IS NOT more than 2, attack can proceed
2 mob, !mob2, 2 IS NOT more than 2, attack can proceed
3 mob, !mob2, 3 IS more than 2, attack should not proceed</PRE>
*once - Performs the command once on a specified target, resets on room change
*room - Performs the command once in a room only, resets on room change
*prone - Checks to see if target is not sleeping|webbed|stunned|kneeling|sitting|lying down|prone|frozen|held in place. Performs command if target status is not one of the previous.
*frozen - Same usage as prone. Broke out of prone check for archers against non-corporeal creatures that deflect ranged. Corporeal creatures can be stunned and will break this check.
*undead - Checks to see if target is undead. Performed command if target is undead.
*flying - Checks to see if target is flying. Performed command if target is flying.
*rooted - Checks to see if the target is rooted. Performed command if target is rooted.
*hidden - Checks to see if you're currently hidden.
*poison - Checks to see if you're currently poisoned.
*disease - Checks to see if you're currently diseased.
*noncorporeal - Checks to see if NPC is [[noncorporeal|non-corporeal]] undead
*pcs - Checks to see if there are any PCS in room that are also not in your group
*outside - Checks to see if the room you are in is outside
*barrage - Checks for the Enhanced Dexterity buff from Barrage.
*fury - Checks for the Enhanced Constitution buff from Fury.
*flurry - Checks for the Slashing Strikes buff from Flurry.
*pummel - Checks for the Concussive Blows buff from Pummel.
*thrash - Checks for the Forceful Blows buff from Thrash.
*vigor - Checks for the Tangleweed Vigor buff from Tangleweed.
*reflex - Checks for the Arcane Reflex buff from Nature's Touch.
*tailwind - Checks for Tailwind buff from Breeze. (tailwind) (!tailwind)
*shout - Checks for the Empowered buff from Shout.
*yowlp - Checks for the Yertie's Yowlp buff from Yowlp.
*holler - Checks for the Horland's Holler buff from Holler.
*voidweaver - checks for the Voidweaver buff from Implosion(720)
*justice - Checks for charges of Swift Justice. (justice) do skill with charges (!justice) do skill with no charges
*buffXX - Fire ability when buff duration is <= XX. Supported for barrage,bearhug,fury,flurry,pummel,thrash,shout,yowlp
*tier# - Perform action if you are at the corresponding tier. (!tier3) don't do it if you are at tier3. (tier2) do it if you are tier2
*censer - Attempt to cast 320 before your command checking mana and cooldown. 309(censer), 335(censer mob3), attack(censer)
*ancient - Checks for grizzled/ancient creatures
*animate - Checks for if you have an animate present or not
*rebuke - Checks for Righteous Rebuke buff
*scourge - Checks for Ardor of the Scourge buff
*momentum - Checks for Glorious Momentum buff
**If command is a spell, will only cast censer if you have the mana for censer and the spell you intend.
**If command is not a spell, will only check you have enough mana for the censer.

===Example Attack Routines===
<PRE>wait 10, kill (x3)</PRE>

Waits 10 seconds for the monster to swing or cast and then immediately counter attacks from the specified attack stance set in the Hunting tab. Swings a total of three times before going into Defensive stance and waiting 10 seconds again.

<PRE>wait 15, incant 505, incant 903 (xx)</PRE>

Waits 15 seconds before INCANTing 505 (Hand of Tonis), hopefully knocking down or stunning the target. Following this, Bigshot casts 903 (minor water) repeatedly until the target is dead (up to 5 times).

<PRE>stance defensive and incant 1615, kill (x100)</PRE>

Casts 1615 (Divine Strike) at the target from Defensive stance, possibly forcing the target to kneel. Then, uses the kill verb to swing continuously until the target is dead or 100 times..whichever happens first.

<PRE>force feint until 101, kill (x2)</PRE>

Uses the Combat Maneuver FEINT against the target until a successful end roll and then hits the target twice before trying to FEINT again.

<PRE>stance defensive and hide, ambush left leg</PRE>

Hides from Defensive stance and then ambushes that the target's left leg. Once round-time is up, repeats (ie HIDES again from defensive stance).

<PRE>incant 720(m50), incant 708, incant 702 channel(xx)</PRE>

Casts 720 (Implosion) at the target if your character has 50 or more mana. Then, INCANTs 708 (Limb Disruption) at the target, using the default AIM location (if set). Finally, casts 702 (Mana Disruption) at the target up to (5) times or until it is dead.

<PRE>prep 708, cast at left leg / prep 708 channel at left leg, incant 719 (m50)(x1), incant 702 (xx)</PRE>

Prepares 708 (Limb Disruption) and CASTs it at the target's left leg. The second prepares the same spell and then CHANNELs it at the target's left leg. It will then cast 719 (Dark Catalyst) if there is at least 50 mana, and will only cast one time. The last will incant 702 until the creature is dead.

<PRE>wait 30, unarmed punch</PRE>

Waits 30 seconds or until your target attacks. Begins attacked with UAC combat using Punch to tier up.

<PRE>shield charge (s15 prone), ambush, mstrike</PRE>

Will shield charge the target if your character has 15 or more stamina and the target is NOT prone.

The second command will then ambush based on the settings in the "Attacking" Tab - in this case a custom order of head, neck, right leg, back was given so Bigshot will first try to Ambush the head unless the head is too injured or the head cannot be reached followed by the neck then right leg then back.

Bigshot will then focus mstrike the target unless the creature count is equal to or greater than the setting in the MSTRIKE Tab, in which case it will open mstrike instead. If you put "mstrike target", Bigshot will always focused mstrike regardless of the settings in the MSTRIKE Tab. Alternatively, you can set the "Unfocused MSTRIKE when creatures equal or greater" to a large number, to always focus your mstrikes (or set it to 1 to always open mstrike).

<PRE>bellow all, wblade(mob3), flurry(!flurry), attack</PRE>

Will aoe bellow, then whirling blade if there are at least 3 targets. The third command will flurry if you don't have the slashing strikes buff. Finally it will attack and continue to attack until one of the previous attacks become available.

<PRE>holler, shield throw(mob3), flurry, thrash, attack</PRE>

Will open up with a taunt from holler, then shield throw if there are at least 3 targets. Third command will flurry on cooldown. Fourth will thrash on cooldown. Finally we will attack if everything else ends up on cooldown or we run out of stamina.

<PRE>shroud(s35 !hidden mob2), divert (s25 hidden mob2), ambush(hidden), flurry, attack</PRE>

If there is more than one mob, it will hide with shroud and divert one of the targets. Third command will ambush if hidden. Fourth will flurry on cooldown followed up with attack to finish anything off.

<PRE>surge(!surge), bullrush, bearhug, pummel, attack</PRE>

Will cast surge when not on cooldown, and bullrush to bust up and apply vulnerable, then bearhug which is faster if target is vulnerable. Third we will pummel on cooldown and attack when nothing else is available.

<PRE>surge, shout(buff10), shield strike, pummel(buff60), attack(x2)</PRE>

Will keep surge active, casting during cooldown for 60 stamina. Next it will shout and refresh shout when there is less than 11 seconds left on the duration. Third it will shield strike followed up with a pummel once every minute. It will finish off with 2 attacks.

<PRE>pindown(mob4), volley(mob2), weed(!vigor !reflex), barrage(!barrage), incant 616 (m16 reflex), fire</PRE>

Will open up with pin down if there are at least 4 targets, then will volley if there are at least 2 targets. The third command will cast tangleweed if you do not have the tangleweed vigor buff or the arcane reflex buff. Our fourth command will barrage unless we have the enhanced dexterity buff from barage. Fifth we will cast a 1 second spike thorn if we do have 16 mana and do have the arcane reflex buff. Finally we will fire until one of our other commands become available.

===Hunting Target Examples===
All of the examples below will work for both the 'valid targets' and 'quickhunt targets' entries.
* A hunting option only using the default command (a) for each creature in an area:
<pre>crazed zombie, niirsha, sacristan spirit</pre>
* A hunting option using custom hunt commands depending on the creature. In this case it will use command (a) for a [[crazed zombie]] and a [[sacristan spirit]], while using (b) for a [[niirsha]]:
<pre>crazed zombie(a), niirsha(b), sacristan spirit(a)</pre>
* A hunting option that will include the [[:Category:Boss creatures|Boss Creatures]] variations as valid targets:
<pre>(?:adroit |afflicted |apt |barbed |belligerent |blurry |canny |combative |dazzling |deft |diseased |drab |dreary |ethereal |flashy |flexile |flickering |flinty |frenzied |ghastly |ghostly |gleaming |glittering |glorious |glowing |grotesque |hardy |illustrious |indistinct |keen |lanky |luminous |lustrous |muculent |nebulous |oozing |pestilent |radiant |raging |ready |resolute |robust |rune-covered |shadowy |shielded |shifting |shimmering |shining |sickly green |sinuous |slimy |sparkling |spindly |spiny |stalwart |steadfast |stout |tattooed |tenebrous |tough |twinkling |unflinching |unyielding |wavering |wispy )?crazed zombie, niirsha, sacristan spirit</pre>
* Some additional advanced options for identifying valid targets:
<pre>
(?:seasoned |grizzled |battle-scarred |weathered |veteran |hulking |haggard )?Grimswarm (?:giant|troll|orc) (?:dissembler|sorcerer|sorceress|warlock|witch)(a)
(?:seasoned |grizzled |battle-scarred |weathered |veteran |hulking |haggard )?Grimswarm (?:giant|troll|orc) (?:barbarian|blackguard|fighter|marauder|soldier|warrior)(b)
(?:seasoned |grizzled |battle-scarred |weathered |veteran |hulking |haggard )?Grimswarm (?:giant|troll|orc) (?:adept|archmage|elementalist|mage|warmage)(c)
(?:seasoned |grizzled |battle-scarred |weathered |veteran |hulking |haggard )?Grimswarm (?:giant|troll|orc) (?:hunter|huntmaster|huntmistress|ranger)(d)
(?:seasoned )?(?:dwarven|elven|halfling|erithian|human|giantman|half-krolvin|gnomish|half-elven) (?:thief|rogue|bandit|mugger|outlaw|highwayman|marauder|brigand|thug|robber)(e)
(?:shopkeeper|innkeeper|bartender|patrol leader|bandit lord|bandit lady|gypsy queen|gypsy king|guard captain|wall captain|drill sergeant|stable hostler|dungeon master|master torturer|butler|cook|
knight captain|foreign dignitary|royal prince|royal princess|royal jester|royal emperor|royal empress)(f)
</pre>
* To attack everything in the room <code>(?:.*)</code>

== Misc Tab==
Various specialized config options

===UAC Options===
The various options for configuring how UAC works:
* '''Tier 3 Attack'''
** The attack used when you have reached excellent in the UAC tier
** Options are jab, punch, grapple, or kick
* '''Aim at location (head, etc)'''
** Used for aimed UAC Combat, which requires ambush training to be effective
** Leave blank when you don't want to aim.
* '''MSTRIKE when creatures equal or greater'''
** Determines how many creatures must be present before using MSTRIKE
* '''Use Voln SMITE?'''
** Will perform a Voln SMITE on [[Non-corporeal]] undead

Frequently, people have trouble setting up Bigshot to work with Unarmed Combat. Bigshot only requires minimal configuration to ensure UAC works well.
#UAC tab: Input your '''Tier 3 Attack''' (jab, punch, grapple, or kick)
#Commands tab: Input your '''hunting commands(a)''' option as '''unarmed jab'''

Important notes to keep in mind on how UAC works in Bigshot:
* The hunting option '''unarmed jab''' can be replaced by any UAC attack type (e.g. '''unarmed punch''')
* UAC follow up strikes will be selected over the base or tier 3 attack
* Tier 3 attacks will be used only when positioning is excellent

There is almost no reason to ever use anything other than '''unarmed jab'' as the hunting command, and either '''grapple''' or '''kick''' as the Tier 3 attack.

===MSTRIKE Options===
MSTRIKE attack now has options for when it should be used.
* '''MSTRIKE during cooldown stamina requirement'''
** Allows you to specify how much stamina you want before it will MSTRIKE during the MSTRIKE Cooldown
** Be careful when setting this too low as it can pop your muscles
** Leave blank for it to use your max stamina.
* '''QUICKSTRIKE stamina requirement'''
** Like above but instead for using QUICKSTRIKE during the MSTRIKE routine.
* '''Unfocused MSTRIKE when creatures equal or greater'''
** Number of creatures in room before you do an unfocused mstrike. Default is 2.
* '''MSTRIKE during cooldown'''
**Toggle for MSTRIKEing during its cooldown period
* '''Use QUICKSTRIKE for MSTRIKE'''
** Toggle for using QUICKSTRIKE when you MSTRIKE

===Ammo/Wands===
Here you find the settings to tell Bigshot where you keep all of your nifty wands and bolts and arrows. If your attack routine involves FIRE or WAND verbs, these fields must be set lest Bigshot hang up.
* find ammo in this container: - Leave BLANK if having Bigshot use FIRE without getting ammo out (Archery 2020 Update). Rather self explanatory, this field holds the location of your ammunition storage, be it a wand harness, a quiver or just your backpack.
* use this ammo type: - Leave BLANK to have Bigshot use FIRE without getting any ammo (Archery 2020 Update). Again, like specifying monsters, Bigshot is most sensative about the NOUNs that you use here. If you
* fresh wand container: - Bigshot looks in this container to find fesh wands to WAVE.
* dead wand container: - ...And then will deposit the used up wands in this container.
* use this wand type: - Here you specify which particular wand type you want to use. Bigshot will then pull only these kinds for WAVEing. Can have multiple types listed. Seperate each one with a comma. Example: "aquamarine wand, bloodwood wand, etc"
* Hide while waiting to pick up ammo - Checking this box will have Bigshot hide when gathering up your spent arrows and bolts.
* Use wands when out of mana - Bigshot will pull whatever wand you have specified in the use this wand type field and automatically stance to your attacking stance and WAVE your wand at valid targets until you are out of wands OR hit your resting conditions.

===MA Grouping===
* Enter the name of the looter in Head/Tail configuration

==Monitoring Tab==
* Monitor interaction - Running scripts automates most functions and happens rather mechanically. Most anyone can tell if you are scripting just by watching you. Checking this box will pop up a window whenever Bigshot thinks that someone or something is trying to interact with you.
* Engage deadman's switch - Selecting this option will force Bigshot to quit Gemstone IV when your character is at less than 40% health, allowing you to log back on and assess the situation manually later.
* Depart/rerun if dead - Enabling this option will force a DEPART, causing your character to wake up in the Temple with low spirit. Following this, Bigshot will re-start, starting a fresh hunt. If you do not have a Check Spirit value set in your Should_hunt? tab, you will start hunting without recuperating lost stats.
* Quiet followers - Followers will wait until leader is done with both actions and resting scripts to begin using their own.

===Debugging:===
<pre{{log2}}>
+---------------------------------------------------------------------------+
| Bigshot Debug Help v5.8.5 |
+---------------------------------------------------------------------------+
| Debug options have changed to be more helpful. |
+--------------------------------------+------------------------------------+
| ;bigshot debug file | Toggles logging to a file <on/off> |
| ;bigshot debug all <true/false> | Toggles true/false all the things |
| ;bigshot debug check | Lists current debug settings |
| ;bigshot debug combat <true/false> | Combat and Creature Status |
| ;bigshot debug commands <true/false> | Attacking and Casting Commands |
| ;bigshot debug status <true/false> | Status Checks of your Character |
| ;bigshot debug system <true/false> | System processes |
| | |
| Options can be combined: |
| ;bigshot debug combat commands status <true/false> |
+---------------------------------------------------------------------------+
</pre>

==Ingame Screenshot==
<gallery perrow="4">
File:bigshot-1.PNG|Profiles
File:bigshot-2.PNG|Resting
File:bigshot-3.PNG|Hunting
File:bigshot-4.PNG|Attacking
File:bigshot-5.PNG|Commands
File:bigshot-6.PNG|Misc
File:bigshot-7.PNG|Monitoring
</gallery>

==Reference==
* Info originally taken from http://forum.gsplayers.com/showthread.php?t=57651

{{Third-Party Software}}
{{top}}

Lich:Software/Installation

2025-07-08T16:35:56Z

WHIGHTCNIGHT: /* Lich Changelog */ add 5.12.3 notes

Lich:Software/Installation

2025-07-08T16:35:14Z

WHIGHTCNIGHT: /* Installing the Latest Stable Release */ update released version to 5.12.3

Lich:Software/Installation

2025-06-25T17:46:37Z

WHIGHTCNIGHT: /* Lich Changelog */ updated to 5.12.1 release

Lich:Software/Installation

2025-06-25T17:42:53Z

WHIGHTCNIGHT: /* Installing the Latest Stable Release */ updated for Lich 5.12.1 release

Lich:Script Repository

2025-05-27T14:39:22Z

WHIGHTCNIGHT: /* Jinx Lich Repository Mirror */ minor corrections to repo name

{{3rd-party}}
The repository, owned by Tillmen, is the most common location for downloading scripts that are not pre-installed with Lich.

==How to Use the Repository==

The repository has four basic commands:

<syntaxhighlight lang="ruby">
;repository

;repository download <scriptname>

;repository info <scriptname>

;repository list
</syntaxhighlight>

The first shows a Help screen and is the root command for all others.

The second, often shortened to ';repo down', lets you download a specified script.

Third, INFO provides information about whatever script is specified. If the author has been kind and thorough, this will tell you how to use the script and if it has any interdependencies.

Fourth, LIST will list all scripts in the repository.

==Updating Scripts==
The repository supports updates via prefedined scripts and the MapDatabase
To see a list of scripts you currently have set to updatable, <CODE>;repo show-updatable</CODE>.
For users on Lich 5+, you want <CODE>Lich: off</CODE> to be displayed.

To add a script to be updated, <CODE>;repo set-updatable <scriptname></CODE>.
To view scripts you have set to be auto-updated, <CODE>;repo show-updatable</CODE>.
It is only recommended to set scripts from authors you trust to auto-update.

If you want to remove, <CODE>;repo unset-updatable <scriptname></CODE>.

==Popular Lich Scripts==

<section begin=popularscripts />The following are a list of scripts that enhance or extend basic functions of Gemstone IV and can improve or streamline your gaming experience to a point where you can't think of ever going back. It's not all inclusive but contains a good starter set or some of the most popular scripts in use.
=== Core components installed with Lich ===

'''Generally speaking, the below scripts should not need to be updated manually by the user, especially if the user keeps up to date on the current lich version.'''
* [[Lich:Script Alias|alias]] - A default script used to create shortcuts in lich. See wiki page for details.
* [[Lich:Script Autostart|autostart]] - A default script to handle which scripts run on startup. See wiki page for details.
* [[Script Go2|go2]] - Go2 is an intelligent travel script that is synchronized to many of the more complex scripts. Go2 uses a Room Number system and can intelligently plot routes between most any two rooms in all of Elanthia. Use can be as simple as <code>;go2 town</code> or <code>;go2 bank</code> to head to the nearest town square or bank. Use <code>;go2 targets</code> to see a list of pre-programmed locations broken down by towns. Or, use <code>;go2 save <new location name>=<new location room number></code> to create your own locations. Go2 is distributed as part of a default Lich installation.
* [[Lich:Script Map|map]] - map (fork of Narost/XNarost) is an active map library that can display your location and allows Point-And-Click travel. Simply right click and choose a map, pick a room on it and click on it. map is distributed as part of a default Lich installation.
* [[Script Repository|repository]] - A default script to view and download other scripts. See wiki page for details.
* [[Lich:Script Vars|vars]] - A default script to create and view variables for both users and scripts. See wiki page for details.
* [[Lich:Script Version|version]] - A default script to output your current lich version and other information. See wiki page for details.

=== Scripts maintained by Elanthia-Online ===
* [[Lich:Script Bigshot|bigshot]] - A script for attacking and hunting routines. See wiki page for details.
* '''blackarts''' - A script for doing various [[alchemy]] tasks. <CODE>;blackarts setup</CODE> for configuration details
* [[Lich:Script Ebounty|ebounty]] - A script to get and perform bounties. See wiki page for details.
* '''ecaster''' - Allows user to type just the spell number and have lich cast that spell. Usage syntax is <code>;ecaster setup</code> for configuration. Set to autostart.
* '''echild''' - A child bounty script that monitors for and returns a child during bounty sessions. Add to autostart or your hunting script when performing a bounty.
* [[Lich:Script Ecleanse|ecleanse]] - A script for dealing with status conditions. See wiki page for details.
* '''ecure''' - A script for healing for empaths. Usage syntax is <code>;ecure setup</code> for first usage.
* [[Lich:Script Eherbs|eherbs]] - A herb healing and stocking script. See wiki page for details.
* [[Lich:Script Eloot|eloot]] - A looting and loot management script. See wiki page for details.
* '''elogin''' - A script for command line login for your characters. . Usage syntax is <code>;elogin <charname></code>
* '''escortgo2''' - A script for bounty escorts. Usage syntax is <code>;escortgo2 help</code> for relevant commands (replaces ;ego2)
* [[Lich:Script Ewaggle|ewaggle]] - A script for spelling yourself and others up. See wiki page for details.
* '''ewander''' - The last of the Trifector of Travel, wander will move from room to room until it runs into a Boundary - a specified room number - or finds a room with a monster AND empty of players. Wander can be used to create a walled in hunting ground, letting you automatically move from room to room without having to use keystrokes. Use the <code>;ewander add</code> command to add the room you are currently standing in to the Wander List. Note: Wander will NOT enter your boundary rooms. For example, adding Town Square East to the list and then executing ;ewander from within the confines of Moot Hall will send your character exploring every room in Moot, but unable to leave as TSE is a Boundary.
* [[Lich:Script foreach|foreach]] - A script for sending a series of commands for each item that matches its criteria. See wiki page for details.
* '''jbackup ''' - A excellent backup and recovery tool that allows lich database and any additional file backup a user prefers. Set to autostart.
* '''ledger''' - A scripting for tracking your silver and bounty incoming across sessions and over time per character and account with a nice ascii display. Requires ascii_charts gem (installed by default with Lich 5.7.0+ full installer)
* '''signore ''' - A script for using society powers <CODE>;signore setup</CODE> for configuration
* '''resource''' - A script for determining your current player service bonus. <CODE> ;resource bonus </CODE> Can also be used to determine the cost of enchanting with the syntax ;resource calc <starting enchant> <ending enchant> <cost per essence> as in <CODE>;resource calc 35 45 50</CODE>
* '''uberbar_eo ''' - The most current Uberbar variant. This will provide a paperdoll with room number, resource information, etc. inside Wrayth. Set to autostart. Note- there is a small performance impact when using Uberbars.

=== Other scripts that are popular ===
* '''character-planner ''' - A script for planning out your character skills and training. <CODE>;character-planner</CODE> for configuration
* '''colmaster ''' - A script for getting and performing COL tasks in Solhaven
* '''dirty-deeds ''' - A script for getting deeds in IMT and WL. <CODE>;dirty-deeds setup</CODE> for configuration
* [[Script invdb|invdb]] - An inventory management database. See wiki page for details
* '''linktothefast''' - A complex script that provides highlighting for Wrayth links when links are disabled. This script can cause issues with [[STOW]] settings, so disable prior to adjusting those settings.
* [[Script LNet|lnet]] - An out of game, third party, not Simutronics controlled chat server. <CODE>;repo download lnet --author=elanthia-online</CODE>. See wiki page for details '''LNet should be installed at your own risk'''. Simutronics has no control over LNet or policy enforcement there. The in-game [[ESP]] is now available and replaces many of the functions that LNet provided.
* '''multi''' - A script to perform repetitive set of commands. Usage syntax is <code>;multi; <number> <action></code> such as <code>;multi 10, get my diamond, drop my diamond</code>
* '''rogues''' - A script for rogue guild tasks <CODE>;rogues setup</CODE> for configuration
* '''sorter ''' Sorter cleans up your bags and breaks down the the output of a LOOK command, sorting the results by type. Makes looking in your locker or backpack, and especially your gem pouch, infinitely easier. *Note* Sorter can mess up some other scripts that deal with inventory, so be cautious in usage. Elanthia-Online scripts like eloot disable sorter when performing relevant functions
* '''stat-maximizer''' - A script for configuring character stats. <CODE>;stat-maximizer</CODE> for configuration
* '''tpick''' - A script for lockpicking <CODE>;tpick setup</CODE> for configuration
* '''volnstep ''' - A script for performing voln tasks in Wehnimer's Landing
* '''warrior''' - A script for warrior guild tasks <CODE>;warrior setup</CODE> for configuration
<section end=popularscripts />

==In-game Help Output==
<PRE>Usage:

;repository list [alpha] lists all scripts available for download (optionally in alphabetial order)
;repository sync [alpha] lists only new and/or updated scripts
;repository info <script name> shows the comments at the top of the script
;repository download <script name> downloads the script
;repository upload <script name> uploads the script
;repository delete <script name> deletes the script from the server

Scripts should include comments at the top describing the purpose of the script. Scripts without comments at the top will not show up on the server.

After uploading a script, a key that allows you to delete/update the script will be saved to C:/Games/lich/keys</PRE>

==Sortable list==
The repository script has an in game GUI available that allows sorting by date, tags, etc.
<CODE>;repo gui</CODE>

==Jinx (Repository alternative)==

Jinx is a project that is an alternative form of script installation from the default ;repository. It can serve up scripts for download similar to the ;repo however it is not dependent on a single server that may be prone to outages. Any one can set up their own script library, and then users can add it as a source for the ;jinx script to search and download from.

Jinx is installed in the default Lich5 package. Jinx can be downloaded and installed into your scripts folder from the Elanthia Online github

https://raw.githubusercontent.com/elanthia-online/scripts/master/scripts/jinx.lic

Right-click the above link and save it into the scripts folder in your lich directory.

Alternatively, the following command can be issued in game via lich to attempt to download the script to the proper directory for you (this command is for when the repository is down and the script cannot be downloaded naturally):
<syntaxhighlight lang="ruby">
;e require 'open-uri';begin;jinx_remote = open("https://raw.githubusercontent.com/elanthia-online/scripts/master/scripts/jinx.lic"); jinx_local = File.open(File.join(SCRIPT_DIR, 'jinx.lic'), "wb"); jinx_local.write(jinx_remote.read);ensure; jinx_remote.close(); jinx_local.close();end</syntaxhighlight>

once installed you can issue: <CODE>;jinx help</CODE> for basic usage information.

===Jinx Lich Repository Mirror===
In the event the main <code>;repository</code> is unavailable, there is currently an actively maintained <code>;jinx</code> repository that is a direct mirror.

https://github.com/FarFigNewGut/lich_repo_mirror

Scripts can be manually retrieved from this Github repository (they are all located in the lib folder). The repository is also packaged and published for use directly with Jinx:

<syntaxhighlight lang="ruby">
;jinx repo add mirror https://ffnglichrepoarchive.netlify.app
</syntaxhighlight>

Once it is setup as a source for <code>;jinx</code> you can install any scripts from the repo with:

<syntaxhighlight lang="ruby">
# install script for the first time
;jinx script install <script name> --repo=mirror

# update previously installed script
;jinx script update <script name> --repo=mirror
</syntaxhighlight>

For example if you wanted to download or update invdb.lic:
<syntaxhighlight lang="ruby">
# first install
;jinx script install invdb --repo=mirror

# update if you had previously downloaded invdb.lic
;jinx script update invdb --repo=mirror
</syntaxhighlight>

Do note, if a script is not available on the archive, it's likely because it belongs to Elanthia-Online and those scripts are not found within the archive, but under a default repo that is configured with jinx. To use it, you would do the following, using bigshot.lic as an example
<syntaxhighlight lang="ruby">
# first install
;jinx script install bigshot --repo=elanthia-online

# update if you had previously downloaded bigshot.lic
;jinx script update bigshot --repo=elanthia-online
</syntaxhighlight>

You can also leave the <code>--repo=<REPO_NAME></code> off to see all available options for a script that is found.

===Jinx Lich Repository Offline Update Info===
At times the default Lich repository (accessed via <code>;repo</code>) can go offline, below are some helpful commands to update core Lich related functionality using Jinx.

<syntaxhighlight lang="ruby">
# ensure running latest jinx.lic for newest compatibility
;jinx script update jinx.lic --repo=elanthia-online

# update spell-list.xml for new spells, cmans, cooldowns, etc
;jinx data update effect-list.xml --repo=elanthia-online

# update gameobj-data.xml for proper classification of NPCs and items
;jinx data update gameobj-data.xml --repo=mirror

# update mapdb and associated missing map files for graphical use
;jinx data update mapdb.json --repo=elanthia-online

</syntaxhighlight>

==In-game Screenshot==
<gallery perrow="4">
File:Repo-1.png|Repo
</gallery>

{{Third-Party Software}}

Lich:Script Repository

2025-05-27T14:38:20Z

WHIGHTCNIGHT: /* Jinx Lich Repository Offline Update Info */ update for more modern Lich5 changes

{{3rd-party}}
The repository, owned by Tillmen, is the most common location for downloading scripts that are not pre-installed with Lich.

==How to Use the Repository==

The repository has four basic commands:

<syntaxhighlight lang="ruby">
;repository

;repository download <scriptname>

;repository info <scriptname>

;repository list
</syntaxhighlight>

The first shows a Help screen and is the root command for all others.

The second, often shortened to ';repo down', lets you download a specified script.

Third, INFO provides information about whatever script is specified. If the author has been kind and thorough, this will tell you how to use the script and if it has any interdependencies.

Fourth, LIST will list all scripts in the repository.

==Updating Scripts==
The repository supports updates via prefedined scripts and the MapDatabase
To see a list of scripts you currently have set to updatable, <CODE>;repo show-updatable</CODE>.
For users on Lich 5+, you want <CODE>Lich: off</CODE> to be displayed.

To add a script to be updated, <CODE>;repo set-updatable <scriptname></CODE>.
To view scripts you have set to be auto-updated, <CODE>;repo show-updatable</CODE>.
It is only recommended to set scripts from authors you trust to auto-update.

If you want to remove, <CODE>;repo unset-updatable <scriptname></CODE>.

==Popular Lich Scripts==

<section begin=popularscripts />The following are a list of scripts that enhance or extend basic functions of Gemstone IV and can improve or streamline your gaming experience to a point where you can't think of ever going back. It's not all inclusive but contains a good starter set or some of the most popular scripts in use.
=== Core components installed with Lich ===

'''Generally speaking, the below scripts should not need to be updated manually by the user, especially if the user keeps up to date on the current lich version.'''
* [[Lich:Script Alias|alias]] - A default script used to create shortcuts in lich. See wiki page for details.
* [[Lich:Script Autostart|autostart]] - A default script to handle which scripts run on startup. See wiki page for details.
* [[Script Go2|go2]] - Go2 is an intelligent travel script that is synchronized to many of the more complex scripts. Go2 uses a Room Number system and can intelligently plot routes between most any two rooms in all of Elanthia. Use can be as simple as <code>;go2 town</code> or <code>;go2 bank</code> to head to the nearest town square or bank. Use <code>;go2 targets</code> to see a list of pre-programmed locations broken down by towns. Or, use <code>;go2 save <new location name>=<new location room number></code> to create your own locations. Go2 is distributed as part of a default Lich installation.
* [[Lich:Script Map|map]] - map (fork of Narost/XNarost) is an active map library that can display your location and allows Point-And-Click travel. Simply right click and choose a map, pick a room on it and click on it. map is distributed as part of a default Lich installation.
* [[Script Repository|repository]] - A default script to view and download other scripts. See wiki page for details.
* [[Lich:Script Vars|vars]] - A default script to create and view variables for both users and scripts. See wiki page for details.
* [[Lich:Script Version|version]] - A default script to output your current lich version and other information. See wiki page for details.

=== Scripts maintained by Elanthia-Online ===
* [[Lich:Script Bigshot|bigshot]] - A script for attacking and hunting routines. See wiki page for details.
* '''blackarts''' - A script for doing various [[alchemy]] tasks. <CODE>;blackarts setup</CODE> for configuration details
* [[Lich:Script Ebounty|ebounty]] - A script to get and perform bounties. See wiki page for details.
* '''ecaster''' - Allows user to type just the spell number and have lich cast that spell. Usage syntax is <code>;ecaster setup</code> for configuration. Set to autostart.
* '''echild''' - A child bounty script that monitors for and returns a child during bounty sessions. Add to autostart or your hunting script when performing a bounty.
* [[Lich:Script Ecleanse|ecleanse]] - A script for dealing with status conditions. See wiki page for details.
* '''ecure''' - A script for healing for empaths. Usage syntax is <code>;ecure setup</code> for first usage.
* [[Lich:Script Eherbs|eherbs]] - A herb healing and stocking script. See wiki page for details.
* [[Lich:Script Eloot|eloot]] - A looting and loot management script. See wiki page for details.
* '''elogin''' - A script for command line login for your characters. . Usage syntax is <code>;elogin <charname></code>
* '''escortgo2''' - A script for bounty escorts. Usage syntax is <code>;escortgo2 help</code> for relevant commands (replaces ;ego2)
* [[Lich:Script Ewaggle|ewaggle]] - A script for spelling yourself and others up. See wiki page for details.
* '''ewander''' - The last of the Trifector of Travel, wander will move from room to room until it runs into a Boundary - a specified room number - or finds a room with a monster AND empty of players. Wander can be used to create a walled in hunting ground, letting you automatically move from room to room without having to use keystrokes. Use the <code>;ewander add</code> command to add the room you are currently standing in to the Wander List. Note: Wander will NOT enter your boundary rooms. For example, adding Town Square East to the list and then executing ;ewander from within the confines of Moot Hall will send your character exploring every room in Moot, but unable to leave as TSE is a Boundary.
* [[Lich:Script foreach|foreach]] - A script for sending a series of commands for each item that matches its criteria. See wiki page for details.
* '''jbackup ''' - A excellent backup and recovery tool that allows lich database and any additional file backup a user prefers. Set to autostart.
* '''ledger''' - A scripting for tracking your silver and bounty incoming across sessions and over time per character and account with a nice ascii display. Requires ascii_charts gem (installed by default with Lich 5.7.0+ full installer)
* '''signore ''' - A script for using society powers <CODE>;signore setup</CODE> for configuration
* '''resource''' - A script for determining your current player service bonus. <CODE> ;resource bonus </CODE> Can also be used to determine the cost of enchanting with the syntax ;resource calc <starting enchant> <ending enchant> <cost per essence> as in <CODE>;resource calc 35 45 50</CODE>
* '''uberbar_eo ''' - The most current Uberbar variant. This will provide a paperdoll with room number, resource information, etc. inside Wrayth. Set to autostart. Note- there is a small performance impact when using Uberbars.

=== Other scripts that are popular ===
* '''character-planner ''' - A script for planning out your character skills and training. <CODE>;character-planner</CODE> for configuration
* '''colmaster ''' - A script for getting and performing COL tasks in Solhaven
* '''dirty-deeds ''' - A script for getting deeds in IMT and WL. <CODE>;dirty-deeds setup</CODE> for configuration
* [[Script invdb|invdb]] - An inventory management database. See wiki page for details
* '''linktothefast''' - A complex script that provides highlighting for Wrayth links when links are disabled. This script can cause issues with [[STOW]] settings, so disable prior to adjusting those settings.
* [[Script LNet|lnet]] - An out of game, third party, not Simutronics controlled chat server. <CODE>;repo download lnet --author=elanthia-online</CODE>. See wiki page for details '''LNet should be installed at your own risk'''. Simutronics has no control over LNet or policy enforcement there. The in-game [[ESP]] is now available and replaces many of the functions that LNet provided.
* '''multi''' - A script to perform repetitive set of commands. Usage syntax is <code>;multi; <number> <action></code> such as <code>;multi 10, get my diamond, drop my diamond</code>
* '''rogues''' - A script for rogue guild tasks <CODE>;rogues setup</CODE> for configuration
* '''sorter ''' Sorter cleans up your bags and breaks down the the output of a LOOK command, sorting the results by type. Makes looking in your locker or backpack, and especially your gem pouch, infinitely easier. *Note* Sorter can mess up some other scripts that deal with inventory, so be cautious in usage. Elanthia-Online scripts like eloot disable sorter when performing relevant functions
* '''stat-maximizer''' - A script for configuring character stats. <CODE>;stat-maximizer</CODE> for configuration
* '''tpick''' - A script for lockpicking <CODE>;tpick setup</CODE> for configuration
* '''volnstep ''' - A script for performing voln tasks in Wehnimer's Landing
* '''warrior''' - A script for warrior guild tasks <CODE>;warrior setup</CODE> for configuration
<section end=popularscripts />

==In-game Help Output==
<PRE>Usage:

;repository list [alpha] lists all scripts available for download (optionally in alphabetial order)
;repository sync [alpha] lists only new and/or updated scripts
;repository info <script name> shows the comments at the top of the script
;repository download <script name> downloads the script
;repository upload <script name> uploads the script
;repository delete <script name> deletes the script from the server

Scripts should include comments at the top describing the purpose of the script. Scripts without comments at the top will not show up on the server.

After uploading a script, a key that allows you to delete/update the script will be saved to C:/Games/lich/keys</PRE>

==Sortable list==
The repository script has an in game GUI available that allows sorting by date, tags, etc.
<CODE>;repo gui</CODE>

==Jinx (Repository alternative)==

Jinx is a project that is an alternative form of script installation from the default ;repository. It can serve up scripts for download similar to the ;repo however it is not dependent on a single server that may be prone to outages. Any one can set up their own script library, and then users can add it as a source for the ;jinx script to search and download from.

Jinx is installed in the default Lich5 package. Jinx can be downloaded and installed into your scripts folder from the Elanthia Online github

https://raw.githubusercontent.com/elanthia-online/scripts/master/scripts/jinx.lic

Right-click the above link and save it into the scripts folder in your lich directory.

Alternatively, the following command can be issued in game via lich to attempt to download the script to the proper directory for you (this command is for when the repository is down and the script cannot be downloaded naturally):
<syntaxhighlight lang="ruby">
;e require 'open-uri';begin;jinx_remote = open("https://raw.githubusercontent.com/elanthia-online/scripts/master/scripts/jinx.lic"); jinx_local = File.open(File.join(SCRIPT_DIR, 'jinx.lic'), "wb"); jinx_local.write(jinx_remote.read);ensure; jinx_remote.close(); jinx_local.close();end</syntaxhighlight>

once installed you can issue: <CODE>;jinx help</CODE> for basic usage information.

===Jinx Lich Repository Mirror===
In the event the main <code>;repository</code> is unavailable, there is currently an actively maintained <code>;jinx</code> repository that is a direct mirror.

https://github.com/FarFigNewGut/lich_repo_mirror

Scripts can be manually retrieved from this Github repository (they are all located in the lib folder). The repository is also packaged and published for use directly with Jinx:

<syntaxhighlight lang="ruby">
;jinx repo add ffnglichrepoarchive https://ffnglichrepoarchive.netlify.app
</syntaxhighlight>
(You can use something shorter instead of "ffnglichrepoarchive" for the repo name if you'd like.)

Once it is setup as a source for <code>;jinx</code> you can install any scripts from the repo with:

<syntaxhighlight lang="ruby">
# install script for the first time
;jinx script install <script name> --repo=ffnglichrepoarchive

# update previously installed script
;jinx script update <script name> --repo=ffnglichrepoarchive
</syntaxhighlight>

For example if you wanted to download or update invdb.lic:
<syntaxhighlight lang="ruby">
# first install
;jinx script install invdb --repo=ffnglichrepoarchive

# update if you had previously downloaded invdb.lic
;jinx script update invdb --repo=ffnglichrepoarchive
</syntaxhighlight>

Do note, if a script is not available on the archive, it's likely because it belongs to Elanthia-Online and those scripts are not found within the archive, but under a default repo that is configured with jinx. To use it, you would do the following, using bigshot.lic as an example
<syntaxhighlight lang="ruby">
# first install
;jinx script install bigshot--repo=elanthia-online

# update if you had previously downloaded bigshot.lic
;jinx script update bigshot --repo=elanthia-online
</syntaxhighlight>

You can also leave the <code>--repo=<REPO_NAME></code> off to see all available options for a script that is found.

===Jinx Lich Repository Offline Update Info===
At times the default Lich repository (accessed via <code>;repo</code>) can go offline, below are some helpful commands to update core Lich related functionality using Jinx.

<syntaxhighlight lang="ruby">
# ensure running latest jinx.lic for newest compatibility
;jinx script update jinx.lic --repo=elanthia-online

# update spell-list.xml for new spells, cmans, cooldowns, etc
;jinx data update effect-list.xml --repo=elanthia-online

# update gameobj-data.xml for proper classification of NPCs and items
;jinx data update gameobj-data.xml --repo=mirror

# update mapdb and associated missing map files for graphical use
;jinx data update mapdb.json --repo=elanthia-online

</syntaxhighlight>

==In-game Screenshot==
<gallery perrow="4">
File:Repo-1.png|Repo
</gallery>

{{Third-Party Software}}

Lich:Script Bigshot

2025-04-25T15:57:06Z

WHIGHTCNIGHT: /* The Resting Tab */ updated percenthealth to Char.percent_health check

{{3rd-party}}
Bigshot is designed to handle combat routines, including moving to and from hunting areas, defining creatures to hunt and accompanying attack routines
Afk scripting on any server but Shattered is in violation of game policy.
{{TOCright| limit=2}}
==Changelog==
*[[Script Bigshot/Changelog|Script Bigshot Changelog]]
==About Bigshot==
===What Does Bigshot Do?===

Using a series of menus and commands inputs, Bigshot lets a user create a modular, customizable and fully automated hunting script. With just a few clicks and tweaks, you can go from scripting Rats to the Rift.

===How Do I Get It?===

Grab it from the Repository: ;repository download Bigshot

===How Do I Make it GO!?===
Initial setup is accessed through ;bigshot setup. There you will see a configuration window with various tabs to setup for your hunting routine.

As with most scripts, using a SETUP command will open a graphical user interface for configuring the script. Use ;bigshot setup to open this dialog. This will open a window with the following tabs:
* Profile - This is where you save/load your profile information. Profiles are saved to your \Lich5\data\<GSServer\<charname>\bigshot_profiles directory. Eg, \Lich5\data\GSIV\Rinualdo\bigshot_profiles (note, if you've previously used bigshot, the file location has changed. The previous location was in your \Lich5\scripts\bigshot_profiles folder. You can copy/paste
* Resting - Set up your resting routine and location.
* Hunting - Create a hunting map by adding BOUNDARIES, define your attack stance and any pre hunt information
* Attacking - configuration for ambushing, bless, reactions, and similar flags
* Commands - Where you define your valid targets and associated attack routines. See sample routines below.
* Misc tab - Various config options

We will take a closer look at each of these individually further on.

There is also several other commands you can do for more functionality.
* ;bigshot quick - Special hunting mode that kills everything in the room your in and quits bigshot. Wont wander at all, and wont attempt to rest. Has its own hunting commands and hunting targets.
* ;bigshot head/tail - This is for Multi-Account hunting. It only works for a single computer. Every character needs to be setup for the hunting area your going to. You start it by having your following characters join your head character. The following characters need to be running bigshot with ;bigshot tail. Once that happens, have the leader of the group do ;Bigshot head. They will then procede to hunt in the area you have setup.
* ;bigshot display - Shows all your current settings.
* ;bigshot reset - Resets all your targetable and untargetable lists. Useful if you find bigshot won't targets something it should.
* ;bigshot ranger or ;bigshot companion - Resets ranger companion setting so you can set it again. Used when you change your companion.
* ;bigshot profile save <name here> - Saves a profile in YAML format in your character's profile folder. Also accessible via the Profiles tab in the setup menu.
* ;bigshot profile load <name here> - Loads a profile from your character's profile folder. Also accessible via the Profiles tab in the setup menu.
* ;bigshot single - When used solo, will execute a single hunting routine, return to your resting location and then exit
* ;bigshot <options> <creature> - example: ;bigshot single giant rat - Will activate ranger tracking of a creature. Anything input besides the above commands will default to "track <input>".

==The Profile Tab==
* Load Profile - will load an existing profile. Nothing will be available if no previous profiles are saved
* Current Profile - shows the existing profile if a new one is loaded.
* Save profile - Valid profile information for future ebounty script support
Save Current Settings - tell Bigshot what you want your profile to be named. Any name will work here. Once a profile is saved, will show up in the Load Profile menu.

==The Resting Tab==
Short and sweet, here is where we setup our resting routines. During REST mode, Bigshot uses the EXP command and checks your mind, hit points, wound status, mana and spirit. Once all of these values are at the specified Should_hunt? settings, Bigshot leaves REST mode and begins a HUNT.

* room id: - This is the room that Bigshot will return to for resting. Use Room Numbers from Map/Go2. Support both LichIDs and SimuIDs with a u, for example, 228 for Town Square Central or u7120.
* pre-rest commands: - These commands run before entering REST mode. An example routine is: 'shea, wear shield, sit, stance offensive, rest'. This will sheath your weapon, wear your shield, sit, enter offensives stance and use the REST verb.
* active resting scripts: - Active resting scripts are scripts that will be run upon entering REST mode. These scripts should be things that you do after a hunt: get healed, empty your bags, spell up. An example list is: 'eloot sell, waggle, eherbs'. This will use eloot to sell according to the options set with eloot. After selling, it will use Waggle to spell you up according to however Waggle is setup. Finally, eherbs will check your PACK and use herbs stored there to heal whatever wounds you have.
* Fog Option: - Uses [[Spirit Guide (130)]], Voln [[Symbol of Return]], [[Traveler's Song (1020)]], [[Sigil of Escape]], [[Familiar Gate (930)]] or Custom when heading back to rest. Setting it to None does nothing. Setting it to 130 will cause it to use 130 first then if that fails symbol of return. Symbol of return will use that first, then 130 if that fails. Setting to Traveler's Song will attempt once and continue. Setting to Familiar Gate will attempt to summon a portal once and walk through it. Will perform a mana pulse if not enough mana is detected. Custom option allows for comma separated list of commands to perform.
* Should Rest?
Bigshot evaluates these conditions and, when they are met, will go to your resting room set on the Resting tab and execute any resting scripts you have set.
* '''when percent mind >='''
** Rests when your mind has reached this threshold. Generally, set this to 100 to rest when fried.
* '''and extra kills >='''
** The number of extra monsters to kill after reaching your `when percent mind` threshold and after LTE boosts used
* '''and used lte boosts >='''
** The number of LTE boosts it will attempt to use after reaching your `when percent mind` threshold
* '''or percentmana <='''
** Forces Bigshot to rest when your percentage of mana is at or below this threshold.
** This can be set to 0, but leaving a bit in the tank can be good if you have to use 406 (Unlock) to open the WL Graveyard gate. 11/17/24: If you run into an error that calls to an "OOM" message, try setting this to 1.
* '''or percentencumbrance >='''
** Forces Bigshot to rest when you have reached a given level of encumbrance.
* '''or wounded eval'''
** Allows you to set an evaluation phrase to determine if you are too wounded to continue hunting. Wound evaluations can send you home on nearly any wounded condition of your choice: bleeding, level 2 wound, can't cast, too many scars etc.

The following is a wounded evaluation that will rest whenever you have any level II wounds:
<PRE>XMLData.injuries.any?{|key,value| value["wound"] > 1} || Char.percent_health <= 70</PRE>
The following is a wound evaluation that will take you home if you can not cast anymore (nerves, level 2 head/eyes, bad scars etc.):
<PRE>bleeding? || Char.percent_health <= 25 || [Wounds.head, Scars.head, Wounds.leftEye, Scars.leftEye, Wounds.rightEye, Scars.rightEye, Wounds.nsys, Scars.nsys].max > 1 || [Wounds.leftArm, Wounds.leftHand, Wounds.rightArm, Wounds.rightHand, Scars.leftArm, Scars.leftHand, Scars.rightArm, Scars.rightHand].max > 2 || ([Wounds.leftArm, Wounds.leftHand, Scars.leftArm, Scars.leftHand].max > 0 && [Wounds.rightArm, Wounds.rightHand, Scars.leftArm, Scars.leftHand].max > 0)</PRE>
The following can be added to one of the above wound evaluations to also rest upon having popped muscles:
<PRE>|| Effects::Debuffs.active?("Overexerted")</PRE>

* '''when creeping dread >='''
** Forces Bigshot to rest when your creeping dread is at or below this threshold.
* '''when crushing dread >='''
** Forces Bigshot to rest when your crushing dread is at or below this threshold.
* '''Wall of Thorns Poison'''
** Forces Bigshot to rest when you are affected by Wall of Thorns Poison.
* '''Confusion Debuff'''
** Forces Bigshot to rest when you are affected by the non-dispellable Confusion Debuff.

==The Hunting Tab==
This is where you will tell bigshot when to hunt, any commands or society abilities to use prior to hunting, and where on the map you want to hunt.
===The Hunting Map===
Your hunting map is a series of Boundaries - rooms that Bigshot will not enter - and a Start room - the first room that Bigshot moves to when a hunt starts. These function very similarly to the boundaries in the ;Wander script, but are stored in Bigshot's configuration files and not in a character cache as with ;Wander. Here you also configure when to hunt
* starting room ID: - This is the first room that Bigshot goes to when hunting. You may set this to any room within the Boundaries that you set with the second option.
* boundary rooms: - Boundary rooms are walls. Bigshot will not enter a Boundary room!

<PRE>X-X-B - A - 0 - 0 - 0
| |
X-X-X</PRE>

The proper syntax for boundary rooms are separated by commas
Some popular Rift boundaries as an example
<PRE>
Plane 1: 2635, 12101, 12208
Plane 2: 2605, 2635, 12093
Plane 3: 2635, 12089, 12152
Plane 4: 12122, 12207, 12235
Plane 5: 2579
North Scatter: 12151, 12254, 12256, 12249, 12247, 12241
South Scatter: 12151, 12219, 12217, 12233, 12237, 12239
</PRE>

For Maaghara boundaries, you can use
<PRE>
9734
</PRE>

Confluence boundaries:<pre>
2300, 3519, 228, 188, 1932, 10855, 3668, 1438, 1005
</pre>

Imagine a hunting area that is a six room square. To enter this square, one must GO DOORWAY from room A. You would set the room outside of the square - ie room A - before you GO DOORWAY, as a boundary. Then, you would set room B to the Starting Room. From there, Bigshot will move to room B and then wander around inside the Boundary - ie the square hunting area - until it your '''Should_rest?''' conditions are met.

* Wait before wandering to another room: - Time you wait before leaving a room to find some creatures. Default is 0.3 seconds. Set to 0 for fastest (spammy) movement.

* attack stance: - Specify what stance you want to attack from. Bigshot will remain in Stance Defensive until an attack command is issued, whereupon it will stance to your Attack Stance and execute your Attacking routine. Bigshot recognizes all stances from the game, Offensive ->-> Defensive.
* pre-hunt commands: - These commands will be executed before Bigshot uses Go2 to travel to your hunt's Starting Room. As an example: 'gird, stance defensive'. This will ensure that you have readied your weapon and are in Defensive stance before traveling. Set short lived combat spells like 1605 (Arm of the Arkati) to be cast in this line.
* active hunting scripts: - Active hunting scripts are scripts that will run while Bigshot is in Hunt mode. Many of these scripts have been made obsolete by the next option. Clever scripters have written some nice scripts that will keep certain spells up, execute cmans based on conditions etc. If you need a complex action to run while Hunting that Bigshot does not have the capacity for, an active hunting script may be called for.
* society abilities/spells/cmans: - Bigshot can be asked to keep certain abilities up at all times during a hunt. Hovering your mouse over this field will display a list of cmans and society abilities specified by their numerical designations. Spells may also be added here. Separate all values by commas. For example, entering '506' will keep the spell Haste up during Hunts, casting whenever it has worn off.
* loot script - Bigshot will call a loot script to loot your kills for you. eloot is commonly scripts used here. Be sure to use the SETUP command on whatever loot script you use, as if it is not configured properly, Bigshot will likely error.
* wracking spirit >= - Setting a value here will WRACK for mana if your spirit is greater than or equal to the value specified. Setting 6, for example, will WRACK down to 5 spirit. This will ONLY function if you have the 'Use sign of wracking/sigil of power' box checked.
* Use sign of wracking/sigil of power - checkbox to enable the use of wracking
* Priority hunt - checkbox to enable the use of the priority system for hunting. This allows you to change targets based on the order listed in valid targets/quickhunt targets. For example, your hunting thunder trolls, wind witches, and puma. Your valid target order is wind witch, thunder troll, puma. Your currently attacking a puma, when a thunder troll walks in. You will switch to the attacking the thunder troll because its before the puma in the valid targets list. After killing the thunder troll, you go back to the puma, only to have a wind witch walk into your room. You will again switch to the wind witch because its in front of the puma. Hope you get the idea. When using the ;bigshot quick option, it will base the order of targets by your quickhunt targets first, then the order of the targets in the room that don't match any of your quickhunt targets. Example, bandits are in your quickhunt targets. You type ;bigshot quick when you get ambushed in the room. Currently in the room is a large ogre and three bandits. The order of targets will be the bandits first, then the large ogre.
* Delay looting - delays looting of creatures in a room.
* Pull players to feet - attempt to pull players to their feet upon passing them in a room
* Stop for dead players - checkbox will pause bigshot if you encounter a dead player
* Sneaky Sneaky - sneak around while out in the hunting area

===Should hunt ===
Bigshot evaluates the conditions set on this tab to determine if you are ready to hunt or not.
* '''when percent mind <='''
** Setting this to 51 will rest until Cleared. Setting at 65 will wait until Muddled.
* '''and percent mana>='''
** Determines the percent total of your maximum mana that must be present before hunting
** Setting below 50 will result in quick, uneventful hunts if you cast much. Generally, this is set at 95 or higher.
* '''and CHECKspirit >='''
** Bigshot will check to see that your current Spirit value is higher than what is listed here.
** Make sure that you have this set high enough that Bigshot won't hunt immediately after DEPARTing if you have Depart / re-run Bigshot checked on the General tab.

==The Attacking Tab==
* Ambush aiming locations (head, etc): - Allows you to specify what order you aim for ambush. Default is head, right leg, left leg, chest.
* Archery aiming locations (head, etc): - Allows you to specify what order you aim for archery. Loops through your aiming locations once you hit the area your aiming at.
* flee if enemy count is > - Flees the room if the total number of enemies in the room exceeds the value. Set this to 1 if you want to engage single targets.
* ...but don't count these: - Bigshot will ignore monsters specified in this line when eveluating if it should flee based on how many monsters are in the room. Useful for when you are hunting in an area with extremely low level monsters mixed in with your targets.
* ...and always flee from: - Bigshot will always flee from the specified monster as soon as possible. Extremely useful if your hunting area has higher level and/or extremely dangerous monsters mixed in with your intented target(s).
* flee from environment message: - Will flee whenever anything you put in here gets sent from the game. (XML regex matching)
* Wait before wandering to another room: - time you spend before moving to a new room. Default is 0.3 seconds. You can set it to 0 to move instantly. Tends to be spammy for anyone in the same hunting area.
* Approach lone targets only - Forces Bigshot to only begin combats against creatures that are alone.
* Bless weapon? - Performs a Consecrate (1604), then a Cleric Bless or Voln Bless on whatever weapon loses its bless during hunting. If you can't bless your weapon while hunting will return you to your rest area and quit the script.
* Flee from boon - Enabling this check box will force Bigshot to flee from all boon/gifted/boss creatures (available in [https://github.com/elanthia-online/scripts/pull/449/commits/afade49e25dd6042c30b6d62fec4d65376667f80 v4.3.0])
* Activate weapon reactions - Will initiate reactive strikes when the opportunity presents itself
* Flee from clouds - Enabling this check box will force Bigshot to flee from Cloud spells such as 125(Call Lightning with its Ominous Cloud), 1704 (Stun Cloud) and 1713 (Death Cloud)
* Flee from vines - Enabling this check box will force Bigshot to flee from Vine spell such as 610(Tangle Weed)
* Flee from webs - Enabling this check box will force Bigshot to flee from webs.
* Flee from voids- Enabling this check box will force Bigshot to flee from voids.

==Commands Tab==
The true guts of Bigshot, this is where you specify your Attack Routine.
* hunting commands - These are the commands that Bigshot will evaluate (ie execute) when it is in the room with a valid target (one that you specified in your Hunting section. These commands are separated by a comma. Bigshot recognizes most hunting verbs and, failing that, will use an fput command (a direct entry method) and just execute the commands directly as written. The following are a list of usable hunting commands:
** kill - Attacks using the KILL verb.
** incant <spell number> - Casts the specified spell with the INCANT verb. This will automatically stance into offensive for bolt and other stance-sensitive spells. A caster may CHANNEL the spell using [[INCANT (verb)]] to INCANT SET CHANNEL <spell> (a standard GSIV verb, not part of Lich). Alternatively, a caster may CHANNEL spells by using the SET verb (a standard GSIV verb, not part of Lich) to SET ChannelIncant ON. This will CHANNEL an INCANTed spell if the caster is in a stance higher than neutral.
** channel <spell number> - Channels the specified spell at the target. This requires a stance higher than neutral to have any effect.
** <Spell Number> - Casts the specified spell with the PREPARE and CAST verbs.
** wand - As in, <CODE>wand target</CODE>. Gets a wand from the specified storage and WAVES it at the target.
** wandolier - Similiar to wand, but uses wandoliers. Gets a wand from the fresh wand container and waves it, rubs container if no wands found. Default waves in offensive. Can change via <CODE>wandolier defensive</CODE> to wave in a different stance
** fire - As in, <CODE>fire target</CODE>. Gets ammunition from the specified storage and FIREs it at the target. Will attempt to aim based on settings on hunting tab.
*** The above listed commands should be used with the (x#) syntax. For example, <CODE>kill target (x3)</CODE> will swing three times at the target before re-evaluating the attack routine. If the (xx) variable is used, Bigshot will continue using the specified attack command up to five (5) times. Example: <CODE>903 target (xx)</CODE> will continue to cast 903 at the target (5) times before restarting the attack routine or until it is dead. If you want to ensure the routine does not restart, using a sufficiently large number should suffice (e.g. x100). Bigshot may also be set to only execute a command based on how much mana or stamina you currently have. For mana, use the (m##) command. <CODE>920 target (m50)</CODE> will only cast 920 (Implosion) if you have 50 or more mana. Similarly, <CODE>cman feint target (s10)</CODE> will only execute the combat maneuver Feint on the target if you have 10 or more stamina. The command syntax is used as a separate call and wrapped in separate parenthesis, as in (m50 s20)(x2).
** aim <location> - Aims at the specified location.
** ambush - Uses the AMBUSH verb to attack. Will aim based on settings in Hunting tab. Also will aim dynamically, "Ambush head" would aim at the head, overwriting any settings or defaults for that attack.
** wait <time> - Bigshot may Stance Dance by using the WAIT command. Bigshot will go into and stay in Stance Defensive until the specified time is over OR the target swings / casts, whereupon it will evaluate the rest of the Attack Routine, changing into your specified attack stance.
** mstrike - As in, <CODE>mstrike target</CODE>. Mstrike depending on mstrike cooldown and stamina. Has its own option page. Can also be used with UAC, "mstrike punch".
** berserk - Executes the BERSERK verb and stands by until it fades.
** throw - Empties hands, Attempts throw, get the stuff you emptied.
** weed/kweed - Casts 610 at target. Using "kweed" as your command will force evoke 610 ensuring the damage version
** curse <curse> - Clumsy/Weakness/Darkness/Itch/Hex/Pox/Nightmare/Star - will prep 715 and use curse command as defined. Will skip "curse star" if buff is up.
** unarmed - Uses the Bigshot UAC routine. Routine will attack with appropriate attacks to rank up and use mstrike based on mstrike options page. Usage "unarmed (punch|jab|kick|grapple)".
** smite - Performs an [[Order of Voln]] [[Kai's_Smite|Smite]] on target until successful.
** leech - Performs a [[Mana Leech (516)]] on target if cooldown is under 15 minutes.
** script <script name> - Executes a specified custom attack script.
** hide - Continue hiding until you're actually hidden. Or it's tired of trying.
** sleep - As in, <CODE>sleep 10</CODE>. Pause bigshot. Useful with fried hunting commands such as: <CODE>410, sleep 15</CODE> will E-wave then wait 15 seconds and e-wave again if there are valid targets.
** stance - As in, <CODE>stance defense</CODE>. Change stances.
** nudgeweapons - Move all weapons on the ground to an adjacent room. Useful for casting Implosion (720).
** force <cmd> until <endroll> - As in, <CODE>force incant 1002 until 101</CODE>. Continue issuing a command until a desired endroll. Only works for normal looking swings/spells/cmans.
** eachtarget <cmd> - issues command to each valid target in room
** efury <fire|cold> - casts Earthern Fury (917) on the target and waits for DOT to end or 12secs to pass
** caststop <spell> - casts the spell and then immediately stops it after casting
** wield <noun> <left|right> - weilds new noun and stores the hand given to put new noun item in
** store - store left, right or both, but only if something is in those hands
** tether <recast> - casts 706 with built-in logic to wait, can also do recast to auto-recast 706 on creature death and DOTs transfer
** unravel <spell> - casts 1013 Song of Unravelling with an optional spell to target against creature
* hunting commands (b) - Attack routines set up for a monster flagged (b) in the Hunting section.
* hunting commands (c) - Attack routines set up for a monster flagged (c) in the Hunting section.
* hunting commands (d) - Attack routines set up for a monster flagged (d) in the Hunting section.
* hunting commands (e) - Attack routines set up for a monster flagged (e) in the Hunting section.
* hunting commands (f) - Attack routines set up for a monster flagged (f) in the Hunting section.
* hunting commands (g) - Attack routines set up for a monster flagged (g) in the Hunting section.
* hunting commands (h) - Attack routines set up for a monster flagged (h) in the Hunting section.
* hunting commands (i) - Attack routines set up for a monster flagged (i) in the Hunting section.
* hunting commands (j) - Attack routines set up for a monster flagged (j) in the Hunting section.
* fried hunting commands - Commands executed specifically when fried. Useful when hunting in a group.
* quick hunting commands - Commands executed specifically when using ;bigshot quick.
* valid targets: - These are the monsters you are hunting. Bigshot will most easily recognize monsters based on the NOUNs or their name. For example, 'a large ogre' can be targeted with just 'ogre'. Using longer descriptors can be troublesome, and you should copy a monster's name directly from the game front end to avoid troubles. You can use multiple entries separated by commas. For example: 'manticore, thrak' will kill manticores and thraks.
* quickhunt targets: - These are monsters you have designated attacks for when your using the ;bigshot quick option for hunting.

===PSM3 Integration===
* hunting commands - Bigshot now supports weapon/shield skills and warcries. Assaults will wait until they finish or are interuppted. These commands are separated by a comma. The following are a list of usable hunting commands:
** barrage, flurry, fury, gthrusts, pummel, thrash - Assaults will wait until attacks are completed/interrupted.
** fury - You can specify the default attack fury will use. Will jab if not specified: fury punch or fury kick
** charge, cripple, dizzyingswing, pindown, twinhammer - Setups will execute on cooldown so make sure to check for prone/stun/root/ect.
** clash, cyclone, pulverize, volley, wblade, whirlwind - AOE will execute on cooldown, limit with check volley(mob3).
** shout - Will perform warcry shout. Must use a command check or it will shout every loop: shout(!shout),shout(buff10 s25)
** yowlp - Will perform warcry yowlp. Must use a command check or it will yowlp every loop: yowlp(!yowlp), yowlp(buff10 s10)
** holler - Will perform warcry holler every loop taunting all the mobs. holler(s60)
** bellow, growl, cry - Offensive warcries can be used with target for single target or all for aoe.
** shield bash, shield charge, shield pin, shield push, shield strike, shield trample, shield throw
** surge - Will keep surge of strength up. surge or surge(surge) will cast even on cooldown, surge(!surge) will only cast when not on cooldown.
** bearhug, bullrush, coupdegrace, cpress, cutthroat, dirtkick, dislodge, divert, eviscerate, exsanguinate, eyepoke, feint, footstomp, garrote, gkick, hamstring, haymaker, headbutt, kifocus, kneebash, leapattack, mblow, mug, nosetweak, sattack, sblow, scleave, shroud, spunch, sthieve, subdue, sunder, sweep, swiftkick, tackle, templeshot, throatchop, trip, truestrike, vaultkick
** dislodge <location> - Dislodge from location specified: dislodge eye neck
** stomp - Will perform a stomp attack. Channels 909 if not active. Can also add 909 to society abilities to keep it active.
** dhurl - Hurl your weapon and recovers it. Works with weapon bonding auto return and the recover verb.
** assume <aspect> <aspect/evoke> - Will cycle between two aspects, or evoke a single aspect. Also works in society ability box. "650 <aspect> <aspect/evoke>"
** briar <weapon> - activate the AS buff on briar weapons. Tracks weapon charge and uses on cooldown.
** stance perfection - Put 10, 20, 30, ect in your attack stance box to take advantage of stance perfection.

You may need to '''SKILLS FULL/CMAN INFO/WEAPON INFO/SHIELD INFO''' if you've recently changed training or skills are being outright skipped.

===Additional Options===
*haste or 506 - Placing this in front of any command will cause you to cast 506 before doing that command. It only casts if it isn't currently up or has less than 3 seconds left on its timer.
<PRE>wait 10, haste kill (x3)</PRE>
*slayer or 240 - Placing this in front of any command will cause you to cast 240 before doing that command. It will not recast if it's already active.
<PRE>slayer 302 (x99)</PRE>

===Command Checks===

Commands need to use the following format:
<CODE>COMMAND (CHECKS)(REPETITIONS)</CODE>

So <CODE>hamstring (mob1 prone)(x2)</CODE> Any (x#) needs to be separate. Also (xx) is not unlimited and is just short for (x5).

Additional checks you can add to any command to customize the attack to your desired scenario.
Each check below can be used by itself or with any other check. Put them inside () with a space between each additional check. Example - Kill(m20 s5 e20)
<p>Each of these also has an inverse or opposite.
Just put a ! in front of the command. Example - Kill(!m20 !s5 !e20)
*s# - Checks that you have the required stamina
*m# - Checks that you have the required mana
*h# - Checks that you have the required health but based on a percentage instead of fixed number
*v# - Checks that you have the required spirit
*e# - Checks that your encumbrance percentage is at or below
*tier# - Checks for your current UAC tier (1,2,3). Performs command if UAC Tier is equal or greater.
*mob# - Checks for the number of npcs in room. Performs command if npcs in room is equal to or more than number specified. Only use for 2 or more creatures in the room
<PRE>To further clarify the mob# implimentation
1 mob, mob2, 1 IS less than 2, attack should not proceed.
2 mob, mob2, 2 IS NOT less than 2, attack can proceed
1 mob, !mob2, 1 IS NOT more than 2, attack can proceed
2 mob, !mob2, 2 IS NOT more than 2, attack can proceed
3 mob, !mob2, 3 IS more than 2, attack should not proceed</PRE>
*once - Performs the command once on a specified target, resets on room change
*room - Performs the command once in a room only, resets on room change
*prone - Checks to see if target is not sleeping|webbed|stunned|kneeling|sitting|lying down|prone|frozen|held in place. Performs command if target status is not one of the previous.
*frozen - Same usage as prone. Broke out of prone check for archers against non-corporeal creatures that deflect ranged. Corporeal creatures can be stunned and will break this check.
*undead - Checks to see if target is undead. Performed command if target is undead.
*flying - Checks to see if target is flying. Performed command if target is flying.
*rooted - Checks to see if the target is rooted. Performed command if target is rooted.
*hidden - Checks to see if you're currently hidden.
*poison - Checks to see if you're currently poisoned.
*disease - Checks to see if you're currently diseased.
*noncorporeal - Checks to see if NPC is [[noncorporeal|non-corporeal]] undead
*pcs - Checks to see if there are any PCS in room that are also not in your group
*outside - Checks to see if the room you are in is outside
*barrage - Checks for the Enhanced Dexterity buff from Barrage.
*fury - Checks for the Enhanced Constitution buff from Fury.
*flurry - Checks for the Slashing Strikes buff from Flurry.
*pummel - Checks for the Concussive Blows buff from Pummel.
*thrash - Checks for the Forceful Blows buff from Thrash.
*vigor - Checks for the Tangleweed Vigor buff from Tangleweed.
*reflex - Checks for the Arcane Reflex buff from Nature's Touch.
*tailwind - Checks for Tailwind buff from Breeze. (tailwind) (!tailwind)
*shout - Checks for the Empowered buff from Shout.
*yowlp - Checks for the Yertie's Yowlp buff from Yowlp.
*holler - Checks for the Horland's Holler buff from Holler.
*voidweaver - checks for the Voidweaver buff from Implosion(720)
*justice - Checks for charges of Swift Justice. (justice) do skill with charges (!justice) do skill with no charges
*buffXX - Fire ability when buff duration is <= XX. Supported for barrage,bearhug,fury,flurry,pummel,thrash,shout,yowlp
*tier# - Perform action if you are at the corresponding tier. (!tier3) don't do it if you are at tier3. (tier2) do it if you are tier2
*censer - Attempt to cast 320 before your command checking mana and cooldown. 309(censer), 335(censer mob3), attack(censer)
*ancient - Checks for grizzled/ancient creatures
*animate - Checks for if you have an animate present or not
**If command is a spell, will only cast censer if you have the mana for censer and the spell you intend.
**If command is not a spell, will only check you have enough mana for the censer.

===Example Attack Routines===
<PRE>wait 10, kill (x3)</PRE>

Waits 10 seconds for the monster to swing or cast and then immediately counter attacks from the specified attack stance set in the Hunting tab. Swings a total of three times before going into Defensive stance and waiting 10 seconds again.

<PRE>wait 15, incant 505, incant 903 (xx)</PRE>

Waits 15 seconds before INCANTing 505 (Hand of Tonis), hopefully knocking down or stunning the target. Following this, Bigshot casts 903 (minor water) repeatedly until the target is dead (up to 5 times).

<PRE>stance defensive and incant 1615, kill (x100)</PRE>

Casts 1615 (Divine Strike) at the target from Defensive stance, possibly forcing the target to kneel. Then, uses the kill verb to swing continuously until the target is dead or 100 times..whichever happens first.

<PRE>force feint until 101, kill (x2)</PRE>

Uses the Combat Maneuver FEINT against the target until a successful end roll and then hits the target twice before trying to FEINT again.

<PRE>stance defensive and hide, ambush left leg</PRE>

Hides from Defensive stance and then ambushes that the target's left leg. Once round-time is up, repeats (ie HIDES again from defensive stance).

<PRE>incant 720(m50), incant 708, incant 702 channel(xx)</PRE>

Casts 720 (Implosion) at the target if your character has 50 or more mana. Then, INCANTs 708 (Limb Disruption) at the target, using the default AIM location (if set). Finally, casts 702 (Mana Disruption) at the target up to (5) times or until it is dead.

<PRE>prep 708, cast at left leg / prep 708 channel at left leg, incant 719 (m50)(x1), incant 702 (xx)</PRE>

Prepares 708 (Limb Disruption) and CASTs it at the target's left leg. The second prepares the same spell and then CHANNELs it at the target's left leg. It will then cast 719 (Dark Catalyst) if there is at least 50 mana, and will only cast one time. The last will incant 702 until the creature is dead.

<PRE>wait 30, unarmed punch</PRE>

Waits 30 seconds or until your target attacks. Begins attacked with UAC combat using Punch to tier up.

<PRE>shield charge (s15 prone), ambush, mstrike</PRE>

Will shield charge the target if your character has 15 or more stamina and the target is NOT prone.

The second command will then ambush based on the settings in the "Attacking" Tab - in this case a custom order of head, neck, right leg, back was given so Bigshot will first try to Ambush the head unless the head is too injured or the head cannot be reached followed by the neck then right leg then back.

Bigshot will then focus mstrike the target unless the creature count is equal to or greater than the setting in the MSTRIKE Tab, in which case it will open mstrike instead. If you put "mstrike target", Bigshot will always focused mstrike regardless of the settings in the MSTRIKE Tab. Alternatively, you can set the "Unfocused MSTRIKE when creatures equal or greater" to a large number, to always focus your mstrikes (or set it to 1 to always open mstrike).

<PRE>bellow all, wblade(mob3), flurry(!flurry), attack</PRE>

Will aoe bellow, then whirling blade if there are at least 3 targets. The third command will flurry if you don't have the slashing strikes buff. Finally it will attack and continue to attack until one of the previous attacks become available.

<PRE>holler, shield throw(mob3), flurry, thrash, attack</PRE>

Will open up with a taunt from holler, then shield throw if there are at least 3 targets. Third command will flurry on cooldown. Fourth will thrash on cooldown. Finally we will attack if everything else ends up on cooldown or we run out of stamina.

<PRE>shroud(s35 !hidden mob2), divert (s25 hidden mob2), ambush(hidden), flurry, attack</PRE>

If there is more than one mob, it will hide with shroud and divert one of the targets. Third command will ambush if hidden. Fourth will flurry on cooldown followed up with attack to finish anything off.

<PRE>surge(!surge), bullrush, bearhug, pummel, attack</PRE>

Will cast surge when not on cooldown, and bullrush to bust up and apply vulnerable, then bearhug which is faster if target is vulnerable. Third we will pummel on cooldown and attack when nothing else is available.

<PRE>surge, shout(buff10), shield strike, pummel(buff60), attack(x2)</PRE>

Will keep surge active, casting during cooldown for 60 stamina. Next it will shout and refresh shout when there is less than 11 seconds left on the duration. Third it will shield strike followed up with a pummel once every minute. It will finish off with 2 attacks.

<PRE>pindown(mob4), volley(mob2), weed(!vigor !reflex), barrage(!barrage), incant 616 (m16 reflex), fire</PRE>

Will open up with pin down if there are at least 4 targets, then will volley if there are at least 2 targets. The third command will cast tangleweed if you do not have the tangleweed vigor buff or the arcane reflex buff. Our fourth command will barrage unless we have the enhanced dexterity buff from barage. Fifth we will cast a 1 second spike thorn if we do have 16 mana and do have the arcane reflex buff. Finally we will fire until one of our other commands become available.

===Hunting Target Examples===
All of the examples below will work for both the 'valid targets' and 'quickhunt targets' entries.
* A hunting option only using the default command (a) for each creature in an area:
<pre>crazed zombie, niirsha, sacristan spirit</pre>
* A hunting option using custom hunt commands depending on the creature. In this case it will use command (a) for a [[crazed zombie]] and a [[sacristan spirit]], while using (b) for a [[niirsha]]:
<pre>crazed zombie(a), niirsha(b), sacristan spirit(a)</pre>
* A hunting option that will include the [[:Category:Boss creatures|Boss Creatures]] variations as valid targets:
<pre>(?:adroit |afflicted |apt |barbed |belligerent |blurry |canny |combative |dazzling |deft |diseased |drab |dreary |ethereal |flashy |flexile |flickering |flinty |frenzied |ghastly |ghostly |gleaming |glittering |glorious |glowing |grotesque |hardy |illustrious |indistinct |keen |lanky |luminous |lustrous |muculent |nebulous |oozing |pestilent |radiant |raging |ready |resolute |robust |rune-covered |shadowy |shielded |shifting |shimmering |shining |sickly green |sinuous |slimy |sparkling |spindly |spiny |stalwart |steadfast |stout |tattooed |tenebrous |tough |twinkling |unflinching |unyielding |wavering |wispy )?crazed zombie, niirsha, sacristan spirit</pre>
* Some additional advanced options for identifying valid targets:
<pre>
(?:seasoned |grizzled |battle-scarred |weathered |veteran |hulking |haggard )?Grimswarm (?:giant|troll|orc) (?:dissembler|sorcerer|sorceress|warlock|witch)(a)
(?:seasoned |grizzled |battle-scarred |weathered |veteran |hulking |haggard )?Grimswarm (?:giant|troll|orc) (?:barbarian|blackguard|fighter|marauder|soldier|warrior)(b)
(?:seasoned |grizzled |battle-scarred |weathered |veteran |hulking |haggard )?Grimswarm (?:giant|troll|orc) (?:adept|archmage|elementalist|mage|warmage)(c)
(?:seasoned |grizzled |battle-scarred |weathered |veteran |hulking |haggard )?Grimswarm (?:giant|troll|orc) (?:hunter|huntmaster|huntmistress|ranger)(d)
(?:seasoned )?(?:dwarven|elven|halfling|erithian|human|giantman|half-krolvin|gnomish|half-elven) (?:thief|rogue|bandit|mugger|outlaw|highwayman|marauder|brigand|thug|robber)(e)
(?:shopkeeper|innkeeper|bartender|patrol leader|bandit lord|bandit lady|gypsy queen|gypsy king|guard captain|wall captain|drill sergeant|stable hostler|dungeon master|master torturer|butler|cook|
knight captain|foreign dignitary|royal prince|royal princess|royal jester|royal emperor|royal empress)(f)

To attack everything in the room (?:.*)</pre>

== Misc Tab==
Various specialized config options

===UAC Options===
The various options for configuring how UAC works:
* '''Tier 3 Attack'''
** The attack used when you have reached excellent in the UAC tier
** Options are jab, punch, grapple, or kick
* '''Aim at location (head, etc)'''
** Used for aimed UAC Combat, which requires ambush training to be effective
** Leave blank when you don't want to aim.
* '''MSTRIKE when creatures equal or greater'''
** Determines how many creatures must be present before using MSTRIKE
* '''Use Voln SMITE?'''
** Will perform a Voln SMITE on [[Non-corporeal]] undead

Frequently, people have trouble setting up Bigshot to work with Unarmed Combat. Bigshot only requires minimal configuration to ensure UAC works well.
#UAC tab: Input your '''Tier 3 Attack''' (jab, punch, grapple, or kick)
#Commands tab: Input your '''hunting commands(a)''' option as '''unarmed jab'''

Important notes to keep in mind on how UAC works in Bigshot:
* The hunting option '''unarmed jab''' can be replaced by any UAC attack type (e.g. '''unarmed punch''')
* UAC follow up strikes will be selected over the base or tier 3 attack
* Tier 3 attacks will be used only when positioning is excellent

There is almost no reason to ever use anything other than '''unarmed jab'' as the hunting command, and either '''grapple''' or '''kick''' as the Tier 3 attack.

===MSTRIKE Options===
MSTRIKE attack now has options for when it should be used.
* '''MSTRIKE during cooldown stamina requirement'''
** Allows you to specify how much stamina you want before it will MSTRIKE during the MSTRIKE Cooldown
** Be careful when setting this too low as it can pop your muscles
** Leave blank for it to use your max stamina.
* '''QUICKSTRIKE stamina requirement'''
** Like above but instead for using QUICKSTRIKE during the MSTRIKE routine.
* '''Unfocused MSTRIKE when creatures equal or greater'''
** Number of creatures in room before you do an unfocused mstrike. Default is 2.
* '''MSTRIKE during cooldown'''
**Toggle for MSTRIKEing during its cooldown period
* '''Use QUICKSTRIKE for MSTRIKE'''
** Toggle for using QUICKSTRIKE when you MSTRIKE

===Ammo/Wands===
Here you find the settings to tell Bigshot where you keep all of your nifty wands and bolts and arrows. If your attack routine involves FIRE or WAND verbs, these fields must be set lest Bigshot hang up.
* find ammo in this container: - Leave BLANK if having Bigshot use FIRE without getting ammo out (Archery 2020 Update). Rather self explanatory, this field holds the location of your ammunition storage, be it a wand harness, a quiver or just your backpack.
* use this ammo type: - Leave BLANK to have Bigshot use FIRE without getting any ammo (Archery 2020 Update). Again, like specifying monsters, Bigshot is most sensative about the NOUNs that you use here. If you
* fresh wand container: - Bigshot looks in this container to find fesh wands to WAVE.
* dead wand container: - ...And then will deposit the used up wands in this container.
* use this wand type: - Here you specify which particular wand type you want to use. Bigshot will then pull only these kinds for WAVEing. Can have multiple types listed. Seperate each one with a comma. Example: "aquamarine wand, bloodwood wand, etc"
* Hide while waiting to pick up ammo - Checking this box will have Bigshot hide when gathering up your spent arrows and bolts.
* Use wands when out of mana - Bigshot will pull whatever wand you have specified in the use this wand type field and automatically stance to your attacking stance and WAVE your wand at valid targets until you are out of wands OR hit your resting conditions.

===MA Grouping===
* Enter the name of the looter in Head/Tail configuration

==Monitoring Tab==
* Monitor interaction - Running scripts automates most functions and happens rather mechanically. Most anyone can tell if you are scripting just by watching you. Checking this box will pop up a window whenever Bigshot thinks that someone or something is trying to interact with you.
* Engage deadman's switch - Selecting this option will force Bigshot to quit Gemstone IV when your character is at less than 40% health, allowing you to log back on and assess the situation manually later.
* Depart/rerun if dead - Enabling this option will force a DEPART, causing your character to wake up in the Temple with low spirit. Following this, Bigshot will re-start, starting a fresh hunt. If you do not have a Check Spirit value set in your Should_hunt? tab, you will start hunting without recuperating lost stats.
* Quiet followers - Followers will wait until leader is done with both actions and resting scripts to begin using their own.

===Debugging:===
<pre{{log2}}>
+---------------------------------------------------------------------------+
| Bigshot Debug Help v5.8.5 |
+---------------------------------------------------------------------------+
| Debug options have changed to be more helpful. |
+--------------------------------------+------------------------------------+
| ;bigshot debug file | Toggles logging to a file <on/off> |
| ;bigshot debug all <true/false> | Toggles true/false all the things |
| ;bigshot debug check | Lists current debug settings |
| ;bigshot debug combat <true/false> | Combat and Creature Status |
| ;bigshot debug commands <true/false> | Attacking and Casting Commands |
| ;bigshot debug status <true/false> | Status Checks of your Character |
| ;bigshot debug system <true/false> | System processes |
| | |
| Options can be combined: |
| ;bigshot debug combat commands status <true/false> |
+---------------------------------------------------------------------------+
</pre>

==Ingame Screenshot==
<gallery perrow="4">
File:bigshot-1.PNG|Profiles
File:bigshot-2.PNG|Resting
File:bigshot-3.PNG|Hunting
File:bigshot-4.PNG|Attacking
File:bigshot-5.PNG|Commands
File:bigshot-6.PNG|Misc
File:bigshot-7.PNG|Monitoring
</gallery>

==Reference==
* Info originally taken from http://forum.gsplayers.com/showthread.php?t=57651

{{Third-Party Software}}
{{top}}

SimuCon 2025

2025-04-23T15:01:30Z

WHIGHTCNIGHT: /* Attendee List */ alphabetized prime players, linked known player wiki profile pages, and corrected spacing

'''SimuCon''' is a yearly gathering in St. Louis near [[Simutronics]] headquarters usually taking place near the end of the summer.

'''<u>OFFICIAL</u>''' dates for 2025 are Thursday, July 10 through Sunday, July 13, 2025 at the Sheraton Westport Plaza Hotel. Room reservation link Room reservation link [https://www.marriott.com/event-reservations/reservation-link.mi?id=1741039429417&key=GRP&app=resvlink here].

==2025 Schedule==
===Main Schedule===
All times CST (CENTRAL TIME)
{| class="wikitable"
!Day
!Time
!Activity
|-
|'''Wednesday<br />July 9th'''
| style="text-align: right" |00:00 PM
| Unknown
|-
|'''Thursday<br />July 10th'''
| style="text-align: right" |00:00 PM
| Unknown
|-
|'''Friday<br />July 11th'''
| style="text-align: right" |00:00 PM
| Unknown
|-
|'''Saturday<br />July 12th'''
| style="text-align: right" |00:00 PM
| Unknown
|-
|'''Sunday<br />July 13th'''
| style="text-align: right" |00:00 PM
| Unknown
|}

For the Live Alteration Sessions:<br>
- First come, first served! There are several sessions scheduled, and everyone is allowed to claim one alteration but they MUST make it to one of these sessions.

<nowiki>*</nowiki>This event requires a laptop or use of one of the workstations provided in the main conference room to access the game.

<nowiki>**</nowiki>D&D One Shots: You must pre-register for a session in the Box Office. It is strongly recommended to attend Session 0.

Event Color Coding:<br>
This event is in the main conference room.<br>
<span style="color:blue">This event is in Breakout 1.</span><br>
<span style="color:#BF40BF">This event is in Breakout 2.</span><br>
<span style="color:red">This event is in Breakout 3.</span>

===Streaming Schedule===
The following Gemstone IV panels will be streamed. All times CST (CENTRAL TIME)

Streaming link: TBD

{| class="wikitable"
!Day
!Time
!Panel
|-
|'''Friday, July 11th'''
|00:00 PM
|unknown
|-
|'''Friday, July 11th'''
|00:00 PM
|unknown
|-
|'''Saturday, July 12th'''
|00:00 PM
|unknown
|-
|'''Saturday, July 12th'''
|00:00 PM
|unknown
|}

==Attendee List==
===Prime Players===
<div style="column-count:4;-moz-column-count:4;-webkit-column-count:4">
* [[Altheren (prime)|Altheren]]
* Amerek
* [[Delindra (prime)|Delindra]]
* [[Dergoatean (prime)|Dergoatean]]
* Durakar
* [[Elgrim (prime)|Elgrim]]
* [[Fyg (prime)|Fyg]]
* Liras
* [[Maylan (prime)|Maylan]]
</div>

===Platinum Players===
<div style="column-count:4;-moz-column-count:4;-webkit-column-count:4">
* unknown
</div>

===Shattered Players===
<div style="column-count:4;-moz-column-count:4;-webkit-column-count:4">
* Drekoi
* Omrii
* Tysong
</div>

===Game Staff===
<div style="column-count:4;-moz-column-count:4;-webkit-column-count:4">
* Aergo
* Ivry
* Mestys
* Nyxus
* Thandiwe
* Valyrka
* Xeraphina
</div>

==Frequently Asked Questions==
===How much does SimuCon cost?===
Attendance badges have previously cost $40 when purchased in advance. Tickets are available at the door, but will be more expensive. Please see the [[#Ticketing|Ticketing]] section for more details.

=== Where do I sign up?===

Ticketing will likely be handled via the play.net Box Office when available. Please see the [[#Ticketing|Ticketing]] section for more details.

===Who organizes SimuCon?===

Typically GameMasters from Gemstone IV and DragonRealms are the official organizers. However, many players pitch in to plan unofficial events or to offer support. All work is strictly volunteer, so please be sure to thank your organizer team!

===What is it like to attend a SimuCon?===

SimuCon is a gathering of players and GameMasters for Simutronics games, including Gemstone IV and DragonRealms. The convention includes several events, as listed in the [[#2025 Schedule|2025 Schedule]], that are planned by both players and staff. In-between events, attendees typically gather at conference tables similar to a large LAN party to play. Board games and other activities are frequently available as well.

===How many people attend SimuCon and when do they show up?===

SimuCon has experienced a growth spurt over the past three years or so. A current rough estimate would be 100 attendees (GS and DR combined) over the course of the weekend. The main convention days are Thursday through Sunday, although several people arrive on Wednesday and stay through Monday. The convention room is typically setup by Wednesday evening.

===What equipment should I bring? ===

Bring your laptop/computer so that you can play Gemstone during the convention. Internet access and power strips are typically provided. '''Note:''' It is not recommended that you leave your equipment unattended in the conference room.

===Will I need a car?===

Many attendees never leave the hotel. However if you are planning to explore St. Louis, a car is recommended as public transportation options are slim. Lyft and Uber are both operational in St. Louis and are ideal for single trips. For any excursions listed in the schedule, carpool options may be available. A shuttle may be available to and from your hotel for airport travel, but don't forget to bring cash for a tip!

===Is SimuCon family friendly?===

In general, yes. Some attendees do bring children but activities in the convention room may be of limited interest to them. Note the [[#Attractions|Attractions]] section listed below for additional kid-friendly activities available in St. Louis. Please expect to encounter explicit language and consumption of alcoholic beverages, which will increase in the late night hours.

===What is the weather typically like?===

Missouri is nicknamed "Misery" for its hot and humid summers. For a current local forecast, click here: https://www.ksdk.com/weather

===Do I need to bring food or beverages?===

Depending on funds available, basic snacks will be provided. You are generally on your own for meals and can purchase food at the grocery or restaurant options listed in the [[#Dining.2FEating|Dining/Eating]] section. SimuCon is strictly BYOB. Alcohol can be purchased in most grocery stores and gas stations in Missouri.

===What should I wear?===

SimuCon is casual attire unless the schedule for a specific event indicates otherwise. Some events may encourage costumes or themed attire.

=== Is there a pool?===

YES, pack your bathing suit! The Sheraton Westport Plaza has an indoor pool, and their sister property the Sheraton Westport Chalet has an outdoor pool. The Chalet's outdoor pool is very close and is a popular day time destination for attendees. All facilities at both hotels are available to any guest staying at either hotel. There is even a poolside bar with snacks and beverages (open Friday through Sunday), and towel service is available. It is recommended that you pack sunscreen ahead of time, because the hotel and nearby shops do not stock any. It is also recommended that you bring pool noodles, because pool noodles are wicked cool.

==Visitor Information==
The convention is typically held in the St. Louis area, home of Simutronic's headquarters. While the host hotel may very, it is usually held at one of the many convention spaces at or near the Westport Plaza. For specific details on the official hotel, please see the below accommodations list. Also below are some nearby shops and other information for visitors. All distances calculated from the host hotel.

===Accommodations===
https://www.marriott.com/event-reservations/reservation-link.mi?id=1741039429417&key=GRP&app=resvlink

{| {{prettytable}} cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em 1em; background: #f9f9f9; border: 1px #aaa solid; border-collapse: collapse; "
|- bgcolor="lightblue"
!Name||Distance||Address|| Link
|-
|'''Sheraton Westport Plaza (Official Hotel)'''||onsite||900 Westport Plaza, St. Louis, MO 63146||[https://www.marriott.com/event-reservations/reservation-link.mi?id=1741039429417&key=GRP&app=resvlink Group Discount Booking Link]
|-
|Sheraton Westport Chalet||onsite||191 Westport Plaza, St. Louis, MO 63146||[https://www.marriott.com/en-us/hotels/stlsi-sheraton-westport-chalet-hotel-st-louis/ Booking Link]
|-
|Staybridge Suites||0.3 miles||25 Progress Pkwy, St. Louis, MO 63146||[https://www.ihg.com/staybridge/hotels/us/en/st-louis/stlsb/hoteldetail Booking Link]
|-
|Comfort Inn Suites||0.7 miles||12031 Lackland Rd., Saint Louis, MO, 63146||[https://www.choicehotels.com/missouri/saint-louis/comfort-inn-hotels/mo608/rates?checkInDate=2022-08-03&checkOutDate=2022-08-79 Booking Link]
|-
|Residence Inn St. Louis Westport||0.6 miles|| 11918 Westline Industrial Drive, St. Louis, MO 63146|| [https://www.marriott.com/hotels/travel/stlwr-residence-inn-st-louis-westport/ Booking Link]
|-
|Farfield Inn and Suites St. Louis Westport||0.6 miles||11918 Westline Industrial Drive, St. Louis, MO 63146||[https://www.marriott.com/hotels/travel/stlfw-fairfield-inn-and-suites-st-louis-westport/ Booking Link]
|-
|Courtyard by Marriott St. Louis Westport||0.7 miles||11888 Westline Industrial Drive, St. Louis, MO 63146||[https://www.marriott.com/hotels/travel/stlwp-courtyard-st-louis-westport-plaza/ Booking Link]
|}

===Dining/Eating===
{| {{prettytable}} cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em 1em; background: #f9f9f9; border: 1px #aaa solid; border-collapse: collapse; "
|- bgcolor="lightblue"
!Name||Type||Distance||Address||Link
|-
|Drunken Fish||Sushi||onsite||639 West Port Plaza, St. Louis, MO 63146 ||https://www.westportstl.com/tenant/drunken-fish/
|-
|Fuzzy's Taco Shop ||Baja Tacos||onsite||302 West Port Plaza, St. Louis, MO 63146|| https://www.westportstl.com/tenant/fuzzys-taco-shop/
|-
|Kobe Japanese Grill||Japanese/Hibachi||onsite||645 West Port Plaza, St. Louis, MO 63146||https://www.westportstl.com/tenant/kobe-steakhouse-of-japan/
|-
|Starbucks||Coffee|| onsite||111 West Port Plaza, St. Louis, MO 63146 ||https://www.westportstl.com/tenant/starbucks/
|-
|Trainwreck Saloon||American/Grill||onsite|| 314 West Port Plaza, St. Louis, MO 63146||https://www.westportstl.com/tenant/trainwreck-saloon/
|-
|Westport Social
|Bar/Games/Karaoke
|onsite
|910 West Port Plaza Dr. St. Louis, MO 63146
|https://www.westportstl.com/tenant/westport-social/
|-
|Jovick Brothers Deli
|Deli
|onsite
|318 West Port Plaza Dr. St. Louis, MO 63146
|https://www.westportstl.com/tenant/jovick-brothers-deli/
|-
|360 Westport
|Rooftop Bar & Lounge
|onsite
|111 West Port Plaza, Suite 1200 St. Louis, MO 63146
| https://www.westportstl.com/tenant/360-westport/
|-
|Soda Fountain Express
|Modern Diner
|onsite
| 147 West Port Plaza Dr St. Louis, MO 63146
|https://www.westportstl.com/tenant/soda-fountain-express/
|-
|O'Fallon Brewery||Beer/American Food||0.3 mi ||45 Progress Pkwy, Maryland Heights, MO 63043 ||http://www.ofallonbrewery.com/
|-
|Giola's Deli||Sandwiches||0.8 mi
| 11855 Adie Rd, Maryland Heights, MO 63043||https://www.gioiasdeli.com/
|}

===Off-Site Dining===
For attendees who want to explore St. Louis cuisine, local players recommend the following restaurants.

{| {{prettytable}} cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em 1em; background: #f9f9f9; border: 1px #aaa solid; border-collapse: collapse; "
|- bgcolor="lightblue"
!Name|| Type||Distance||Address||Link
|-
|DD Mau||Vietnamese / Bao||1.3 mi||11982 Dorsett Rd, Maryland Heights, MO 63043
|http://www.ddmaustl.com/
|-
|Gobble STOP Smokehouse|| BBQ Poultry||2.8 mi||1227 Castillon Arcade Plaza, Creve Coeur, MO 63141||http://gobblestopsmokehouse.net/
|-
| Nudo House STL||Ramen / Japanese
|3.0 mi||11423 Olive Blvd, St. Louis, MO 63141||http://nudohousestl.com/
|-
|Dave & Tony's||Premium Burgers||3.2 mi||12766 Olive Blvd, St. Louis, MO 63146||http://www.daveandtonys.com/
|-
|Taqueria Durango|| Mexican||3.5 mi|| 10238 Page Ave, Overland, MO||https://www.facebook.com/TaqueriaDurangoSaintLouis
|-
| Nick & Elena's Pizzeria||Pizza/Italian||5.4 mi||3007 Woodson Rd, Overland, MO 63114||https://www.facebook.com/NICKnELENAS/
|-
|Sugarfire Smokehouse||BBQ||6.0 mi||9200 Olive Blvd, St. Louis, MO 63132||https://sugarfiresmokehouse.com/locations/mo-olivette/

|-
|Salt + Smoke|| BBQ||9.0 mi||501 S Main St, St. Charles, MO 63301 || https://saltandsmokestl.com/
|-
|BEAST||BBQ||17.1 mi||4156 Manchester Ave, St. Louis, MO 63110||https://beastbbqstl.com/
|-
|Pappy's Smokehouse||BBQ||18.7 mi||3106 Olive St, St. Louis, MO 63103||https://www.pappyssmokehouse.com/
|-
|Bogart's||BBQ||20.8 mi||71627 S 9th St, St. Louis, MO 63104||https://www.bogartssmokehouse.com/
|-
|Broadway Oyster Bar||Cajun||23.7 mi||736 S Broadway, St. Louis, MO 63102||http://www.broadwayoysterbar.com/
|-
| Ted Drewes||Famous local frozen custard||21.6 mi||6726 Chippewa, St. Louis, MO 63109|| http://teddrewes.com/
|-
|Bombay Food Junkies||Vegan Options||5.2 mi||3580 Adie Rd, St Ann, MO 63074||https://www.bombayfoodjunkies.com/
|-
|Hi-Point Drive-In
|Burgers
|12 mi
|1033 McCausland Ave, St. Louis, MO 63117
|https://hipointedrivein.com/about/
|-
|Bar Louie
|Bar & Grill
|8.4 mi
|1650 Beale Street Suite 180, St. Charles, MO 63303
|https://www.barlouie.com/
|-
|Sauce on the Side
|Calzones
|9.2 mi
|7810 Forsyth Blvd., Clayton, MO 63105
|https://sauceontheside.com/
|-
|Blueberry Hill
|Landmark restaurant / Americana
|9.4 mi
|6504 Delmar Blvd, University City, MO 63130
|https://blueberryhill.com/
|-
|Fitz's
|Local root beer & burgers
|9.3 mi
|6605 Delmar Blvd, St. Louis, MO 63130
|https://fitzsrootbeer.com/
|}

===Shopping/Groceries===
{| {{prettytable}} cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em 1em; background: #f9f9f9; border: 1px #aaa solid; border-collapse: collapse; "
|- bgcolor="lightblue"
!Name||Distance||Address||Link
|-
|Target||5.9 mi||12275 St Charles Rock Rd, Bridgeton, MO 63044||[https://www.target.com/sl/bridgeton/12 website]
|-
|Costco||13.3 mi||200 Costco Way, St Peters, MO 63376||[https://www.costco.com/warehouse-locations/st-peters-saint-peters-mo-382.html website]
|-
|Schnucks Dorsett (Grocery Store) ||1.5 mi||2030 Dorsett Rd, Maryland Heights, MO 63043||[https://locations.schnucks.com/mo-maryland-heights-117 website]
|-
|Walgreens ||1.6 mi||12509 Dorsett Rd, Maryland Heights, MO 63043||[https://www.walgreens.com/locator/walgreens-12509+dorsett+rd-maryland+heights-mo-63043/id=9481 website]
|-
|BP Gas Station||0.3 mi||11988 Westline Industrial Dr, St. Louis, MO 63146||
|-
|ALDI||2.6 mi||11745 Olive Blvd, Creve Coeur, MO 63141||[https://www.aldi.us/ website]
|-
|Trader Joe's||[https://goo.gl/maps/3aV8WLBakaB2 2.4 mi]||11505 Olive Blvd, Creve Coeur, MO 63141||[https://locations.traderjoes.com/mo/creve-coeur/694/ website]
|-
|D&J Liquor||[https://goo.gl/maps/a6m73h9w4ynWnWqh8 1.5 mi]||1914 McKelvey Rd, Maryland Heights, MO 63043||
|}

===Attractions===

Most attractions are a 15-30 minute drive from the hotel. For tourism information, click here: https://explorestlouis.com/

{| {{prettytable}} cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em 1em; background: #f9f9f9; border: 1px #aaa solid; border-collapse: collapse; "
|- bgcolor="lightblue"
!Name||Description||Address||Link
|-
|The Gateway Arch||Oh look, it's the Arch||200 Washington Ave, St. Louis, MO 63102|| https://www.gatewayarch.com/
|-
|Busch Stadium ||Cardinals Baseball Stadium||700 Clark Ave, St. Louis, MO 63102||https://www.mlb.com/cardinals/ballpark
|-
|Forest Park||Large public park, home to several free attractions ||5595 Grand Dr, St. Louis, MO 63112||https://forestparkmap.org/
|-
|St. Louis Zoo||Free zoo, located inside Forest Park||Government Dr, St. Louis, MO 63110 ||https://www.stlzoo.org/
|-
|St. Louis Aquarium at Union Station||Opened Dec. 2019, the otters and spitting fish are worth the admission, skip the wheel||201 S 18th St, St. Louis, MO 63103||https://www.stlouisaquarium.com/
|-
|St. Louis Art Museum||Free art museum, located inside Forest Park||1 Fine Arts Dr, St. Louis, MO 63110||https://www.slam.org/
|-
|Creve Coeur Lake Park||[https://goo.gl/maps/7s9nUCbcyBM2 3.4 mi] from the hotel. Trails, kayak rentals, Go Ape||13725 Marine Ave, St. Louis, MO 63146||[https://www.stlouisco.com/Parks-and-Recreation/Park-Pages/Creve-Coeur website]
|-
|The Muny||Outdoor theater, located inside Forest Park||1 Theatre Dr, St. Louis, MO 63112||https://muny.org/
|-
|Missouri Botanical Gardens||Outdoor garden ||4344 Shaw Blvd, St. Louis, MO 63110 ||http://www.missouribotanicalgarden.org/
|-
|Anheuser-Busch St. Louis Brewery||Main brewery, offers tours||1200 Lynch St, St. Louis, MO 63118||https://www.budweisertours.com/locations/st-louis-missouri.html
|-
|City Museum||Architectural Anomaly/Interactive Art/Climbing Museum||750 N 16th St, St. Louis, MO 63103|| https://www.citymuseum.org/
|-
|Grants Farm||Free wildlife park with tram tours and free beer||10501 Gravois Rd, St. Louis, MO 63123||https://www.grantsfarm.com/home.html
|-
|The Butterfly House||Indoor butterfly pavilion ||15193 Olive Blvd, Chesterfield, MO 63017|| http://www.missouribotanicalgarden.org/visit/family-of-attractions/butterfly-house.aspx
|-
|Science Center||Kid-friendly interactive museum, includes IMAX and planetarium||5050 Oakland Ave, St. Louis, MO 63110||https://www.slsc.org/
|-
| Magic House ||Kid-friendly interactive museum, includes magic||516 S Kirkwood Rd, St. Louis, MO 63122||https://www.magichouse.org/
|-
|Fox Theatre||Historic theater, offers tours||527 NORTH GRAND BLVD., St. Louis, MO 63103||https://www.fabulousfox.com/visit/tours
|-
|St. Louis Neighborhoods||Shopping/Nightlife/Exploring|| Various||https://explorestlouis.com/things-to-do/neighborhoods/
|-
|Live Music Venues||St. Louis is known for its blues and jazz scene||Various ||https://explorestlouis.com/discover/st-louis-music-lovers/st-louis-live-music-venues/
|-
|Casinos||Gambling||Various||https://www.tripadvisor.com/Attractions-g44881-Activities-c53-Saint_Louis_Missouri.html
|-
|Cahokia Mounds||Ruins of the largest prehistoric civilization north of Mexico, 30 min drive from hotel||30 Ramey Street Collinsville, IL 62234|| https://cahokiamounds.org/
|-
|A Gathering Place||Massages within walking distance of convention center||12140 Lackland Rd, St. Louis, MO 63146 ||https://www.agatheringplace.com/
|}

==Ticketing==
Ticketing is handled through the play.net [https://www.play.net/gs4/quests/ Box Office] page. '''Be sure to click on the Details button in the Box Office to view the specifics of your selection.''' To attend, a badge is required and all attendees must display their badge at all times while in the official event rooms. Badges can be purchased at the door, but will be more expensive.

===Non-Attendee Options===
Not available yet.

===Attendee Ticket Options===
Not available yet.
==See Also==
*[https://discord.gg/ypGH9P4AsB Official Simutronics Discord Server]
*[https://elanthipedia.play.net/SimuCon DragonRealms Simucon Page] (DR's Wiki Page)

[[Category:SimuCon]]

Lich:Script Bigshot/Changelog

2025-04-08T13:35:46Z

WHIGHTCNIGHT: /* Change Log */ update changelog

{{3rd-party}}
== Change Log ==

<pre{{log2|background=none|border=none|margin-left=none|margin-right=none|font-size=93%}}>
v5.8.5 (2025-03-28)
- bugfix for follower resting commands use running a script
- add cooldown detection to cmd_spell and 140/919/211/215/219/1619/1650
v5.8.4 (2025-03-19)
- remove deprecated calls
v5.8.3 (2025-03-10)
- bugfix in run_script to use exact naming of script that was started
v5.8.2 (2025-02-26)
- bugfix in run_script needing EXACT match for Script.running? check. Script.start is not exact. Causing issues
- bugfix in command_check split_check
v5.8.1 (2025-02-26)
- add garrote command to buffXX command check validity for Enh. Agility buff
- add garrote command check for active buff check
- cleanup command check regex to simplify
v5.8.0 (2025-02-20)
- add custom fog option
- option to force resting if looting leaves a box in your hand
- enable pre-rest commands to call scripts eg. script go2 place
- bugfix in tether command
- add ancient & !ancient command checks for grizzled/ancient creatures
- add animate & !animate command checks for if you have an animate present or not
- change command_checks to lamdas for optimization
v5.7.10 (2025-02-18)
- add option for cmd_tether to recast upon death and transfer of dots
v5.7.9 (2025-02-15)
- fix stand() to not stand if casting 608 and kneeling with a crossbow in hand
v5.7.8 (2025-02-11)
- update $bigshot_status to utilize :ready instead of :hunting when clear to hunt
- update $bigshot_status to :hunting when arrived in do_hunt() and actually starts hunting
v5.7.7 (2025-02-10)
- bugfix in cmd_curse due to custom prep/curse logic
v5.7.6 (2025-02-08)
- bugfix where claims was including characters disk
v5.7.5 (2025-01-30)
- bugfix in resting method for fog_return
v5.7.4 (2025-01-22)
- adjust loop delay for efury and tether
v5.7.3 (2025-01-20)
- added command tether to have spell 706 wait until completion
- update to efury command
- fix for constant redefinition Ruby warnings
v5.7.2 (2025-01-15)
- added implosion(720) cooldown
- added check for voidwalker buff from 720
v5.7.1 (2025-01-13)
- added client input into debug file
v5.7.0 (2025-01-12)
- added debug logging to file
v5.6.11 (2025-01-02)
- added cmd_rapid for rapidfire/515 usage
- added rapid/!rapid command check for current rapidfire buff
- bugfix for room claim with disks if SET DESCRIPTION is off
v5.6.10 (2024-12-22)
- added optional stand-up stance selection
- bugfix for surge in cmd_surge and command_check
- bugfix for burst in command_check
v5.6.9 (2024-12-09)
- bugfix for group members in room claim
- bugfix for weapon reactions to be done in @HUNTING_STANCE
v5.6.8 (2024-12-06)
- additional regex for rooted debuff
- bugfix for leader waiting to regroup during rest cycle
v5.6.7 (2024-12-06)
- bugfix for follower not attacking
- add cmd_wandolier (using fresh wand container and wand name)
v5.6.6 (2024-12-02)
- typo in load_settings: 'maxstamina' should be maxstamina
v5.6.5 (2024-11-23)
- added test method, usage: ;bigshot test <method> <arg1> <arg2> etc.
- added ;bigshot list to display initialized values
- bugfix for out of mana default not an integer
- update to check_required_values
- update to load_settings
- bugfix to allow follower to sit when resting
- bugfix updating spin button settings
- $rest_reason wasn't being reset before next hunt
- bugfix in profile sorting
- bugfix for leader to wait for wounded follower
- bugfix unnecessary groupcheck in pre_hunt method
v5.6.4 (2024-11-18)
- bugfix for ready_to_hunt stamina check when set to 100
v5.6.3 (2024-11-14)
- bugfix for the command check when rooted
v5.6.2 (2024-11-13
- prevent UAC from trying to kick when rooted
v5.6.1 (2024-11-13)
- bugfix in bandit tracking
- bugfix in loot() method
- add msg in class BSAreaRooms if open boundary
v5.6.0 (2024-09-11)
- new room claim process inspired by ;overwatch and Lich::Claim
- additional targeting for bandits
- bugfix on confusion status to confused
v5.5.0 (2024-08-24)
- rework of debug messaging
- removed duplicate calls to methods
- once command update for force
- updated check_required_values for integer Use
- set defaults for integer settings
- support for worn items with wield command
v5.4.5 (2024-08-20)
- update spinButton to save properly when manually entered
v5.4.4 (2024-08-19)
- remove unused GUI elements
v5.4.3 (2024-08-19)
- updated wander wait to a spin button
- bugfix for missing id on lte_boost
- update OOM spin button to allow for negatives
- updated OOM check for negative values
v5.4.2 (2024-08-17)
- bugfix in cmd_spell to set Spell's @@after_stance to prevent forced stance dancing when hunting_stance is offensive
v5.4.1 (2024-08-14)
- room command check logic correction
v5.4.0 (2024-08-07)
- UI updates
- Notes section added on profiles tab
- percent_stamina added as a should_hunt? parameter
- wander stance added
v5.3.17 (2024-08-05)
- added 506/celerity check
- fix for hunt_monitor not working for followers
v5.3.16 (2024-08-04)
- fix for ROOM being missed in command_check regex
v5.3.15 (2024-07-25)
- add ROOM command check, Performs the command a single time only per room, clears on room change
v5.3.14 (2024-07-24)
- bugfix for reset_variables
v5.3.13 (2024-07-19)
- bugfix for head/tail random looting
- bugfix for smite tracking in a group
v5.3.12 (2024-07-13)
- update profile_current and save_profile_name when using CLI profile load/save
- bugfix ready_to_rest? should_rest lambda logic
v5.3.11 (2024-06-20)
- fix to break from cmd_assault command on cooldown if loop repeated
v5.3.10 (2024-06-15)
- added support for Seanette's Shout in Society/Abilities/Spells/Cmans section of the hunting tab
v5.3.9 (2024-05-29)
- add additional missing cmd_assault regex matching
v5.3.8 (2024-05-18)
- remove superfluous check for escorts, not needed since they are not valid targets
v5.3.7 (2024-05-01)
- fix for Char.prof/Char.level to Stats.prof/Stats.level
v5.3.6 (2024-04-28)
- add additional custom disk noun
v5.3.5 (2024-04-24)
- handle all the new custom disk nouns
v5.3.4 (2024-03-29)
- fix to add Tangle Weed (610) status of "entangled" to the PRONE regex
- fix for kweed command to use EVOKE instead of stancing
v5.3.3 (2024-03-15)
- fix for cmd_briar to use MEASURE instead of LOOK due to gamefeed issue with extended show descriptions
- fix for cmd_briar to support UCS worn gear and two weapon combat
v5.3.2 (2024-03-12)
- bugfix in check_required_values
v5.3.1 (2024-03-11)
- bugfix for UIDs in boundary rooms and new boundary return outside of hunting area feature
- added cmd_curse command for Sorcerer spell Curse 715
- added cmd_store command to store left, right or both, but only if something is in those hands
v5.3.0 (2023-11-29)
- added boundary return if character ends up outside hunting area
- added option to double cast on fog options when returning from the Rift
- added support for warcry holler buff
- fixed bug in stand method when command is an array
- fixed command to standardize to downcase
- fixed bug in head/tail looting where the leader wasn't waiting for the follower to loot
- removed $bigshot_briar in favor of Spell[9105]
- added toggle to check for favor before using voln symbol on hunting tab
- expanded need_to_loot method for 1108 kills
- added escape for temporal rift
- added eachtarget command that attacks each creature in the room eg. (eachtarget force incant 917 until 101 (once), incant 903 (x10))
- removed change log comments before 5.0.0 and updated wiki
v5.2.2 (2023-11-21)
- bugfix causing bs_wander to delay 0.5 seconds longer than needed
- added Roa'ter and Ooze escape check in bs_wander
v5.2.1 (2023-11-15)
- add new efury, caststop, and wield cmd
- redo unravel/barddispel cmd
v5.2.0 (2023-10-02)
- general adjustment to group hunting
- additions to group looting for exclude individuals as well as allowing for changing looter based on encumbrance
- changes to try and prevent leaving stray bandits
- update to prevent targeting 709 arms
- allows multiple rally rooms just separate with commas
- added multiple return room waypoints
- added support for ranger tracking. Usage ;bigshot <options> <creature> example: ;bigshot single giant rat
v5.1.10 (2023-09-28)
- bugfix for ;bigshot quick occassionally stopping when another character enters the room
- changed BIGSHOT_VERSION variable to pull version from title block
- bugfix for display output
v5.1.9 (2023-09-24)
- fix to debug variable being hard set at launch to false.
- add CLI debug option to toggle debug value between true/false.
v5.1.8 (2023-09-18)
- add acid & steam to incant 518 allowances in cmd_spell
v5.1.7 (2023-09-16)
- bugfix wracking not considering active COL signs
- added RT check for wand method
v5.1.6 (2023-09-12)
- bugfix for cmd_force when target has 115
v5.1.5 (2023-08-30)
- bugfix for calling escape_rooms for tail
v5.1.4 (2023-08-30)
- bugfix for Roa'ter and Ooze escape for head/tail
v5.1.3 (2023-08-26)
- add 335/Divine Wrath cooldown check in cmd_spell to not cast
- change cmd_spell to use Spell.force_incant for incanted spells instead of bs_put
v5.1.2 (2023-08-21)
- fix incorrect regex match for mighty blow
v5.1.1 (2023-08-14)
- fix missing regex match for censer command check
v5.1.0 (2023-08-07)
- add ooze_escape for getting out of Ooze, Innards in HW.
v5.0.0 (2023-7-19)
- move method spell_is_selfcast? inside Bigshot class
- corrected deadmans typo
- moved Setup class outside main Bigshot block
- renamed various methods to snake case
- removed changlog notes older than 4.17.0 and updated changelog on wiki
- bugfix for bearhug complete_regex and in the command check
- retry RT commands for warrior and rogue guild cmans
- added rooted to status check
- bugfix in check_target_vitals
- bugfix in cast_signs undefined method `=~' for false:FalseClass
v4.17.6 (2023-07-11)
- will perform one final loot call if OOM, bounty complete, dread, or fried before resting
- bugfix in cast signs for KS+Mental Acuity Monk
v4.17.5 (2023-07-05)
- Added support for MA hunting single loop
v4.17.4 (2023-06-29)
- Expanded UCS followup attack tracking to work with PSM attacks.
- Added UCS tier command checks tier3, !tier3, ect.
v4.17.3 (2023-06-24)
- Added support for sneaking while hunting.
v4.17.2 (2023-06-21)
- Added missing regex for fury completion.
v4.17.1 (2023-06-13)
- Reconfigure assume aspect
- Removed check that could cause nerves to get blown.
- Added cman ki focus
v4.17.0 (2023-06-04)
- Skip infomon.lic check if on newer Lich versions
v4.16.3 (2023-05-20)
- Update for groupcheck to strip XML from $grouplist
v4.16.2 (2023-05-19)
- Update for GROUP output display
v4.16.1 (2023-05-16)
- Add burst of swiftness
v4.16.0 (2023-04-06)
- Add bard command unravel to dispel and stop
- Add bard command barddispel to dispel single spell from target
- Add once command check to perform a command one time on a specific target only. Resets on room change.
- bugfix for barrange and using bolts
v4.15.6 (2023-04-04)
- Add cman sbash to cmans as was missing
v4.15.5 (2023-03-15)
- Rubocop cleanup
- replace script.vars with Script.current.vars
v4.15.4 (2023-03-13)
- add additional missing 709 arms to exclude for NPCs check
v4.15.3 (2023-03-02)
- bugfix for cmd_shields
v4.15.2 (2023-03-01)
- bugfix to allow cmd_weapons to work if using more than base Mnemonic
- bugfix to allow cmd_shields to work if using more than base Mnemonic
- bugfix to allow cmd_cmans to work if using more than base Mnemonic
- bugfix to allow cmd_bearhug to work if using more than base Mnemonic
- bugfix to allow cmd_rogue_cmans to work if using more than base Mnemonic
v4.15.1 (2023-02-18)
- initial bugfix(s) for Ruby 3.x compliance
- fix for exiting cmd_force if command check fails on cmd
v4.15.0 (2023-02-18)
- add tonis/1035 command
- bugfix to not try to pull dead people up
v4.14.8 (2023-02-11)
- moved bounty check to after looting to avoid excessive game feed
v4.14.7 (2023-02-09)
- added missing room claim check
v4.14.6 (2023-02-06)
- fix head/tail issues with claim
- cleaned up also here detection
- cleaned up cast_signs to not spam song status for bards
v4.14.5 (2023-02-03)
- regex fix for hunt monitor claim_room
- fix in bs_wander method for 'approach lone target only'
v4.14.4 (2023-02-02)
- fix second target aquisition to use valid_targets?
- fix odd issue that would cause you to loot existing corpses in specific scenarios.
v4.14.3 (2023-02-01)
- fixed bigshot quick group room claim
- fixed regex to prevent attacks from removing people from claim
v4.14.2 (2023-01-31)
- updates to room claim system ;e UserVars.show_claim = true/false to echo when room is claimed.
v4.14.1 (2023-01-28)
- bugfix for GTK display if old settings contained integer for certain fields
- bugfix to allow cmd_assault to work if using more than Mnemonic (ie fury punch)
- add new regex result for cmd_cmans for sattack
- remove spam/unspam as waitrt?/waitcastrt? updated in Lich5 to be faster by default
v4.14.0 (2023-01-25)
- add new slayer command for 240
- fix for wander_wait to use should_flee?
v4.13.18 (2023-01-24)
- introduced room claim system to prevent poaching.
v4.13.17 (2023-01-23)
- move wander_wait to prevent poaching
v4.13.16 (2023-01-21)
- added support to rest for debuffs: Wall of Thorn Poison, Confusion, Creeping Dread, and Crushing Dread
v4.13.15 (2023-01-12)
- Add 1650 cooldown check for cast_signs
v4.13.14 (2023-01-12)
- add bounty check while resting and in bounty mode
v4.13.13 (2022-12-03)
- add bounty check while resting and in bounty mode
v4.13.12 (2022-12-01)
- reset bounty_eval when bounty complete
v4.13.11
- bounty mode will only exit if bounty is complete or child present
v4.13.10 (2022-11-30)
- bug fix for comparison of bonded weapon return
v4.13.9 (2022-11-30)
- bug fix for extra kills not being in monsterbold
v4.13.8 (2022-11-18)
- convert directory lookups to File.join to prevent OS pathname issues
- bug fix for poaching on rally_point and starting room
- bug fix for cmd_assume
- fix for cmd_hide using bs_put instead of fput
- bug fix to create UserVars.op on first run
- remove message() override color and update calls to use yellow to retain previous coloring
v4.13.7 (2022-11-14)
- bugfix for overkill hunting
v4.13.6 (2022-11-10)
- rearranged command tab for clarity
- removed profile checkboxes for ebounty, not needed
- added bounty_eval to support bounty mode and ebounty completion
v4.13.5 (2022-11-7)
- bug fix for MA looter
v4.13.4 (2022-11-7)
- bug fix for split, buff, and other checks
v4.13.3 (2022-11-7)
- bug fix for censure command
v4.13.2 (2022-11-5)
- added support to designate a looter for head/tail operations: See Misc tab
- added check for ...wait issue on routines
- reorganized the commands a little more to help with troubleshooting
v4.13.1 (2022-11-03)
Typo fixes in cman regex
v4.13.0 (2022-11-03)
Added profile support to UI
***************************
Changed file save location
/scripts/bigshot_profiles to Lich5/data/GSIV/<charname>/bigshot_profiles.
Lich5/data/GSIV/Rinualdo/bigshot_profiles as an example.
Existing profiles will need to be resaved or migrated over.
***************************
Added standard Lich messaging functionality
Reorganized UI menu and locations
Code cleanup.
Support for future (RSN) ebounty script
Fix to allow 640 blocked attacks to work for wait_for_attack
Fix to only account for renewal mana if bard and have renewal costs
Support for uid's for hunting and resting
Fix for percent_mind to more accurately gauge current mind full status
v4.12.12 (2022-10-28)
Fix for waitcastrt? before commands unless command can be executed during castrt
Fix for quickhunt targets when given an attack routine
v4.12.11 (2022-09-18)
Fixed calls to kill hunting scripts started with args
v4.12.10 (2022-08-21)
Added tumbleweed to list of tangleweed nouns
v4.12.9 (2022-08-08)
Bugfix for 9625/burst of swiftness
v4.12.8 (2022-08-07)
Added support for Burst of Swiftness. 9625 in society box.
Added kneeling command check (k) (!k)
Will no longer attempt to stand when hidden and kneeling.
v4.12.7 (2022-07-27)
Added checkbox to opt out of mstrike on unarmed combat.
v4.12.6 (2022-07-24)
Gave frozen it's own command check
Expanded support for dislodge firing only on specific locations.
Commented out ammo gathering.
v4.12.5 (2022-07-21)
Fixed shield bash to work for both shield and cman skills.
1040 now has a checkbox to auto shout if you or group member could benefit.
Will no longer pull kneeling people to their feet.
Will no longer attempt to pull the dead to their feet.
v4.12.4 (2022-07-01)
Add command check for tailwind.
Fixed briar command with briar weapon in off hand of twc.
Fixed bigshot quick standing around waiting for mana.
v4.12.3 (2022-07-01)
Add check to deadman's switch to only work in Shattered.
v4.12.2 (2022-06-08)
Add checks for Divergence cooldown spells for hunting tab abilities/spells/cmans
Changed boon detection to look at gameobj-data.xml TYPE instead of hardcoded name adjective check
v4.12.1 (2022-06-01)
Add SSR to force results check
Add additional weed/kweed for Tangle Weed 610
Adjusted hunt logic to prevent fleeing when someone enters.
v4.12.0 (2022-05-24)
Update various GameObj.npcs to use GameObj.targets
Add familiar gate(930) as a fog option
Add cmd_leech to cast Mana Leech/516
Fix for spell cleave cman to not attempt if on cooldown
v4.11.4 (2022-05-20)
Fix for cmd_ambush to switch to attack if not hidden
Update flee_message tooltip to state uses XML feed not plain text
v4.11.3 (2022-05-01)
Fixed dhurl with the new aim messaging
Adjusted location of waitrt in command checks
Changed do_hunt() to use no_players() instead of no_players_hunt() to prevent poaching in first room of the hunt.
v4.11.2 (2022-04-29)
Added a waitrt? to cmd_spell routine.
v4.11.1 (2022-04-23)
Fixed bug with cast_signs() assuming bards are always singing.
Cleaned up RoaterEscape(), it will now open containers to look for dagger type weapon.
Roater's and Rift Crawlers are pretty much identical in this aspect. No changes needed to work for both.
Added waitrt? to command checks to prevent check from clearing while in rt from previous move.
v4.11.0 (2022-04-15)
Adjusted hide to specify number of attempts to try and hide if failing: hide 2
Added Swift Justice tracking command check: (justice) (!justice) to use skill when swift justice has charges or has no charges.
v4.10.1 (2022-04-04)
Update consecrate to not return from hunt if blessing a sanctified weapon
v4.10.0 (2022-04-02)
Fixed pummel buff check from crushing blows to concussive blows.
Added stomp command for Tremors.
v4.9.0 (2022-03-24)
Added support for briar weapons. Will check for buff and check status of weapons charge.
Added support for assume aspect. Will alternate between aspects or evoke for one aspect.
Added support for cman stance perfection. Put 10,20,30,ect in attack stance box.
Fixed dhurl command knowing weapon auto returned from bond.
v4.8.7 (2022-03-12)
Fixed mstrike cooldown and debuff checks.
Added Barkskin cooldown support. Add 605 to your society abilities box.
Added song renewal mana cost check to cast_signs()
Fix for animated slushes registering as animates
Added (censer) command check to attempt a 320 before the command.
Added hurl command. Will hurl and recover item.
Fix familiar check to not cause familiar to return
v4.8.6 (2022-03-10)
Fixed conflict with 1040 and warcry shout. Simply '1040' to use 1040 not shout 1040.
Fixed missing msg from bullrush and forced prone check for bullrush/twin weapon.
Update for disk detection of group members
v4.8.5 (2022-03-10)
Added attempt mana pulse on 130 fog option if not enough mana
v4.8.4 (2022-03-08)
Fixed 9605 in society box, integrated surge in hunting commands.
Added command switch to refresh buffs based on duration.
v4.8.3 (2022-03-08)
Fixed global variable call for standing
v4.8.2 (2022-03-08)
Added version check for Infomon due to new Effects/Cmans
v4.8.1 (2022-03-08)
Added version check for Lich due to new Effects/Cmans
v4.8.0 (2022-03-07)
Integrated weapon/shield/cman skills and warcries.
barrage(!barrage) will only barrage if you don't have the buff
bellow all, will aoe bellow vs bellow target, will single target bellow
v4.7.7 (2022-03-02)
Add option to Stop for Deaders on Hunting tab
When enabled, bigshot will PAUSE when it encounters a dead player
v4.7.6 (2022-03-02)
Updated Fog options to include Sigil of Escape
v4.7.5 (2022-02-02)
Updated needs bless logic to to remove false positives (most cases)
v4.7.4 (2022-01-29)
Updated target logic to ignore sorcerer animates.
Updated loot subroutine to flag looting active - prevent BS from forcing stand
v4.7.3 (2022-01-25)
Updated bless routines to current text and provide option to continue hunt.
Disabled default startup sound value. Uncomment print "\a" unless $bigshot_quick if function is desired.
v4.7.2 (2021-12-14)
Updated GTK version detection for proper display in dark-mode
v4.7.1 (2021-12-12)
Adding bigshot single run mode accessed via ;bigshot single
v4.7.0 (2021-08-11)
-Updated group and event namespace to prevent future conflicts
-Consolidated Changelog and updated it on the GS wiki
v4.6.0 (2021-08-06)
-Separated bigshot_monitor to only run while hunting (to resolve lag in very active rooms)
-Added initial automatic weapon reactions
v4.5.0 (2021-06-25)
-Add fog only if encumbered or injured checkbox
v4.4.0 (2021-06-25)
-Add flee from voids option to general tab
v4.3.4 (2021-05-29)
-Updated UAC mstrike to always use tier3 for auto-tiering
v4.3.3 (2021-05-12)
-Revise GTK3 check to be more compatible with older versions of GTK that don't support Gtk::Version calls
v4.3.2 (2021-05-02)
-Updated Etheral Censer to be used in signs based on the cooldown refreshes
v4.3.1 (2021-04-30)
-Added regex for stance changing when using STANCE VERBOSE
v4.3.0 (2021-04-13)
-Add flee from boon/boss/glamour mobs checkbox on attacking tab
v4.2.4 (2021-03-02)
-Fix cast roundtime regex match for chan
v4.2.3 (2021-02-10)
-Fixes cman's to be usable with the force until option.
v4.2.2 (2021-01-19)
-Fix for certain values getting set when opening GUI, overwriting own settings
v4.2.1 (2021-01-12)
-Fixed stand() def to not stand if xbow kneel/fire
-Update buffer check for SMR result txt
v4.2.0 (2021-01-03)
-Removed 1617 from forced stance change
-Added customizable interaction monitoring panel
v4.1.1 (2020-12-31)
-Added cleanup from selfcast check in bigshot PR #374
-Included v3.93 updates
-Added loot room option when no loot script is defined
-Migrated v3 changelog to gswiki
-Updated Version Control
v4.1 (2020-12-31)
-Added GTK2/GTK3 dual logic for compatability
v4.0 (2020-08-13)
-Fix for ambush (Head/Neck/Eyes), no longer get stuck ambushing a head/neck over and over
-Archery Updates
Change aim location based on target actual status
BUGFIX:Aiming should now actually function as intended when switching targets
--TODO!Crossbows should now work with Bigshot, see pre-fire commands for details
-Group logic changes
Followers can now stay in the resting area and wait to run scripts/commands until leader is done
To do this, have the leader disband before running their scripts. With quiet followers selected
Followers attempt to not execute scripts/actions until the leader is in the rest area with them (regardless of disband)
Quiet Followers can be toggled off (not recommended)
Followers will now wait to cast signs until hunt is about to begin
Leader will no longer begin hunt until all followers are present and ready to go
--TODO!Leader will wait at rallypoint for entire group to arrive before moving to hunt starting room
If this feature is selected, the leader will not wait to hunt when at hunt starting room after rallypoint check
BUGFIX:Fix for fatal recursion cause by obvious hiding players
--TODO!Group should move more intelligently when seeking leader if group is broken
BUGFIX:Group will now be more responsive to commands
-Major UCS updates
BUGFIX:Will now use Tier 3 attack when tiered up to 3 and no follow up available for everything, not just jab
BUGFIX:Updates to UCS Mstrike, should no longer do open mstrikes when at or below threshhold instead of targetted mstrike
UCS mstrike threshold merged with MStrike tab threshold
--Still to be done: Per creature tier ups
-Bigshot now has the ability to turn some individual checks on and off
Functionality allows for custom hunting scripts to be built using Bigshot logic
Added ability to send custom "fput" to Group
Added ability to send custom "client_put" to Group
v3.92 (2020-07-08)
-Added LTE support for followers, overkill support for followers, & fried hunting commands for followers
v3.91 (2020-06-16)
-Added longterm boost usage option
v3.90 (2020-05-19)
-Minor fix to add a delay to 130/sym of return/1020 return option case in RT
v3.89 (2020-03-28)
-Crude fix for archery update, BLANK out your ammo & ammo container setting to NOT attempt to get ammo any longer
v3.88 (2020-03-28)
-Fixed a bug with obvious_hiding_player detection (Probably, at least)
-Fixed a bug with poaching when other players are present
-Cleaned out changelog history after updating wiki
-Re-organized global variables and requires statements (alphabetized)
-Added a sleep between resting_commands and hunting_prep_commands to prevent issues
-Replaced all pause commands with sleep
-Updated all sleep commands to follow proper syntax
v3.87 (2020-19-11)
-Added overkill counter for extra killed monsters
-Tooltip updates
-Formatting changes to make script more easily read
v3.86 (2020-03-11)
-Added outside & !outside command checks
v3.85 (2020-02-28)
-Resolved `block in setup` error when running setup in Fedora
v3.84 (2020-02-15)
-Fix a bug with "obvious hiding" players detection
v3.83 (2020-02-13)
-Added check for "obvious hiding" players (SET ObviousHiding ON)
v3.82 (2020-02-02)
-Added a v & !v command checks for checking spirit
-Possible fix for FOG_RETURN not loading when doing ;bigshot setup properly
-Added ;bigshot profile support
;bigshot profile load <name here, no spaces>
;bigshot profile save <name here, no spaces>
Allows saving of bigshot profiles as YAML files, saved in your LICH\scripts\bigshot_profiles folder
v3.81 (2019-09-06)
-Fix for wands with extra descriptors in hand vs grab name
-Add 1020 as an option for fleeing
v3.80 (2019-08-01)
-Exit cleanly from bounty mode
-Don't count regenerating troll kings when deciding if there's enough enemies to flee
-Treat intense shimmering circles like clouds when deciding to flee
-Don't require Gtk if $bigshot_headless is defined
v3.79 (2019-05-25)
-Removed 309 from hardcoded selfcast list
v3.78 (2019-05-10)
-Missed a few settings for flying
v3.77 (2019-05-10)
-Added flying/!flying as command checks for attacks
v3.76 (2018-07-04)
-Fixed INCANT command to respect Spell.stance setting
v3.75 (2018-07-02)
-Fix ;bigshot bounty
-Don't flee from your own group even if they're not hunting
v3.74 (2018-04-30)
-Added water as option for cmd_spell extra variable
v3.73 (2018-04-22)
-Add flee from webs option
-Add 917 to not stance offensive if using incant
v3.72 (2017-10-10)
-Fix bug in berserk
v3.71 (2017-10-08)
-Attack line now recognizes "wand" by itself
-Fix GameObjAdd autostart
v3.70 (2017-09-28)
-Fix download loop of GameObjAdd.lic
v3.69 (2016-09-20)
-Wont stance offensive for the spell 703 anymore
-Fixes for delayed looting
-option to pull players to there feet, Defaults to on
-Only pulls the player to there feet if their is an aggressive npc in the room with them
v3.68 (2016-09-14)
-option to stance defensive before looting if not all the creatures in room are dead
-wracking option now will use "Symbol of Mana" for voln peoples :)
-Performs the bless routine if needed when you wander or go to rest now
-Added a delayed looting option
-skips looting when creature still alive in the room or its been less than 15 seconds since the last creature died
-Will now try to escape from the inside of a roa'ter if you get swallowed
v3.67 (2016-08-31)
-Optimization for priority checks, wont run that section of code so often anymore.
-Manual aiming for unarmed combat routine. Command is "unarmed <punch/kick/grapple/jab> <aim location>"
-Will swap to the default aiming when you can't reach what your aiming at or its already missing.
v3.66 (2016-08-29)
-Only checks for group members if there are other pcs in the room
-Won't loot in the Duskruin Arena anymore
v3.65 (2016-08-28)
-Fixes for targeting, fleeing, and priority targeting
-This should let bigshot work in the duskruin arena
v3.64 (2016-08-23)
-Changed Celerity option to only recast if you have less than 3 seconds left
-Changed so it doesn't change into your attacking stance before casting
-Changed Fog return option to be an option pulldown instead of a checkbox, defaults to None
v3.63 (2016-08-23)
-Added option to use Celerity (506) for any command.
-Will cast if you dont have it on you or you have less than 6 seconds or so left on haste.
-Just add haste or 506 to the front of any command you want it to be cast before.
-example: "506 kill target" or "haste kill target(x3),525(pcs)"
v3.62 (2016-08-23)
-UAC Mstrike no longer will ignore the number of creatures in the room in some instances.
-Option to flee the room when player-defined message from the game happen
-Check the Attacking tab for box to input your text
-Fixed issue with bigshot not targeting "do not count these" targets
-Fixed issue with force command until # not working correctly
v3.61 (2016-08-15)
-Fix for new fogging option triggering at weird times.
v3.60 (2016-08-15)
-Fix for ;bigshot quick not working correctly when you dont have any quickhunt targets.
-Option to use Spirit Guide (130) or Voln Symbol of Return when going to rest. Option is on Rest Tab.
v3.59 (2016-08-13)
-To prevent me having to duplicate code, Bigshot will now download GameObjAdd.lic and make it autostart
-Spells should no longer target npcs when they are meant to target you. Let me know if something happens otherwise.
v3.58 (2016-08-07)
-companions and familiars should now be excluded from fleeing and targeting stuff
-companions and familiars count for poaching checks now just like a disk does
-this check only works for solo hunters, group bigshot hunters will ignore this
-Ambushers that are part of your group should no longer trigger the poaching routine
-Bigshot will on first run for a Ranger with a companion set your companion to a variable.
-You can reset this variable with ;bigshot ranger or ;bigshot companion
v3.57 (2016-08-04)
-Bigshot won't consider arms(709) and demons(725) as room creatures for targeting or fleeing purposes
-Priority should now ignore some NPCs when it does its calculations
v3.56 (2016-08-02)
-Think I have all the Reim mobs handled
-Fix for Multi-account hunting...oops
-other minor tweaks
v3.55 (2016-07-31)
-Target tracking for Aura of the Arkati (1614). Wont cast again on something that is affected.
-More Reim creatures added, Still missing creatures from the gypsy camp probably, celestial types
-New Command check: noncorporeal - Will see if current creature is non-corporeal undead
-New Command check: pcs - Will check for other non-grouped players in the room
v3.54 (2016-07-30)
-REIM! Quick update for some support for reim creatures
-Smite tracks individual mobs now, So if you switch creatures before killing it, will smite the new one
-Fixed the lag issue
v3.53 (2016-07-29)
-Incant should now work for any incant combination
-Bless can now bless two weapons that lose bless in same attack
v3.52 (2016-07-27)
-Changed variable tracking to be downstream hook instead of exec script
-Please let me know if anything doesn't work like it did in the previous versions
-Tracking added for Corrupt Essence (703), will no longer repeatedly cast and waste that precious mana
-You can also cast it open as "incant 703 open"
-Added flee from vines option to first tab of ;bigshot setup
v3.51 (2016-07-25)
-Special coding for 1700. Wont stance offensive for "incant 1700", Will stance offensive for "incant 1700 evoke"
-Fix for ;Bigshot quick not working when your quickhunt targets was empty
v3.50 (2016-07-24)
-Untargetable and Targetable lists now use the name instead of noun. Option to clear these so they can start fresh using ;bigshot reset. This will fix the issue for being unable to target guards in warcamps.
-Targetable and Untargetable are now listed in ;bigshot display
-Fix for Head/Tail Routine. Head wasn't waiting for the tail members to join bigshot group.
v3.49 (2016-07-24)
-Updated berserk to use Spell.cast functionality, should now use STOP BERSERK when no alive mobs in the room.
-Command check added for poison and disease
-Fixed some options that were out of place, oops
-Tail should now use scripts when performing pre-hunt commands
-Head should wait for tails to be out of RT before heading to rest now
-Incant should no longer fry your nerves when you dont have enough mana.
-Changed incant to use wands when you dont have enough mana.
-Also checks your target before incanting, so you always target the correct creature
-Changed wand routine to be able to use multiple wand types, "use this wand type" now takes comma seperated wands "use this wand type" example: "aquamarine wand, bloodwood wand, etc"
-Changed incant, spell and wand routines to return to attack stance option instead of stance defensive.
-Fixed bug with bless routine, maybe
-Option to use Voln SMITE in UAC routine now, instead of always doing it.
v3.48 (2016-07-20)
-Added Consecrate(1604) to bless routine
-Quickhunt targets code update and fixes
-Made bless work with identical weapons
v3.47 (2016-07-19)
-fix for blessing weapons
v3.46 (2016-07-19)
-now tries to pull someone to their feet when they are lying down/kneeling/etc.
-Rewrote the bless option to bless anything that runs out of a bless.
-Now located on Attacking Tab as a checkbox
-Returns you to your resting area if you can't bless things.
-Added a priority targeting option to hunting tab.
-Will switch target based on the order of your valid targets, whenever its attacking.
-Added Quickhunt targets, These always are first in terms of priority (Quickhunt targets, room targets)
-You can use the (a)|(b)|(etc) in here instead of just the Quickhunt routine every time.
v3.45 (2016-07-09)
-better code for checking for an escort, less error prone now (:
-fixed rare issue with ambusher jumping out of hiding just as go to move and it screwing up bigshot
-UAC Bless option changed so that you can leave it blank and it wont stop hunting. Has tooltip explaining different options.
v3.44 (2016-07-01)
-Fix for the fix for the fix!!
-Added a check for spell 608 to skip if already hidden
-Added hidden and !hidden a command check, hidden only works when your hiding, !hidden when your not hiding
v3.43 (2016-07-01)
-Fix for the Fix :(
v3.42 (2016-06-30)
-Fix for mob command check due to recent change
-Optimized the escort npc check
v3.41 (2016-06-30)
-Fixed Head/Tail bigshot hunting
V3.40 (2016-06-30)
-Mstrike will now cast 1107 and 1607 when appropriate
-Quick Hunting mode tweaked so that it works when your in a group, or in a room that isn't mapped
-added inverse command checks, put a ! in front of the command check, i.e kill(!h60)
-Doesn't count escorts anymore for NPC checks
V3.39 (2016-06-26)
-Quick Hunting mode added - Just start bigshot with the variable quick - ;bigshot quick
-Quick Mode overrides your currently setup targets and targets the current room npcs
-Wandering, Fleeing and Resting is disabled
-Bigshot exits when no NPCS found in room
-Uses Quick Hunting Commands
-Supports up to 10 (A-J) different attack routines now.
-Moved all the attack routines to new tab, Commands
-Moved few options to the attacking tab
v3.38 (2016-06-25)
-added command check for target not being prone or target being undead
-current checks are mana/stamina/health(percentage)/encumbrance/unarmed tiering/mobs in room/target not prone/target undead
-m/s/h/e/tier/mob/prone/undead respectively
-Prone means target is sleeping|webbed|stunned|kneeling|sitting|lying down|prone|frozen|held in place
v3.37 (2016-06-24)
-can now have two or more checks for a command. i.e kill(mob3 s20 h80) 3 mobs in room, stamina is above 20, health is above 80%
-must all be inside the () and seperated with a space
-current checks are mana/stamina/health(percentage)/encumbrance/unarmed tiering/mobs in room
-m/s/h/e/tier/mob respectively
v3.36 (2016-06-23)
-Added option for adjusting wander time between rooms (Found on Hunting Map Tab)
v3.35 (2016-06-14)
-Added option for attacks to only trigger when certain number of creatures are in the room.
-Just add (mob#) to the attack you want to do
-Fixes for unarmed combat getting stalled
-Now attempts to soothe (1205) when appropriate
v3.34 (2016-06-08)
-Added aiming for archery to the Hunting tab in setup.
-Will change location once you stick the place your aiming at, looping until the creature is dead
-Made gathering ammo a bit more specific about what its grabbing and where its putting it.
-Also works with bolts and darts now if you gathered things to the ground.
v3.33 (2016-06-06)
-Fix for creatures leaving room and script getting stuck (Hopefully)
-Fix for loot script activating during roundtime
-Fix for issue with targeting using creatures name or noun
v3.32 (2016-06-02)
-Changed aiming for UAC to continue until if finds something you can hit or just hits them like normal
-Added Voln Smite to command, use Smite in your hunting commands
-Rewrote Ambush again! Now has the option to pick locations you want to ambush at on the hunting page
-Also supports it from the hunting command i.e. "ambush head"
-If left blank without picking any options in setup will default to Head, Right Leg, Left Leg, Chest
v3.31 (2016-06-02)
-Changed up the ambush command so it ambushes what you said to ambush first, then attempts right leg, left leg, then chest
-Added an option to trigger the mstrike during UAC combat, other MSTRIKE options apply
-Few fixes to MSTRIKE routine, now checks number of creatures in room as an equal or greater
-Fixed bug caused when doing commands like "stance for and kill target"

Edits by Hazado: (2016-06-01)
V3.3 (2016-06-01)
-Added UAC combat! Start it with hunting command "unarmed punch/jab/kick/grapple"
-Added options for UAC in setup
-Added options for MSTRIKEing in setup
-Rewrote MSTRIKE routine
-can now check mana/stamina/health(percentage)/encumbrance/unarmed tiering inside the hunting commands
-Changed wander routine to hit every room in area instead of random wandering

Edits by Zhiart: (2016-03-25)
-Added new ambush command for legging a critter and then go for the head as long as they are prone (Code by SashaFierce)

v3.2 (2/27/2016)
-Added changes to fix incant loot issues (might work)
-Added ability to detect renaming of bigshot without destroying exec scripts
-Converted exec scripts to strings to allow =>quiet

Edits by Kalros: (2015-11-2015)
v3.1
-Fixed Disk poaching.
-Fixed First room poaching.
-Removed group poaching logic.
-Ambush detection via Exec Script. It will leave the room if it detects an ambush line.
-Rewrote and updated wander targeting sections. Fixes some target related bugs.
-Moved WAIT command to exec to prevent line buffer issues and make more responsive

3.0 (2015-05-30):
stop trying to attack monsters that aren't in the room (wild guess, untested)
bumped version up from 2.12052012 to 3.0, because 2.12052012 is a stupid version format
added message to trust script
</pre>

Lich:Script Bigshot

2025-04-08T13:34:17Z

WHIGHTCNIGHT: /* Commands Tab */ add unravel cmd

{{3rd-party}}
Bigshot is designed to handle combat routines, including moving to and from hunting areas, defining creatures to hunt and accompanying attack routines
Afk scripting on any server but Shattered is in violation of game policy.
{{TOCright| limit=2}}
==Changelog==
*[[Script Bigshot/Changelog|Script Bigshot Changelog]]
==About Bigshot==
===What Does Bigshot Do?===

Using a series of menus and commands inputs, Bigshot lets a user create a modular, customizable and fully automated hunting script. With just a few clicks and tweaks, you can go from scripting Rats to the Rift.

===How Do I Get It?===

Grab it from the Repository: ;repository download Bigshot

===How Do I Make it GO!?===
Initial setup is accessed through ;bigshot setup. There you will see a configuration window with various tabs to setup for your hunting routine.

As with most scripts, using a SETUP command will open a graphical user interface for configuring the script. Use ;bigshot setup to open this dialog. This will open a window with the following tabs:
* Profile - This is where you save/load your profile information. Profiles are saved to your \Lich5\data\<GSServer\<charname>\bigshot_profiles directory. Eg, \Lich5\data\GSIV\Rinualdo\bigshot_profiles (note, if you've previously used bigshot, the file location has changed. The previous location was in your \Lich5\scripts\bigshot_profiles folder. You can copy/paste
* Resting - Set up your resting routine and location.
* Hunting - Create a hunting map by adding BOUNDARIES, define your attack stance and any pre hunt information
* Attacking - configuration for ambushing, bless, reactions, and similar flags
* Commands - Where you define your valid targets and associated attack routines. See sample routines below.
* Misc tab - Various config options

We will take a closer look at each of these individually further on.

There is also several other commands you can do for more functionality.
* ;bigshot quick - Special hunting mode that kills everything in the room your in and quits bigshot. Wont wander at all, and wont attempt to rest. Has its own hunting commands and hunting targets.
* ;bigshot head/tail - This is for Multi-Account hunting. It only works for a single computer. Every character needs to be setup for the hunting area your going to. You start it by having your following characters join your head character. The following characters need to be running bigshot with ;bigshot tail. Once that happens, have the leader of the group do ;Bigshot head. They will then procede to hunt in the area you have setup.
* ;bigshot display - Shows all your current settings.
* ;bigshot reset - Resets all your targetable and untargetable lists. Useful if you find bigshot won't targets something it should.
* ;bigshot ranger or ;bigshot companion - Resets ranger companion setting so you can set it again. Used when you change your companion.
* ;bigshot profile save <name here> - Saves a profile in YAML format in your character's profile folder. Also accessible via the Profiles tab in the setup menu.
* ;bigshot profile load <name here> - Loads a profile from your character's profile folder. Also accessible via the Profiles tab in the setup menu.
* ;bigshot single - When used solo, will execute a single hunting routine, return to your resting location and then exit
* ;bigshot <options> <creature> - example: ;bigshot single giant rat - Will activate ranger tracking of a creature. Anything input besides the above commands will default to "track <input>".

==The Profile Tab==
* Load Profile - will load an existing profile. Nothing will be available if no previous profiles are saved
* Current Profile - shows the existing profile if a new one is loaded.
* Save profile - Valid profile information for future ebounty script support
Save Current Settings - tell Bigshot what you want your profile to be named. Any name will work here. Once a profile is saved, will show up in the Load Profile menu.

==The Resting Tab==
Short and sweet, here is where we setup our resting routines. During REST mode, Bigshot uses the EXP command and checks your mind, hit points, wound status, mana and spirit. Once all of these values are at the specified Should_hunt? settings, Bigshot leaves REST mode and begins a HUNT.

* room id: - This is the room that Bigshot will return to for resting. Use Room Numbers from Map/Go2. Support both LichIDs and SimuIDs with a u, for example, 228 for Town Square Central or u7120.
* pre-rest commands: - These commands run before entering REST mode. An example routine is: 'shea, wear shield, sit, stance offensive, rest'. This will sheath your weapon, wear your shield, sit, enter offensives stance and use the REST verb.
* active resting scripts: - Active resting scripts are scripts that will be run upon entering REST mode. These scripts should be things that you do after a hunt: get healed, empty your bags, spell up. An example list is: 'eloot sell, waggle, eherbs'. This will use eloot to sell according to the options set with eloot. After selling, it will use Waggle to spell you up according to however Waggle is setup. Finally, eherbs will check your PACK and use herbs stored there to heal whatever wounds you have.
* Fog Option: - Uses [[Spirit Guide (130)]], Voln [[Symbol of Return]], [[Traveler's Song (1020)]], [[Sigil of Escape]], [[Familiar Gate (930)]] or Custom when heading back to rest. Setting it to None does nothing. Setting it to 130 will cause it to use 130 first then if that fails symbol of return. Symbol of return will use that first, then 130 if that fails. Setting to Traveler's Song will attempt once and continue. Setting to Familiar Gate will attempt to summon a portal once and walk through it. Will perform a mana pulse if not enough mana is detected. Custom option allows for comma separated list of commands to perform.
* Should Rest?
Bigshot evaluates these conditions and, when they are met, will go to your resting room set on the Resting tab and execute any resting scripts you have set.
* '''when percent mind >='''
** Rests when your mind has reached this threshold. Generally, set this to 100 to rest when fried.
* '''and extra kills >='''
** The number of extra monsters to kill after reaching your `when percent mind` threshold and after LTE boosts used
* '''and used lte boosts >='''
** The number of LTE boosts it will attempt to use after reaching your `when percent mind` threshold
* '''or percentmana <='''
** Forces Bigshot to rest when your percentage of mana is at or below this threshold.
** This can be set to 0, but leaving a bit in the tank can be good if you have to use 406 (Unlock) to open the WL Graveyard gate. 11/17/24: If you run into an error that calls to an "OOM" message, try setting this to 1.
* '''or percentencumbrance >='''
** Forces Bigshot to rest when you have reached a given level of encumbrance.
* '''or wounded eval'''
** Allows you to set an evaluation phrase to determine if you are too wounded to continue hunting. Wound evaluations can send you home on nearly any wounded condition of your choice: bleeding, level 2 wound, can't cast, too many scars etc.

The following is a wounded evaluation that will rest whenever you have any level II wounds:
<PRE>XMLData.injuries.any?{|key,value| value["wound"] > 1} || percenthealth <= 70</PRE>
The following is a wound evaluation that will take you home if you can not cast anymore (nerves, level 2 head/eyes, bad scars etc.):
<PRE>bleeding? || percenthealth <= 25 || [Wounds.head, Scars.head, Wounds.leftEye, Scars.leftEye, Wounds.rightEye, Scars.rightEye, Wounds.nsys, Scars.nsys].max > 1 || [Wounds.leftArm, Wounds.leftHand, Wounds.rightArm, Wounds.rightHand, Scars.leftArm, Scars.leftHand, Scars.rightArm, Scars.rightHand].max > 2 || ([Wounds.leftArm, Wounds.leftHand, Scars.leftArm, Scars.leftHand].max > 0 && [Wounds.rightArm, Wounds.rightHand, Scars.leftArm, Scars.leftHand].max > 0)</PRE>
The following can be added to one of the above wound evaluations to also rest upon having popped muscles:
<PRE>|| Effects::Debuffs.active?("Overexerted")</PRE>

* '''when creeping dread >='''
** Forces Bigshot to rest when your creeping dread is at or below this threshold.
* '''when crushing dread >='''
** Forces Bigshot to rest when your crushing dread is at or below this threshold.
* '''Wall of Thorns Poison'''
** Forces Bigshot to rest when you are affected by Wall of Thorns Poison.
* '''Confusion Debuff'''
** Forces Bigshot to rest when you are affected by the non-dispellable Confusion Debuff.

==The Hunting Tab==
This is where you will tell bigshot when to hunt, any commands or society abilities to use prior to hunting, and where on the map you want to hunt.
===The Hunting Map===
Your hunting map is a series of Boundaries - rooms that Bigshot will not enter - and a Start room - the first room that Bigshot moves to when a hunt starts. These function very similarly to the boundaries in the ;Wander script, but are stored in Bigshot's configuration files and not in a character cache as with ;Wander. Here you also configure when to hunt
* starting room ID: - This is the first room that Bigshot goes to when hunting. You may set this to any room within the Boundaries that you set with the second option.
* boundary rooms: - Boundary rooms are walls. Bigshot will not enter a Boundary room!

<PRE>X-X-B - A - 0 - 0 - 0
| |
X-X-X</PRE>

The proper syntax for boundry rooms are separated by commas
Some popular Rift boundries as an example
<PRE>
Plane 1: 2635, 12101, 12208
Plane 2: 2605, 2635, 12093
Plane 3: 2635, 12089, 12152
Plane 4: 12122, 12207, 12235
Plane 5: 2579
North Scatter: 12151, 12254, 12256, 12249, 12247, 12241
South Scatter: 12151, 12219, 12217, 12233, 12237, 12239
</PRE>

For Maaghara boundries, you can use
<PRE>
9734
</PRE>

Imagine a hunting area that is a six room square. To enter this square, one must GO DOORWAY from room A. You would set the room outside of the square - ie room A - before you GO DOORWAY, as a boundary. Then, you would set room B to the Starting Room. From there, Bigshot will move to room B and then wander around inside the Boundary - ie the square hunting area - until it your '''Should_rest?''' conditions are met.

* Wait before wandering to another room: - Time you wait before leaving a room to find some creatures. Default is 0.3 seconds. Set to 0 for fastest (spammy) movement.

* attack stance: - Specify what stance you want to attack from. Bigshot will remain in Stance Defensive until an attack command is issued, whereupon it will stance to your Attack Stance and execute your Attacking routine. Bigshot recognizes all stances from the game, Offensive ->-> Defensive.
* pre-hunt commands: - These commands will be executed before Bigshot uses Go2 to travel to your hunt's Starting Room. As an example: 'gird, stance defensive'. This will ensure that you have readied your weapon and are in Defensive stance before traveling. Set short lived combat spells like 1605 (Arm of the Arkati) to be cast in this line.
* active hunting scripts: - Active hunting scripts are scripts that will run while Bigshot is in Hunt mode. Many of these scripts have been made obsolete by the next option. Clever scripters have written some nice scripts that will keep certain spells up, execute cmans based on conditions etc. If you need a complex action to run while Hunting that Bigshot does not have the capacity for, an active hunting script may be called for.
* society abilities/spells/cmans: - Bigshot can be asked to keep certain abilities up at all times during a hunt. Hovering your mouse over this field will display a list of cmans and society abilities specified by their numerical designations. Spells may also be added here. Separate all values by commas. For example, entering '506' will keep the spell Haste up during Hunts, casting whenever it has worn off.
* loot script - Bigshot will call a loot script to loot your kills for you. eloot is commonly scripts used here. Be sure to use the SETUP command on whatever loot script you use, as if it is not configured properly, Bigshot will likely error.
* wracking spirit >= - Setting a value here will WRACK for mana if your spirit is greater than or equal to the value specified. Setting 6, for example, will WRACK down to 5 spirit. This will ONLY function if you have the 'Use sign of wracking/sigil of power' box checked.
* Use sign of wracking/sigil of power - checkbox to enable the use of wracking
* Priority hunt - checkbox to enable the use of the priority system for hunting. This allows you to change targets based on the order listed in valid targets/quickhunt targets. For example, your hunting thunder trolls, wind witches, and puma. Your valid target order is wind witch, thunder troll, puma. Your currently attacking a puma, when a thunder troll walks in. You will switch to the attacking the thunder troll because its before the puma in the valid targets list. After killing the thunder troll, you go back to the puma, only to have a wind witch walk into your room. You will again switch to the wind witch because its in front of the puma. Hope you get the idea. When using the ;bigshot quick option, it will base the order of targets by your quickhunt targets first, then the order of the targets in the room that don't match any of your quickhunt targets. Example, bandits are in your quickhunt targets. You type ;bigshot quick when you get ambushed in the room. Currently in the room is a large ogre and three bandits. The order of targets will be the bandits first, then the large ogre.
* Delay looting - delays looting of creatures in a room.
* Pull players to feet - attempt to pull players to their feet upon passing them in a room
* Stop for dead players - checkbox will pause bigshot if you encounter a dead player
* Sneaky Sneaky - sneak around while out in the hunting area

===Should hunt ===
Bigshot evaluates the conditions set on this tab to determine if you are ready to hunt or not.
* '''when percent mind <='''
** Setting this to 51 will rest until Cleared. Setting at 65 will wait until Muddled.
* '''and percent mana>='''
** Determines the percent total of your maximum mana that must be present before hunting
** Setting below 50 will result in quick, uneventful hunts if you cast much. Generally, this is set at 95 or higher.
* '''and CHECKspirit >='''
** Bigshot will check to see that your current Spirit value is higher than what is listed here.
** Make sure that you have this set high enough that Bigshot won't hunt immediately after DEPARTing if you have Depart / re-run Bigshot checked on the General tab.

==The Attacking Tab==
* Ambush aiming locations (head, etc): - Allows you to specify what order you aim for ambush. Default is head, right leg, left leg, chest.
* Archery aiming locations (head, etc): - Allows you to specify what order you aim for archery. Loops through your aiming locations once you hit the area your aiming at.
* flee if enemy count is > - Flees the room if the total number of enemies in the room exceeds the value. Set this to 1 if you want to engage single targets.
* ...but don't count these: - Bigshot will ignore monsters specified in this line when eveluating if it should flee based on how many monsters are in the room. Useful for when you are hunting in an area with extremely low level monsters mixed in with your targets.
* ...and always flee from: - Bigshot will always flee from the specified monster as soon as possible. Extremely useful if your hunting area has higher level and/or extremely dangerous monsters mixed in with your intented target(s).
* flee from environment message: - Will flee whenever anything you put in here gets sent from the game. (XML regex matching)
* Wait before wandering to another room: - time you spend before moving to a new room. Default is 0.3 seconds. You can set it to 0 to move instantly. Tends to be spammy for anyone in the same hunting area.
* Approach lone targets only - Forces Bigshot to only begin combats against creatures that are alone.
* Bless weapon? - Performs a Consecrate (1604), then a Cleric Bless or Voln Bless on whatever weapon loses its bless during hunting. If you can't bless your weapon while hunting will return you to your rest area and quit the script.
* Flee from boon - Enabling this check box will force Bigshot to flee from all boon/gifted/boss creatures (available in [https://github.com/elanthia-online/scripts/pull/449/commits/afade49e25dd6042c30b6d62fec4d65376667f80 v4.3.0])
* Activate weapon reactions - Will initiate reactive strikes when the opportunity presents itself
* Flee from clouds - Enabling this check box will force Bigshot to flee from Cloud spells such as 125(Call Lightning with its Ominous Cloud), 1704 (Stun Cloud) and 1713 (Death Cloud)
* Flee from vines - Enabling this check box will force Bigshot to flee from Vine spell such as 610(Tangle Weed)
* Flee from webs - Enabling this check box will force Bigshot to flee from webs.
* Flee from voids- Enabling this check box will force Bigshot to flee from voids.

==Commands Tab==
The true guts of Bigshot, this is where you specify your Attack Routine.
* hunting commands - These are the commands that Bigshot will evaluate (ie execute) when it is in the room with a valid target (one that you specified in your Hunting section. These commands are separated by a comma. Bigshot recognizes most hunting verbs and, failing that, will use an fput command (a direct entry method) and just execute the commands directly as written. The following are a list of usable hunting commands:
** kill - Attacks using the KILL verb.
** incant <spell number> - Casts the specified spell with the INCANT verb. This will automatically stance into offensive for bolt and other stance-sensitive spells. A caster may CHANNEL the spell using [[INCANT (verb)]] to INCANT SET CHANNEL <spell> (a standard GSIV verb, not part of Lich). Alternatively, a caster may CHANNEL spells by using the SET verb (a standard GSIV verb, not part of Lich) to SET ChannelIncant ON. This will CHANNEL an INCANTed spell if the caster is in a stance higher than neutral.
** channel <spell number> - Channels the specified spell at the target. This requires a stance higher than neutral to have any effect.
** <Spell Number> - Casts the specified spell with the PREPARE and CAST verbs.
** wand - As in, <CODE>wand target</CODE>. Gets a wand from the specified storage and WAVES it at the target.
** wandolier - Similiar to wand, but uses wandoliers. Gets a wand from the fresh wand container and waves it, rubs container if no wands found. Default waves in offensive. Can change via <CODE>wandolier defensive</CODE> to wave in a different stance
** fire - As in, <CODE>fire target</CODE>. Gets ammunition from the specified storage and FIREs it at the target. Will attempt to aim based on settings on hunting tab.
*** The above listed commands should be used with the (x#) syntax. For example, <CODE>kill target (x3)</CODE> will swing three times at the target before re-evaluating the attack routine. If the (xx) variable is used, Bigshot will continue using the specified attack command up to five (5) times. Example: <CODE>903 target (xx)</CODE> will continue to cast 903 at the target (5) times before restarting the attack routine or until it is dead. If you want to ensure the routine does not restart, using a sufficiently large number should suffice (e.g. x100). Bigshot may also be set to only execute a command based on how much mana or stamina you currently have. For mana, use the (m##) command. <CODE>920 target (m50)</CODE> will only cast 920 (Implosion) if you have 50 or more mana. Similarly, <CODE>cman feint target (s10)</CODE> will only execute the combat maneuver Feint on the target if you have 10 or more stamina. The command syntax is used as a separate call and wrapped in separate parenthesis, as in (m50 s20)(x2).
** aim <location> - Aims at the specified location.
** ambush - Uses the AMBUSH verb to attack. Will aim based on settings in Hunting tab. Also will aim dynamically, "Ambush head" would aim at the head, overwriting any settings or defaults for that attack.
** wait <time> - Bigshot may Stance Dance by using the WAIT command. Bigshot will go into and stay in Stance Defensive until the specified time is over OR the target swings / casts, whereupon it will evaluate the rest of the Attack Routine, changing into your specified attack stance.
** mstrike - As in, <CODE>mstrike target</CODE>. Mstrike depending on mstrike cooldown and stamina. Has its own option page. Can also be used with UAC, "mstrike punch".
** berserk - Executes the BERSERK verb and stands by until it fades.
** throw - Empties hands, Attempts throw, get the stuff you emptied.
** weed/kweed - Casts 610 at target. Using "kweed" as your command will force evoke 610 ensuring the damage version
** curse <curse> - Clumsy/Weakness/Darkness/Itch/Hex/Pox/Nightmare/Star - will prep 715 and use curse command as defined. Will skip "curse star" if buff is up.
** unarmed - Uses the Bigshot UAC routine. Routine will attack with appropriate attacks to rank up and use mstrike based on mstrike options page. Usage "unarmed (punch|jab|kick|grapple)".
** smite - Performs an [[Order of Voln]] [[Kai's_Smite|Smite]] on target until successful.
** leech - Performs a [[Mana Leech (516)]] on target if cooldown is under 15 minutes.
** script <script name> - Executes a specified custom attack script.
** hide - Continue hiding until you're actually hidden. Or it's tired of trying.
** sleep - As in, <CODE>sleep 10</CODE>. Pause bigshot. Useful with fried hunting commands such as: <CODE>410, sleep 15</CODE> will E-wave then wait 15 seconds and e-wave again if there are valid targets.
** stance - As in, <CODE>stance defense</CODE>. Change stances.
** nudgeweapons - Move all weapons on the ground to an adjacent room. Useful for casting Implosion (720).
** force <cmd> until <endroll> - As in, <CODE>force incant 1002 until 101</CODE>. Continue issuing a command until a desired endroll. Only works for normal looking swings/spells/cmans.
** eachtarget <cmd> - issues command to each valid target in room
** efury <fire|cold> - casts Earthern Fury (917) on the target and waits for DOT to end or 12secs to pass
** caststop <spell> - casts the spell and then immediately stops it after casting
** wield <noun> <left|right> - weilds new noun and stores the hand given to put new noun item in
** store - store left, right or both, but only if something is in those hands
** tether <recast> - casts 706 with built-in logic to wait, can also do recast to auto-recast 706 on creature death and DOTs transfer
** unravel <spell> - casts 1013 Song of Unravelling with an optional spell to target against creature
* hunting commands (b) - Attack routines set up for a monster flagged (b) in the Hunting section.
* hunting commands (c) - Attack routines set up for a monster flagged (c) in the Hunting section.
* hunting commands (d) - Attack routines set up for a monster flagged (d) in the Hunting section.
* hunting commands (e) - Attack routines set up for a monster flagged (e) in the Hunting section.
* hunting commands (f) - Attack routines set up for a monster flagged (f) in the Hunting section.
* hunting commands (g) - Attack routines set up for a monster flagged (g) in the Hunting section.
* hunting commands (h) - Attack routines set up for a monster flagged (h) in the Hunting section.
* hunting commands (i) - Attack routines set up for a monster flagged (i) in the Hunting section.
* hunting commands (j) - Attack routines set up for a monster flagged (j) in the Hunting section.
* fried hunting commands - Commands executed specifically when fried. Useful when hunting in a group.
* quick hunting commands - Commands executed specifically when using ;bigshot quick.
* valid targets: - These are the monsters you are hunting. Bigshot will most easily recognize monsters based on the NOUNs or their name. For example, 'a large ogre' can be targeted with just 'ogre'. Using longer descriptors can be troublesome, and you should copy a monster's name directly from the game front end to avoid troubles. You can use multiple entries separated by commas. For example: 'manticore, thrak' will kill manticores and thraks.
* quickhunt targets: - These are monsters you have designated attacks for when your using the ;bigshot quick option for hunting.

===PSM3 Integration===
* hunting commands - Bigshot now supports weapon/shield skills and warcries. Assaults will wait until they finish or are interuppted. These commands are separated by a comma. The following are a list of usable hunting commands:
** barrage, flurry, fury, gthrusts, pummel, thrash - Assaults will wait until attacks are completed/interrupted.
** fury - You can specify the default attack fury will use. Will jab if not specified: fury punch or fury kick
** charge, cripple, dizzyingswing, pindown, twinhammer - Setups will execute on cooldown so make sure to check for prone/stun/root/ect.
** clash, cyclone, pulverize, volley, wblade, whirlwind - AOE will execute on cooldown, limit with check volley(mob3).
** shout - Will perform warcry shout. Must use a command check or it will shout every loop: shout(!shout),shout(buff10 s25)
** yowlp - Will perform warcry yowlp. Must use a command check or it will yowlp every loop: yowlp(!yowlp), yowlp(buff10 s10)
** holler - Will perform warcry holler every loop taunting all the mobs. holler(s60)
** bellow, growl, cry - Offensive warcries can be used with target for single target or all for aoe.
** shield bash, shield charge, shield pin, shield push, shield strike, shield trample, shield throw
** surge - Will keep surge of strength up. surge or surge(surge) will cast even on cooldown, surge(!surge) will only cast when not on cooldown.
** bearhug, bullrush, coupdegrace, cpress, cutthroat, dirtkick, dislodge, divert, eviscerate, exsanguinate, eyepoke, feint, footstomp, garrote, gkick, hamstring, haymaker, headbutt, kifocus, kneebash, leapattack, mblow, mug, nosetweak, sattack, sblow, scleave, shroud, spunch, sthieve, subdue, sunder, sweep, swiftkick, tackle, templeshot, throatchop, trip, truestrike, vaultkick
** dislodge <location> - Dislodge from location specified: dislodge eye neck
** stomp - Will perform a stomp attack. Channels 909 if not active. Can also add 909 to society abilities to keep it active.
** dhurl - Hurl your weapon and recovers it. Works with weapon bonding auto return and the recover verb.
** assume <aspect> <aspect/evoke> - Will cycle between two aspects, or evoke a single aspect. Also works in society ability box. "650 <aspect> <aspect/evoke>"
** briar <weapon> - activate the AS buff on briar weapons. Tracks weapon charge and uses on cooldown.
** stance perfection - Put 10, 20, 30, ect in your attack stance box to take advantage of stance perfection.

You may need to '''SKILLS FULL/CMAN INFO/WEAPON INFO/SHIELD INFO''' if you've recently changed training or skills are being outright skipped.

===Additional Options===
*haste or 506 - Placing this in front of any command will cause you to cast 506 before doing that command. It only casts if it isn't currently up or has less than 3 seconds left on its timer.
<PRE>wait 10, haste kill (x3)</PRE>
*slayer or 240 - Placing this in front of any command will cause you to cast 240 before doing that command. It will not recast if it's already active.
<PRE>slayer 302 (x99)</PRE>

===Command Checks===

Commands need to use the following format:
<CODE>COMMAND (CHECKS)(REPETITIONS)</CODE>

So <CODE>hamstring (mob1 prone)(x2)</CODE> Any (x#) needs to be separate. Also (xx) is not unlimited and is just short for (x5).

Additional checks you can add to any command to customize the attack to your desired scenario.
Each check below can be used by itself or with any other check. Put them inside () with a space between each additional check. Example - Kill(m20 s5 e20)
<p>Each of these also has an inverse or opposite.
Just put a ! in front of the command. Example - Kill(!m20 !s5 !e20)
*s# - Checks that you have the required stamina
*m# - Checks that you have the required mana
*h# - Checks that you have the required health but based on a percentage instead of fixed number
*v# - Checks that you have the required spirit
*e# - Checks that your encumbrance percentage is at or below
*tier# - Checks for your current UAC tier (1,2,3). Performs command if UAC Tier is equal or greater.
*mob# - Checks for the number of npcs in room. Performs command if npcs in room is equal to or more than number specified. Only use for 2 or more creatures in the room
<PRE>To further clarify the mob# implimentation
1 mob, mob2, 1 IS less than 2, attack should not proceed.
2 mob, mob2, 2 IS NOT less than 2, attack can proceed
1 mob, !mob2, 1 IS NOT more than 2, attack can proceed
2 mob, !mob2, 2 IS NOT more than 2, attack can proceed
3 mob, !mob2, 3 IS more than 2, attack should not proceed</PRE>
*once - Performs the command once on a specified target, resets on room change
*room - Performs the command once in a room only, resets on room change
*prone - Checks to see if target is not sleeping|webbed|stunned|kneeling|sitting|lying down|prone|frozen|held in place. Performs command if target status is not one of the previous.
*frozen - Same usage as prone. Broke out of prone check for archers against non-corporeal creatures that deflect ranged. Corporeal creatures can be stunned and will break this check.
*undead - Checks to see if target is undead. Performed command if target is undead.
*flying - Checks to see if target is flying. Performed command if target is flying.
*rooted - Checks to see if the target is rooted. Performed command if target is rooted.
*hidden - Checks to see if you're currently hidden.
*poison - Checks to see if you're currently poisoned.
*disease - Checks to see if you're currently diseased.
*noncorporeal - Checks to see if NPC is [[noncorporeal|non-corporeal]] undead
*pcs - Checks to see if there are any PCS in room that are also not in your group
*outside - Checks to see if the room you are in is outside
*barrage - Checks for the Enhanced Dexterity buff from Barrage.
*fury - Checks for the Enhanced Constitution buff from Fury.
*flurry - Checks for the Slashing Strikes buff from Flurry.
*pummel - Checks for the Concussive Blows buff from Pummel.
*thrash - Checks for the Forceful Blows buff from Thrash.
*vigor - Checks for the Tangleweed Vigor buff from Tangleweed.
*reflex - Checks for the Arcane Reflex buff from Nature's Touch.
*tailwind - Checks for Tailwind buff from Breeze. (tailwind) (!tailwind)
*shout - Checks for the Empowered buff from Shout.
*yowlp - Checks for the Yertie's Yowlp buff from Yowlp.
*holler - Checks for the Horland's Holler buff from Holler.
*voidweaver - checks for the Voidweaver buff from Implosion(720)
*justice - Checks for charges of Swift Justice. (justice) do skill with charges (!justice) do skill with no charges
*buffXX - Fire ability when buff duration is <= XX. Supported for barrage,bearhug,fury,flurry,pummel,thrash,shout,yowlp
*tier# - Perform action if you are at the corresponding tier. (!tier3) don't do it if you are at tier3. (tier2) do it if you are tier2
*censer - Attempt to cast 320 before your command checking mana and cooldown. 309(censer), 335(censer mob3), attack(censer)
*ancient - Checks for grizzled/ancient creatures
*animate - Checks for if you have an animate present or not
**If command is a spell, will only cast censer if you have the mana for censer and the spell you intend.
**If command is not a spell, will only check you have enough mana for the censer.

===Example Attack Routines===
<PRE>wait 10, kill (x3)</PRE>

Waits 10 seconds for the monster to swing or cast and then immediately counter attacks from the specified attack stance set in the Hunting tab. Swings a total of three times before going into Defensive stance and waiting 10 seconds again.

<PRE>wait 15, incant 505, incant 903 (xx)</PRE>

Waits 15 seconds before INCANTing 505 (Hand of Tonis), hopefully knocking down or stunning the target. Following this, Bigshot casts 903 (minor water) repeatedly until the target is dead (up to 5 times).

<PRE>stance defensive and incant 1615, kill (x100)</PRE>

Casts 1615 (Divine Strike) at the target from Defensive stance, possibly forcing the target to kneel. Then, uses the kill verb to swing continuously until the target is dead or 100 times..whichever happens first.

<PRE>force feint until 101, kill (x2)</PRE>

Uses the Combat Maneuver FEINT against the target until a successful end roll and then hits the target twice before trying to FEINT again.

<PRE>stance defensive and hide, ambush left leg</PRE>

Hides from Defensive stance and then ambushes that the target's left leg. Once round-time is up, repeats (ie HIDES again from defensive stance).

<PRE>incant 720(m50), incant 708, incant 702 channel(xx)</PRE>

Casts 720 (Implosion) at the target if your character has 50 or more mana. Then, INCANTs 708 (Limb Disruption) at the target, using the default AIM location (if set). Finally, casts 702 (Mana Disruption) at the target up to (5) times or until it is dead.

<PRE>prep 708, cast at left leg / prep 708 channel at left leg, incant 719 (m50)(x1), incant 702 (xx)</PRE>

Prepares 708 (Limb Disruption) and CASTs it at the target's left leg. The second prepares the same spell and then CHANNELs it at the target's left leg. It will then cast 719 (Dark Catalyst) if there is at least 50 mana, and will only cast one time. The last will incant 702 until the creature is dead.

<PRE>wait 30, unarmed punch</PRE>

Waits 30 seconds or until your target attacks. Begins attacked with UAC combat using Punch to tier up.

<PRE>shield charge (s15 prone), ambush, mstrike</PRE>

Will shield charge the target if your character has 15 or more stamina and the target is NOT prone.

The second command will then ambush based on the settings in the "Attacking" Tab - in this case a custom order of head, neck, right leg, back was given so Bigshot will first try to Ambush the head unless the head is too injured or the head cannot be reached followed by the neck then right leg then back.

Bigshot will then focus mstrike the target unless the creature count is equal to or greater than the setting in the MSTRIKE Tab, in which case it will open mstrike instead. If you put "mstrike target", Bigshot will always focused mstrike regardless of the settings in the MSTRIKE Tab. Alternatively, you can set the "Unfocused MSTRIKE when creatures equal or greater" to a large number, to always focus your mstrikes (or set it to 1 to always open mstrike).

<PRE>bellow all, wblade(mob3), flurry(!flurry), attack</PRE>

Will aoe bellow, then whirling blade if there are at least 3 targets. The third command will flurry if you don't have the slashing strikes buff. Finally it will attack and continue to attack until one of the previous attacks become available.

<PRE>holler, shield throw(mob3), flurry, thrash, attack</PRE>

Will open up with a taunt from holler, then shield throw if there are at least 3 targets. Third command will flurry on cooldown. Fourth will thrash on cooldown. Finally we will attack if everything else ends up on cooldown or we run out of stamina.

<PRE>shroud(s35 !hidden mob2), divert (s25 hidden mob2), ambush(hidden), flurry, attack</PRE>

If there is more than one mob, it will hide with shroud and divert one of the targets. Third command will ambush if hidden. Fourth will flurry on cooldown followed up with attack to finish anything off.

<PRE>surge(!surge), bullrush, bearhug, pummel, attack</PRE>

Will cast surge when not on cooldown, and bullrush to bust up and apply vulnerable, then bearhug which is faster if target is vulnerable. Third we will pummel on cooldown and attack when nothing else is available.

<PRE>surge, shout(buff10), shield strike, pummel(buff60), attack(x2)</PRE>

Will keep surge active, casting during cooldown for 60 stamina. Next it will shout and refresh shout when there is less than 11 seconds left on the duration. Third it will shield strike followed up with a pummel once every minute. It will finish off with 2 attacks.

<PRE>pindown(mob4), volley(mob2), weed(!vigor !reflex), barrage(!barrage), incant 616 (m16 reflex), fire</PRE>

Will open up with pin down if there are at least 4 targets, then will volley if there are at least 2 targets. The third command will cast tangleweed if you do not have the tangleweed vigor buff or the arcane reflex buff. Our fourth command will barrage unless we have the enhanced dexterity buff from barage. Fifth we will cast a 1 second spike thorn if we do have 16 mana and do have the arcane reflex buff. Finally we will fire until one of our other commands become available.

===Hunting Target Examples===
All of the examples below will work for both the 'valid targets' and 'quickhunt targets' entries.
* A hunting option only using the default command (a) for each creature in an area:
<pre>crazed zombie, niirsha, sacristan spirit</pre>
* A hunting option using custom hunt commands depending on the creature. In this case it will use command (a) for a [[crazed zombie]] and a [[sacristan spirit]], while using (b) for a [[niirsha]]:
<pre>crazed zombie(a), niirsha(b), sacristan spirit(a)</pre>
* A hunting option that will include the [[:Category:Boss creatures|Boss Creatures]] variations as valid targets:
<pre>(?:adroit |afflicted |apt |barbed |belligerent |blurry |canny |combative |dazzling |deft |diseased |drab |dreary |ethereal |flashy |flexile |flickering |flinty |frenzied |ghastly |ghostly |gleaming |glittering |glorious |glowing |grotesque |hardy |illustrious |indistinct |keen |lanky |luminous |lustrous |muculent |nebulous |oozing |pestilent |radiant |raging |ready |resolute |robust |rune-covered |shadowy |shielded |shifting |shimmering |shining |sickly green |sinuous |slimy |sparkling |spindly |spiny |stalwart |steadfast |stout |tattooed |tenebrous |tough |twinkling |unflinching |unyielding |wavering |wispy )?crazed zombie, niirsha, sacristan spirit</pre>
* Some additional advanced options for identifying valid targets:
<pre>
(?:seasoned |grizzled |battle-scarred |weathered |veteran |hulking |haggard )?Grimswarm (?:giant|troll|orc) (?:dissembler|sorcerer|sorceress|warlock|witch)(a)
(?:seasoned |grizzled |battle-scarred |weathered |veteran |hulking |haggard )?Grimswarm (?:giant|troll|orc) (?:barbarian|blackguard|fighter|marauder|soldier|warrior)(b)
(?:seasoned |grizzled |battle-scarred |weathered |veteran |hulking |haggard )?Grimswarm (?:giant|troll|orc) (?:adept|archmage|elementalist|mage|warmage)(c)
(?:seasoned |grizzled |battle-scarred |weathered |veteran |hulking |haggard )?Grimswarm (?:giant|troll|orc) (?:hunter|huntmaster|huntmistress|ranger)(d)
(?:seasoned )?(?:dwarven|elven|halfling|erithian|human|giantman|half-krolvin|gnomish|half-elven) (?:thief|rogue|bandit|mugger|outlaw|highwayman|marauder|brigand|thug|robber)(e)
(?:shopkeeper|innkeeper|bartender|patrol leader|bandit lord|bandit lady|gypsy queen|gypsy king|guard captain|wall captain|drill sergeant|stable hostler|dungeon master|master torturer|butler|cook|
knight captain|foreign dignitary|royal prince|royal princess|royal jester|royal emperor|royal empress)(f)

To attack everything in the room (?:.*)</pre>

== Misc Tab==
Various specialized config options

===UAC Options===
The various options for configuring how UAC works:
* '''Tier 3 Attack'''
** The attack used when you have reached excellent in the UAC tier
** Options are jab, punch, grapple, or kick
* '''Aim at location (head, etc)'''
** Used for aimed UAC Combat, which requires ambush training to be effective
** Leave blank when you don't want to aim.
* '''MSTRIKE when creatures equal or greater'''
** Determines how many creatures must be present before using MSTRIKE
* '''Use Voln SMITE?'''
** Will perform a Voln SMITE on [[Non-corporeal]] undead

Frequently, people have trouble setting up Bigshot to work with Unarmed Combat. Bigshot only requires minimal configuration to ensure UAC works well.
#UAC tab: Input your '''Tier 3 Attack''' (jab, punch, grapple, or kick)
#Commands tab: Input your '''hunting commands(a)''' option as '''unarmed jab'''

Important notes to keep in mind on how UAC works in Bigshot:
* The hunting option '''unarmed jab''' can be replaced by any UAC attack type (e.g. '''unarmed punch''')
* UAC follow up strikes will be selected over the base or tier 3 attack
* Tier 3 attacks will be used only when positioning is excellent

There is almost no reason to ever use anything other than '''unarmed jab'' as the hunting command, and either '''grapple''' or '''kick''' as the Tier 3 attack.

===MSTRIKE Options===
MSTRIKE attack now has options for when it should be used.
* '''MSTRIKE during cooldown stamina requirement'''
** Allows you to specify how much stamina you want before it will MSTRIKE during the MSTRIKE Cooldown
** Be careful when setting this too low as it can pop your muscles
** Leave blank for it to use your max stamina.
* '''QUICKSTRIKE stamina requirement'''
** Like above but instead for using QUICKSTRIKE during the MSTRIKE routine.
* '''Unfocused MSTRIKE when creatures equal or greater'''
** Number of creatures in room before you do an unfocused mstrike. Default is 2.
* '''MSTRIKE during cooldown'''
**Toggle for MSTRIKEing during its cooldown period
* '''Use QUICKSTRIKE for MSTRIKE'''
** Toggle for using QUICKSTRIKE when you MSTRIKE

===Ammo/Wands===
Here you find the settings to tell Bigshot where you keep all of your nifty wands and bolts and arrows. If your attack routine involves FIRE or WAND verbs, these fields must be set lest Bigshot hang up.
* find ammo in this container: - Leave BLANK if having Bigshot use FIRE without getting ammo out (Archery 2020 Update). Rather self explanatory, this field holds the location of your ammunition storage, be it a wand harness, a quiver or just your backpack.
* use this ammo type: - Leave BLANK to have Bigshot use FIRE without getting any ammo (Archery 2020 Update). Again, like specifying monsters, Bigshot is most sensative about the NOUNs that you use here. If you
* fresh wand container: - Bigshot looks in this container to find fesh wands to WAVE.
* dead wand container: - ...And then will deposit the used up wands in this container.
* use this wand type: - Here you specify which particular wand type you want to use. Bigshot will then pull only these kinds for WAVEing. Can have multiple types listed. Seperate each one with a comma. Example: "aquamarine wand, bloodwood wand, etc"
* Hide while waiting to pick up ammo - Checking this box will have Bigshot hide when gathering up your spent arrows and bolts.
* Use wands when out of mana - Bigshot will pull whatever wand you have specified in the use this wand type field and automatically stance to your attacking stance and WAVE your wand at valid targets until you are out of wands OR hit your resting conditions.

===MA Grouping===
* Enter the name of the looter in Head/Tail configuration

==Monitoring Tab==
* Monitor interaction - Running scripts automates most functions and happens rather mechanically. Most anyone can tell if you are scripting just by watching you. Checking this box will pop up a window whenever Bigshot thinks that someone or something is trying to interact with you.
* Engage deadman's switch - Selecting this option will force Bigshot to quit Gemstone IV when your character is at less than 40% health, allowing you to log back on and assess the situation manually later.
* Depart/rerun if dead - Enabling this option will force a DEPART, causing your character to wake up in the Temple with low spirit. Following this, Bigshot will re-start, starting a fresh hunt. If you do not have a Check Spirit value set in your Should_hunt? tab, you will start hunting without recuperating lost stats.
* Quiet followers - Followers will wait until leader is done with both actions and resting scripts to begin using their own.

==Ingame Screenshot==
<gallery perrow="4">
File:bigshot-1.PNG|Profiles
File:bigshot-2.PNG|Resting
File:bigshot-3.PNG|Hunting
File:bigshot-4.PNG|Attacking
File:bigshot-5.PNG|Commands
File:bigshot-6.PNG|Misc
File:bigshot-7.PNG|Monitoring
</gallery>

==Reference==
* Info originally taken from http://forum.gsplayers.com/showthread.php?t=57651

{{Third-Party Software}}
{{top}}

Lock and Key

2025-04-07T20:21:36Z

WHIGHTCNIGHT: /* Rewards */ add torn page vibrant reward

==Overview==
The Lock and Key system is a new treasure system mechanic that has multiple components and rewards to help facilitate trade and make treasure more fun. The system composes of various locks, keys, baubles, and rewards. You combine a lock and key to be rewarded with a bauble that has the reward inside. The system components are all trade-able. Lock and Key component drop rate is affected by [[Loot cap]] and there are limited amount released per week into the treasure system.

The system currently is two-tiered system components:
* Common: vibrant (level 30+)
* Rare: radiant (level 60+)

Current system has four color components allowing for 8 combinations of locks and keys you can find.
* Blood Red
* Forest Green
* Frosty White
* Royal Blue

You can combine two of any color tier and type component to create a rainbow-hued component. Rainbow-hued locks and keys can be used on any color of similar tier lock and key. To do so, hold two similar components of the same tier and CHANT to combine them into the rainbow-hued variant.

==Locks==
Locks are found via SEARCHing creatures, as well as via [[Mug]], and are not box-found items. These come pre-marked to not be sold. To open a lock, you'll need the matching tier color key or a rainbow-hued key of the same tier in order to open it.

==Keys==
Keys are found via SEARCHing creatures, as well as via [[Mug]], and are not box-found items. These come pre-marked to not be sold. To use the key on a lock, you'll need a matching tier color lock or a rainbow-hued lock of the same tier in order to open it.

==Baubles==
Baubles are the result of unlocking a lock with a key. Radiant baubles having a higher tier loot than vibrant baubles.

==Rewards==
Rewards vary, but the ultimate reward is a new rune system that allow you to enhance your [[Verb:RUNE|RUNE POWER]]. Each rune grants a +1 bonus to the ability that it's created for. Other rewards are possible to be found, but while not as powerful as runes, still are quite valuable.

The system requires you to have a lock & key of the same color and tier. A rainbow-hued variant lock or key can be substituted in place of one or the other. You open the lock by holding both the lock and key in each hand and OPEN MY LOCK. This then grants you a bauble of the same tier. From here, you must BREAK the bauble to reveal your reward. The reward is generated at the time of breaking it open.

All rewards are as follows:
{|width="90%" class="wikitable sortable" {{prettytable}}
!style="width: 15%;"|Item Name
!style="width: 5%;"|Tier
!style="width: 65%;"|Description
|-
|glowing rune-incised stone||radiant||[[Verb:RUNE|rune power]], +1 bonus to Bolt Attack Strength
|-
|glowing torn page||radiant||+50% [[experience]] for 3 day(s)
|-
|shimmering indigo orb||radiant|| 3x [[Roleplaying award|RPA]]
|-
|silvery crimson vial||radiant||grants +75 [[Verb:BOOSTS|bounty boosts]]
|-
|silvery indigo vial||radiant||grants +50,000 experience worth of [[Suffusion|suffused energy]]
|-
|shimmering blue orb||vibrant|| 2x [[Roleplaying award|RPA]]
|-
|tiny blue vial||vibrant||grants +2 [[Guild]] ranks, exact guild skill changed by TAP'ing the vial
|-
|tiny orange vial||vibrant||grants +10 [[deed]]s
|-
|tiny pink vial||vibrant||grants +25,000 profession's [[Verb:RESOURCE|resource]]
|-
|tiny red vial||vibrant||grants +25 [[Verb:BOOSTS|bounty boosts]]
|-
|torn page||vibrant||+50% [[experience]] for 1 day
|-
|vial of iridescent oil||vibrant||charge a [[Gilded locus]] for one month
|-
|COLOR radiant lock||vibrant||radiant lock component
|-
|COLOR radiant key||vibrant||radiant key component
|}

==See Also==
* [[Announcement:New Rare Treasure! Baubles, Keys, and Locks!]]

Lich:Script Repository

2025-04-04T13:51:39Z

WHIGHTCNIGHT: /* Core components installed with Lich */ spelling

{{3rd-party}}
The repository, owned by Tillmen, is the most common location for downloading scripts that are not pre-installed with Lich.

==How to Use the Repository==

The repository has four basic commands:

<syntaxhighlight lang="ruby">
;repository

;repository download <scriptname>

;repository info <scriptname>

;repository list
</syntaxhighlight>

The first shows a Help screen and is the root command for all others.

The second, often shortened to ';repo down', lets you download a specified script.

Third, INFO provides information about whatever script is specified. If the author has been kind and thorough, this will tell you how to use the script and if it has any interdependencies.

Fourth, LIST will list all scripts in the repository.

==Updating Scripts==
The repository supports updates via prefedined scripts and the MapDatabase
To see a list of scripts you currently have set to updatable, <CODE>;repo show-updatable</CODE>.
For users on Lich 5+, you want <CODE>Lich: off</CODE> to be displayed.

To add a script to be updated, <CODE>;repo set-updatable <scriptname></CODE>.
To view scripts you have set to be auto-updated, <CODE>;repo show-updatable</CODE>.
It is only recommended to set scripts from authors you trust to auto-update.

If you want to remove, <CODE>;repo unset-updatable <scriptname></CODE>.

==Popular Lich Scripts==

<section begin=popularscripts />The following are a list of scripts that enhance or extend basic functions of Gemstone IV and can improve or streamline your gaming experience to a point where you can't think of ever going back. It's not all inclusive but contains a good starter set or some of the most popular scripts in use.
=== Core components installed with Lich ===

'''Generally speaking, the below scripts should not need to be updated manually by the user, especially if the user keeps up to date on the current lich version.'''
* [[Lich:Script Alias|alias]] - A default script used to create shortcuts in lich. See wiki page for details.
* [[Lich:Script Autostart|autostart]] - A default script to handle which scripts run on startup. See wiki page for details.
* [[Script Go2|go2]] - Go2 is an intelligent travel script that is synchronized to many of the more complex scripts. Go2 uses a Room Number system and can intelligently plot routes between most any two rooms in all of Elanthia. Use can be as simple as <code>;go2 town</code> or <code>;go2 bank</code> to head to the nearest town square or bank. Use <code>;go2 targets</code> to see a list of pre-programmed locations broken down by towns. Or, use <code>;go2 save <new location name>=<new location room number></code> to create your own locations. Go2 is distributed as part of a default Lich installation.
* [[Lich:Script Map|map]] - map (fork of Narost/XNarost) is an active map library that can display your location and allows Point-And-Click travel. Simply right click and choose a map, pick a room on it and click on it. map is distributed as part of a default Lich installation.
* [[Script Repository|repository]] - A default script to view and download other scripts. See wiki page for details.
* [[Lich:Script Vars|vars]] - A default script to create and view variables for both users and scripts. See wiki page for details.
* [[Lich:Script Version|version]] - A default script to output your current lich version and other information. See wiki page for details.

=== Scripts maintained by Elanthia-Online ===
* [[Lich:Script Bigshot|bigshot]] - A script for attacking and hunting routines. See wiki page for details.
* '''blackarts''' - A script for doing various [[alchemy]] tasks. <CODE>;blackarts setup</CODE> for configuration details
* [[Lich:Script Ebounty|ebounty]] - A script to get and perform bounties. See wiki page for details.
* '''ecaster''' - Allows user to type just the spell number and have lich cast that spell. Usage syntax is <code>;ecaster setup</code> for configuration. Set to autostart.
* '''echild''' - A child bounty script that monitors for and returns a child during bounty sessions. Add to autostart or your hunting script when performing a bounty.
* [[Lich:Script Ecleanse|ecleanse]] - A script for dealing with status conditions. See wiki page for details.
* '''ecure''' - A script for healing for empaths. Usage syntax is <code>;ecure setup</code> for first usage.
* [[Lich:Script Eherbs|eherbs]] - A herb healing and stocking script. See wiki page for details.
* [[Lich:Script Eloot|eloot]] - A looting and loot management script. See wiki page for details.
* '''elogin''' - A script for command line login for your characters. . Usage syntax is <code>;elogin <charname></code>
* '''escortgo2''' - A script for bounty escorts. Usage syntax is <code>;escortgo2 help</code> for relevant commands (replaces ;ego2)
* [[Lich:Script Ewaggle|ewaggle]] - A script for spelling yourself and others up. See wiki page for details.
* '''ewander''' - The last of the Trifector of Travel, wander will move from room to room until it runs into a Boundary - a specified room number - or finds a room with a monster AND empty of players. Wander can be used to create a walled in hunting ground, letting you automatically move from room to room without having to use keystrokes. Use the <code>;ewander add</code> command to add the room you are currently standing in to the Wander List. Note: Wander will NOT enter your boundary rooms. For example, adding Town Square East to the list and then executing ;ewander from within the confines of Moot Hall will send your character exploring every room in Moot, but unable to leave as TSE is a Boundary.
* [[Lich:Script foreach|foreach]] - A script for sending a series of commands for each item that matches its criteria. See wiki page for details.
* '''jbackup ''' - A excellent backup and recovery tool that allows lich database and any additional file backup a user prefers. Set to autostart.
* '''ledger''' - A scripting for tracking your silver and bounty incoming across sessions and over time per character and account with a nice ascii display. Requires ascii_charts gem (installed by default with Lich 5.7.0+ full installer)
* '''signore ''' - A script for using society powers <CODE>;signore setup</CODE> for configuration
* '''resource''' - A script for determining your current player service bonus. <CODE> ;resource bonus </CODE> Can also be used to determine the cost of enchanting with the syntax ;resource calc <starting enchant> <ending enchant> <cost per essence> as in <CODE>;resource calc 35 45 50</CODE>
* '''uberbar_eo ''' - The most current Uberbar variant. This will provide a paperdoll with room number, resource information, etc. inside Wrayth. Set to autostart. Note- there is a small performance impact when using Uberbars.

=== Other scripts that are popular ===
* '''character-planner ''' - A script for planning out your character skills and training. <CODE>;character-planner</CODE> for configuration
* '''colmaster ''' - A script for getting and performing COL tasks in Solhaven
* '''dirty-deeds ''' - A script for getting deeds in IMT and WL. <CODE>;dirty-deeds setup</CODE> for configuration
* [[Script invdb|invdb]] - An inventory management database. See wiki page for details
* '''linktothefast''' - A complex script that provides highlighting for Wrayth links when links are disabled. This script can cause issues with [[STOW]] settings, so disable prior to adjusting those settings.
* [[Script LNet|lnet]] - An out of game, third party, not Simutronics controlled chat server. <CODE>;repo download lnet --author=elanthia-online</CODE>. See wiki page for details '''LNet should be installed at your own risk'''. Simutronics has no control over LNet or policy enforcement there. The in-game [[ESP]] is now available and replaces many of the functions that LNet provided.
* '''multi''' - A script to perform repetitive set of commands. Usage syntax is <code>;multi; <number> <action></code> such as <code>;multi 10, get my diamond, drop my diamond</code>
* '''rogues''' - A script for rogue guild tasks <CODE>;rogues setup</CODE> for configuration
* '''sorter ''' Sorter cleans up your bags and breaks down the the output of a LOOK command, sorting the results by type. Makes looking in your locker or backpack, and especially your gem pouch, infinitely easier. *Note* Sorter can mess up some other scripts that deal with inventory, so be cautious in usage. Elanthia-Online scripts like eloot disable sorter when performing relevant functions
* '''stat-maximizer''' - A script for configuring character stats. <CODE>;stat-maximizer</CODE> for configuration
* '''tpick''' - A script for lockpicking <CODE>;tpick setup</CODE> for configuration
* '''volnstep ''' - A script for performing voln tasks in Wehnimer's Landing
* '''warrior''' - A script for warrior guild tasks <CODE>;warrior setup</CODE> for configuration
<section end=popularscripts />

==In-game Help Output==
<PRE>Usage:

;repository list [alpha] lists all scripts available for download (optionally in alphabetial order)
;repository sync [alpha] lists only new and/or updated scripts
;repository info <script name> shows the comments at the top of the script
;repository download <script name> downloads the script
;repository upload <script name> uploads the script
;repository delete <script name> deletes the script from the server

Scripts should include comments at the top describing the purpose of the script. Scripts without comments at the top will not show up on the server.

After uploading a script, a key that allows you to delete/update the script will be saved to C:/Games/lich/keys</PRE>

==Sortable list==
The repository script has an in game GUI available that allows sorting by date, tags, etc.
<CODE>;repo gui</CODE>

==Jinx (Repository alternative)==

Jinx is a project that is an alternative form of script installation from the default ;repository. It can serve up scripts for download similar to the ;repo however it is not dependent on a single server that may be prone to outages. Any one can set up their own script library, and then users can add it as a source for the ;jinx script to search and download from.

Jinx is installed in the default Lich5 package. Jinx can be downloaded and installed into your scripts folder from the Elanthia Online github

https://raw.githubusercontent.com/elanthia-online/scripts/master/scripts/jinx.lic

Right-click the above link and save it into the scripts folder in your lich directory.

Alternatively, the following command can be issued in game via lich to attempt to download the script to the proper directory for you (this command is for when the repository is down and the script cannot be downloaded naturally):
<syntaxhighlight lang="ruby">
;e require 'open-uri';begin;jinx_remote = open("https://raw.githubusercontent.com/elanthia-online/scripts/master/scripts/jinx.lic"); jinx_local = File.open(File.join(SCRIPT_DIR, 'jinx.lic'), "wb"); jinx_local.write(jinx_remote.read);ensure; jinx_remote.close(); jinx_local.close();end</syntaxhighlight>

once installed you can issue: <CODE>;jinx help</CODE> for basic usage information.

===Jinx Lich Repository Mirror===
In the event the main <code>;repository</code> is unavailable, there is currently an actively maintained <code>;jinx</code> repository that is a direct mirror.

https://github.com/FarFigNewGut/lich_repo_mirror

Scripts can be manually retrieved from this Github repository (they are all located in the lib folder). The repository is also packaged and published for use directly with Jinx:

<syntaxhighlight lang="ruby">
;jinx repo add ffnglichrepoarchive https://ffnglichrepoarchive.netlify.app
</syntaxhighlight>
(You can use something shorter instead of "ffnglichrepoarchive" for the repo name if you'd like.)

Once it is setup as a source for <code>;jinx</code> you can install any scripts from the repo with:

<syntaxhighlight lang="ruby">
# install script for the first time
;jinx script install <script name> --repo=ffnglichrepoarchive

# update previously installed script
;jinx script update <script name> --repo=ffnglichrepoarchive
</syntaxhighlight>

For example if you wanted to download or update invdb.lic:
<syntaxhighlight lang="ruby">
# first install
;jinx script install invdb --repo=ffnglichrepoarchive

# update if you had previously downloaded invdb.lic
;jinx script update invdb --repo=ffnglichrepoarchive
</syntaxhighlight>

Do note, if a script is not available on the archive, it's likely because it belongs to Elanthia-Online and those scripts are not found within the archive, but under a default repo that is configured with jinx. To use it, you would do the following, using bigshot.lic as an example
<syntaxhighlight lang="ruby">
# first install
;jinx script install bigshot--repo=elanthia-online

# update if you had previously downloaded bigshot.lic
;jinx script update bigshot --repo=elanthia-online
</syntaxhighlight>

You can also leave the <code>--repo=<REPO_NAME></code> off to see all available options for a script that is found.

===Jinx Lich Repository Offline Update Info===
At times the default Lich repository (accessed via <code>;repo</code>) can go offline, below are some helpful commands to update core Lich related functionality using Jinx.

<syntaxhighlight lang="ruby">
# ensure running latest jinx.lic for newest compatibility
;jinx script update jinx.lic --repo=elanthia-online

# update spell-list.xml for new spells, cmans, cooldowns, etc
;jinx data update spell-list.xml --repo=elanthia-online

# update gameobj-data.xml for proper classification of NPCs and items
;jinx data update gameobj-data.xml --repo=core

# update mapdb and associated missing map files for graphical use
;jinx data update mapdb.json --repo=core

# update infomon for proper ingame tracking of skills, stats, spells, effects
;jinx script update infomon.lic --repo=elanthia-online
</syntaxhighlight>

==In-game Screenshot==
<gallery perrow="4">
File:Repo-1.png|Repo
</gallery>

{{Third-Party Software}}

Lich:Script Repository

2025-04-04T13:51:17Z

WHIGHTCNIGHT: /* Scripts maintained by Elanthia-Online */ spelling

{{3rd-party}}
The repository, owned by Tillmen, is the most common location for downloading scripts that are not pre-installed with Lich.

==How to Use the Repository==

The repository has four basic commands:

<syntaxhighlight lang="ruby">
;repository

;repository download <scriptname>

;repository info <scriptname>

;repository list
</syntaxhighlight>

The first shows a Help screen and is the root command for all others.

The second, often shortened to ';repo down', lets you download a specified script.

Third, INFO provides information about whatever script is specified. If the author has been kind and thorough, this will tell you how to use the script and if it has any interdependencies.

Fourth, LIST will list all scripts in the repository.

==Updating Scripts==
The repository supports updates via prefedined scripts and the MapDatabase
To see a list of scripts you currently have set to updatable, <CODE>;repo show-updatable</CODE>.
For users on Lich 5+, you want <CODE>Lich: off</CODE> to be displayed.

To add a script to be updated, <CODE>;repo set-updatable <scriptname></CODE>.
To view scripts you have set to be auto-updated, <CODE>;repo show-updatable</CODE>.
It is only recommended to set scripts from authors you trust to auto-update.

If you want to remove, <CODE>;repo unset-updatable <scriptname></CODE>.

==Popular Lich Scripts==

<section begin=popularscripts />The following are a list of scripts that enhance or extend basic functions of Gemstone IV and can improve or streamline your gaming experience to a point where you can't think of ever going back. It's not all inclusive but contains a good starter set or some of the most popular scripts in use.
=== Core components installed with Lich ===

'''Generally speaking, the below scripts should not need to be updated manually by the user, especially if the user keeps up to date on the current lich version.'''
* [[Lich:Script Alias|alias]] - A default script used to create shortcuts in lich. See wiki page for details.
* [[Lich:Script Autostart|autostart]] - A default script to handle which scripts run on startup. See wiki page for details.
* [[Script Go2|go2]] - Go2 is an intelligent travel script that is synchronized to many of the more complex scripts. Go2 uses a Room Number system and can intelligently plot routes between most any two rooms in all of Elanthia. Use can be as simple as <code>;go2 town</code> or <code>;go2 bank</code> to head to the nearest town square or bank. Use <code>;go2 targets</code> to see a list of pre-programmed locations broken down by towns. Or, use <code>;go2 save <new location name>=<new location room number></code> to create your own locations. Go2 is distributed as part of a default Lich installation.
* [[Lich:Script Map|map]] - map (fork of Narost/XNarost) is an active map library that can display your location and allows Point-And-Click travel. Simply right click and choose a map, pick a room on it and click on it. map is distributed as part of a default Lich installation.
* [[Script Repository|repository]] - A default script to view and dowload other scripts. See wiki page for details.
* [[Lich:Script Vars|vars]] - A default script to create and view variables for both users and scripts. See wiki page for details.
* [[Lich:Script Version|version]] - A default script to output your current lich version and other information. See wiki page for details.

=== Scripts maintained by Elanthia-Online ===
* [[Lich:Script Bigshot|bigshot]] - A script for attacking and hunting routines. See wiki page for details.
* '''blackarts''' - A script for doing various [[alchemy]] tasks. <CODE>;blackarts setup</CODE> for configuration details
* [[Lich:Script Ebounty|ebounty]] - A script to get and perform bounties. See wiki page for details.
* '''ecaster''' - Allows user to type just the spell number and have lich cast that spell. Usage syntax is <code>;ecaster setup</code> for configuration. Set to autostart.
* '''echild''' - A child bounty script that monitors for and returns a child during bounty sessions. Add to autostart or your hunting script when performing a bounty.
* [[Lich:Script Ecleanse|ecleanse]] - A script for dealing with status conditions. See wiki page for details.
* '''ecure''' - A script for healing for empaths. Usage syntax is <code>;ecure setup</code> for first usage.
* [[Lich:Script Eherbs|eherbs]] - A herb healing and stocking script. See wiki page for details.
* [[Lich:Script Eloot|eloot]] - A looting and loot management script. See wiki page for details.
* '''elogin''' - A script for command line login for your characters. . Usage syntax is <code>;elogin <charname></code>
* '''escortgo2''' - A script for bounty escorts. Usage syntax is <code>;escortgo2 help</code> for relevant commands (replaces ;ego2)
* [[Lich:Script Ewaggle|ewaggle]] - A script for spelling yourself and others up. See wiki page for details.
* '''ewander''' - The last of the Trifector of Travel, wander will move from room to room until it runs into a Boundary - a specified room number - or finds a room with a monster AND empty of players. Wander can be used to create a walled in hunting ground, letting you automatically move from room to room without having to use keystrokes. Use the <code>;ewander add</code> command to add the room you are currently standing in to the Wander List. Note: Wander will NOT enter your boundary rooms. For example, adding Town Square East to the list and then executing ;ewander from within the confines of Moot Hall will send your character exploring every room in Moot, but unable to leave as TSE is a Boundary.
* [[Lich:Script foreach|foreach]] - A script for sending a series of commands for each item that matches its criteria. See wiki page for details.
* '''jbackup ''' - A excellent backup and recovery tool that allows lich database and any additional file backup a user prefers. Set to autostart.
* '''ledger''' - A scripting for tracking your silver and bounty incoming across sessions and over time per character and account with a nice ascii display. Requires ascii_charts gem (installed by default with Lich 5.7.0+ full installer)
* '''signore ''' - A script for using society powers <CODE>;signore setup</CODE> for configuration
* '''resource''' - A script for determining your current player service bonus. <CODE> ;resource bonus </CODE> Can also be used to determine the cost of enchanting with the syntax ;resource calc <starting enchant> <ending enchant> <cost per essence> as in <CODE>;resource calc 35 45 50</CODE>
* '''uberbar_eo ''' - The most current Uberbar variant. This will provide a paperdoll with room number, resource information, etc. inside Wrayth. Set to autostart. Note- there is a small performance impact when using Uberbars.

=== Other scripts that are popular ===
* '''character-planner ''' - A script for planning out your character skills and training. <CODE>;character-planner</CODE> for configuration
* '''colmaster ''' - A script for getting and performing COL tasks in Solhaven
* '''dirty-deeds ''' - A script for getting deeds in IMT and WL. <CODE>;dirty-deeds setup</CODE> for configuration
* [[Script invdb|invdb]] - An inventory management database. See wiki page for details
* '''linktothefast''' - A complex script that provides highlighting for Wrayth links when links are disabled. This script can cause issues with [[STOW]] settings, so disable prior to adjusting those settings.
* [[Script LNet|lnet]] - An out of game, third party, not Simutronics controlled chat server. <CODE>;repo download lnet --author=elanthia-online</CODE>. See wiki page for details '''LNet should be installed at your own risk'''. Simutronics has no control over LNet or policy enforcement there. The in-game [[ESP]] is now available and replaces many of the functions that LNet provided.
* '''multi''' - A script to perform repetitive set of commands. Usage syntax is <code>;multi; <number> <action></code> such as <code>;multi 10, get my diamond, drop my diamond</code>
* '''rogues''' - A script for rogue guild tasks <CODE>;rogues setup</CODE> for configuration
* '''sorter ''' Sorter cleans up your bags and breaks down the the output of a LOOK command, sorting the results by type. Makes looking in your locker or backpack, and especially your gem pouch, infinitely easier. *Note* Sorter can mess up some other scripts that deal with inventory, so be cautious in usage. Elanthia-Online scripts like eloot disable sorter when performing relevant functions
* '''stat-maximizer''' - A script for configuring character stats. <CODE>;stat-maximizer</CODE> for configuration
* '''tpick''' - A script for lockpicking <CODE>;tpick setup</CODE> for configuration
* '''volnstep ''' - A script for performing voln tasks in Wehnimer's Landing
* '''warrior''' - A script for warrior guild tasks <CODE>;warrior setup</CODE> for configuration
<section end=popularscripts />

==In-game Help Output==
<PRE>Usage:

;repository list [alpha] lists all scripts available for download (optionally in alphabetial order)
;repository sync [alpha] lists only new and/or updated scripts
;repository info <script name> shows the comments at the top of the script
;repository download <script name> downloads the script
;repository upload <script name> uploads the script
;repository delete <script name> deletes the script from the server

Scripts should include comments at the top describing the purpose of the script. Scripts without comments at the top will not show up on the server.

After uploading a script, a key that allows you to delete/update the script will be saved to C:/Games/lich/keys</PRE>

==Sortable list==
The repository script has an in game GUI available that allows sorting by date, tags, etc.
<CODE>;repo gui</CODE>

==Jinx (Repository alternative)==

Jinx is a project that is an alternative form of script installation from the default ;repository. It can serve up scripts for download similar to the ;repo however it is not dependent on a single server that may be prone to outages. Any one can set up their own script library, and then users can add it as a source for the ;jinx script to search and download from.

Jinx is installed in the default Lich5 package. Jinx can be downloaded and installed into your scripts folder from the Elanthia Online github

https://raw.githubusercontent.com/elanthia-online/scripts/master/scripts/jinx.lic

Right-click the above link and save it into the scripts folder in your lich directory.

Alternatively, the following command can be issued in game via lich to attempt to download the script to the proper directory for you (this command is for when the repository is down and the script cannot be downloaded naturally):
<syntaxhighlight lang="ruby">
;e require 'open-uri';begin;jinx_remote = open("https://raw.githubusercontent.com/elanthia-online/scripts/master/scripts/jinx.lic"); jinx_local = File.open(File.join(SCRIPT_DIR, 'jinx.lic'), "wb"); jinx_local.write(jinx_remote.read);ensure; jinx_remote.close(); jinx_local.close();end</syntaxhighlight>

once installed you can issue: <CODE>;jinx help</CODE> for basic usage information.

===Jinx Lich Repository Mirror===
In the event the main <code>;repository</code> is unavailable, there is currently an actively maintained <code>;jinx</code> repository that is a direct mirror.

https://github.com/FarFigNewGut/lich_repo_mirror

Scripts can be manually retrieved from this Github repository (they are all located in the lib folder). The repository is also packaged and published for use directly with Jinx:

<syntaxhighlight lang="ruby">
;jinx repo add ffnglichrepoarchive https://ffnglichrepoarchive.netlify.app
</syntaxhighlight>
(You can use something shorter instead of "ffnglichrepoarchive" for the repo name if you'd like.)

Once it is setup as a source for <code>;jinx</code> you can install any scripts from the repo with:

<syntaxhighlight lang="ruby">
# install script for the first time
;jinx script install <script name> --repo=ffnglichrepoarchive

# update previously installed script
;jinx script update <script name> --repo=ffnglichrepoarchive
</syntaxhighlight>

For example if you wanted to download or update invdb.lic:
<syntaxhighlight lang="ruby">
# first install
;jinx script install invdb --repo=ffnglichrepoarchive

# update if you had previously downloaded invdb.lic
;jinx script update invdb --repo=ffnglichrepoarchive
</syntaxhighlight>

Do note, if a script is not available on the archive, it's likely because it belongs to Elanthia-Online and those scripts are not found within the archive, but under a default repo that is configured with jinx. To use it, you would do the following, using bigshot.lic as an example
<syntaxhighlight lang="ruby">
# first install
;jinx script install bigshot--repo=elanthia-online

# update if you had previously downloaded bigshot.lic
;jinx script update bigshot --repo=elanthia-online
</syntaxhighlight>

You can also leave the <code>--repo=<REPO_NAME></code> off to see all available options for a script that is found.

===Jinx Lich Repository Offline Update Info===
At times the default Lich repository (accessed via <code>;repo</code>) can go offline, below are some helpful commands to update core Lich related functionality using Jinx.

<syntaxhighlight lang="ruby">
# ensure running latest jinx.lic for newest compatibility
;jinx script update jinx.lic --repo=elanthia-online

# update spell-list.xml for new spells, cmans, cooldowns, etc
;jinx data update spell-list.xml --repo=elanthia-online

# update gameobj-data.xml for proper classification of NPCs and items
;jinx data update gameobj-data.xml --repo=core

# update mapdb and associated missing map files for graphical use
;jinx data update mapdb.json --repo=core

# update infomon for proper ingame tracking of skills, stats, spells, effects
;jinx script update infomon.lic --repo=elanthia-online
</syntaxhighlight>

==In-game Screenshot==
<gallery perrow="4">
File:Repo-1.png|Repo
</gallery>

{{Third-Party Software}}

Lich:Script Repository

2025-04-04T13:49:06Z

WHIGHTCNIGHT: /* Other scripts that are popular */ added info about ESP to lnet

{{3rd-party}}
The repository, owned by Tillmen, is the most common location for downloading scripts that are not pre-installed with Lich.

==How to Use the Repository==

The repository has four basic commands:

<syntaxhighlight lang="ruby">
;repository

;repository download <scriptname>

;repository info <scriptname>

;repository list
</syntaxhighlight>

The first shows a Help screen and is the root command for all others.

The second, often shortened to ';repo down', lets you download a specified script.

Third, INFO provides information about whatever script is specified. If the author has been kind and thorough, this will tell you how to use the script and if it has any interdependencies.

Fourth, LIST will list all scripts in the repository.

==Updating Scripts==
The repository supports updates via prefedined scripts and the MapDatabase
To see a list of scripts you currently have set to updatable, <CODE>;repo show-updatable</CODE>.
For users on Lich 5+, you want <CODE>Lich: off</CODE> to be displayed.

To add a script to be updated, <CODE>;repo set-updatable <scriptname></CODE>.
To view scripts you have set to be auto-updated, <CODE>;repo show-updatable</CODE>.
It is only recommended to set scripts from authors you trust to auto-update.

If you want to remove, <CODE>;repo unset-updatable <scriptname></CODE>.

==Popular Lich Scripts==

<section begin=popularscripts />The following are a list of scripts that enhance or extend basic functions of Gemstone IV and can improve or streamline your gaming experience to a point where you can't think of ever going back. It's not all inclusive but contains a good starter set or some of the most popular scripts in use.
=== Core components installed with Lich ===

'''Generally speaking, the below scripts should not need to be updated manually by the user, especially if the user keeps up to date on the current lich version.'''
* [[Lich:Script Alias|alias]] - A default script used to create shortcuts in lich. See wiki page for details.
* [[Lich:Script Autostart|autostart]] - A default script to handle which scripts run on startup. See wiki page for details.
* [[Script Go2|go2]] - Go2 is an intelligent travel script that is synchronized to many of the more complex scripts. Go2 uses a Room Number system and can intelligently plot routes between most any two rooms in all of Elanthia. Use can be as simple as <code>;go2 town</code> or <code>;go2 bank</code> to head to the nearest town square or bank. Use <code>;go2 targets</code> to see a list of pre-programmed locations broken down by towns. Or, use <code>;go2 save <new location name>=<new location room number></code> to create your own locations. Go2 is distributed as part of a default Lich installation.
* [[Lich:Script Map|map]] - map (fork of Narost/XNarost) is an active map library that can display your location and allows Point-And-Click travel. Simply right click and choose a map, pick a room on it and click on it. map is distributed as part of a default Lich installation.
* [[Script Repository|repository]] - A default script to view and dowload other scripts. See wiki page for details.
* [[Lich:Script Vars|vars]] - A default script to create and view variables for both users and scripts. See wiki page for details.
* [[Lich:Script Version|version]] - A default script to output your current lich version and other information. See wiki page for details.

=== Scripts maintained by Elanthia-Online ===
* [[Lich:Script Bigshot|bigshot]] - A script for attacking and hunting routines. See wiki page for details.
* '''blackarts''' - A script for doing various [[alchemy]] tasks. <CODE>;blackarts setup</CODE> for configuration details
* [[Lich:Script Ebounty|ebounty]] - A script to get and perform bounties. See wiki page for details.
* '''ecaster''' - Allows user to type just the spell number and have lich cast that spell. Usage syntax is <code>;ecaster setup</code> for configuration. Set to autostart.
* '''echild''' - A child bounty script that monitors for and returns a child during bounty sessions. Add to autostart or your hunting script when performing a bounty.
* [[Lich:Script Ecleanse|ecleanse]] - A script for dealing with status conditions. See wiki page for details.
* '''ecure''' - A script for healing for empaths. Usage syntax is <code>;ecure setup</code> for first usage.
* [[Lich:Script Eherbs|eherbs]] - A herb heaing and stocking script. See wiki page for details.
* [[Lich:Script Eloot|eloot]] - A looting and loot management script. See wiki page for details.
* '''elogin''' - A script for command line login for your characters. . Usage syntax is <code>;elogin <charname></code>
* '''escortgo2''' - A script for bounty escorts. Usage syntax is <code>;escortgo2 help</code> for relevant commands (replaces ;ego2)
* [[Lich:Script Ewaggle|ewaggle]] - A script for spelling yourself and others up. See wiki page for details.
* '''ewander''' - The last of the Trifector of Travel, wander will move from room to room until it runs into a Boundary - a specified room number - or finds a room with a monster AND empty of players. Wander can be used to create a walled in hunting ground, letting you automatically move from room to room without having to use keystrokes. Use the <code>;ewander add</code> command to add the room you are currently standing in to the Wander List. Note: Wander will NOT enter your boundary rooms. For example, adding Town Square East to the list and then executing ;ewander from within the confines of Moot Hall will send your character exploring every room in Moot, but unable to leave as TSE is a Boundary.
* [[Lich:Script foreach|foreach]] - A script for sending a series of commands for each item that matches its criteria. See wiki page for details.
* '''jbackup ''' - A excellent backup and recovery tool that allows lich database and any additional file backup a user prefers. Set to autostart.
* '''ledger''' - A scripting for tracking your silver and bounty incoming across sessios and over time per character and account with a nice ascii discplay. Requires ascii_charts gem (installed by default with Lich 5.7.0+ full installer)
* '''signore ''' - A script for using society powers <CODE>;signore setup</CODE> for configuration
* '''resource''' - A script for determining your current player service bonus. <CODE> ;resource bonus </CODE> Can also be used to determine the cost of enchanting with the syntanx ;Resource calc <starting enchant> <ending enchant> <cost per essence> as in <CODE>;resource calc 35 45 50</CODE>
* '''uberbar_eo ''' - The most current Uberbar variant. This will provide a paperdoll with room number, resource information, etc inside wrayth. Set to autostart. Note- there is a small performance impact when using Uberbars.

=== Other scripts that are popular ===
* '''character-planner ''' - A script for planning out your character skills and training. <CODE>;character-planner</CODE> for configuration
* '''colmaster ''' - A script for getting and performing COL tasks in Solhaven
* '''dirty-deeds ''' - A script for getting deeds in IMT and WL. <CODE>;dirty-deeds setup</CODE> for configuration
* [[Script invdb|invdb]] - An inventory management database. See wiki page for details
* '''linktothefast''' - A complex script that provides highlighting for Wrayth links when links are disabled. This script can cause issues with [[STOW]] settings, so disable prior to adjusting those settings.
* [[Script LNet|lnet]] - An out of game, third party, not Simutronics controlled chat server. <CODE>;repo download lnet --author=elanthia-online</CODE>. See wiki page for details '''LNet should be installed at your own risk'''. Simutronics has no control over LNet or policy enforcement there. The in-game [[ESP]] is now available and replaces many of the functions that LNet provided.
* '''multi''' - A script to perform repetitive set of commands. Usage syntax is <code>;multi; <number> <action></code> such as <code>;multi 10, get my diamond, drop my diamond</code>
* '''rogues''' - A script for rogue guild tasks <CODE>;rogues setup</CODE> for configuration
* '''sorter ''' Sorter cleans up your bags and breaks down the the output of a LOOK command, sorting the results by type. Makes looking in your locker or backpack, and especially your gem pouch, infinitely easier. *Note* Sorter can mess up some other scripts that deal with inventory, so be cautious in usage. Elanthia-Online scripts like eloot disable sorter when performing relevant functions
* '''stat-maximizer''' - A script for configuring character stats. <CODE>;stat-maximizer</CODE> for configuration
* '''tpick''' - A script for lockpicking <CODE>;tpick setup</CODE> for configuration
* '''volnstep ''' - A script for performing voln tasks in Wehnimer's Landing
* '''warrior''' - A script for warrior guild tasks <CODE>;warrior setup</CODE> for configuration
<section end=popularscripts />

==In-game Help Output==
<PRE>Usage:

;repository list [alpha] lists all scripts available for download (optionally in alphabetial order)
;repository sync [alpha] lists only new and/or updated scripts
;repository info <script name> shows the comments at the top of the script
;repository download <script name> downloads the script
;repository upload <script name> uploads the script
;repository delete <script name> deletes the script from the server

Scripts should include comments at the top describing the purpose of the script. Scripts without comments at the top will not show up on the server.

After uploading a script, a key that allows you to delete/update the script will be saved to C:/Games/lich/keys</PRE>

==Sortable list==
The repository script has an in game GUI available that allows sorting by date, tags, etc.
<CODE>;repo gui</CODE>

==Jinx (Repository alternative)==

Jinx is a project that is an alternative form of script installation from the default ;repository. It can serve up scripts for download similar to the ;repo however it is not dependent on a single server that may be prone to outages. Any one can set up their own script library, and then users can add it as a source for the ;jinx script to search and download from.

Jinx is installed in the default Lich5 package. Jinx can be downloaded and installed into your scripts folder from the Elanthia Online github

https://raw.githubusercontent.com/elanthia-online/scripts/master/scripts/jinx.lic

Right-click the above link and save it into the scripts folder in your lich directory.

Alternatively, the following command can be issued in game via lich to attempt to download the script to the proper directory for you (this command is for when the repository is down and the script cannot be downloaded naturally):
<syntaxhighlight lang="ruby">
;e require 'open-uri';begin;jinx_remote = open("https://raw.githubusercontent.com/elanthia-online/scripts/master/scripts/jinx.lic"); jinx_local = File.open(File.join(SCRIPT_DIR, 'jinx.lic'), "wb"); jinx_local.write(jinx_remote.read);ensure; jinx_remote.close(); jinx_local.close();end</syntaxhighlight>

once installed you can issue: <CODE>;jinx help</CODE> for basic usage information.

===Jinx Lich Repository Mirror===
In the event the main <code>;repository</code> is unavailable, there is currently an actively maintained <code>;jinx</code> repository that is a direct mirror.

https://github.com/FarFigNewGut/lich_repo_mirror

Scripts can be manually retrieved from this Github repository (they are all located in the lib folder). The repository is also packaged and published for use directly with Jinx:

<syntaxhighlight lang="ruby">
;jinx repo add ffnglichrepoarchive https://ffnglichrepoarchive.netlify.app
</syntaxhighlight>
(You can use something shorter instead of "ffnglichrepoarchive" for the repo name if you'd like.)

Once it is setup as a source for <code>;jinx</code> you can install any scripts from the repo with:

<syntaxhighlight lang="ruby">
# install script for the first time
;jinx script install <script name> --repo=ffnglichrepoarchive

# update previously installed script
;jinx script update <script name> --repo=ffnglichrepoarchive
</syntaxhighlight>

For example if you wanted to download or update invdb.lic:
<syntaxhighlight lang="ruby">
# first install
;jinx script install invdb --repo=ffnglichrepoarchive

# update if you had previously downloaded invdb.lic
;jinx script update invdb --repo=ffnglichrepoarchive
</syntaxhighlight>

Do note, if a script is not available on the archive, it's likely because it belongs to Elanthia-Online and those scripts are not found within the archive, but under a default repo that is configured with jinx. To use it, you would do the following, using bigshot.lic as an example
<syntaxhighlight lang="ruby">
# first install
;jinx script install bigshot--repo=elanthia-online

# update if you had previously downloaded bigshot.lic
;jinx script update bigshot --repo=elanthia-online
</syntaxhighlight>

You can also leave the <code>--repo=<REPO_NAME></code> off to see all available options for a script that is found.

===Jinx Lich Repository Offline Update Info===
At times the default Lich repository (accessed via <code>;repo</code>) can go offline, below are some helpful commands to update core Lich related functionality using Jinx.

<syntaxhighlight lang="ruby">
# ensure running latest jinx.lic for newest compatibility
;jinx script update jinx.lic --repo=elanthia-online

# update spell-list.xml for new spells, cmans, cooldowns, etc
;jinx data update spell-list.xml --repo=elanthia-online

# update gameobj-data.xml for proper classification of NPCs and items
;jinx data update gameobj-data.xml --repo=core

# update mapdb and associated missing map files for graphical use
;jinx data update mapdb.json --repo=core

# update infomon for proper ingame tracking of skills, stats, spells, effects
;jinx script update infomon.lic --repo=elanthia-online
</syntaxhighlight>

==In-game Screenshot==
<gallery perrow="4">
File:Repo-1.png|Repo
</gallery>

{{Third-Party Software}}

Lich:Script Repository

2025-04-04T13:46:43Z

WHIGHTCNIGHT: /* Scripts maintained by Elanthia-Online */

{{3rd-party}}
The repository, owned by Tillmen, is the most common location for downloading scripts that are not pre-installed with Lich.

==How to Use the Repository==

The repository has four basic commands:

<syntaxhighlight lang="ruby">
;repository

;repository download <scriptname>

;repository info <scriptname>

;repository list
</syntaxhighlight>

The first shows a Help screen and is the root command for all others.

The second, often shortened to ';repo down', lets you download a specified script.

Third, INFO provides information about whatever script is specified. If the author has been kind and thorough, this will tell you how to use the script and if it has any interdependencies.

Fourth, LIST will list all scripts in the repository.

==Updating Scripts==
The repository supports updates via prefedined scripts and the MapDatabase
To see a list of scripts you currently have set to updatable, <CODE>;repo show-updatable</CODE>.
For users on Lich 5+, you want <CODE>Lich: off</CODE> to be displayed.

To add a script to be updated, <CODE>;repo set-updatable <scriptname></CODE>.
To view scripts you have set to be auto-updated, <CODE>;repo show-updatable</CODE>.
It is only recommended to set scripts from authors you trust to auto-update.

If you want to remove, <CODE>;repo unset-updatable <scriptname></CODE>.

==Popular Lich Scripts==

<section begin=popularscripts />The following are a list of scripts that enhance or extend basic functions of Gemstone IV and can improve or streamline your gaming experience to a point where you can't think of ever going back. It's not all inclusive but contains a good starter set or some of the most popular scripts in use.
=== Core components installed with Lich ===

'''Generally speaking, the below scripts should not need to be updated manually by the user, especially if the user keeps up to date on the current lich version.'''
* [[Lich:Script Alias|alias]] - A default script used to create shortcuts in lich. See wiki page for details.
* [[Lich:Script Autostart|autostart]] - A default script to handle which scripts run on startup. See wiki page for details.
* [[Script Go2|go2]] - Go2 is an intelligent travel script that is synchronized to many of the more complex scripts. Go2 uses a Room Number system and can intelligently plot routes between most any two rooms in all of Elanthia. Use can be as simple as <code>;go2 town</code> or <code>;go2 bank</code> to head to the nearest town square or bank. Use <code>;go2 targets</code> to see a list of pre-programmed locations broken down by towns. Or, use <code>;go2 save <new location name>=<new location room number></code> to create your own locations. Go2 is distributed as part of a default Lich installation.
* [[Lich:Script Map|map]] - map (fork of Narost/XNarost) is an active map library that can display your location and allows Point-And-Click travel. Simply right click and choose a map, pick a room on it and click on it. map is distributed as part of a default Lich installation.
* [[Script Repository|repository]] - A default script to view and dowload other scripts. See wiki page for details.
* [[Lich:Script Vars|vars]] - A default script to create and view variables for both users and scripts. See wiki page for details.
* [[Lich:Script Version|version]] - A default script to output your current lich version and other information. See wiki page for details.

=== Scripts maintained by Elanthia-Online ===
* [[Lich:Script Bigshot|bigshot]] - A script for attacking and hunting routines. See wiki page for details.
* '''blackarts''' - A script for doing various [[alchemy]] tasks. <CODE>;blackarts setup</CODE> for configuration details
* [[Lich:Script Ebounty|ebounty]] - A script to get and perform bounties. See wiki page for details.
* '''ecaster''' - Allows user to type just the spell number and have lich cast that spell. Usage syntax is <code>;ecaster setup</code> for configuration. Set to autostart.
* '''echild''' - A child bounty script that monitors for and returns a child during bounty sessions. Add to autostart or your hunting script when performing a bounty.
* [[Lich:Script Ecleanse|ecleanse]] - A script for dealing with status conditions. See wiki page for details.
* '''ecure''' - A script for healing for empaths. Usage syntax is <code>;ecure setup</code> for first usage.
* [[Lich:Script Eherbs|eherbs]] - A herb heaing and stocking script. See wiki page for details.
* [[Lich:Script Eloot|eloot]] - A looting and loot management script. See wiki page for details.
* '''elogin''' - A script for command line login for your characters. . Usage syntax is <code>;elogin <charname></code>
* '''escortgo2''' - A script for bounty escorts. Usage syntax is <code>;escortgo2 help</code> for relevant commands (replaces ;ego2)
* [[Lich:Script Ewaggle|ewaggle]] - A script for spelling yourself and others up. See wiki page for details.
* '''ewander''' - The last of the Trifector of Travel, wander will move from room to room until it runs into a Boundary - a specified room number - or finds a room with a monster AND empty of players. Wander can be used to create a walled in hunting ground, letting you automatically move from room to room without having to use keystrokes. Use the <code>;ewander add</code> command to add the room you are currently standing in to the Wander List. Note: Wander will NOT enter your boundary rooms. For example, adding Town Square East to the list and then executing ;ewander from within the confines of Moot Hall will send your character exploring every room in Moot, but unable to leave as TSE is a Boundary.
* [[Lich:Script foreach|foreach]] - A script for sending a series of commands for each item that matches its criteria. See wiki page for details.
* '''jbackup ''' - A excellent backup and recovery tool that allows lich database and any additional file backup a user prefers. Set to autostart.
* '''ledger''' - A scripting for tracking your silver and bounty incoming across sessios and over time per character and account with a nice ascii discplay. Requires ascii_charts gem (installed by default with Lich 5.7.0+ full installer)
* '''signore ''' - A script for using society powers <CODE>;signore setup</CODE> for configuration
* '''resource''' - A script for determining your current player service bonus. <CODE> ;resource bonus </CODE> Can also be used to determine the cost of enchanting with the syntanx ;Resource calc <starting enchant> <ending enchant> <cost per essence> as in <CODE>;resource calc 35 45 50</CODE>
* '''uberbar_eo ''' - The most current Uberbar variant. This will provide a paperdoll with room number, resource information, etc inside wrayth. Set to autostart. Note- there is a small performance impact when using Uberbars.

=== Other scripts that are popular ===
* '''character-planner ''' - A script for planning out your character skills and training. <CODE>;character-planner</CODE> for configuration
* '''colmaster ''' - A script for getting and performing COL tasks in Solhaven
* '''dirty-deeds ''' - A script for getting deeds in IMT and WL. <CODE>;dirty-deeds setup</CODE> for configuration
* [[Script invdb|invdb]] - An inventory management database. See wiki page for details
* '''linktothefast''' - A complex script that provides highliting for Wryath links when links are disabled. This script can cause issues with [[STOW]] settings, so disable prior to adjusting those settings.
* [[Script LNet|lnet]] - An out of game, third party, not Simutronics controlled chat server. <CODE>;repo download lnet --author=elanthia-online</CODE>. See wiki page for details '''LNET should be installed at your own risk'''. Simutronics has no control over lnet or policy enforcement there.
* '''multi''' - A script to peform repetitive set of commands. Usage syntax is <code>;multi; <number> <action></code> such as <code>;multi 10, get my diamond, drop my diamond</code>
* '''rogues''' - A script for rogue guild tasks <CODE>;rogues setup</CODE> for configuration
* '''sorter ''' Sorter cleans up your bags and breaks down the the output of a LOOK command, sorting the results by type. Makes looking in your locker or backpack, and especially your gem pouch, infinitely easier. *Note* Sorter can mess up some other scripts that deal with inventory, so be cautious in usage. Elanthia-Online scripts like eloot disable sorter when performing relevant functions
* '''stat-maximizer''' - A script for configuring character stats. <CODE>;stat-maximizer</CODE> for configuration
* '''tpick''' - A script for lockpicking <CODE>;tpick setup</CODE> for configuration
* '''volnstep ''' - A script for performing voln tasks in Wehnimer's Landing
* '''warrior''' - A script for warrior guild tasks <CODE>;warrior setup</CODE> for configuration
<section end=popularscripts />

==In-game Help Output==
<PRE>Usage:

;repository list [alpha] lists all scripts available for download (optionally in alphabetial order)
;repository sync [alpha] lists only new and/or updated scripts
;repository info <script name> shows the comments at the top of the script
;repository download <script name> downloads the script
;repository upload <script name> uploads the script
;repository delete <script name> deletes the script from the server

Scripts should include comments at the top describing the purpose of the script. Scripts without comments at the top will not show up on the server.

After uploading a script, a key that allows you to delete/update the script will be saved to C:/Games/lich/keys</PRE>

==Sortable list==
The repository script has an in game GUI available that allows sorting by date, tags, etc.
<CODE>;repo gui</CODE>

==Jinx (Repository alternative)==

Jinx is a project that is an alternative form of script installation from the default ;repository. It can serve up scripts for download similar to the ;repo however it is not dependent on a single server that may be prone to outages. Any one can set up their own script library, and then users can add it as a source for the ;jinx script to search and download from.

Jinx is installed in the default Lich5 package. Jinx can be downloaded and installed into your scripts folder from the Elanthia Online github

https://raw.githubusercontent.com/elanthia-online/scripts/master/scripts/jinx.lic

Right-click the above link and save it into the scripts folder in your lich directory.

Alternatively, the following command can be issued in game via lich to attempt to download the script to the proper directory for you (this command is for when the repository is down and the script cannot be downloaded naturally):
<syntaxhighlight lang="ruby">
;e require 'open-uri';begin;jinx_remote = open("https://raw.githubusercontent.com/elanthia-online/scripts/master/scripts/jinx.lic"); jinx_local = File.open(File.join(SCRIPT_DIR, 'jinx.lic'), "wb"); jinx_local.write(jinx_remote.read);ensure; jinx_remote.close(); jinx_local.close();end</syntaxhighlight>

once installed you can issue: <CODE>;jinx help</CODE> for basic usage information.

===Jinx Lich Repository Mirror===
In the event the main <code>;repository</code> is unavailable, there is currently an actively maintained <code>;jinx</code> repository that is a direct mirror.

https://github.com/FarFigNewGut/lich_repo_mirror

Scripts can be manually retrieved from this Github repository (they are all located in the lib folder). The repository is also packaged and published for use directly with Jinx:

<syntaxhighlight lang="ruby">
;jinx repo add ffnglichrepoarchive https://ffnglichrepoarchive.netlify.app
</syntaxhighlight>
(You can use something shorter instead of "ffnglichrepoarchive" for the repo name if you'd like.)

Once it is setup as a source for <code>;jinx</code> you can install any scripts from the repo with:

<syntaxhighlight lang="ruby">
# install script for the first time
;jinx script install <script name> --repo=ffnglichrepoarchive

# update previously installed script
;jinx script update <script name> --repo=ffnglichrepoarchive
</syntaxhighlight>

For example if you wanted to download or update invdb.lic:
<syntaxhighlight lang="ruby">
# first install
;jinx script install invdb --repo=ffnglichrepoarchive

# update if you had previously downloaded invdb.lic
;jinx script update invdb --repo=ffnglichrepoarchive
</syntaxhighlight>

Do note, if a script is not available on the archive, it's likely because it belongs to Elanthia-Online and those scripts are not found within the archive, but under a default repo that is configured with jinx. To use it, you would do the following, using bigshot.lic as an example
<syntaxhighlight lang="ruby">
# first install
;jinx script install bigshot--repo=elanthia-online

# update if you had previously downloaded bigshot.lic
;jinx script update bigshot --repo=elanthia-online
</syntaxhighlight>

You can also leave the <code>--repo=<REPO_NAME></code> off to see all available options for a script that is found.

===Jinx Lich Repository Offline Update Info===
At times the default Lich repository (accessed via <code>;repo</code>) can go offline, below are some helpful commands to update core Lich related functionality using Jinx.

<syntaxhighlight lang="ruby">
# ensure running latest jinx.lic for newest compatibility
;jinx script update jinx.lic --repo=elanthia-online

# update spell-list.xml for new spells, cmans, cooldowns, etc
;jinx data update spell-list.xml --repo=elanthia-online

# update gameobj-data.xml for proper classification of NPCs and items
;jinx data update gameobj-data.xml --repo=core

# update mapdb and associated missing map files for graphical use
;jinx data update mapdb.json --repo=core

# update infomon for proper ingame tracking of skills, stats, spells, effects
;jinx script update infomon.lic --repo=elanthia-online
</syntaxhighlight>

==In-game Screenshot==
<gallery perrow="4">
File:Repo-1.png|Repo
</gallery>

{{Third-Party Software}}

Lich:Script Repository

2025-04-04T13:46:20Z

WHIGHTCNIGHT: /* Scripts maintained by Elanthia-Online */ add ewander as replacement for wander

{{3rd-party}}
The repository, owned by Tillmen, is the most common location for downloading scripts that are not pre-installed with Lich.

==How to Use the Repository==

The repository has four basic commands:

<syntaxhighlight lang="ruby">
;repository

;repository download <scriptname>

;repository info <scriptname>

;repository list
</syntaxhighlight>

The first shows a Help screen and is the root command for all others.

The second, often shortened to ';repo down', lets you download a specified script.

Third, INFO provides information about whatever script is specified. If the author has been kind and thorough, this will tell you how to use the script and if it has any interdependencies.

Fourth, LIST will list all scripts in the repository.

==Updating Scripts==
The repository supports updates via prefedined scripts and the MapDatabase
To see a list of scripts you currently have set to updatable, <CODE>;repo show-updatable</CODE>.
For users on Lich 5+, you want <CODE>Lich: off</CODE> to be displayed.

To add a script to be updated, <CODE>;repo set-updatable <scriptname></CODE>.
To view scripts you have set to be auto-updated, <CODE>;repo show-updatable</CODE>.
It is only recommended to set scripts from authors you trust to auto-update.

If you want to remove, <CODE>;repo unset-updatable <scriptname></CODE>.

==Popular Lich Scripts==

<section begin=popularscripts />The following are a list of scripts that enhance or extend basic functions of Gemstone IV and can improve or streamline your gaming experience to a point where you can't think of ever going back. It's not all inclusive but contains a good starter set or some of the most popular scripts in use.
=== Core components installed with Lich ===

'''Generally speaking, the below scripts should not need to be updated manually by the user, especially if the user keeps up to date on the current lich version.'''
* [[Lich:Script Alias|alias]] - A default script used to create shortcuts in lich. See wiki page for details.
* [[Lich:Script Autostart|autostart]] - A default script to handle which scripts run on startup. See wiki page for details.
* [[Script Go2|go2]] - Go2 is an intelligent travel script that is synchronized to many of the more complex scripts. Go2 uses a Room Number system and can intelligently plot routes between most any two rooms in all of Elanthia. Use can be as simple as <code>;go2 town</code> or <code>;go2 bank</code> to head to the nearest town square or bank. Use <code>;go2 targets</code> to see a list of pre-programmed locations broken down by towns. Or, use <code>;go2 save <new location name>=<new location room number></code> to create your own locations. Go2 is distributed as part of a default Lich installation.
* [[Lich:Script Map|map]] - map (fork of Narost/XNarost) is an active map library that can display your location and allows Point-And-Click travel. Simply right click and choose a map, pick a room on it and click on it. map is distributed as part of a default Lich installation.
* [[Script Repository|repository]] - A default script to view and dowload other scripts. See wiki page for details.
* [[Lich:Script Vars|vars]] - A default script to create and view variables for both users and scripts. See wiki page for details.
* [[Lich:Script Version|version]] - A default script to output your current lich version and other information. See wiki page for details.

=== Scripts maintained by Elanthia-Online ===
* [[Lich:Script Bigshot|bigshot]] - A script for attacking and hunting routines. See wiki page for details.
* '''blackarts''' - A script for doing various [[alchemy]] tasks. <CODE>;blackarts setup</CODE> for configuration details
* [[Lich:Script Ebounty|ebounty]] - A script to get and perform bounties. See wiki page for details.
* '''ecaster''' - Allows user to type just the spell number and have lich cast that spell. Usage syntax is <code>;ecaster setup</code> for configuration. Set to autostart.
* '''echild''' - A child bounty script that monitors for and returns a child during bounty sessions. Add to autostart or your hunting script when performing a bounty.
* [[Lich:Script Ecleanse|ecleanse]] - A script for dealing with status conditions. See wiki page for details.
* '''ecure''' - A script for healing for empaths. Usage syntax is <code>;ecure setup</code> for first usage.
* [[Lich:Script Eherbs|eherbs]] - A herb heaing and stocking script. See wiki page for details.
* [[Lich:Script Eloot|eloot]] - A looting and loot management script. See wiki page for details.
* '''elogin''' - A script for command line login for your characters. . Usage syntax is <code>;elogin <charname></code>
* '''escortgo2''' - A script for bounty escorts. Usage syntax is <code>;escortgo2 help</code> for relevant commands (replaces ;ego2)
* [[Lich:Script Ewaggle|ewaggle]] - A script for spelling yourself and others up. See wiki page for details.
* '''ewander''' - The last of the Trifector of Travel, wander will move from room to room until it runs into a Boundary - a specified room number - or finds a room with a monster AND empty of players. Wander can be used to create a walled in hunting ground, letting you automatically move from room to room without having to use keystrokes. Use the <code>;wander add</code> command to add the room you are currently standing in to the Wander List. Note: Wander will NOT enter your boundary rooms. For example, adding Town Square East to the list and then executing ;wander from within the confines of Moot Hall will send your character exploring every room in Moot, but unable to leave as TSE is a Boundary.
* [[Lich:Script foreach|foreach]] - A script for sending a series of commands for each item that matches its criteria. See wiki page for details.
* '''jbackup ''' - A excellent backup and recovery tool that allows lich database and any additional file backup a user prefers. Set to autostart.
* '''ledger''' - A scripting for tracking your silver and bounty incoming across sessios and over time per character and account with a nice ascii discplay. Requires ascii_charts gem (installed by default with Lich 5.7.0+ full installer)
* '''signore ''' - A script for using society powers <CODE>;signore setup</CODE> for configuration
* '''resource''' - A script for determining your current player service bonus. <CODE> ;resource bonus </CODE> Can also be used to determine the cost of enchanting with the syntanx ;Resource calc <starting enchant> <ending enchant> <cost per essence> as in <CODE>;resource calc 35 45 50</CODE>
* '''uberbar_eo ''' - The most current Uberbar variant. This will provide a paperdoll with room number, resource information, etc inside wrayth. Set to autostart. Note- there is a small performance impact when using Uberbars.

=== Other scripts that are popular ===
* '''character-planner ''' - A script for planning out your character skills and training. <CODE>;character-planner</CODE> for configuration
* '''colmaster ''' - A script for getting and performing COL tasks in Solhaven
* '''dirty-deeds ''' - A script for getting deeds in IMT and WL. <CODE>;dirty-deeds setup</CODE> for configuration
* [[Script invdb|invdb]] - An inventory management database. See wiki page for details
* '''linktothefast''' - A complex script that provides highliting for Wryath links when links are disabled. This script can cause issues with [[STOW]] settings, so disable prior to adjusting those settings.
* [[Script LNet|lnet]] - An out of game, third party, not Simutronics controlled chat server. <CODE>;repo download lnet --author=elanthia-online</CODE>. See wiki page for details '''LNET should be installed at your own risk'''. Simutronics has no control over lnet or policy enforcement there.
* '''multi''' - A script to peform repetitive set of commands. Usage syntax is <code>;multi; <number> <action></code> such as <code>;multi 10, get my diamond, drop my diamond</code>
* '''rogues''' - A script for rogue guild tasks <CODE>;rogues setup</CODE> for configuration
* '''sorter ''' Sorter cleans up your bags and breaks down the the output of a LOOK command, sorting the results by type. Makes looking in your locker or backpack, and especially your gem pouch, infinitely easier. *Note* Sorter can mess up some other scripts that deal with inventory, so be cautious in usage. Elanthia-Online scripts like eloot disable sorter when performing relevant functions
* '''stat-maximizer''' - A script for configuring character stats. <CODE>;stat-maximizer</CODE> for configuration
* '''tpick''' - A script for lockpicking <CODE>;tpick setup</CODE> for configuration
* '''volnstep ''' - A script for performing voln tasks in Wehnimer's Landing
* '''warrior''' - A script for warrior guild tasks <CODE>;warrior setup</CODE> for configuration
<section end=popularscripts />

==In-game Help Output==
<PRE>Usage:

;repository list [alpha] lists all scripts available for download (optionally in alphabetial order)
;repository sync [alpha] lists only new and/or updated scripts
;repository info <script name> shows the comments at the top of the script
;repository download <script name> downloads the script
;repository upload <script name> uploads the script
;repository delete <script name> deletes the script from the server

Scripts should include comments at the top describing the purpose of the script. Scripts without comments at the top will not show up on the server.

After uploading a script, a key that allows you to delete/update the script will be saved to C:/Games/lich/keys</PRE>

==Sortable list==
The repository script has an in game GUI available that allows sorting by date, tags, etc.
<CODE>;repo gui</CODE>

==Jinx (Repository alternative)==

Jinx is a project that is an alternative form of script installation from the default ;repository. It can serve up scripts for download similar to the ;repo however it is not dependent on a single server that may be prone to outages. Any one can set up their own script library, and then users can add it as a source for the ;jinx script to search and download from.

Jinx is installed in the default Lich5 package. Jinx can be downloaded and installed into your scripts folder from the Elanthia Online github

https://raw.githubusercontent.com/elanthia-online/scripts/master/scripts/jinx.lic

Right-click the above link and save it into the scripts folder in your lich directory.

Alternatively, the following command can be issued in game via lich to attempt to download the script to the proper directory for you (this command is for when the repository is down and the script cannot be downloaded naturally):
<syntaxhighlight lang="ruby">
;e require 'open-uri';begin;jinx_remote = open("https://raw.githubusercontent.com/elanthia-online/scripts/master/scripts/jinx.lic"); jinx_local = File.open(File.join(SCRIPT_DIR, 'jinx.lic'), "wb"); jinx_local.write(jinx_remote.read);ensure; jinx_remote.close(); jinx_local.close();end</syntaxhighlight>

once installed you can issue: <CODE>;jinx help</CODE> for basic usage information.

===Jinx Lich Repository Mirror===
In the event the main <code>;repository</code> is unavailable, there is currently an actively maintained <code>;jinx</code> repository that is a direct mirror.

https://github.com/FarFigNewGut/lich_repo_mirror

Scripts can be manually retrieved from this Github repository (they are all located in the lib folder). The repository is also packaged and published for use directly with Jinx:

<syntaxhighlight lang="ruby">
;jinx repo add ffnglichrepoarchive https://ffnglichrepoarchive.netlify.app
</syntaxhighlight>
(You can use something shorter instead of "ffnglichrepoarchive" for the repo name if you'd like.)

Once it is setup as a source for <code>;jinx</code> you can install any scripts from the repo with:

<syntaxhighlight lang="ruby">
# install script for the first time
;jinx script install <script name> --repo=ffnglichrepoarchive

# update previously installed script
;jinx script update <script name> --repo=ffnglichrepoarchive
</syntaxhighlight>

For example if you wanted to download or update invdb.lic:
<syntaxhighlight lang="ruby">
# first install
;jinx script install invdb --repo=ffnglichrepoarchive

# update if you had previously downloaded invdb.lic
;jinx script update invdb --repo=ffnglichrepoarchive
</syntaxhighlight>

Do note, if a script is not available on the archive, it's likely because it belongs to Elanthia-Online and those scripts are not found within the archive, but under a default repo that is configured with jinx. To use it, you would do the following, using bigshot.lic as an example
<syntaxhighlight lang="ruby">
# first install
;jinx script install bigshot--repo=elanthia-online

# update if you had previously downloaded bigshot.lic
;jinx script update bigshot --repo=elanthia-online
</syntaxhighlight>

You can also leave the <code>--repo=<REPO_NAME></code> off to see all available options for a script that is found.

===Jinx Lich Repository Offline Update Info===
At times the default Lich repository (accessed via <code>;repo</code>) can go offline, below are some helpful commands to update core Lich related functionality using Jinx.

<syntaxhighlight lang="ruby">
# ensure running latest jinx.lic for newest compatibility
;jinx script update jinx.lic --repo=elanthia-online

# update spell-list.xml for new spells, cmans, cooldowns, etc
;jinx data update spell-list.xml --repo=elanthia-online

# update gameobj-data.xml for proper classification of NPCs and items
;jinx data update gameobj-data.xml --repo=core

# update mapdb and associated missing map files for graphical use
;jinx data update mapdb.json --repo=core

# update infomon for proper ingame tracking of skills, stats, spells, effects
;jinx script update infomon.lic --repo=elanthia-online
</syntaxhighlight>

==In-game Screenshot==
<gallery perrow="4">
File:Repo-1.png|Repo
</gallery>

{{Third-Party Software}}

Lich:Script Repository

2025-04-04T13:45:49Z

WHIGHTCNIGHT: /* Other scripts that are popular */ remove wander as ewander now available

{{3rd-party}}
The repository, owned by Tillmen, is the most common location for downloading scripts that are not pre-installed with Lich.

==How to Use the Repository==

The repository has four basic commands:

<syntaxhighlight lang="ruby">
;repository

;repository download <scriptname>

;repository info <scriptname>

;repository list
</syntaxhighlight>

The first shows a Help screen and is the root command for all others.

The second, often shortened to ';repo down', lets you download a specified script.

Third, INFO provides information about whatever script is specified. If the author has been kind and thorough, this will tell you how to use the script and if it has any interdependencies.

Fourth, LIST will list all scripts in the repository.

==Updating Scripts==
The repository supports updates via prefedined scripts and the MapDatabase
To see a list of scripts you currently have set to updatable, <CODE>;repo show-updatable</CODE>.
For users on Lich 5+, you want <CODE>Lich: off</CODE> to be displayed.

To add a script to be updated, <CODE>;repo set-updatable <scriptname></CODE>.
To view scripts you have set to be auto-updated, <CODE>;repo show-updatable</CODE>.
It is only recommended to set scripts from authors you trust to auto-update.

If you want to remove, <CODE>;repo unset-updatable <scriptname></CODE>.

==Popular Lich Scripts==

<section begin=popularscripts />The following are a list of scripts that enhance or extend basic functions of Gemstone IV and can improve or streamline your gaming experience to a point where you can't think of ever going back. It's not all inclusive but contains a good starter set or some of the most popular scripts in use.
=== Core components installed with Lich ===

'''Generally speaking, the below scripts should not need to be updated manually by the user, especially if the user keeps up to date on the current lich version.'''
* [[Lich:Script Alias|alias]] - A default script used to create shortcuts in lich. See wiki page for details.
* [[Lich:Script Autostart|autostart]] - A default script to handle which scripts run on startup. See wiki page for details.
* [[Script Go2|go2]] - Go2 is an intelligent travel script that is synchronized to many of the more complex scripts. Go2 uses a Room Number system and can intelligently plot routes between most any two rooms in all of Elanthia. Use can be as simple as <code>;go2 town</code> or <code>;go2 bank</code> to head to the nearest town square or bank. Use <code>;go2 targets</code> to see a list of pre-programmed locations broken down by towns. Or, use <code>;go2 save <new location name>=<new location room number></code> to create your own locations. Go2 is distributed as part of a default Lich installation.
* [[Lich:Script Map|map]] - map (fork of Narost/XNarost) is an active map library that can display your location and allows Point-And-Click travel. Simply right click and choose a map, pick a room on it and click on it. map is distributed as part of a default Lich installation.
* [[Script Repository|repository]] - A default script to view and dowload other scripts. See wiki page for details.
* [[Lich:Script Vars|vars]] - A default script to create and view variables for both users and scripts. See wiki page for details.
* [[Lich:Script Version|version]] - A default script to output your current lich version and other information. See wiki page for details.

=== Scripts maintained by Elanthia-Online ===
* [[Lich:Script Bigshot|bigshot]] - A script for attacking and hunting routines. See wiki page for details.
* '''blackarts''' - A script for doing various [[alchemy]] tasks. <CODE>;blackarts setup</CODE> for configuration details
* [[Lich:Script Ebounty|ebounty]] - A script to get and perform bounties. See wiki page for details.
* '''ecaster''' - Allows user to type just the spell number and have lich cast that spell. Usage syntax is <code>;ecaster setup</code> for configuration. Set to autostart.
* '''echild''' - A child bounty script that monitors for and returns a child during bounty sessions. Add to autostart or your hunting script when performing a bounty.
* [[Lich:Script Ecleanse|ecleanse]] - A script for dealing with status conditions. See wiki page for details.
* '''ecure''' - A script for healing for empaths. Usage syntax is <code>;ecure setup</code> for first usage.
* [[Lich:Script Eherbs|eherbs]] - A herb heaing and stocking script. See wiki page for details.
* [[Lich:Script Eloot|eloot]] - A looting and loot management script. See wiki page for details.
* '''elogin''' - A script for command line login for your characters. . Usage syntax is <code>;elogin <charname></code>
* '''escortgo2''' - A script for bounty escorts. Usage syntax is <code>;escortgo2 help</code> for relevant commands (replaces ;ego2)
* [[Lich:Script Ewaggle|ewaggle]] - A script for spelling yourself and others up. See wiki page for details.
* [[Lich:Script foreach|foreach]] - A script for sending a series of commands for each item that matches its criteria. See wiki page for details.
* '''jbackup ''' - A excellent backup and recovery tool that allows lich database and any additional file backup a user prefers. Set to autostart.
* '''ledger''' - A scripting for tracking your silver and bounty incoming across sessios and over time per character and account with a nice ascii discplay. Requires ascii_charts gem (installed by default with Lich 5.7.0+ full installer)
* '''signore ''' - A script for using society powers <CODE>;signore setup</CODE> for configuration
* '''resource''' - A script for determining your current player service bonus. <CODE> ;resource bonus </CODE> Can also be used to determine the cost of enchanting with the syntanx ;Resource calc <starting enchant> <ending enchant> <cost per essence> as in <CODE>;resource calc 35 45 50</CODE>
* '''uberbar_eo ''' - The most current Uberbar variant. This will provide a paperdoll with room number, resource information, etc inside wrayth. Set to autostart. Note- there is a small performance impact when using Uberbars.

=== Other scripts that are popular ===
* '''character-planner ''' - A script for planning out your character skills and training. <CODE>;character-planner</CODE> for configuration
* '''colmaster ''' - A script for getting and performing COL tasks in Solhaven
* '''dirty-deeds ''' - A script for getting deeds in IMT and WL. <CODE>;dirty-deeds setup</CODE> for configuration
* [[Script invdb|invdb]] - An inventory management database. See wiki page for details
* '''linktothefast''' - A complex script that provides highliting for Wryath links when links are disabled. This script can cause issues with [[STOW]] settings, so disable prior to adjusting those settings.
* [[Script LNet|lnet]] - An out of game, third party, not Simutronics controlled chat server. <CODE>;repo download lnet --author=elanthia-online</CODE>. See wiki page for details '''LNET should be installed at your own risk'''. Simutronics has no control over lnet or policy enforcement there.
* '''multi''' - A script to peform repetitive set of commands. Usage syntax is <code>;multi; <number> <action></code> such as <code>;multi 10, get my diamond, drop my diamond</code>
* '''rogues''' - A script for rogue guild tasks <CODE>;rogues setup</CODE> for configuration
* '''sorter ''' Sorter cleans up your bags and breaks down the the output of a LOOK command, sorting the results by type. Makes looking in your locker or backpack, and especially your gem pouch, infinitely easier. *Note* Sorter can mess up some other scripts that deal with inventory, so be cautious in usage. Elanthia-Online scripts like eloot disable sorter when performing relevant functions
* '''stat-maximizer''' - A script for configuring character stats. <CODE>;stat-maximizer</CODE> for configuration
* '''tpick''' - A script for lockpicking <CODE>;tpick setup</CODE> for configuration
* '''volnstep ''' - A script for performing voln tasks in Wehnimer's Landing
* '''warrior''' - A script for warrior guild tasks <CODE>;warrior setup</CODE> for configuration
<section end=popularscripts />

==In-game Help Output==
<PRE>Usage:

;repository list [alpha] lists all scripts available for download (optionally in alphabetial order)
;repository sync [alpha] lists only new and/or updated scripts
;repository info <script name> shows the comments at the top of the script
;repository download <script name> downloads the script
;repository upload <script name> uploads the script
;repository delete <script name> deletes the script from the server

Scripts should include comments at the top describing the purpose of the script. Scripts without comments at the top will not show up on the server.

After uploading a script, a key that allows you to delete/update the script will be saved to C:/Games/lich/keys</PRE>

==Sortable list==
The repository script has an in game GUI available that allows sorting by date, tags, etc.
<CODE>;repo gui</CODE>

==Jinx (Repository alternative)==

Jinx is a project that is an alternative form of script installation from the default ;repository. It can serve up scripts for download similar to the ;repo however it is not dependent on a single server that may be prone to outages. Any one can set up their own script library, and then users can add it as a source for the ;jinx script to search and download from.

Jinx is installed in the default Lich5 package. Jinx can be downloaded and installed into your scripts folder from the Elanthia Online github

https://raw.githubusercontent.com/elanthia-online/scripts/master/scripts/jinx.lic

Right-click the above link and save it into the scripts folder in your lich directory.

Alternatively, the following command can be issued in game via lich to attempt to download the script to the proper directory for you (this command is for when the repository is down and the script cannot be downloaded naturally):
<syntaxhighlight lang="ruby">
;e require 'open-uri';begin;jinx_remote = open("https://raw.githubusercontent.com/elanthia-online/scripts/master/scripts/jinx.lic"); jinx_local = File.open(File.join(SCRIPT_DIR, 'jinx.lic'), "wb"); jinx_local.write(jinx_remote.read);ensure; jinx_remote.close(); jinx_local.close();end</syntaxhighlight>

once installed you can issue: <CODE>;jinx help</CODE> for basic usage information.

===Jinx Lich Repository Mirror===
In the event the main <code>;repository</code> is unavailable, there is currently an actively maintained <code>;jinx</code> repository that is a direct mirror.

https://github.com/FarFigNewGut/lich_repo_mirror

Scripts can be manually retrieved from this Github repository (they are all located in the lib folder). The repository is also packaged and published for use directly with Jinx:

<syntaxhighlight lang="ruby">
;jinx repo add ffnglichrepoarchive https://ffnglichrepoarchive.netlify.app
</syntaxhighlight>
(You can use something shorter instead of "ffnglichrepoarchive" for the repo name if you'd like.)

Once it is setup as a source for <code>;jinx</code> you can install any scripts from the repo with:

<syntaxhighlight lang="ruby">
# install script for the first time
;jinx script install <script name> --repo=ffnglichrepoarchive

# update previously installed script
;jinx script update <script name> --repo=ffnglichrepoarchive
</syntaxhighlight>

For example if you wanted to download or update invdb.lic:
<syntaxhighlight lang="ruby">
# first install
;jinx script install invdb --repo=ffnglichrepoarchive

# update if you had previously downloaded invdb.lic
;jinx script update invdb --repo=ffnglichrepoarchive
</syntaxhighlight>

Do note, if a script is not available on the archive, it's likely because it belongs to Elanthia-Online and those scripts are not found within the archive, but under a default repo that is configured with jinx. To use it, you would do the following, using bigshot.lic as an example
<syntaxhighlight lang="ruby">
# first install
;jinx script install bigshot--repo=elanthia-online

# update if you had previously downloaded bigshot.lic
;jinx script update bigshot --repo=elanthia-online
</syntaxhighlight>

You can also leave the <code>--repo=<REPO_NAME></code> off to see all available options for a script that is found.

===Jinx Lich Repository Offline Update Info===
At times the default Lich repository (accessed via <code>;repo</code>) can go offline, below are some helpful commands to update core Lich related functionality using Jinx.

<syntaxhighlight lang="ruby">
# ensure running latest jinx.lic for newest compatibility
;jinx script update jinx.lic --repo=elanthia-online

# update spell-list.xml for new spells, cmans, cooldowns, etc
;jinx data update spell-list.xml --repo=elanthia-online

# update gameobj-data.xml for proper classification of NPCs and items
;jinx data update gameobj-data.xml --repo=core

# update mapdb and associated missing map files for graphical use
;jinx data update mapdb.json --repo=core

# update infomon for proper ingame tracking of skills, stats, spells, effects
;jinx script update infomon.lic --repo=elanthia-online
</syntaxhighlight>

==In-game Screenshot==
<gallery perrow="4">
File:Repo-1.png|Repo
</gallery>

{{Third-Party Software}}

Lich:Software/Installation

2025-03-27T15:06:28Z

WHIGHTCNIGHT: updated version to 5.11.1