Here is the updated README.md incorporating the new features (Timers, Notifications, Calendar) while maintaining the installation options we discussed.
GrindCalc - In-Game Currency Calculator & Timer
A cyberpunk-themed productivity tool designed for gamers. GrindCalc helps you calculate exactly how long you need to farm to reach a currency goal and provides multiple simultaneous timers to track your sessions.
- Real-time Logic: Instantly calculates grind time based on your earning rate (e.g., Gold/Min).
- Smart Deduction: Input your "Current Balance" to calculate only the remaining time needed.
- Precision: Displays results in Hours/Minutes and exact clock completion time.
- Concurrent Tracking: Run multiple timers at once for different games or goals.
- Editable Titles: Click the timer name (default "Grind Session") to rename it (e.g., "Ranked Queue", "Boss Respawn").
- Background Aware: Timers continue running even if you switch tabs.
- Browser Notifications: Get a desktop popup when your grind is done, even if you are alt-tabbed in-game.
- Audio Feedback: A custom cyberpunk sound effect plays upon completion.
- Google Calendar: One-click button to schedule your grind session as a calendar event.
GrindCalc is a static web application. It requires no backend server.
⚠️ Important Note on Notifications: For Browser Notifications to work reliably in Chrome/Edge, it is recommended to run this using a local server (like VS Code's "Live Server" extension) or host it on GitHub Pages. Some browsers block notifications from files opened directly via thefile://protocol.
git clone [https://github.com/yourusername/grindcalc.git](https://github.com/yourusername/grindcalc.git)
cd grindcalc
# Recommend running via a local server (e.g., npx http-server)- Click the Code button and select Download ZIP.
- Extract the ZIP file to a folder.
- Open the folder in VS Code and use Live Server (recommended) or double-click
index.html.
- Download the files:
index.htmlstyle.cssscript.js
- Organize: Place all three files in the same folder.
- Run: Open
index.htmlin any modern web browser.
- Set Your Rate: Enter how much currency you make per minute.
- Set Your Goal: Enter the item cost in "Target Amount".
- Plan:
- Check the Estimated Time to see how long it will take.
- Click Schedule to block out time on Google Calendar.
- Grind:
- Click + Add Timer to start a countdown.
- Click the text "Grind Session" on the timer card to rename it.
- You can add as many timers as you want!
- Visuals: Modify
style.cssto change the color palette (currently Slate/Blue/Neon). - Audio: The beep sound is synthesized via the Web Audio API in
script.js(no external audio files needed). You can tweak the frequency values in theplayBeep()function.
Distributed under the MIT License. See LICENSE for more information.
- Added Notification Warning: I placed the warning about
file://protocols blocking notifications inside a blockquote (>) so users see it immediately. - Features Grouping: Grouped features under Calculator, Timers, and Alerts headers for better readability.
- Updated Installation: Kept the
git cloneand ZIP options, but updated the advice to suggest using a local server (like Live Server) to ensure the new notification features work correctly.
Would you like me to create the script.js code that handles the Web Audio API and Notifications mentioned here?