https://github.com/loathers/bountiful

a better bounty script
https://github.com/loathers/bountiful

Last synced: about 1 month ago
JSON representation

a better bounty script

• Host: GitHub
• URL: https://github.com/loathers/bountiful
• Owner: loathers
• Created: 2022-08-23T13:39:50.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-10-12T17:56:38.000Z (about 1 year ago)
• Last Synced: 2024-10-24T17:54:25.059Z (about 2 months ago)
• Language: AGS Script
• Homepage:
• Size: 54.7 KB
• Stars: 2
• Watchers: 8
• Forks: 7
• Open Issues: 6
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# bountiful.ash

> :paw_prints: a better bounty script :paw_prints:

## Installation

To install this script in KolMafia, simply use the following command in the gCLI:

`git checkout loathers/bountiful`

## Configuration

The script uses the following properties to determine behavior:

Property                      | Default Value     | Description

----------------------------- | ----------------- | -----------------------------------------------------------------------

bountiful.useBanisher         | false             | Whether or not to banish non-bounty monsters within the bounty location

bountiful.useCopier           | false             | Whether or not to copy the bounty monster using Spooky Putty/Rain-Doh

bountiful.useFax              | false             | Whether or not to fax in the bounty monster. Ensure your clan uses the fax machine for general purpose and is not relied upon by the fax network bots.

bountiful.useFreeKill         | false             | Whether or not to kill the bounty monster with Power pills

bountiful.maxBanishCost       | autoBuyPriceLimit | Maximum price willing to spend on individual banishers

bountiful.maxSpecialCost      | autoBuyPriceLimit | Maximum price willing to spend on special bounty content unlockers

bountiful.automaticallyGiveup | false             | Whether or not to "Give up" bounties which cannot be accessed

bountiful.useAllOlfactCharges | false             | If false, reserves 1 olfact charge for the user to use later in their KOL day 	(for farming or in-run use). If true, uses all 3 of your daily olfactions on bounty hunting. Note that if you have olfaction, this script will always use up to 2 charges regardless.

To set a property, simply type the following into the gCLI:

`set [insert property here] = [insert value here]`

A relay settings will be coming soon:tm:.

## Usage

Once the script is installed, use the following commands to do begin hunting:

Command      | Description

------------ | --------------------------------------------------

hunt easy    | Hunt the "easy" bounty

hunt hard    | Hunt the "hard" bounty

hunt special | Hunt the "special" bounty

hunt optimal | Hunts the bounty with the fewest items required

hunt all     | Hunts all possible bounties in order of item count

So, an example run could be: `bountiful hunt all`.

## Miscellaneous Information

This script is still in the "beta" stages and has been tested but not thoroughly, bug reporting is appreciated.

The code is documented using JavaDoc/JSDoc style comments if you are interested in taking a peek at the source code.

This script is forked from RESPRiT (https://github.com/RESPRiT/bountiful). Which was adapted (but very different) from AutoBHH, originally by izchak and majorly revised by Raorn and Zarqon. Thank you all for your contributions to this script.

Feel free to provide feedback of any kind!