Skip to content

Commit

Permalink
Refactor README.md: Update mod name and feature descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
jcppkkk committed Mar 18, 2024
1 parent c5f7092 commit 168cb08
Showing 1 changed file with 17 additions and 26 deletions.
43 changes: 17 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,39 +1,30 @@
# BestDealHelper
# Cookie Profit Predictor

Enhance your gaming experience with this mod, offering strategic features such as:
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:

- 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.
- A ranking system for buildings and upgrades based on their payback efficiency, helping you make the best investment decisions.
- A timer showing the waiting period for acquiring buildings and upgrades, allowing for better planning and strategy.
- Compatibility with achievements, ensuring that none are disabled, so you can play without any restrictions.
## Payback Efficiency Indicator
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.

Get ready for a more tactical gaming session with this mod!
- 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.
- 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.
- Customizable Color Coding: Personalize the color scheme used for payback efficiency indicators, providing a visual representation that aligns with your preferences.

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

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

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

### 2. Automated Sorting for Buildings and Upgrades (Toggle Feature)
Automatically ranks buildings and upgrades by their Payback Rate, guiding you towards the most beneficial purchases.
- 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.

### 3. Waiting Time Indication ⏳
Presents a waiting time indicator for each item, giving you transparency on the expected delays.

### 4. Tier Upgrade Forecasting
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.

### 5. Rainbow Color Coding for Optimal Intermediate Purchases
Highlights alternative, more affordable purchases in rainbow colors that can accelerate your progress towards the best long-term investments.

### 6. Wizard Tower Exclusion Option (Toggle Feature)
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.
## Auto-Buy Functionality
Automatically purchases the most efficient item based on the current payback efficiency calculations, streamlining the investment process.

## Resources

- [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)
- [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)
- Report issues [on the Github](https://github.com/jcppkkk/BestDealHelper/issues)
- Join us on [Discord](https://discord.gg/VxVdXDdTNW)

0 comments on commit 168cb08

Please sign in to comment.