
The Ultimate Production Planning Tool for Star Rupture
Plan, optimize, and have fun with perfect resource management! ๐
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! ๐
- 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
- 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
- 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
- Modern, responsive design with Tailwind CSS + DaisyUI
- Smooth animations and transitions
- Light/Dark theme toggle
- Intuitive tab-based navigation
- Node.js 18+
- npm or yarn
# 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!
# Create optimized build
npm run build
# Preview production build
npm run preview
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 |
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
- 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
- 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
- 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
We love contributors! Whether you're fixing bugs, adding features, or improving docs, every contribution makes Rupture Planner better.
- Check existing issues
- Create a new issue with:
- Clear description
- Steps to reproduce
- Expected vs actual behavior
- Screenshots if applicable
- Open an issue to discuss your idea
- We'll help you shape it into an actionable plan
- Fork, code, and submit a PR!
# 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
- 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! ๐
Game data lives in src/data/
:
items_catalog.json
- All game itemsbuildings_and_recipes.json
- Buildings and their recipes
To add new items/buildings:
- Update the JSON files
- Add corresponding icon images to
assets/icons/
- Test in the app
- Submit a PR!
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! ๐
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
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!
- 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