https://github.com/loathers/greenbox

Script for examining and sharing a player's loadout of skills and items in the Kingdom of Loathing
https://github.com/loathers/greenbox

kingdom-of-loathing kol kolmafia typescript

Last synced: about 1 month ago
JSON representation

Script for examining and sharing a player's loadout of skills and items in the Kingdom of Loathing

• Host: GitHub
• URL: https://github.com/loathers/greenbox
• Owner: loathers
• License: apache-2.0
• Created: 2022-07-13T21:29:44.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-23T16:04:23.000Z (2 months ago)
• Last Synced: 2024-10-24T17:54:26.102Z (about 2 months ago)
• Topics: kingdom-of-loathing, kol, kolmafia, typescript
• Language: TypeScript
• Homepage: https://greenbox.loathers.net
• Size: 18.1 MB
• Stars: 6
• Watchers: 9
• Forks: 8
• Open Issues: 5
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


`greenbox` is a script to examine a [Kingdom of Loathing](https://www.kingdomofloathing.com/) player's overall loadout and return a graphical interface showing the user what they own and do not own, among some of the coolest items, tattoos, and trophies in the kingdom.

To install, run the following command on an up-to-date [KoLMafia](https://github.com/kolmafia/kolmafia) version:

`git checkout loathers/greenbox release `

Once installed, run `greenbox` in the GCLI and your profile will be updated at `https://greenbox.loathers.net/?u=`. Whenever you re-run `greenbox`, these data will be updated automatically!

If you want to generate a non-public readout link, run `greenbox --private`. Similiarly, if you would like to remove your public profile just run `greenbox --wipe`.

To be reminded of usage instructions at any time, run `greenbox --help`.

## Development

We have constructed greenbox as a monorepo -- this means that there are three distinct scripts that live inside a single repo. To assist in the development of this script, we have added a series of readmes that should help walk through code structure and describe PRs that would touch each specific section.

For more information on the...

- ... overall structure, [click here](packages/README.md).

- ... data that powers greenbox, [click here](packages/greenbox-data/README.md).

- ... script run within KoLMafia to calculate and update your greenboxen, [click here](packages/greenbox-script/README.md).

- ... frontend of the script that displays the aforementioned data, [click here](packages/greenbox-web/README.md).

- ... service that receives, stores, and serves the data, [click here](https://github.com/loathers/oaf/blob/main/src/greenbox.ts).

## History

In KoL's community, "green boxes" are a reference to a profile snapshot script [once owned by BumCheekCity](http://forums.kingdomofloathing.com/vb/showthread.php?t=179109) and more [recently owned by CheeseCookie](http://forums.kingdomofloathing.com/vb/showthread.php?t=218735). In the parlance of these snapshots, a green box means you own the thing that's in the box. Hence the name of this script. While this script was coded from scratch, the general structure (and the community impact of the script) owes a substantial amount to BumCheekCity and CheeseCookie, and we are thankful for their contributions to KoL.