Code Monkey home page Code Monkey logo

cbc-kitten-scientists's Introduction

Kitten Scientists

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.

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.

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.

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.

However, this is not entirely accurate, as the overall process is more complicated. 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

  • Workshop upgrades and techs are automatically bought when affordable, prioritizing the workshop if both are enabled.
  • Races for trading are automatically explored as they become available.
  • Space missions can automatically be conducted.
  • Buildings can be set to be automatically upgraded to their second stage as soon as upgrading would not significantly impact income.

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.

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.

Options

  • Observe Astro Events: Automatically observe astronomical events as they happen.
  • Hold Festivals: Automatically hold festivals as soon as the previous one ends and enough resources are available and holding the festival won't drain your stockpile.
  • Auto Praise: Automatically praises the sun as your faith approaches the resource limit.
  • Force Ships to 243: Ensures that 243 ships are constructed as soon as possible, ignoring other resource constraints. This is useful because after 243 ships, trades for titanium with the zebras are guaranteed to be successful 100% of the time.
  • Feed Leviathans: Automatically feed the leviathans race necrocorns to ensure they stay longer for possible trading.
  • Hunt: Automatically send your kittens hunting as you approach the catpower limit. This automation has a configurable trigger. The default value is 0.98, which means the kittens will hunt when your catpower is at 98% of your catpower limit.
  • Trade Blackcoin: Automatically trade blackcoin with the leviathans at low prices and sells near the peak.
  • Build Embassies (Beta): Automatically builds embassies, just like other buildings.
  • Explore (deprecated): relates to a feature no longer present in current versions of Kittens Game

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!

cbc-kitten-scientists's People

Contributors

cameroncondry avatar wymrite avatar jacob-keller avatar oliversalzburg avatar coderpatsy avatar sjdrodge avatar toadjaune avatar trini avatar mjdillon avatar magus424 avatar amaranth avatar poizan42 avatar cokernel avatar woutershep avatar phoenix09 avatar tewebu avatar hypehuman avatar zelenay avatar mammothb avatar riannucci avatar drgaellon avatar hastebro avatar jcranmer avatar kobata avatar markuskeunecke avatar mmccubbing avatar noobkitten avatar romanalexander avatar kmchappell avatar tomrauchenwald avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.