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 22.18+ in the 22.x series, or 24.11+ (required by the project dependencies)
- npm or yarn
- Install Node.js with npm included, using a version listed above.
- Clone the repository, or download its ZIP from GitHub and extract it completely.
- Double-click
START.batin the project folder.
The launcher checks Node.js and npm, installs missing dependencies from package-lock.json on the first run (internet access required), then starts the server in a minimized Rupture Planner window and opens your default browser at http://localhost:5173.
Keep that window running while using the planner. Restore it from the taskbar to see server output; close it to stop the server. Closing the browser alone does not stop it. Setup errors stay visible; if the browser does not open, restore the minimized window to check for a startup error.
The launcher keeps port 5173 fixed so your browser-saved plans remain available at the same address. If the port is already in use, stop the existing server and try again. Plans saved on the hosted website are separate from local plans; use the planner's export/import settings to transfer them.
After pulling or downloading an update, run npm ci --include=dev in the project folder if its dependencies changed.
# 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 previewThis 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! 🎉
The UI uses a typed English message catalog with language selection in Global settings.
Game data and game-specific names remain unchanged. See the localization guide
to add a language or new UI copy. Validate catalogs with npm run test:i18n.
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!
The project's source code is licensed under the MIT License - see the LICENSE file for details.
Game assets are excluded: All files in assets/icons/ and its subdirectories are excluded from the MIT License. These icons come from StarRupture and belong to their respective rights holders. This project grants no license to them. See assets/icons/LICENSE for the full notice.
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! ⭐