Tools: Difference between revisions

From A KoL Wiki
imported>Bale
imported>Akatosh
m KoLmafia: - link to loathers
 
(9 intermediate revisions by 7 users not shown)
Line 6: Line 6:


__TOC__
__TOC__
==Alternate User Interfaces==
==Advanced User Interfaces==
These tools are freestanding and run outside the normal browser security sandbox, which allows for more powerful features such as logging your ascensions to your hard disk and automating tasks.
These tools are freestanding and run outside the normal browser security sandbox, which allows for more powerful features such as logging your ascensions and automated adventuring.


===KoLmafia===
===KoLmafia===
*Provides an improved web browser interface, a graphical window interface, and a textual command-line interface as alternatives for playing KoL.
*Has many many features, with various functionality for every part of KoL, and a large [http://kolmafia.us/forumdisplay.php?3-Repository scripting community]. You can obtain many useful scripts from [https://github.com/loathers Loathers.]
*Is a cross-platform desktop interface to KoL, written by '''holatuwol''' and others.
*Is a cross-platform desktop interface to KoL, written by '''holatuwol''' and others.
*Is written in [[Wikipedia:Java (programming language)|Java]] and requires the [http://www.java.com/en/download/index.jsp Java Runtime Environment (JRE)] to run.
*Open Source with code available to build, edit or inspect in a [https://github.com/kolmafia/kolmafia GitHub repository].
*Provides an improved web browser interface, a graphical window interface, and a textual command-line interface as alternatives for playing KoL.
*Is written in [[Wikipedia:Java (programming language)|Java]] and requires [https://adoptium.net Java Development Kit (JDK)] 11 or newer to run.
*Has many many features, with various functionality for every part of KoL.
*JDK 17 is supported and recommended.
*Can be scripted using KoLmafia's own ASH scripting language.
*Can be scripted using KoLmafia's own [http://wiki.kolmafia.us/index.php?title=ASH_For_Beginners ASH] scripting language.
*Forum thread is located [http://forums.kingdomofloathing.com:8080/vb/showthread.php?t=186011 here].
*Forum thread is located [http://forums.kingdomofloathing.com/vb/showthread.php?t=186011 here].
*Availability:
*Availability:
**The latest stable version is available [http://sourceforge.net/projects/kolmafia/files/ here].
**The latest versions are available [http://builds.kolmafia.us/ here].  
**The latest unstable versions are available [http://builds.kolmafia.us/ here]. This is actually the recommended link because it tries to keep up with KoL's latest updates and changes.
**The [https://github.com/kolmafia/kolmafia/releases/latest latest release] on GitHub has packaged builds including a JRE for Windows (.exe), MacOS (.dmg), and Debian (.deb)


===Kolproxy===
===Kolproxy===
*Enhances the web browser interface for playing KoL, with features not available from browser scripts.
*'''No longer maintained'''
*Has a strong focus on correctness and helping the player ascend better, with many included warnings for mistakes and misclicks.
*Enhances the web browser interface for playing KoL. Built to provide better support for ascension and automation, without surprises or gotchas.
*Can be scripted using Lua (and the included interface enhancements are also Lua scripts).
*Focused on helping players ascend better (suitable for newbies to #1 leaderboarders depending on settings), and automating entire quests or ascensions. Limited support for non-ascension-relevant content.
*Can be scripted using [[Wikipedia:Lua (programming language)|Lua]], a popular programming language for video games. (Kolproxy's features are also implemented as Lua scripts.)
*Forum thread is located [http://forums.kingdomofloathing.com/vb/showthread.php?t=180265 here].
*Forum thread is located [http://forums.kingdomofloathing.com/vb/showthread.php?t=180265 here].
*Available for Windows, Mac, Linux (and as source code).
*Available for Windows, Mac, Linux (and as source code).
*The latest version and more information is available at the [http://www.houeland.com/kolproxy/wiki/ kolproxy wiki].
*The latest version and more information is available at [https://github.com/houeland/kolproxy/ https://github.com/houeland/kolproxy/] and the [http://www.houeland.com/kolproxy/wiki/ kolproxy wiki].
 
Support for using both KoLmafia and kolproxy in the same session is limited, and requires recompiling KoLmafia yourself with a compatibility patch. Usually players using both instead log off/on again to switch between the two depending on what they're doing.


==Scripts & Scriptlets==
==Scripts & Scriptlets==
Line 35: Line 40:
Scriptlets are usually run by entering "javascript:''SCRIPT''" in the address bar of a web browser. They can also be bookmarked for easier use. Some scriptlets are browser-dependent.
Scriptlets are usually run by entering "javascript:''SCRIPT''" in the address bar of a web browser. They can also be bookmarked for easier use. Some scriptlets are browser-dependent.


*'''[[User:Ohayou|Ohayou]]''' has written a multitude of handy scriptlets. His Repeat Action Scriptlet has been revised in [http://forums.kingdomofloathing.com:8080/vb/showthread.php?t=119658 this forum thread]. Also popular is his [http://forums.kingdomofloathing.com:8080/vb/showthread.php?t=174943 UI improvements script], which not only logs and displays his item effect logging scriptlet, but also combines a variety of his other scriptlets.
*'''[[User:Ohayou|Ohayou]]''' has written a multitude of handy scriptlets. His Repeat Action Scriptlet has been revised in [http://forums.kingdomofloathing.com/vb/showthread.php?t=119658 this forum thread]. Also popular is his [http://forums.kingdomofloathing.com/vb/showthread.php?t=174943 UI improvements script], which not only logs and displays his item effect logging scriptlet, but also combines a variety of his other scriptlets.


==Greasemonkey User Scripts==
==Greasemonkey User Scripts==
[https://addons.mozilla.org/en-US/firefox/addon/greasemonkey/ Greasemonkey] is an extension for the [[Wikipedia:Firefox|Firefox]] web browser that provides a framework for user scripts to be written to automatically be invoked when you visit a particular page.
[https://addons.mozilla.org/en-US/firefox/addon/greasemonkey/ Greasemonkey] is an extension for the [[Wikipedia:Firefox|Firefox]] web browser that provides a framework for user scripts to be written to automatically be invoked when you visit a particular page.


In-depth instructions on using Greasemonkey are available at [http://forums.kingdomofloathing.com:8080/vb/showthread.php?t=136174 this forum post], courtesy of '''Aprocalypse'''.
In-depth instructions on using Greasemonkey are available at [http://forums.kingdomofloathing.com/vb/showthread.php?t=136174 this forum post], courtesy of '''Aprocalypse'''.


The following scripts all require Greasemonkey.   
The following scripts all require Greasemonkey.   
Line 52: Line 57:
For a more complete list, see the [[list of Greasemonkey scripts]].
For a more complete list, see the [[list of Greasemonkey scripts]].


==Stylish==
==Stylus==
[https://addons.mozilla.org/en-US/firefox/addon/stylish/ Stylish] is a [[Wikipedia:Firefox|Firefox]] extension that is similar to Greasemonkey, but is more visual than functional in nature. KoL Stylish scripts include one that labels chat mods and one that colorizes a menu to highlight HP and MP Restorers.
[https://addons.mozilla.org/en-US/firefox/addon/styl-us/ Stylus] is a replacement for the old [https://addons.mozilla.org/en-US/firefox/addon/stylish/ Stylish] extension that is similar to Greasemonkey, but is more visual than functional in nature. KoL Stylish scripts include one that labels chat mods and one that colorizes a menu to highlight HP and MP Restorers.  [https://chrome.google.com/webstore/detail/stylus/clngdbkpkpeebahjckkjfobafhncgmne Chrome] and [https://addons.opera.com/en/extensions/details/stylus/ Opera] versions of the extension also exist.


For more information, see the [http://userstyles.org/ Stylish website] and a [http://userstyles.org/styles/browse/kingdomofloathing list of KoL Stylish scripts].
For more information, see the [https://add0n.com/stylus.html Stylus website] and a [http://userstyles.org/styles/browse/kingdomofloathing list of KoL Stylish scripts].


==Web-Based Tools==
==Web-Based Tools==
Line 63: Line 68:
*[http://www.retrofrog.hardcoreoxygenation.com/ RetroFrog's KoL Tools] page contains tools for consumption, skills, familiars, and more.
*[http://www.retrofrog.hardcoreoxygenation.com/ RetroFrog's KoL Tools] page contains tools for consumption, skills, familiars, and more.
*[http://www.acme.com/jef/kol/warmeat/ Jef's War Meat Optimizer] lets you calculate the best combination of smashing, nickel-and-diming, and selling war items in the mall for the highest possible profit.
*[http://www.acme.com/jef/kol/warmeat/ Jef's War Meat Optimizer] lets you calculate the best combination of smashing, nickel-and-diming, and selling war items in the mall for the highest possible profit.
*[http://www.houeland.com/kol/diets Eleron's KoL diet lists] display the optimal aftercore diets based on current mall prices.
*[http://www.lethe.xyz/kol/diets.php tehtmi's Kingdom of Loathing diet calculator], based on the now-defunct [http://www.houeland.com/kol/diets Eleron's KoL diet lists], displays the optimal aftercore diets based on current mall prices.
*The Well-Tempered [http://kol.coldfront.net/tools/anvil/ Anvil], [http://kol.coldfront.net/tools/epicure/ Epicure], and [http://kol.coldfront.net/tools/mixology/ Mixologist] allow you to calculate the returns from food, booze, and pulverizing under various conditions.
*The Well-Tempered [http://kol.coldfront.net/tools/anvil/ Anvil], [http://kol.coldfront.net/tools/epicure/ Epicure], and [http://kol.coldfront.net/tools/mixology/ Mixologist] allow you to calculate the returns from food, booze, and pulverizing under various conditions.
*[http://kol.coldfront.net/newmarket/ KoL Coldfront Marketplace 2.0] provides long-term history of item prices in the mall. It requires Adobe Flash.
**[https://g1wjmf0i0h.execute-api.us-east-2.amazonaws.com/default/itemindex KoL Marketplace 2.1] is an alternative version that does not require Flash.


==Offline Tools==
==Offline Tools==
In addition to many online resources, there are also some tools for offline use.
In addition to many online resources, there are also some tools for offline use.


*[http://www.alliancefromhell.com/viewtopic.php?t=949 KujjieKujjieKoo's Barrel Full of Barrels Calculators] are able to calculate the probability of each possible outcome of any given barrel.
*[https://alliancefromhell.com/viewtopic.php?t=949 KujjieKujjieKoo's Barrel Full of Barrels Calculators] are able to calculate the probability of each possible outcome of any given barrel.
*The [http://code.google.com/p/ascension-log-visualizer/ Ascension Log Visualizer] is a tool that is able to create ascension logs from Kolmafia sessions and visualize them through various different charts. It can also make visualizations from pre-parsed logs.
*The [http://code.google.com/p/ascension-log-visualizer/ Ascension Log Visualizer] is a tool that is able to create ascension logs from Kolmafia sessions and visualize them through various different charts. It can also make visualizations from pre-parsed logs.



Latest revision as of 17:03, 31 July 2023

HammerScrewdriverPliers

There are a variety of tools that automate, simplify, reproduce, and/or add functionality to the Kingdom of Loathing.

Advanced User Interfaces

These tools are freestanding and run outside the normal browser security sandbox, which allows for more powerful features such as logging your ascensions and automated adventuring.

KoLmafia

  • Provides an improved web browser interface, a graphical window interface, and a textual command-line interface as alternatives for playing KoL.
  • Has many many features, with various functionality for every part of KoL, and a large scripting community. You can obtain many useful scripts from Loathers.
  • Is a cross-platform desktop interface to KoL, written by holatuwol and others.
  • Open Source with code available to build, edit or inspect in a GitHub repository.
  • Is written in Java and requires Java Development Kit (JDK) 11 or newer to run.
  • JDK 17 is supported and recommended.
  • Can be scripted using KoLmafia's own ASH scripting language.
  • Forum thread is located here.
  • Availability:
    • The latest versions are available here.
    • The latest release on GitHub has packaged builds including a JRE for Windows (.exe), MacOS (.dmg), and Debian (.deb)

Kolproxy

  • No longer maintained
  • Enhances the web browser interface for playing KoL. Built to provide better support for ascension and automation, without surprises or gotchas.
  • Focused on helping players ascend better (suitable for newbies to #1 leaderboarders depending on settings), and automating entire quests or ascensions. Limited support for non-ascension-relevant content.
  • Can be scripted using Lua, a popular programming language for video games. (Kolproxy's features are also implemented as Lua scripts.)
  • Forum thread is located here.
  • Available for Windows, Mac, Linux (and as source code).
  • The latest version and more information is available at https://github.com/houeland/kolproxy/ and the kolproxy wiki.

Support for using both KoLmafia and kolproxy in the same session is limited, and requires recompiling KoLmafia yourself with a compatibility patch. Usually players using both instead log off/on again to switch between the two depending on what they're doing.

Scripts & Scriptlets

Scripts/Scriptlets directly affect and/or enhance the functionality of the standard KoL web browser interface.

They are commonly implemented in JavaScript, a browser/client scripting language, but are sometimes dynamically generated by PHP or some other server scripting language.

Scriptlets are usually run by entering "javascript:SCRIPT" in the address bar of a web browser. They can also be bookmarked for easier use. Some scriptlets are browser-dependent.

  • Ohayou has written a multitude of handy scriptlets. His Repeat Action Scriptlet has been revised in this forum thread. Also popular is his UI improvements script, which not only logs and displays his item effect logging scriptlet, but also combines a variety of his other scriptlets.

Greasemonkey User Scripts

Greasemonkey is an extension for the Firefox web browser that provides a framework for user scripts to be written to automatically be invoked when you visit a particular page.

In-depth instructions on using Greasemonkey are available at this forum post, courtesy of Aprocalypse.

The following scripts all require Greasemonkey.

  • Tard created a multitude of various scripts, from an arena trainer to spoiler/helper scripts, that can automatically inform you of updates when using his Framework script. These scripts were updated and maintained by SomeStranger until 2008 at his user scripts page. Currently, several of them are updated and maintained by Hellion at his user scripts page.
  • Numfar has authored a monster stat, wiki-linking, and bang potion script, which are available at his user scripts page.
  • DaCyclops provides a number of small helpful scripts, including one that counts visible trophies and one that shows the moon sign effects after ascending, at his user scripts page.

For a more complete list, see the list of Greasemonkey scripts.

Stylus

Stylus is a replacement for the old Stylish extension that is similar to Greasemonkey, but is more visual than functional in nature. KoL Stylish scripts include one that labels chat mods and one that colorizes a menu to highlight HP and MP Restorers. Chrome and Opera versions of the extension also exist.

For more information, see the Stylus website and a list of KoL Stylish scripts.

Web-Based Tools

There are some tools to assist with gameplay that are accessed by a standard web browser. Typically, you type or cut-and-paste information into them:

Offline Tools

In addition to many online resources, there are also some tools for offline use.

See Also