Skip to content

jtn0123/MegaBonk

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

771 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

๐ŸŽฎ MegaBonk Complete Guide

GitHub release CI codecov Lighthouse

The ultimate reference system for MegaBonk - 80 items, 29 weapons, 23 tomes, 20 characters, 8 shrines, build planning, screenshot scanning, and breakpoint tools in one interactive web app.

โœจ Core Features

๐Ÿ“ฆ 7 Complete Categories

  • Items (80/80) โœ… COMPLETE - Scaling graphs, stacking behavior, true formulas
  • Weapons (29/29) โœ… COMPLETE - Tier rankings, upgrade paths, synergies
  • Tomes (23/23) โœ… COMPLETE - Priority rankings, stat scaling, recommendations
  • Characters (20/20) โœ… COMPLETE - Passives, strengths/weaknesses, builds
  • Shrines (8/8) โœ… COMPLETE - Types, strategies, rewards
  • Build Planner + Screenshot Import - Create builds manually or review a screenshot import before applying it
  • Breakpoint Calculator - "How many stacks?" solver with visual graphs

๐ŸŽจ Visual Excellence

  • Color-coded rarity system (Common โ†’ Legendary)
  • Tier badges (SS/S/A/B/C) for power rankings
  • Tab navigation with smooth transitions
  • Context-sensitive filters per category
  • Dark theme optimized for long sessions
  • Fully responsive (desktop + mobile)

๐Ÿ› ๏ธ Build Planner with Stats Calculator

  • Select character + weapon + tomes + items
  • Screenshot import review flow - Import a pause-menu screenshot, inspect confidence, then apply it manually
  • Real-time stat calculation - See total damage, HP, crit chance, attack speed, etc.
  • OVERCRIT detection - Special highlight when crit >100%
  • Automatic synergy detection across all categories
  • Export/import builds via clipboard
  • Visual analysis showing optimal combinations

๐Ÿงฎ Breakpoint Calculator

  • "How many Big Bonks for 100% proc?" - Instant answer
  • Visual scaling graphs for 1-10 stacks
  • Common breakpoints quick reference
  • Stack cap warnings
  • One-and-done item detection

โš–๏ธ Compare Mode

  • Side-by-side comparison of 2-3 items
  • Compare formulas, scaling, synergies
  • Easy selection from item cards
  • Detailed breakdowns

๐Ÿ“Š Data Quality

  • Exact formulas and scaling values
  • Cross-category synergy mapping
  • Tier rankings from meta analysis
  • Unlock requirements and costs
  • Build tips and strategies

๐Ÿ’พ Easy to Maintain

  • JSON-based data structure
  • Update items/weapons/characters by editing JSON
  • No coding required for content updates
  • Takes 5-10 minutes per game patch
  • Git tracks all changes

๐Ÿš€ Quick Start

๐Ÿ“ฑ Launch on Desktop or Mobile

Easiest way (works on any device):

npm install
npm run dev

Then:

  • Desktop: Open the Vite URL shown in the terminal
  • Mobile: Open the same LAN URL on your phone to test the responsive/PWA flow

Simple static preview:

python3 serve.py

๐Ÿ“ฒ Install as Mobile App

  1. Launch with npm run dev
  2. Open on your phone
  3. Tap "Add to Home Screen"
  4. Now it works offline like a real app!

๐Ÿ“ฑ Package as Standalone Android App

Want a true standalone APK that works without your computer?

  • Full Guide: See docs/ANDROID_STANDALONE.md for detailed instructions

Build methods:

  • PWABuilder (easiest, no installation)
  • Bubblewrap (local development) โ† Step-by-step instructions ready!
  • Capacitor (advanced, native features)

Update the Guide

When the game meta changes:

  1. Open data/items.json
  2. Find the item you want to update
  3. Modify the values (see docs/UPDATE_GUIDE.md for details)
  4. Run npm run dev and refresh your browser

Takes 5-10 minutes per update.

๐Ÿ“ Project Structure

MegaBonk/
โ”œโ”€โ”€ data/
โ”‚   โ”œโ”€โ”€ items.json          # 80 items with scaling graphs
โ”‚   โ”œโ”€โ”€ weapons.json        # 29 weapons with synergies
โ”‚   โ”œโ”€โ”€ tomes.json          # 23 tomes with priorities
โ”‚   โ”œโ”€โ”€ characters.json     # 20 characters with passives
โ”‚   โ”œโ”€โ”€ shrines.json        # 8 shrines with strategies
โ”‚   โ””โ”€โ”€ stats.json          # Game mechanics formulas + breakpoints
โ”œโ”€โ”€ src/
โ”‚   โ”œโ”€โ”€ index.html          # Main app shell and metadata
โ”‚   โ”œโ”€โ”€ script.ts           # App entrypoint
โ”‚   โ”œโ”€โ”€ manifest.json       # Source manifest metadata
โ”‚   โ”œโ”€โ”€ modules/            # Feature modules (search, planner, scan, CV, etc.)
โ”‚   โ”œโ”€โ”€ styles/             # Modular CSS
โ”‚   โ”œโ”€โ”€ images/             # App image assets
โ”‚   โ””โ”€โ”€ icons/              # App icons for PWA/mobile install
โ”œโ”€โ”€ scripts/                # Build, test, release, and data utilities
โ”œโ”€โ”€ docs/
โ”‚   โ”œโ”€โ”€ UPDATE_GUIDE.md     # Maintenance instructions
โ”‚   โ”œโ”€โ”€ DATA_FORMAT.md      # JSON schema reference
โ”‚   โ””โ”€โ”€ SOURCES.md          # Data sources
โ”œโ”€โ”€ vite.build.config.js    # Main Vite build + PWA config
โ”œโ”€โ”€ serve.py                # Lightweight local static server
โ””โ”€โ”€ README.md               # This file

๐Ÿ“– Documentation

๐ŸŽฏ Use Cases

For Players

  • "Should I stack Big Bonk?" - Check scaling graphs
  • "What's the best weapon for CL4NK?" - View character page
  • "Which tomes should I prioritize?" - See tier rankings
  • "How do I build for crit?" - Use Build Planner
  • "What shrines should I take?" - Read strategies

For Build Crafters

  • Plan complete loadouts with Build Planner
  • Discover synergies automatically
  • Compare weapon upgrade paths
  • Optimize tome priorities
  • Export and share builds

For Theorycrafters

  • Analyze scaling formulas (crit overcrit, armor diminishing returns)
  • Calculate breakpoints (when items hit 100% proc rate)
  • Compare tier rankings across categories
  • Understand stat interactions

For Community

  • Share builds via export codes
  • Update guide when game patches
  • Track meta shifts with git history
  • Contribute corrections via pull requests

๐ŸŽจ Visual Features

Rarity Colors

  • ๐ŸŸข Common: Green (#5cb85c)
  • ๐Ÿ”ต Uncommon: Blue (#5bc0de)
  • ๐ŸŸฃ Rare: Magenta (#d946ef)
  • ๐ŸŸช Epic: Purple (#8b5cf6)
  • ๐ŸŸก Legendary: Gold (#fbbf24)

Tier Badges

  • โญโญ SS Tier: Game-breaking (Gold)
  • โญ S Tier: Excellent (Silver)
  • ๐Ÿฅ‰ A Tier: Strong (Bronze)
  • โ—ผ๏ธ B Tier: Situational (Gray)
  • ๐Ÿ”ด C Tier: Weak (Red)

Stacking Indicators

  • โˆž - Stacks well (get more!)
  • โœ“ - One-and-done (don't stack)
  • ~ - Limited stacking (situational)

๐Ÿ’ก Example Content

๐Ÿ“ฆ Items

  • Big Bonk - 2% chance for 20x damage (stacks infinitely)
  • Anvil - +1 to all weapon upgrades (one-and-done)
  • Beefy Ring - +20% damage per 100 HP (scales with HP)
  • Cursed Doll - 30% enemy max HP as DoT (boss melter)
  • All with scaling graphs showing 1-10+ stack value

โš”๏ธ Weapons

  • Sniper Rifle (SS) - 22 base damage, piercing, crit scaling
  • Revolver (S) - 6 projectiles, attack speed monster
  • Black Hole (S) - Crowd control king, size scaling
  • Katana (S) - Crit slasher, many upgrade paths
  • Each with upgrade paths, synergies, build tips

๐Ÿ“š Tomes

  • Damage Tome (SS, Priority 1) - Foundation of all builds
  • Precision (SS, Priority 2) - Crit chance โ†’ Overcrit scaling
  • XP Tome (S, Priority 1) - Fast leveling (capped at 10x)
  • Chaos Tome (S) - Random stats, pure RNG fun
  • All with priority rankings and recommendations

๐Ÿ‘ค Characters

  • CL4NK (SS) - +1% crit/level โ†’ Guaranteed Overcrit
  • Sir Oofie (S) - +1% armor/level โ†’ Unkillable tank
  • Vlad (S) - +1% lifesteal/level โ†’ Sustain god
  • Ninja (A) - Execute on evasion โ†’ High skill, high reward
  • All with passives, synergies, build strategies

๐Ÿ”„ Updating for New Patches

When a Patch Drops

  1. Check patch notes for item changes
  2. Open data/items.json
  3. Update changed values
  4. Increment version number
  5. Test in browser
  6. Commit with descriptive message

Example Update:

{
  "id": "gym_sauce",
  "base_effect": "+12% damage",  // Changed from +10%
  "scaling_per_stack": [12, 24, 36, 48, 60, 72, 84, 96, 108, 120]
}

Detailed instructions in docs/UPDATE_GUIDE.md.

๐Ÿงช Testing & Coverage

Run Tests

# Unit tests
npm run test:unit

# Unit tests with coverage
npm run test:unit:coverage

# E2E tests (Playwright)
npm run test:e2e

# E2E tests with coverage
npm run test:e2e:coverage

# Combined coverage (unit + E2E merged)
npm run test:coverage:all

Coverage Reports

  • Unit coverage: coverage/unit/index.html
  • E2E coverage: coverage/e2e/report.html
  • Merged coverage: coverage/merged/index.html

The merge script combines Istanbul coverage from unit tests with browser coverage from E2E tests, giving a holistic view of what code is actually tested.

๐Ÿ› ๏ธ Technical Details

Technologies

  • HTML5 - Semantic, accessible markup
  • CSS3 - Modern styling with Grid/Flexbox
  • TypeScript - Modular app logic with static checks
  • Vite - Dev server, production build, and PWA packaging
  • Chart.js - Beautiful interactive graphs
  • JSON - Human-readable data storage

Browser Support

  • โœ… Chrome/Edge (latest)
  • โœ… Firefox (latest)
  • โœ… Safari (latest)
  • โœ… Mobile browsers

Local Development

  • Node.js 20+
  • npm install
  • npm run dev for local development
  • npm run build for a production bundle in dist/

๐Ÿ“ Contributing

Found incorrect data or want to add missing items?

  1. Verify the information in-game or from official sources
  2. Update the relevant JSON file
  3. Test your changes locally
  4. Commit with a clear message
  5. Push to the repository

See docs/UPDATE_GUIDE.md for detailed instructions.

๐ŸŽฎ About MegaBonk

MegaBonk is a roguelike action game available on Steam. This guide is a community-created resource to help players understand item mechanics and scaling.

๐Ÿ“œ Data Sources

All data compiled from:

  • Official game (v1.0.17)
  • MegaBonk.org community wiki
  • Steam Community guides
  • Gaming news sites (GameRant, Dexerto, PCGamesN)
  • Community testing and discussions

Full source list in docs/SOURCES.md.

โš ๏ธ Disclaimer

This is a community-created resource based on publicly available information. While we strive for accuracy:

  • Always verify critical information in-game
  • Some mechanics may change with patches
  • Tier rankings reflect community consensus
  • Formulas are based on community testing

๐Ÿ“„ License

This project is open source and available for community use. Data is compiled from publicly available sources.

๐Ÿ™ Acknowledgments

  • MegaBonk developers for creating an amazing game
  • MegaBonk.org for comprehensive wiki data
  • Steam Community for detailed guides and testing
  • All players who contribute to understanding the mechanics

โœ… Recently Added (v1.0.18)

  • โœ… Complete item database - All 80/80 items
  • โœ… Complete weapons - All 29/29 weapons
  • โœ… Complete tomes - All 23/23 tomes
  • โœ… Build planner stats calculator - Real-time stat calculations
  • โœ… Compare mode - Side-by-side item comparison
  • โœ… Breakpoint calculator - Stack calculation solver
  • โœ… PWA support - Install as mobile app
  • โœ… Offline mode - Works without internet
  • โœ… Mobile launcher - One-click serve.py script

๐Ÿ”ฎ Possible Future Additions

  • Export build as image (PNG/JPEG)
  • Dark/light theme toggle
  • Save/load multiple builds to localStorage
  • Community build sharing
  • Advanced filters (combine multiple criteria)

Made with โค๏ธ for the MegaBonk community

Play MegaBonk: Steam Store Page


Quick Navigation

  • ๐Ÿ“– Update Guide - How to maintain this guide
  • ๐Ÿ“Š Data Format - JSON structure reference
  • ๐Ÿ”— Sources - Where data comes from
  • ๐ŸŽฏ Run npm run dev - Launch the guide locally

Questions? Check the docs or open an issue!

About

No description, website, or topics provided.

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors