loathers / excavator

A script for automatically gathering spading data while playing the Kingdom of Loathing ♠️
https://excavator.loathers.net
4 stars 6 forks source link

excavator ♠️

excavator is a spadingScript for KoLmafia (at least r20145) for collaboratively gathering data while playing the Kingdom of Loathing. It collects sends data via kmail to the player Excavator when possible (i.e. when you're not in an encounter), otherwise it is cached in the spadingData property. The cache can be processed by running the spade command in the CLI.

Only data pertinent to the current projects are reported (outcomes from combats, state of flags or counters on your player etc) and each packet of data can be reviewed and approved before it is sent. No personal information will ever be transmitted.

These data are pulled every 15 minutes to a database and displayed on https://excavator.loathers.net. Before this site they were imported to Google Sheets, where some data remains for posterity.

It is maintained by gausie (#1197090).

Installation and Usage

Install the script using the KoLmafia CLI:

git checkout loathers/excavator release

Set up KoLmafia to use excavator.js as your spadingScript:

set spadingScript = excavator.js

Data will be automatically submitted when possible, but if you want to manually clear the cache in the spadingData prop, you can do so using the spade autoconfirm command:

spade

A reminder to do so appears on login and in the Daily Deeds panel.

Further information

To get involved in writing a project or if you have any other queries join us on the Ascension Speed Society Discord server.