Tools: Difference between revisions

From A KoL Wiki
imported>Oneforfortytwo
updated some links, removed broken ones
imported>Eleron
Added kolproxy
Line 7: Line 7:
__TOC__
__TOC__
==Alternate User Interfaces==
==Alternate User Interfaces==
These tools are usually freestanding and often provide an alternate way to play KoL, rather than using the standard web browser interface.
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.


===KoLmafia===
===KoLmafia===
*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]].
*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.
*Requires the [http://www.java.com/en/download/index.jsp Java Runtime Environment (JRE)].
*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.
*Can be scripted using KoLmafia's own 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:8080/vb/showthread.php?t=186011 here].
*Availability:
*Availability:
**The latest stable version is available [http://sourceforge.net/projects/kolmafia/files/ here].
**The latest stable version is available [http://sourceforge.net/projects/kolmafia/files/ here].
**The latest unstable versions are available [http://builds.kolmafia.us/ here].
**The latest unstable versions are available [http://builds.kolmafia.us/ here].
===Kolproxy===
*Enhances the web browser interface for playing KoL, with features not available from browser scripts.
*Has a strong focus on correctness and helping the player ascend better, with many included warnings for mistakes and misclicks.
*Can be scripted using Lua (and the included interface enhancements are also Lua scripts).
*Forum thread is located [http://forums.kingdomofloathing.com/vb/showthread.php?t=180265 here].
*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].


==Scripts & Scriptlets==
==Scripts & Scriptlets==
Line 53: Line 63:
*[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] fetch food prices from the mall and calculate the optimal diet for various farming incomes.
*[http://www.houeland.com/kol/diets Eleron's KoL diet lists] display 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.



Revision as of 22:31, 23 December 2012

HammerScrewdriverPliers

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

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

KoLmafia

  • Is a cross-platform desktop interface to KoL, written by holatuwol and others.
  • Is written in Java and requires the Java Runtime Environment (JRE) to run.
  • 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.
  • Can be scripted using KoLmafia's own ASH scripting language.
  • Forum thread is located here.
  • Availability:
    • The latest stable version is available here.
    • The latest unstable versions are available here.

Kolproxy

  • Enhances the web browser interface for playing KoL, with features not available from browser scripts.
  • Has a strong focus on correctness and helping the player ascend better, with many included warnings for mistakes and misclicks.
  • Can be scripted using Lua (and the included interface enhancements are also 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 the kolproxy wiki.

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.

Stylish

Stylish is a 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.

For more information, see the Stylish 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