david/CookieMonster
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Rename Return On Investment to Payback Period to fit what the number represents better (Issue #68)

Browse Source
This commit is contained in:
Aktanusa
2016-03-27 17:57:50 -04:00
parent 57ab55a2c1
commit 5d0958b63a
6 changed files with 121 additions and 119 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@@ -12,21 +12,21 @@ You can see the current version, and a full history of all versions and what the
At its core, Cookie Monster computes an index on both buildings and upgrades:
* **Return On Investment (ROI)**: Indicates how much a building is worth by using the formula max(cost - cookies in bank, 0)/cps + cost/Δ cps
* **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 ROI than any building
* Green: This item has the best ROI
* 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 ROI
* Purple: (upgrades) This item has a worse ROI than any building
* 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 ROI of 1 is more interesting than one with a ROI of 3.
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
@@ -134,5 +134,5 @@ All suggestions are welcome, even the smallest ones.
* **[Alderi Tokori](http://forum.dashnet.org/profile/Alderi)**: ROI calculations (unused now)
* **[Alhifar](https://github.com/Alhifar)**: Missed Golden Cookie Stat
* **[BlackenedGem](https://github.com/BlackenedGem)**: Golden/Wrath Cookie Favicons
* **[Sandworm](https://github.com/svschouw)**: Modified ROI calculation
* **[Sandworm](https://github.com/svschouw)**: Modified PP calculation
* **[Aktanusa](https://github.com/Aktanusa)**: Current maintainer