Lich:Script Repository: Difference between revisions

The official GemStone IV encyclopedia.
Jump to navigation Jump to search
No edit summary
(→‎Jinx Lich Repository Mirror: added additional information about jinx usage)
 
(28 intermediate revisions by 4 users not shown)
Line 32: Line 32:
To view scripts you have set to be auto-updated, <CODE>;repo show-updatable</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.
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==
==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.
<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 Lich components installed with lich ===
=== Core components installed with Lich ===

* [[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.
'''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 Xnarost|Xnarost]] - Narost 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. Xnarost is distributed as part of a default Lich installation.

* [[Lich:Script Alias|Alias]] - A default script used to create shortcuts in lich. 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 Vars|Vars]] - A default script to create and view variables for both users and scripts. See wiki page for details.
* [[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.
* [[Lich:Script Autostart|Autostart]] - A default script to handle which scripts run on startup. See wiki page for details.
* [[Script Repository|Repository]] - A default script to view and dowload other scripts. See wiki page for details.
* [[Lich:Script Alias|alias]] - A default script used to create shortcuts in lich. 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.
* [[Lich:Script Vars|vars]] - A default script to create and view variables for both users and scripts. 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 Repository|repository]] - A default script to view and dowload other 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 ===
=== Scripts maintained by Elanthia-Online ===
* [[Lich:Script Ewaggle|Ewaggle]] - A script for spelling yourself and others up. See wiki page for details.
* [[Lich:Script Bigshot|bigshot]] - A script for attacking and hunting routines. See wiki page for details.
* [[Lich:Script Ebounty|Ebounty]] - A script to get and perform bounties. See wiki page for details.
* '''blackarts''' - A script for doing various [[alchemy]] tasks. <CODE>;blackarts setup</CODE> for configuration details
* [[Lich:Script Eloot|Eloot]] - A looting and loot management script. See wiki page for details.
* [[Lich:Script Ewaggle|ewaggle]] - A script for spelling yourself and others up. See wiki page for details.
* [[Lich:Script Ecleanse|Ecleanse]] - A script for dealing with status conditions. See wiki page for details.
* [[Lich:Script Ebounty|ebounty]] - A script to get and perform bounties. See wiki page for details.
* [[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.
* '''Ecure''' - A script for healing for empaths. Usage syntax is <code>;ecure setup</code> for first usage.
* [[Lich:Script Ecleanse|ecleanse]] - A script for dealing with status conditions. See wiki page for details.
* [[Lich:Script Eherbs|eherbs]] - A herb heaing and stocking script. See wiki page for details.
* '''Elogin''' - A script for command line login for your characters. . Usage syntax is <code>;elogin <charname></code>
* '''ecure''' - A script for healing for empaths. Usage syntax is <code>;ecure setup</code> for first usage.
* '''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.
* '''elogin''' - A script for command line login for your characters. . Usage syntax is <code>;elogin <charname></code>
* '''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 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>
* '''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.


=== Other scripts that are popular ===
=== Other scripts that are popular ===
* [[Script invdb|invdb]] - An inventory management database. See wiki page for details
* [[Script invdb|invdb]] - An inventory management database. See wiki page for details
* [[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>
* '''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>
* '''ego2''' - A script for bounty escorts. Usage syntax is <code>;ego2 help</code> for relevant commands.
* '''ego2''' - A script for bounty escorts. Usage syntax is <code>;ego2 help</code> for relevant commands.
* '''spellcaster''' - Allows user to type just the spell number and have lich cast that spell. Usage syntax is <code>;Spellcaster setup</code> for configuration. Set to autostart.
* '''wander''' - 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.
* '''wander''' - 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.
* '''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
* '''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
* '''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.
* '''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.
* '''Uberbarv_D ''' - 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.
* '''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.
* '''dirty-deeds ''' - A script for getting deeds in IMT and WL. <CODE>;dirty-deeds setup</CODE> for configuration
* '''Jbackup ''' - A excellent backup and recovery tool that allows lich database and any additional file backup a user prefers. Set to autostart.
* '''dirty-deeds ''' - A script for getting deeds in IMT and WL. <CODE>;dirty-deeds setup</CODE> for configuration
* '''colmaster ''' - A script for getting and performing COL tasks in Solhaven
* '''volnstep ''' - A script for performing voln tasks in Wehnimer's Landing
* '''character-planner ''' - A script for planning out your character skills and training. <CODE>;character-planner</CODE> for configuration
* '''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
* '''warrior''' - A script for warrior guild tasks <CODE>;warrior setup</CODE> for configuration
* '''rogues''' - A script for rogue guild tasks <CODE>;rogues setup</CODE> for configuration
<section end=popularscripts /><!--- Add any additional popular scripts to the list ABOVE this line. --->
<section end=popularscripts /><!--- Add any additional popular scripts to the list ABOVE this line. --->


Line 90: Line 109:
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 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 is installed in the default Lich5 package. Jinx can be downloaded and installed into your scripts folder from the Elanthia Online github
<div class="mw-customtoggle-kestrels" style="font-size:16px;overflow:auto;color:#0000FF">[Click to Expand For more information]</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-kestrels">
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
https://raw.githubusercontent.com/elanthia-online/scripts/master/scripts/jinx.lic
Line 135: Line 151:
;jinx script update invdb --repo=ffnglichrepoarchive
;jinx script update invdb --repo=ffnglichrepoarchive
</syntaxhighlight>
</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===
===Jinx Lich Repository Offline Update Info===
Line 155: Line 182:
;jinx script update infomon.lic --repo=elanthia-online
;jinx script update infomon.lic --repo=elanthia-online
</syntaxhighlight>
</syntaxhighlight>
</div>


==In-game Screenshot==
==In-game Screenshot==
<gallery perrow="4">
<gallery perrow="4">
File:Repo-1.png|Profiles
File:Repo-1.png|Repo
</gallery>
</gallery>



Latest revision as of 20:12, 4 September 2024

Lich:Script Repository is a third party script and is not maintained by Simutronics. Simutronics is not responsible for the accuracy of the information presented on this page, nor is it liable for issues stemming from the use of the application on players' personal devices.

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:

;repository

;repository download <scriptname>

;repository info <scriptname>

;repository list

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, ;repo show-updatable. For users on Lich 5+, you want Lich: off to be displayed.

To add a script to be updated, ;repo set-updatable <scriptname>. To view scripts you have set to be auto-updated, ;repo show-updatable. It is only recommended to set scripts from authors you trust to auto-update.

If you want to remove, ;repo unset-updatable <scriptname>.

Popular Lich Scripts

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.

  • 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 ;go2 town or ;go2 bank to head to the nearest town square or bank. Use ;go2 targets to see a list of pre-programmed locations broken down by towns. Or, use ;go2 save <new location name>=<new location room number> to create your own locations. Go2 is distributed as part of a default Lich installation.
  • 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.
  • alias - A default script used to create shortcuts in lich. See wiki page for details.
  • vars - A default script to create and view variables for both users and scripts. See wiki page for details.
  • autostart - A default script to handle which scripts run on startup. See wiki page for details.
  • repository - A default script to view and dowload other scripts. See wiki page for details.
  • version - A default script to output your current lich version and other information. See wiki page for details.

Scripts maintained by Elanthia-Online

  • bigshot - A script for attacking and hunting routines. See wiki page for details.
  • blackarts - A script for doing various alchemy tasks. ;blackarts setup for configuration details
  • ewaggle - A script for spelling yourself and others up. See wiki page for details.
  • ebounty - A script to get and perform bounties. See wiki page for details.
  • eloot - A looting and loot management script. See wiki page for details.
  • ecleanse - A script for dealing with status conditions. See wiki page for details.
  • eherbs - A herb heaing and stocking script. See wiki page for details.
  • ecure - A script for healing for empaths. Usage syntax is ;ecure setup for first usage.
  • elogin - A script for command line login for your characters. . Usage syntax is ;elogin <charname>
  • 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.
  • 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 ;signore setup for configuration
  • resource - A script for determining your current player service bonus. ;resource bonus Can also be used to determine the cost of enchanting with the syntanx ;Resource calc <starting enchant> <ending enchant> <cost per essence> as in ;resource calc 35 45 50
  • ecaster - Allows user to type just the spell number and have lich cast that spell. Usage syntax is ;ecaster setup for configuration. Set to autostart.

Other scripts that are popular

  • invdb - An inventory management database. See wiki page for details
  • lnet - An out of game, third party, not Simutronics controlled chat server. ;repo download lnet --author=elanthia-online. 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 ;multi; <number> <action> such as ;multi 10, get my diamond, drop my diamond
  • ego2 - A script for bounty escorts. Usage syntax is ;ego2 help for relevant commands.
  • wander - 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 ;wander add 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.
  • 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
  • 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.
  • 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.
  • dirty-deeds - A script for getting deeds in IMT and WL. ;dirty-deeds setup for configuration
  • colmaster - A script for getting and performing COL tasks in Solhaven
  • volnstep - A script for performing voln tasks in Wehnimer's Landing
  • character-planner - A script for planning out your character skills and training. ;character-planner for configuration
  • stat-maximizer - A script for configuring character stats. ;stat-maximizer for configuration
  • tpick - A script for lockpicking ;tpick setup for configuration
  • warrior - A script for warrior guild tasks ;warrior setup for configuration
  • rogues - A script for rogue guild tasks ;rogues setup for configuration


In-game Help Output

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

Sortable list

The repository script has an in game GUI available that allows sorting by date, tags, etc. ;repo gui

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

;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

once installed you can issue: ;jinx help for basic usage information.

Jinx Lich Repository Mirror

In the event the main ;repository is unavailable, there is currently an actively maintained ;jinx 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:

;jinx repo add ffnglichrepoarchive https://ffnglichrepoarchive.netlify.app

(You can use something shorter instead of "ffnglichrepoarchive" for the repo name if you'd like.)

Once it is setup as a source for ;jinx you can install any scripts from the repo with:

# install script for the first time
;jinx script install <script name> --repo=ffnglichrepoarchive

# update previously installed script
;jinx script update <script name> --repo=ffnglichrepoarchive

For example if you wanted to download or update invdb.lic:

# first install
;jinx script install invdb --repo=ffnglichrepoarchive

# update if you had previously downloaded invdb.lic
;jinx script update invdb --repo=ffnglichrepoarchive

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

# first install
;jinx script install bigshot--repo=elanthia-online

# update if you had previously downloaded bigshot.lic
;jinx script update bigshot --repo=elanthia-online

You can also leave the --repo=<REPO_NAME> 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 ;repo) can go offline, below are some helpful commands to update core Lich related functionality using Jinx.

# 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

In-game Screenshot

Third-Party Software - edit
Lich Installation: Lich
Downloadable Lich Scripts: Go2 | Map | Repository | Popular Scripts