[size=+2]Excavator[/size]
I recently added a new type of script to KoLmafia - spadingScript. At certain points in the game, a spadingScript will be triggered with the name of the event, the contents of the page, and any other important information. I've now written a script that can use that new functionality to passively collect data for ongoing spading projects. It collects and 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 Google Sheet for anyone to review and process.
It is very new so there may be some small bugs so please do report them here, on GitHub, or on the Discord channel.
[size=+1]Installation and Usage[/size]
Install the script using the KoLmafia CLI:
Set up KoLmafia to use excavator.js as your spadingScript:
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 command:
A reminder to do so appears on login and in the Daily Deeds panel.
[size=+1]Further information[/size]
You can find a list of active projects on the GitHub repository for the code. I've also set up a dedicated channel on the Ascension Speed Society Discord server if you want to talk more about it or get involved.
I recently added a new type of script to KoLmafia - spadingScript. At certain points in the game, a spadingScript will be triggered with the name of the event, the contents of the page, and any other important information. I've now written a script that can use that new functionality to passively collect data for ongoing spading projects. It collects and 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 Google Sheet for anyone to review and process.
It is very new so there may be some small bugs so please do report them here, on GitHub, or on the Discord channel.
[size=+1]Installation and Usage[/size]
Install the script using the KoLmafia CLI:
Code:
git checkout loathers/excavator release
Set up KoLmafia to use excavator.js as your spadingScript:
Code:
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 command:
Code:
spade
A reminder to do so appears on login and in the Daily Deeds panel.
[size=+1]Further information[/size]
You can find a list of active projects on the GitHub repository for the code. I've also set up a dedicated channel on the Ascension Speed Society Discord server if you want to talk more about it or get involved.
Last edited: