Skip to content

Latest commit

 

History

History
142 lines (104 loc) · 6 KB

README.md

File metadata and controls

142 lines (104 loc) · 6 KB
Raw

Cookie Monster

Cookie Monster is an addon you can load into Cookie Clicker, that offers a wide range of tools and statistics to enhance the game. It is not a cheat interface – although it does offer helpers for golden cookies and such, everything can be toggled off at will to only leave how much information you want.

This is a helper, and it is here to help you at whichever degree you want, if you only need some help shortening long numbers, it does that. If you need to be accompanied by hand to pick the best buildings to buy, it does that, but everything is an option.

Current version

You can see the current version, and a full history of all versions and what they changed by consulting the releases page.

What it does

At its core, Cookie Monster computes an index on both buildings and upgrades:

  • Payback Period (PP): Indicates how much a building is worth by using the formula max(cost - cookies in bank, 0)/cps + cost/Δ cps

Cookie Monster also indicates the time left before being able to buy an upgrade or building, and takes it into consideration. It will take everything in consideration, meaning if buying a building also unlocks an achievement which boosts your income, which unlocks an achievement, it will know and highlight that building's value.

This index is computed for buildings and upgrades. If the relevant option is enabled, it will color-code each of them based on their value:

  • Light Blue: (upgrades) This item has a better PP than any building
  • Green: This item has the best PP
  • Yellow: This item is not the best, but it is closer to best than it is to worst
  • Orange: This item is not the worst, but it is closer to worst than it is to best
  • Red: This item has the worst PP
  • Purple: (upgrades) This item has a worse PP than any building
  • Gray: (upgrades) This item has not been calculated and/or cannot be calculated due to no definitive worth.

Note: For this index, lower is better, meaning a building with a PP of 1 is more interesting than one with a PP of 3.

What it doesn't do

Most likely you'll find items in gray like Golden Cookie upgrades, clicking upgrades, season upgrades – everything that doesn't earn you a direct bonus to your income will display as gray. This means the following upgrades are not taken into account by Cookie Monster:

  • Plastic mouse
  • Iron mouse
  • Titanium mouse
  • Adamantium mouse
  • Unobtainium mouse
  • Lucky day
  • Serendipity
  • Get lucky
  • Elder Pledge
  • Sacrificial rolling pins
  • etc.

Do note though that, although these upgrades have no direct value, if buying them earns you an achievement of some sort which in return gives you milk and income, Cookie Monster will display that value.

Using

Bookmarklet

Copy this code and save it as a bookmark. Paste it in the URL section. To activate, click the bookmark when the game's open.

javascript: (function () {
	Game.LoadMod('https://aktanusa.github.io/CookieMonster/CookieMonster.js');
}());

If (for some reason) the above doesn't work, trying pasting everything after the javascript: bit into your browser's console.

For beta, use the following instead:

javascript: (function () {
	Game.LoadMod('https://aktanusa.github.io/CookieMonster/CookieMonsterBeta.js');
}());

Userscript

If you'd rather use the addon as a script via per example Greasemonkey or Tampermonkey, you can use the following script, which will automatically load Cookie Monster every time the original game loads. You may need to specify http://orteil.dashnet.org/cookieclicker/ when asked for a namespace or includes. For how to add an userscript to your browser, refer to your browser/plugin's documentation as the method changes for each one.

// ==UserScript==
// @name Cookie Monster
// @namespace Cookie
// @include http://orteil.dashnet.org/cookieclicker/
// @version 1
// @grant none
// ==/UserScript==

var code = "(" + (function() {
    var checkReady = setInterval(function() {
        if (typeof Game.ready !== 'undefined' && Game.ready) {
            Game.LoadMod('https://aktanusa.github.io/CookieMonster/CookieMonster.js');
            clearInterval(checkReady);
        }
    }, 1000);
}).toString() + ")()";

window.eval(code);

If you are using the beta, use this instead:

// ==UserScript==
// @name Cookie Monster Beta
// @namespace Cookie
// @include http://orteil.dashnet.org/cookieclicker/beta/
// @version 1
// @grant none
// ==/UserScript==

var code = "(" + (function() {
    var checkReady = setInterval(function() {
        if (typeof Game.ready !== 'undefined' && Game.ready) {
            Game.LoadMod('https://aktanusa.github.io/CookieMonster/CookieMonsterBeta.js');
            clearInterval(checkReady);
        }
    }, 1000);
}).toString() + ")()";

window.eval(code);

Bugs and suggestions

Any bug or suggestion should be opened as an issue in the repository for easier tracking. This allows me to close issues once they're fixed.

Before submitting a bug, make sure to give a shot at the latest version of the addon on the dev branch. For this, use the following bookmarklet:

javascript: (function () {
	Game.LoadMod('https://cdn.rawgit.com/Aktanusa/CookieMonster/dev/CookieMonster.js');
}());

If the bug is still here, you can submit an issue for it.

All suggestions are welcome, even the smallest ones.

Contributors