Skip to content

Commit 168cb08

Browse files
committed
Refactor README.md: Update mod name and feature descriptions
1 parent c5f7092 commit 168cb08

File tree

1 file changed

+17
-26
lines changed

1 file changed

+17
-26
lines changed

README.md

Lines changed: 17 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,30 @@
1-
# BestDealHelper
1+
# Cookie Profit Predictor
22

3-
Enhance your gaming experience with this mod, offering strategic features such as:
3+
Elevate your gameplay with the Cookie Profit Predictor mod, which introduces a suite of strategic tools designed to optimize your resource management and decision-making:
44

5-
- A Payback Rate indicator that displays the Cookies Per Second (CPS) you'll earn from an item, showing how quickly the item's cost will be recouped. It's a key metric for efficient gameplay.
6-
- A ranking system for buildings and upgrades based on their payback efficiency, helping you make the best investment decisions.
7-
- A timer showing the waiting period for acquiring buildings and upgrades, allowing for better planning and strategy.
8-
- Compatibility with achievements, ensuring that none are disabled, so you can play without any restrictions.
5+
## Payback Efficiency Indicator
6+
Displays the projected Cookies Per Second (CPS) gain from investments, helping you understand how swiftly an item will pay for itself. This is a crucial metric for maximizing gameplay efficiency.
97

10-
Get ready for a more tactical gaming session with this mod!
8+
- Tier Upgrade Path Planning: Calculates the potential benefits of bulk purchasing buildings to unlock the next tier upgrade, which can often enhance the payback efficiency.
9+
- Rainbow Highlighting for Optimal Interim Purchases: Uses a spectrum of colors to spotlight interim purchases that, while not the ultimate best deal, can expedite your progress toward the most beneficial long-term investments.
10+
- Customizable Color Coding: Personalize the color scheme used for payback efficiency indicators, providing a visual representation that aligns with your preferences.
1111

12-
-----
12+
## Item Timer
13+
Reveals how long you'll need to wait before you can afford a building or upgrade, enabling you to plan your strategy more effectively.
1314

14-
## Comprehensive Feature Overview
15+
## Banking Strategy Integration
16+
Locks a target CPS of your cookies to maximize saving for a "Lucky!" payout or other bonuses.
1517

16-
### 1. Payback Rate Ratio Display 💹
17-
Introduces a **normalized** Payback Rate, with higher values indicating shorter payback periods after purchases. This helps you identify the most profitable items quickly.
18-
*Normalization adjusts each Payback Rate to a percentage that reflects its efficiency compared to the average, making comparisons easier.
18+
## Auto-Sorting by Payback Efficiency
19+
Automatically orders buildings and upgrades by their payback efficiency, steering you toward the most advantageous purchases first.
1920

20-
### 2. Automated Sorting for Buildings and Upgrades (Toggle Feature)
21-
Automatically ranks buildings and upgrades by their Payback Rate, guiding you towards the most beneficial purchases.
21+
- Wizard Tower Exclusion Feature: Exclude Wizard Towers from payback efficiency calculations, a useful feature for those who wish to maintain specific spell intervals without affecting their strategic planning.
2222

23-
### 3. Waiting Time Indication ⏳
24-
Presents a waiting time indicator for each item, giving you transparency on the expected delays.
25-
26-
### 4. Tier Upgrade Forecasting
27-
Estimates the benefits of purchasing multiple buildings up to the next upgrade tier, which can often result in a more favorable Payback Rate. The "(to X)" notation helps you understand how many buildings are needed to reach the optimal Payback Rate, factoring in tier upgrades.
28-
29-
### 5. Rainbow Color Coding for Optimal Intermediate Purchases
30-
Highlights alternative, more affordable purchases in rainbow colors that can accelerate your progress towards the best long-term investments.
31-
32-
### 6. Wizard Tower Exclusion Option (Toggle Feature)
33-
For advanced players aiming to maintain specific spell intervals, this option allows for the exclusion of wizard towers from Payback Rate calculations, preventing them from skewing your strategic overview.
23+
## Auto-Buy Functionality
24+
Automatically purchases the most efficient item based on the current payback efficiency calculations, streamlining the investment process.
3425

3526
## Resources
3627

37-
- [In-Depth Design Presentation for the Payback Rate Mod (Slides)](https://docs.google.com/presentation/d/e/2PACX-1vTzBJulPWJ08URtZp5QLGivJpnkVb3hF7dLUSOcUoWH9Pdtxmj3jmoPwnbL71LTP2moVhr3-GTd0cdA/pub?start=false&loop=false&delayms=60000)
28+
- [In-Depth Design Presentation for the Payback Efficiency Mod (Slides)](https://docs.google.com/presentation/d/e/2PACX-1vTzBJulPWJ08URtZp5QLGivJpnkVb3hF7dLUSOcUoWH9Pdtxmj3jmoPwnbL71LTP2moVhr3-GTd0cdA/pub?start=false&loop=false&delayms=60000)
3829
- Report issues [on the Github](https://github.com/jcppkkk/BestDealHelper/issues)
3930
- Join us on [Discord](https://discord.gg/VxVdXDdTNW)

0 commit comments

Comments
 (0)