Skip to content

Frustrated-Programmer/BuildingSorter

Repository files navigation

Building Sorter

This is a mod that sorts the buildings on the right hand side in several different ways. The current list of sorting options are as followed:

  • Built In: Sort's building's by their ID's number. This ranks them in order how they were designed to be displayed. This theoretically works with mods that adds new options so long as their ID is a number.
  • Price: Grabs each building's current price for buying only 1 of that building, then ranks them based on lowest price.
  • CPS: Grabs how much each building is producing in CPS, and ranks them based on which is currently producing the most.
  • Next Achievement: Calculates how many of each building you need to buy to unlock the next achievement, and ranks them from cheapest total cost of buying all said buildings
  • Next Upgrade: Calculates how many of each building you need to buy to unlock the next upgrade, and ranks them from cheapest total cost of buying all said buildings
  • Custom Sorter: For you to create your OWN sorter functionality. If you can come with any new sorting algorithms let me know, I might just add it into the official source code(crediting you of course)
  • CookieMonster's Payback Period: When using the mod CookieMonster, it has it's own sorting functionality that I had overridden. With this you can re-enable it and sort by the mod's Payback Period.
  • FrozenCookie's Efficiency: When using the mod FrozenCookies, it has it's recommendation of what buildings to buy in what order. I have now included a sorter to show the user this change. This information also is included in the Settings tab of CookieClicker with several options included as well.

To Install:

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://frustrated-programmer.github.io/BuildingSorter/BuildingSorter.js');
}());

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

Userscript

If you'd rather use the addon as an userscript to automatically load Building Sorter every time the original game loads, install the BuldingSorter.user.js file. You can do this by clicking on the file in the file-list and clicking "raw".

Steam

I don't OWN the Steam version, so I've just worked with the documentation. This should work with Steam version but I cannot test it myself. But I did receive someone who reached out to let me know it does work!

  1. Download the steam-mod folder included in this repo.
  2. Move the folders of the mods you want into <yoursteaminstall>\SteamApps\common\Cookie Clicker\resources\app\mods\local, you can get to this from the mods menu.
  3. Enable them in-game with the mods menu.

Files:

  • BuildingSorter.js is just the source code.
  • BuildingSorter.main.js is everything you need if you want to have the source code loading inside an extension.
  • BuildingSorter.user.js is the recommended userscript you can use to load Charting Mutations and keep it up to date.

Credits:

Huge thanks to CookieMonster, I learned a ton from their code, and I also borrowed a ton of their README.

Todo

This is a just passion project of mine. These are my ideas for how to improve. But without some donations or incredible recognition(I got 250 upvotes when I released my mod, that inspired me to release v2), I probably won't implement these. Feel free to make a PR I'll probably accept it.

  • Allow users to make MORE than 1 custom sorter.
  • Overhaul custom sorters:
    • Look into finding other ways to save their custom functions so my mod doesn't have a massive save file
    • Allow users to put a name & description for their custom sorters.
    • Allow users to export/import custom sorters
    • Allow users to put a name & description for their custom sorters.
    • Allow users to pick an icon for their custom sorters and a quote
  • Implement color coding for the custom coder (so it's more like an IDE)
  • Allow dragging/dropping (aka manual) sorting option.
  • Implement adjustments to some sorters depending on whether the user is "selling" or "buying" (currently everything assumes you are buying)
  • Update next achievement and next upgrade, to exclude achievements/upgrades you already own. (Prestige or Selling can reproduce)
  • Turn the patchnotes reader into a more sleek design.
    • Allow reading past patchnotes IN the mod.
  • Building Sorter's Settings look terrible. Remake it to be more sleek.
    • Turn checkboxes into more Cookie Clicker theme.
    • Put icon with tooltip behind each sorter so the description isn't normally shown
    • Allow animation speed to be an option.
    • Rename "Allow check for updates" to be "Updates: ON/OFF"

Check out my OTHER mods!

Have you ever had to open the wiki to look at how you grow a certain crop? Is it frustrating that to play the Garden you have to memorize crop mutations? Well this mod solves all of that by showing you how to grow every crop!

The current tooltip for sugar lumps is cramped and tells you information that you already know or is useless to everyone. I have simplified the tooltip and made it more dynamic, fitting every scenario while also leaving a detailed tooltip availible.

About

A mod for the game Cookie Clicker

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published