Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/loathers/tourguide
Relay script for KoLmafia, for the web game Kingdom of Loathing. Gives advice on how to play.
https://github.com/loathers/tourguide
kingdom-of-loathing kolmafia
Last synced: about 1 month ago
JSON representation
Relay script for KoLmafia, for the web game Kingdom of Loathing. Gives advice on how to play.
- Host: GitHub
- URL: https://github.com/loathers/tourguide
- Owner: loathers
- License: unlicense
- Created: 2021-09-05T18:40:14.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-06T21:30:22.000Z (3 months ago)
- Last Synced: 2024-10-24T17:54:28.969Z (about 2 months ago)
- Topics: kingdom-of-loathing, kolmafia
- Language: AGS Script
- Homepage:
- Size: 10.5 MB
- Stars: 14
- Watchers: 9
- Forks: 17
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
**TourGuide** is a script meant to help [Kingdom of Loathing](https://www.kingdomofloathing.com/) players efficiently play through an ascension. It will give you advice on getting through your active quests, tips on how to efficiently use your resources, and reminders on using time-limited resources.
To install, run the following command on an up-to-date [KolMafia](https://github.com/kolmafia/kolmafia) version:
> `git checkout loathers/tourguide Release`
To update, run `git update` or check the "Update installed Git projects on login" box within Mafia preferences.
## Running TourGuide
Once TourGuide is installed, look at the top bar within your relay browser. In the upper right, underneath the moon state and the bug report button, there will be a drop-down menu. Select TourGuide from this menu, and the script will dock to the right side of your window.
## Using TourGuide
At its core, TourGuide is like Clippy, Microsoft's wildly unsuccessful advice daemon from Microsoft Word 1997. You can use it as actively or as minimally as you want. TourGuide aims to inform you of the many resources a KoL player has -- things like free runaways, banishes, free kills, et cetera -- and give you ideas on what to use them on. TourGuide aims to give users a heads up on the many arcane speedster strats used to complete ascensions in the minimum possible turns. KoL is a complicated game, and TourGuide is the little parrot that sits on your shoulder and pecks at you to remind you not to lose track of your resources.
Some people use TourGuide on every quest, referring back to it like a treasured family accountant. Others open it at the end of a KoL day to see what resources they may have forgotten to use. Others still use it, but minimize every tab except for Guzzlr, because they love Guzzlr so much that the entire game is just endless Guzzlr parties. There are many ways to use TourGuide.
For samples of TourGuide output (and general notes on how to read and use the tool), please visit our [TourGuide Usage Documentation](documentation/usage.md) page.
## Development & History
TourGuide is open source and contributions are encouraged. This script, as well as its support scripts, are in the public domain.
- For an overview on how to develop for TourGuide and create PRs, [click here](documentation/develop.md).
- For more information about TourGuide's scope and the limitations of the tool, [click here](documentation/scope.md).
- For more information about TourGuide's history, [click here](documentation/history.md).
For support, questions, and comments visit the Ascension Speed Society discord channel.