cameroncondry / cbc-kitten-scientists

Add-on for the wonderful incremental browser game: http://kittensgame.com/web/
MIT License
114 stars 94 forks source link

Kitten Scientists

The script has not been maintained in a while, you might want to check out https://github.com/kitten-science/kitten-scientists instead.

Kitten Scientists (KS) is a simple automation script for the complex Kittens Game.

Quick Start

Create the following JavaScript bookmarklet (create a new bookmark and paste this as the URL):

javascript:(function(){var d=document,s=d.createElement('script');s.src='https://cdn.jsdelivr.net/gh/cameroncondry/cbc-kitten-scientists@master/kitten-scientists.user.js';d.body.appendChild(s);})();

Manual Installation

You can also permanently install Kitten Scientists with a userscript manager.

Now simply open the script and you should be prompted to install it.

Troubleshooting

In the event the script is not up to date, try purging the cache at: https://purge.jsdelivr.net/gh/cameroncondry/cbc-kitten-scientists@master

Introduction

Note that the default configuration of Kitten Scientists is designed to already give very good results for most stages of the game. When you're exploring the features of KS, try disabling all sections and then re-enabling them one-by-one.

As you get more comfortable with the behavior of KS, feel free to fine-tune the settings to achieve your goals faster.

UI Guide

To enable/disable the entire suite of automations of KS, click the Enable Scientists label at the top of the UI.

Individual automation sections can be enabled/disabled by clicking on the label of the automation section. By clicking the items label to the right of the label, you can expand/collapse the panel that holds the individual automation options of that section. Their specific behavior is documented below.

Bonfire

This section has a configurable threshold for when the automation should be activated. Click the trigger label to the right of the Bonfire label to set your desired threshold. The default value is 0 (activate as soon as possible).

By clicking the names of the individual buildings, you can select which buildings from the Bonfire page you want to have built automatically. The Max setting tells KS not to build any more than the designated number (the default value of -1 allowing unlimited production).

Please note that the Unic. Pasture is in the Religion section.

Space

This section has a configurable threshold for when the automation should be activated. Click the trigger label to the right of the Space label to set your desired threshold. The default value is 0 (activate as soon as possible).

As in the Bonfire section, here you can select which buildings from the Space page you want to have built automatically.

Crafting

This section has a configurable threshold for when the automation should be activated. Click the trigger label to the right of the Crafting label to set your desired threshold. The default value is 0.95. This means that a resource will be crafted when it is at 95% of your storage limit. (What about unlimited resources?)

In this section, you can select which craftable resources you want to craft automatically.

When you enable the Limited option for a resource, then only a portion of the source materials is crafted into the desired resource. The portion is currently set to 50% (this is currently not configurable).

This means that if you have 1000 beams, and you have crafting of scaffolds enabled, then only 500 beams would be crafted into scaffolds. This is especially useful for when you want to split up source materials between different craftable resources.

Consider crafting steel and plates. Both require iron. If you would allow unlimited plate crafting, then you wouldn't have any iron left to craft steel. By having steel and plates set to limited, the iron resource is split between the two craftable resources.

Resources

By clicking the Resources label, you can access the fine-grained resource management.

For each resource, you can set a consumption rate (60% by default) and a stock (0 by default). The consumption rate defines how much of the trigger value times the storage capacity that autocrafting is allowed to consume (meaning with the default consumption rate and a trigger value of 100%, autocrafting would leave 40% of the resource's storage capacity). The stock setting keeps a specific amount on hand, regardless of all other settings.

Unlocking

Trading

This section has a configurable threshold for when the automation should be activated. Click the trigger label to the right of the Trading label to set your desired threshold. The default value is 0.98. This means that a trade will be made, when you're at 98% of your storage limit. This only relates to resources that have a storage limit.

By default, the trades are optimized to only happen during seasons when the trade is most effective. You can customize these seasons by clicking the seasons label to the right of the individual races.

Trading also has a limited trading mode. This mode determines how much production time is needed to make the trade's input resources versus the time to make the trade's average output resources to determine if a trade is profitable. The resources gained and spent trading and hunting are also factored in, making this mode self-limiting.

Religion

This section has a configurable threshold for when the automation should be activated. Click the trigger label to the right of the Religion label to set your desired threshold. The default value is 0 (activate as soon as possible).

In the Religion section, you can select which buildings and techs from the Religion page you want to have purchased automatically. If necessary and possible, unicorns will be sacrificed to produce tears.

Click addition to customize these additional options:

Time

This section has a configurable threshold for when the automation should be activated. Click the trigger label to the right of the Time label to set your desired threshold. The default value is 0 (activate as soon as possible).

The automations in this section behave exactly like in the Bonfire and Space sections, but here you select which buildings from the Time page you want to have built automatically.

Time Control

Kitten Resources

Options

Filters

The filters allow you to set which types of messages you want to see in the game log.

Note that enabling a filter will cause the message to not be logged. This is in contrast to the Log Filters that are already present in Kittens Game, where the logic is reversed.

Contributors

If you would like to contribute to the Kitten Scientists, then you can do so in these ways:

Thanks to these past and present contributors!