Tools: Difference between revisions

From A KoL Wiki
← Older edit
imported>Asturia
No edit summary
imported>Akatosh
m →KoLmafia: - link to loathers
 
(32 intermediate revisions by 21 users not shown)
Line 1: Line 1:
<div style="text-align: center;">
<div style="text-align: center;">
[[Image:hammer.gif|Hammer]][[Image:screwdrive.gif|Screwdriver]][[Image:pliers.gif|Pliers]]
[[File:hammer.gif|Hammer]][[File:screwdrive.gif|Screwdriver]][[File:pliers.gif|Pliers]]
</div>
</div>


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


__TOC__
__TOC__
==Alternate User Interfaces==
==Advanced User Interfaces==
These tools are usually freestanding and often provide a complete 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 and automated adventuring.
 
===KoL CLI===
*Is a [[Wikipedia:command line interface|command line interface]] to KoL.
*Is written in [[Wikipedia:Perl|Perl]].
*Requires [[Wikipedia:Perl|Perl]] with [[Wikipedia:cURL|cURL]] to run.
*Availablity:
**Original branch, now deprecated, is available [http://www.subjunctive.net/kol/kolcli.html here].
**Was later maintained by '''The Iron Chefs''' and is available [http://ironchefs.getsloppy.com/icdownloads.html here].
**Is now maintained as a more [http://gna.org/projects/kolcli/ open project at GNA], and can be downloaded [http://download.gna.org/kolcli/ here].
 
===KoLmelion===
*Is a [[Wikipedia:Graphical user interface|GUI]] for KoL created by [[Papa Zito]].
*Is written in [[Wikipedia:Visual Basic .NET|Visual Basic .NET]].
*Requires [[Wikipedia:Microsoft Windows|Windows]] with the [[Wikipedia:Microsoft .NET|.NET Framework]] to run.
*Availability: (''deprecated'')
**Final version is available [http://kolmelion.sourceforge.net/ here].


===KoLmafia===
===KoLmafia===
*Is a cross-platform desktop interface to KoL created by '''holatuwol''' and others.
*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]].
*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.]
*Requires the [http://java.com Java Runtime Environment (JRE)].
*Is a cross-platform desktop interface to KoL, written by '''holatuwol''' and others.
*Availability:
*Open Source with code available to build, edit or inspect in a [https://github.com/kolmafia/kolmafia GitHub repository].
**Latest version is available [http://kolmafia.sourceforge.net/ here].
*Is written in [[Wikipedia:Java (programming language)|Java]] and requires [https://adoptium.net Java Development Kit (JDK)] 11 or newer to run.
**Unstable releases are available [http://kolmafia.us/ here]. Use these at your own risk.
*JDK 17 is supported and recommended.
 
*Can be scripted using KoLmafia's own [http://wiki.kolmafia.us/index.php?title=ASH_For_Beginners ASH] scripting language.
===KoLHack===
*Forum thread is located [http://forums.kingdomofloathing.com/vb/showthread.php?t=186011 here].
*Is a prototype text-based rogue-like interface to KoL written by '''us3r1d'''.
*Is written in Perl.
*Forum thread is [http://forums.kingdomofloathing.com/viewtopic.php?t=82703 here].
*Availability:
*Availability:
**Is included in the [http://kol.devnull.net /dev/null/kolbot development kit].
**The latest versions are available [http://builds.kolmafia.us/ here].  
 
**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)
==Bots==
Simply put, a bot is anything that automates the actions of a player. There are bots that automatically sell buffs, cook, chat, roll dice, and regulate games.  The above "Alternate User Inferfaces" could technically be classified as "auto-adventuring bots".
 
*For more detailed information, see [[Bots]].
 
==Browser Plugins==
Browser plugins are independent toolbars that install to your browser (usually Firefox)


*[https://addons.mozilla.org/en-US/firefox/addon/4219 KoL Toolbar] Firefox browser plugin with basic navigation, intelligent Wiki searching, radio DJ information that allows you to listen to RKoL from the browser, an autologin feature and a feature for searching [http://koloot.com KoLoot]
===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 [[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].
*Available for Windows, Mac, Linux (and as source code).
*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].


*[https://addons.mozilla.org/en-US/firefox/addon/4416 RKOL Status] Firefox browser plugin that can be used to monitor the song, artist and number of users on a ShoutCast server. It was written specifically for Radio-KOL but will work for other ShoutCast servers. It places a small icon in the lower right-hand corner of the window and displays the song and artist currently playing on the radio. The tooltip can display a multitude of other information including the name of the DJ, the last five songs played, and the schedule.
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==
Scripts/Scriptlets directly affect and/or enhance the functionality of the standard web browser interface of KoL, such as combining scripts, inventory scripts, and chat scripts.
Scripts/Scriptlets directly affect and/or enhance the functionality of the standard KoL web browser interface.


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


Scriplets are usually run by entering "javascript:''SCRIPT''" in the address bar of a web browser. They can also be bookmarked for easier use. Some scriplets 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. The Repeat Action Scriptlet has later been revised in [http://forums.kingdomofloathing.com/viewtopic.php?t=57391 this KoL Forum thread]. He also had an [http://www.lysator.liu.se/~jhs/KoL/effects/ item effect logger scriptlet] which contributed to (and drew data from) his [http://www.lysator.liu.se/~jhs/KoL/effects/ KoL Item Effects database], which is no longer active. Another popular script was his  [http://userscripts.org/scripts/show/1583 UI improvements scriptlet], which not only logs and displays item effect logging scriptlet, but combines a variety of his other scriplets, such as a combining help and a repeat adventure script.
*'''[[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.
 
*'''[[User:JRSiebz|JRSiebz]]''' has started an [http://home.cinci.rr.com/jrsiebz/KoL/KoL_Tools.html all-purpose script] which is mostly inventory management combined with all types of recipe assistance and a few other added UI improvements mixed in.
 
*'''[[:User:Dramatix01|dramatix01]]''' has menu addition, friend list, and gift shop scripts available at his [http://www.djlphotos.com/ KoL script repository].


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


[http://www.greasespot.net/ Greasemonkey] is an extension for the [http://www.mozilla.com/firefox/ Firefox] web browser, which 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/vb/showthread.php?t=136174 this forum post], courtesy of '''Aprocalypse'''.
 
In-depth instructions on using Greasemonkey scripts are available via [http://forums.kingdomofloathing.com/viewtopic.php?t=79085 this forum post], courtesy of '''Aprocalypse'''.


The following scripts all require Greasemonkey.   
The following scripts all require Greasemonkey.   


*'''Tard''' created a multitude of various scripts, from an arena trainer to spoiler/helper scripts, which can also automatically inform you of updates when using his framework script, all available at his [http://kol.dashida.com/ scripts page]. These scripts have since been updated and maintained by '''SomeStranger''' at his [http://somestranger.kol.googlepages.com/ Greasemonkey scripts page].
*'''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 [https://www.sites.google.com/site/somestrangerkol/other user scripts page]. Currently, several of them are updated and maintained by '''Hellion''' at his [http://userscripts.org/users/103890/scripts user scripts page].
 
*'''Turias''' has a selection of scripts available at [http://forums.kingdomofloathing.com/viewtopic.php?t=48919 this forum thread], including a color-changing, a location dropdown, a moon, a search, and a toolbar script.
 
*'''Numfar''' has authored a monster stat script, a wiki-linking script, and a bang potion script at his Greasemonkey [http://batmantis.com/kol/ script page].
 
*'''OneTonTomato''' has authored a large number of scripts, all of which are available at his [http://kol.upup.us/scripts/ user scripts page].
 
*'''Picklish''' provides a script which makes compact mode a little less compact, another which will "despoil" the KoL forums, a script to buy items from multiple stores at the mall, one that removes animation delays from "sparkly" mining squares, another that changes Hagnk's interface to look more like your inventory, still another that adds auto-login buttons for any character you login with, and one that adds extra links for using items that are acquired or bought. You can find these at [http://picklish.kol.googlepages.com/ this page] (screenshots included).
 
*'''DaCyclops''' provides a number of small helper scripts, including one that counts visible trophies and one that shows the Moon Sign effect on ascension at his [http://cyclops.yqmonline.com/kol_monkey.php scripts page].


For a more complete list, see [[List of all Greasemonkey Scripts (Categorized)]].
*'''Numfar''' has authored a monster stat, wiki-linking, and bang potion script, which are available at his [http://www.batmantis.com/kol/ user scripts page].


==Stylish==
*'''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 [http://www.cyclops.yqmonline.com/kol_monkey.php user scripts page].
Stylish is a Firefox extension similar to Greasemonkey, but more visual than functional in nature. You can even preview the scripts before loading them into Stylish. KoL Stylish scripts include one that labels chat mods, and one that colorizes a menu to highlight HP and MP restorers.


See [https://addons.mozilla.org/en-US/firefox/addon/2108 Stylish] & [http://www.userstyles.org/styles/search/kol A list of KoL scripts for stylish]
For a more complete list, see the [[list of Greasemonkey scripts]].


==Web-based tools==
==Stylus==
[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.


There are some tools to assist with game play that are accessed by a standard web browser. Typically you type or cut-and-paste information into them:
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].


<!--*[http://sol.kolmafia.us The Simulator of Loathing], developed by Ayvuir and released under the GPL.  Lets you predict the outcome of adventuring given your zone, monster, and player state.-->
==Web-Based Tools==
*[http://items.ofloathing.org Items of Loathing], The ofLoathing Network's price history and prediction database.
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:
*MaxDemian's [http://max.subfighter.com/kol/items.php Item Database], [http://max.subfighter.com/kol/doorcode.php Door Code Generator] & [http://max.subfighter.com/kol/violetfog.php Violet Fog Mapper]
*Cisco's <!--[http://hardcoreoxygenation.com/cgi-bin/moxie.cgi Moxie Lookup] and -->[http://hardcoreoxygenation.com/cgi-bin/door.cgi Door Code Generator]
*[http://www.the-rye.dreamhosters.com/familiars/ The Rye Familiar Arena Tool]
*[http://www.few.vu.nl/~rminne/kol/kolfamiliars.php Xylpher's Familiar Arena Tool]
*[http://retrofrog.hardcoreoxygenation.com/ RetroFrog KoL Tools]:  Consumption, Skills, Familiars, and more.
*[http://www.idea-inc.com/~allanc/bonezorz.php Allanc's dusty bone count checker]
*[http://forums.kingdomofloathing.com/viewtopic.php?t=75847 KProxy] is a web-based account proxy to KoL written by '''us3r1d''' which allows the sharing of KoL accounts without distributing the account password with a configurable set of restrictions on player actions.  It is included in the [http://kol.devnull.net /dev/null/kolbot distribution].
*[http://haxot.com/KoL/kolproc.pl Bulk KMailer] is a tool for generating KoLMafia scripts that will send all your current tradable inventory to a different character (in preparation for Ascension).
*[http://www.gone.tc/optimizr/ TeKRunneR's Level 12 Quest Optimizer] lets you calculate the best way through the level 12 quest. This is the web version of [http://www.alliancefromhell.com/forum/viewtopic.php?t=766 Bazzel's and QuantumNightmare's Level 12 quest spreadsheet]


==Offline tools==
*[http://www.hardcoreoxygenation.com/cgi-bin/door.cgi Cisco's Door Code Generator] can help you if are [[Deciphering the Door Code]].
*[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.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.
*[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.


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


*[http://www.alliancefromhell.com/forum/viewtopic.php?t=766 Bazzel's and QuantumNightmare's Level 12 quest spreadsheet] lets you calculate the best way through the level 12 quest.
*[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.
*[http://www.alliancefromhell.com/forum/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 based on the fact that the Barrel full of Barrels distribution isn't completely random but instead uses specific patterns.
*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.
*[http://www.alliancefromhell.com/forum/viewtopic.php?t=117 QuantumNightmare's Optimal place to level spreadsheet] calculates the best location to get stats from based on various inputs from the user. Since it's creation, there were also meat-per-turn calculations added for some of the areas.
*[http://www.alliancefromhell.com/forum/viewtopic.php?t=586 Flolle's Area Simulator] is a tool written in Java which emulates the encounter rolling of KoL and thus is able to do all kinds of stat, Meat or turn calculations.
*[http://www.alliancefromhell.com/forum/viewtopic.php?t=125 VladimirPootin's Mafia Log Parser] revised by QuantumNightmare is a tool written in Perl which is able to parse logs created by KolMafia into summarized ascension logs, which hold a complete turn rundown with critical item drops, familiar changes, pulls, etc. and some summaries such as turns spent per area and level or skill casts.
**[http://www.alliancefromhell.com/forum/viewtopic.php?t=125&start=100#15294 Flolle's Log Visualizer] is able to put ascension logs created by the Mafia Log Parser into various charts.


Other links are available on the [[Community]] and [[Bots]] pages.  For a specific type of web link, see the related wiki page, for example see [[Kingdom of Loathing Calendar]] for calendar related links, see [[Deciphering the Door Code]] for door code generators, see [[The Cake-Shaped Arena]] for Arena tools, etc.
==See Also==
*[[Bots]]
*[[Community]]


[[Category:Basics]]
[[Category:Basics]]
[[Category:Help]]
[[Category:Help]]

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

Retrieved from "https://wiki.kingdomofloathing.com/index.php?title=Tools&oldid=404148"