Skip to content

flexsurfer/starrupture-planner

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

15 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

Rupture Planner

The Ultimate Production Planning Tool for Star Rupture

Plan, optimize, and have fun with perfect resource management! ๐ŸŒŒ

Built with React TypeScript Vite Tailwind CSS

๐ŸŽฎ Open Planner โ€ข ๐Ÿ›  Contribute


โœจ What is Rupture Planner?

Rupture Planner is a free, open-source production planning tool designed for the Star Rupture game. Whether you're a casual builder or a min-maxing efficiency expert, this tool helps you:

  • ๐Ÿญ Visualize complex production chains with interactive flow diagrams
  • ๐Ÿ“Š Calculate exact building requirements for any production target
  • ๐ŸŽฏ Optimize resource allocation and eliminate bottlenecks
  • ๐Ÿ” Browse all items and recipes with advanced filtering
  • ๐ŸŒ™ Work in comfort with beautiful light/dark themes

Built by gamers, for gamers - just for the fun of it! ๐ŸŽ‰


๐ŸŒŸ Features

๐Ÿ“ฆ Smart Item Catalog

  • Browse all game items with beautiful icons
  • Filter by type: Raw Materials, Processed, Components, Ammo
  • Color-coded categories for instant recognition
  • Responsive grid layout that adapts to your screen

โš—๏ธ Interactive Recipe Browser

  • Collapsible building sections (closed by default for clean browsing)
  • Visual input/output relationships with item icons
  • Production rates clearly displayed for each recipe
  • Hover effects and smooth animations

๐Ÿญ Advanced Production Planner

  • Interactive Flow Diagrams: See your entire production chain at a glance
  • Smart Auto-Layout: Uses Dagre algorithm for optimal node positioning
  • Visual Production Flow: Item icons on edges show what flows where
  • Building Count Calculator: Automatically calculates exact requirements
  • Lazy Loading: Optimized bundle splitting for fast initial load
  • Auto-Fit View: Automatically centers and scales diagrams when switching items
  • Zoom & Pan: Full navigation controls with minimap

๐ŸŽจ Beautiful User Experience

  • Modern, responsive design with Tailwind CSS + DaisyUI
  • Smooth animations and transitions
  • Light/Dark theme toggle
  • Intuitive tab-based navigation

๐Ÿš€ Quick Start

Prerequisites

  • Node.js 18+
  • npm or yarn

Installation

# Clone the repository
git clone https://github.com/flexsurfer/starrupture-planner.git
cd starrupture-planner

# Install dependencies
npm install

# Start development server
npm run dev

๐ŸŽ‰ That's it! Open http://localhost:5173 and start planning your galactic empire!

Build for Production

# Create optimized build
npm run build

# Preview production build
npm run preview

๐Ÿ›  Tech Stack

This project uses modern, cutting-edge technologies:

Technology Purpose Version
โš›๏ธ React UI Framework 19.1.0
๐Ÿ“˜ TypeScript Type Safety 5.8.3
โšก Vite Build Tool 7.0.4
๐ŸŽจ Tailwind CSS Styling 4.1.11
๐ŸŒธ DaisyUI UI Components 5.0.50
๐Ÿ”„ React Flow Interactive Diagrams 12.8.2
๐Ÿ“Š Dagre Graph Layout 0.8.5
๐Ÿ”ฅ Reflex State Management 0.1.12
๐Ÿงช Vitest Testing 3.2.4

๐Ÿ“ Project Structure

starrupture-planner/
โ”œโ”€โ”€ ๐Ÿ“„ README.md           # You are here!
โ”œโ”€โ”€ ๐ŸŽจ assets/             # Static assets (images, icons)
โ”‚   โ””โ”€โ”€ icons/
โ”‚       โ”œโ”€โ”€ buildings/     # Building icons
โ”‚       โ””โ”€โ”€ items/         # Item icons
โ”œโ”€โ”€ ๐Ÿ—๏ธ src/
โ”‚   โ”œโ”€โ”€ components/        # React components
โ”‚   โ”‚   โ”œโ”€โ”€ planner/       # Production planner logic
โ”‚   โ”‚   โ””โ”€โ”€ ui/           # Reusable UI components
โ”‚   โ”œโ”€โ”€ state/            # Reflex state management
โ”‚   โ””โ”€โ”€ data/             # Game data (JSON)
โ”œโ”€โ”€ ๐Ÿ“ฆ dist/              # Production build
โ””โ”€โ”€ โš™๏ธ config files       # Vite, TypeScript, ESLint

๐ŸŽฎ How to Use

1. Browse Items ๐Ÿ“ฆ

  • Click the Items tab to explore all game items
  • Use category filters to find what you need
  • Each item shows its type with color coding

2. Explore Recipes โš—๏ธ

  • Visit the Recipes tab to see all production recipes
  • Click on any building header to expand/collapse its recipes
  • Visual flow shows inputs โ†’ building โ†’ outputs

3. Plan Production ๐Ÿญ

  • Go to the Planner tab for advanced planning
  • Select any item from the dropdown
  • Set your target production rate
  • Watch the magic happen! โœจ

The planner will:

  • Calculate exact building counts needed
  • Show the complete supply chain
  • Display item flow rates between buildings
  • Auto-arrange everything in a clean diagram

๐Ÿค Contributing

We love contributors! Whether you're fixing bugs, adding features, or improving docs, every contribution makes Rupture Planner better.

๐Ÿ› Found a Bug?

  1. Check existing issues
  2. Create a new issue with:
    • Clear description
    • Steps to reproduce
    • Expected vs actual behavior
    • Screenshots if applicable

๐Ÿ’ก Have an Idea?

  1. Open an issue to discuss your idea
  2. We'll help you shape it into an actionable plan
  3. Fork, code, and submit a PR!

๐Ÿ›  Development Workflow

# 1. Fork and clone
git clone https://github.com/flexsurfer/starrupture-planner.git
cd starrupture-planner

# 2. Create feature branch
git checkout -b feature/awesome-feature

# 3. Install and start
npm install
npm run dev

# 4. Code your magic โœจ
# ... make your changes ...

# 5. Test everything
npm run test
npm run lint

# 6. Commit and push
git commit -m "Add awesome feature"
git push origin feature/awesome-feature

# 7. Create Pull Request

๐Ÿ“‹ Contribution Guidelines

  • Code Style: We use ESLint + Prettier (runs automatically)
  • Testing: Add tests for new features
  • Documentation: Update README if needed
  • Small PRs: Keep changes focused and reviewable
  • Have Fun: This is a fun project - enjoy the process! ๐ŸŽ‰

๐ŸŽจ Adding New Game Data

Game data lives in src/data/:

  • items_catalog.json - All game items
  • buildings_and_recipes.json - Buildings and their recipes

To add new items/buildings:

  1. Update the JSON files
  2. Add corresponding icon images to assets/icons/
  3. Test in the app
  4. Submit a PR!

๐Ÿ“„ License

This project is licensed under the MIT License - see the LICENSE file for details.

TL;DR: Free to use, modify, and share. Just give credit where it's due! ๐Ÿ™


๐ŸŽฏ Roadmap

Exciting features coming soon:

  • ๐Ÿ”ง Recipe Optimization: Find the most efficient production setups
  • ๐Ÿ’พ Save/Load Plans: Bookmark your favorite production chains
  • ๐Ÿ” Advanced Search: Find items by name, type, or usage
  • ๐Ÿ“Š Resource Calculator: Calculate total raw material needs
  • ๐ŸŒ Multiplayer Planning: Share plans with your team
  • ๐Ÿ“ฑ Mobile App: Take your plans on the go
  • ๐ŸŽจ Custom Themes: Personalize your planning experience

๐Ÿ™‹โ€โ™€๏ธ FAQ

Q: Is this official?
A: Nope! This is a fan-made tool built for fun by the community.

Q: Is it free?
A: 100% free, open-source, and always will be!

Q: Can I contribute?
A: Absolutely! We welcome all skill levels.

Q: Does it work on mobile?
A: It's responsive and works on mobile, but desktop is recommended for complex planning.

Q: What if the game updates?
A: We'll update the data files to match. Community help is always welcome!


๐Ÿ’– Acknowledgments

  • Star Rupture community for inspiration
  • React Flow team for amazing diagram capabilities
  • Tailwind CSS & DaisyUI for beautiful styling
  • All contributors and users who make this project awesome!

Made with โค๏ธ by gamers, for gamers

May your production lines be efficient and your resources abundant! ๐ŸŒŒ

โญ Star this repo if it helped you! โญ

๐Ÿ› Report Bug โ€ข ๐Ÿ’ก Request Feature โ€ข ๐Ÿค Contribute

About

The ultimate production planning tool for Star Rupture game - plan, optimize, and have fun!

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Languages