diff --git a/README.md b/README.md index eda0aa9..e2f95ca 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ > **"Build the Ultimate Global Supply Chain Empire."** -**Production - The Idle Game** is an expansive, strategic incremental/idle tycoon simulator inspired by *Factorio*, *Capitalism*, and modern idle engineering games. Take command of a burgeoning enterprise, starting from primary extraction (wheat, timber, iron ore) and scaling into complex, multi-tiered industrial supply chains producing microchips, commercial trucks, consumer smartphones, and corporate office furniture. +**Production - The Idle Game** is an expansive, strategic incremental/idle tycoon simulator inspired by *Factorio*, *Capitalism*, and modern industrial engineering games. Take command of a burgeoning enterprise, starting from primary extraction (wheat, timber, iron ore) and scaling into complex, multi-tiered industrial supply chains producing microchips, commercial trucks, consumer smartphones, electric hypercars, quantum computers, and space launch vehicles. The game is packaged as a lightweight, turnkey **Docker Compose stack** powered by a fast Python FastAPI backend with SQLite persistence and a high-performance Nginx reverse-proxy frontend. @@ -17,47 +17,76 @@ The game is packaged as a lightweight, turnkey **Docker Compose stack** powered * **Production Target Throttling:** Dial down any facility to 100%, 75%, 50%, 25%, or 0% (Paused) to conserve upstream stockpiles or manage intermediate bottlenecks. * **Distribution Fleet Toggle:** Toggle wholesale logistics off per facility to preserve finished goods for internal downstream lines or B2B tenders. * **Downstream Supply Policy:** Block or permit delivery to downstream consumers on a per-facility basis. - * **6 Interconnected Industry Sectors (24 Facilities & Commodities):** - 1. **Agriculture & Food:** Wheat, Milled Flour, Sugar Beet, Refined Sugar, Artisan Bread, Packaged Meals. - 2. **Forestry & Materials:** Raw Timber, Milled Planks, Industrial Paper, Office Furniture. - 3. **Mining & Metallurgy:** Iron Ore, Coking Coal, Structural Steel, Heavy Frameworks. - 4. **Chemicals & Polymers:** Crude Oil, Silica Quartz Sand, Industrial Polymers, Purified Silicon, Industrial Fertilizer. - 5. **High-Tech & Electronics:** Silicon Microchips, PCB Motherboards, Consumer Smartphones. - 6. **Heavy Industry & Vehicles:** Industrial Engines, Commercial Logistics Trucks. + * **12 Interconnected Industry Sectors (96 Facilities & Commodities across 8 Tiers):** + 1. **Agriculture & Food:** Wheat, Milled Flour, Sugar Beet, Refined Sugar, Artisan Bread, Packaged Meals, Fermented Yeast, Craft Beer. + 2. **Forestry & Materials:** Raw Timber, Milled Planks, Industrial Paper, Wood Pulp, Packaging Cartons, Plywood Sheets, Designer Furniture, Luxury Paperboard. + 3. **Mining & Metallurgy:** Iron Ore, Coking Coal, Crude Bauxite, Structural Steel, Refined Aluminium, Heavy Frameworks, Copper Ore, Refined Copper Wire. + 4. **Chemicals & Polymers:** Crude Oil, Silica Quartz Sand, Industrial Polymers, Purified Silicon, Industrial Fertilizer, Synthetic Resin, Industrial Solvent, Advanced Composites. + 5. **Energy & Power:** Raw Coal, Enriched Uranium, Solar Silicon Wafers, High-Capacity Batteries, Power Grid Transformers, Fuel Cells, Supercapacitors, Fusion Fuel Cells. + 6. **Electronics & Microtechnology:** Silicon Microchips, PCB Motherboards, Optical Glass, Micro Sensors, Display Panels, Consumer Smartphones, Fiber Optic Transceivers, Quantum Logic Gates. + 7. **Automotive & Heavy Industry:** Industrial Engines, Commercial Logistics Trucks, Industrial Gearboxes, Electric Drive Motors, Lithium Battery Packs, Electric Hypercars, Construction Cranes, Heavy Excavators. + 8. **Construction & Civil Engineering:** Limestone Rock, Portland Cement, Concrete Slag, Reinforced Rebar, Precast Concrete Beams, Architectural Glass, Steel Modular Trusses, High-Rise Prefab Pods. + 9. **Biotechnology & Pharmaceuticals:** Organic Culture Broth, Herbal Biomass, Synthetic Enzymes, Active Pharma Ingredients, Sterile Syringes, Antibiotic Medicine, Bio-Polymer Hydrogels, Gene Therapy Vials. + 10. **Consumer Goods & Appliances:** Cotton Fiber, Spun Yarn, Industrial Fabrics, Tempered Glass, Workwear Apparel, Smart Washing Machines, Smart Refrigerators, Robotic Vacuum Cleaners. + 11. **Robotics & Industrial Automation:** Hydraulic Pistons, Precision Servos, CNC Controllers, Industrial Robotic Arms, Automated Conveyors, Factory Cobots, Autonomous Mobile Robots, Automated High-Bay Warehouses. + 12. **Aerospace & Defense:** High-Strength Titanium Alloy, Jet Turbine Bladings, Turbofan Jet Engines, Carbon-Carbon Heat Shields, Commercial Avionics Suites, Satellite Bus Platforms, Commercial Airliners, Orbital Launch Vehicles. + +* **Corporate Reputation (Rep) & Strategic Standing Hub:** + * Fulfilling B2B procurement tenders awards **Corporate Reputation (Rep)** into your company's strategic reserve pool. + * Re-allocate Rep points dynamically at any time across 3 strategic pillars: + * **Model 1: B2B Procurement Standing:** Earn **+0.5% bonus cash payout** per allocated Rep point on every fulfilled corporate tender. + * **Model 2: Client Strategic Relations (MegaCorp Synergies):** Deepen alliances with the 4 MegaCorps: + * *Apex Resources:* **+0.2% raw material extraction yield** per point. + * *Titan Heavy Industries:* **0.2% discount on line expansion costs** per point (up to 50% discount). + * *Omni Dynamics:* **+0.15% cycle speed** per point. + * *Vanguard Shipping:* **+0.25% logistics fleet sales throughput** per point. + * **Model 3: Wholesale Brand Premium:** Command market pricing power with **+0.25% higher wholesale sales price** on all passive fleet sales per point. + * Points can be recalled and redistributed via the **Reset Allocations** button at any time. * **Modular "Plug & Play" Product Architecture (Scale to 100+ Products):** * Sector manifests are stored as self-contained ES-module catalog files under `frontend/js/data/sectors/*.js`. * **Single Source of Truth:** The Python FastAPI backend dynamically parses and registers sector files on startup (`backend/catalog_loader.py`), keeping frontend and backend simulation logic 100% in sync without duplicated configurations. - * Creating a new sector or adding 10, 50, or 100+ new units requires simply dropping a new sector file or object into `frontend/js/data/sectors/` and adding matching photos. + * Adding new sectors or units is as simple as dropping a new sector file or object into `frontend/js/data/sectors/` and adding matching photos. * See [`PRODUCT_GENERATOR_GUIDE.md`](./PRODUCT_GENERATOR_GUIDE.md) for complete manifest schemas, AI generator prompts, and instructions for bulk-adding products and sectors. +* **Flexible Floor Displays (Standard & Compact Views):** + * **Standard View:** Comprehensive cards featuring high-resolution cropped photographic banners of finished commodities, input chips with live depletion rates, policy switches, and batch action bars. + * **Compact View:** Dense, high-information table grid featuring square commodity thumbnails, real-time cycle progress indicators, quick-buy expansion buttons, and direct technical dossier links. Toggle easily via the header button. + * **Dedicated Facility Intelligence Dossier (Unit Detail View):** - * Clicking any facility card opens a comprehensive, full-page analytics dossier tailored for data and numbers enthusiasts. + * Clicking any facility card or inspector link opens a full-page deep-dive analytics dossier. * **Financial Telemetry:** Wholesale unit price, live revenue/s, projected revenue/hour, asset valuation, and stock inventory value. * **Cycle Dynamics:** Operating lines, base cycle duration, milestone throughput multipliers, batches/second, units/second, and hourly output projections. * **Net Flow Balance Breakdown:** Transparent arithmetic showing `Production Rate - Downstream Pull - Logistics Sales = Net Inventory Change (Δ/s)`. - * **Visual Presentation:** Dual photography placeholders for facility architecture and product specimens (with pre-built hooks for custom photographic assets). + * **Visual Presentation:** Dual photography for facility architecture blueprints and product specimens. * **Spot-Market Liquidation:** Instantly liquidate 50% or 100% of stockpiles for immediate emergency cash injection. * **Interactive Upstream/Downstream DAG Navigation:** Jump between connected facilities with one click. +* **Savegame Import & Export:** + * Complete data portability: Export your entire corporate empire as an encrypted/formatted JSON save file directly from your user profile modal. + * Seamlessly backup, inspect, restore, or transfer savegames across devices and browsers. + * **Streamlined Executive Navigation & Layout:** * **Full-Width Sticky Executive Header:** * **Capital & Valuation:** Consolidated live cash balance, net cashflow/s, Enterprise Valuation, and Venture Shares ($V-Shares). - * **Full-Width Sector Control Bar:** Seamless edge-to-edge sector switcher with live sector income rates. + * **Full-Width Sector Control Bar:** Seamless edge-to-edge sector switcher with live sector income rates and alert badges. * **Department Quick-Actions:** Instant access to B2B Contracts, Boardroom, Milestones, and Buy Multipliers (1x, 10x, 100x, Next). * **Theme & Number Settings:** Built-in Dark / Light theme toggle with persistent preferences and Standard/Scientific notation toggle. * **Zero Annoying Browser Popups:** All interactions, confirmations, and alerts use native, stylized modals and toasts. - * **Responsive Grid Layout:** - * "All Sectors" view displays a clean 3x2 grid on desktop and 2 columns on tablet/mobile. - * Mobile optimization with thumb-friendly bottom navigation and condensed pill icons. * **Dual Revenue Channels:** * **Continuous Logistics Distribution:** Deploy dedicated logistics fleets to automatically wholesale products to regional distributors for continuous passive cashflow. - * **B2B Procurement Contracts Board:** Bid on time-sensitive procurement tenders from MegaCorps and industrial clients for massive capital injections and corporate prestige. + * **B2B Procurement Contracts Board:** Bid on time-sensitive procurement tenders from MegaCorps for massive capital injections and corporate prestige. * **Corporate IPO & Boardroom Prestige:** * File for an **Initial Public Offering (IPO)** on Wall Street when your enterprise valuation reaches critical mass. - * Cash in for **Venture Shares ($V-Shares)** to unlock permanent perks on the Boardroom R&D Tech Tree (Automated ERP Routing, Industrial Robotics, Logistics Subsidies, Venture Capital Syndicate). + * Cash in for **Venture Shares ($V-Shares)** to unlock permanent perks on the Boardroom R&D Tech Tree: + * *Automated Supply Chain Routing:* +15% raw yield per level. + * *Industrial Robotics & AI:* +20% cycle speed per level. + * *Fleet Logistics Optimization:* +25% wholesale sales price per level. + * *State Subsidies & Procurement:* +35% cash payout on completed B2B tenders per level. + * *Venture Capital Syndicate:* Seed corporate re-expansions with up to $5,000,000 starting cash. + * *Brand Legacy & Heritage:* Retain 10%, 20%, 30%, 40%, up to 50% of your accumulated Corporate Reputation across IPOs. * **Cloud & Offline Sync:** * Instant Guest play with local persistence. @@ -136,13 +165,14 @@ python backend/validate_dag.py ├── docker-compose.yml ├── FACILITY_PHOTO_PROMPT_GUIDE.md # Photographic generation guide for units & goods ├── PRODUCT_GENERATOR_GUIDE.md # AI prompt & schema guide for scaling to 100+ products +├── README.md # Master project overview & architecture documentation ├── backend/ │ ├── Dockerfile │ ├── requirements.txt │ ├── auth.py # JWT authentication & password hashing │ ├── catalog_loader.py # Dynamic loader for modular frontend sector files │ ├── database.py # SQLite connection and migration setup -│ ├── engine.py # Authoritative DAG simulation and offline calculations +│ ├── engine.py # Authoritative DAG simulation, Rep bonuses & offline calculations │ ├── main.py # FastAPI endpoints │ ├── models.py # Pydantic schemas │ ├── test_engine.py # Comprehensive backend regression test suite @@ -163,23 +193,23 @@ python backend/validate_dag.py │ │ │ ├── workspace.css# Responsive content canvas │ │ │ └── responsive.css# Breakpoints & mobile navigation │ │ └── views/ -│ │ ├── production.css # Facility cards & sector summaries +│ │ ├── production.css # Facility cards, compact grid & sector summaries │ │ ├── unitDetail.css # Full facility intelligence dossier -│ │ ├── contracts.css # B2B contracts board +│ │ ├── contracts.css # B2B contracts board & Reputation Allocation Hub │ │ ├── boardroom.css # Executive suite & IPO perks │ │ └── achievements.css# Milestones & badges │ └── js/ │ ├── app.js # Application orchestrator, theme manager & event loop │ ├── core/ -│ │ ├── engine.js # Client-side DAG tick simulation +│ │ ├── engine.js # Client-side DAG tick simulation & Rep multipliers │ │ ├── formatters.js# Number notations (Standard K/M/B/T, Scientific, Currency) -│ │ ├── state.js # State manager, schema handling & IPO reset +│ │ ├── state.js # State manager, savegame export/import & IPO reset │ │ └── sync.js # Backend synchronization & auth handling │ ├── data/ │ │ ├── products.js # Central re-exporter of modular sectors -│ │ ├── sectors/ # Modular sector & product definitions (Agriculture, etc.) -│ │ ├── contracts.js # B2B procurement tenders -│ │ ├── boardroom.js # IPO perks and Venture Share logic +│ │ ├── sectors/ # 12 Modular sector files (Agriculture, Aerospace, Biotech, etc.) +│ │ ├── contracts.js # B2B procurement tenders & clients +│ │ ├── boardroom.js # IPO perks, Brand Legacy & Venture Share logic │ │ └── achievements.js │ └── ui/ │ ├── productionView.js @@ -188,6 +218,7 @@ python backend/validate_dag.py │ ├── boardroomView.js │ ├── achievementsView.js │ └── production/ +│ ├── compactFacilityCard.js │ ├── facilityCard.js │ ├── ratesCalculator.js │ └── sectorBar.js @@ -199,5 +230,5 @@ python backend/validate_dag.py ## 🎨 Asset Generation & Custom Visuals -* Refer to [`FACILITY_PHOTO_PROMPT_GUIDE.md`](./FACILITY_PHOTO_PROMPT_GUIDE.md) for master prompts and camera recipes to generate photorealistic assets for production facilities and commodities using modern image models (Midjourney, Stable Diffusion, Imagen). Dropping generated images into `frontend/assets/images/facilities/` and `frontend/assets/images/products/` seamlessly populates the facility dossiers without modifying any code. +* Refer to [`FACILITY_PHOTO_PROMPT_GUIDE.md`](./FACILITY_PHOTO_PROMPT_GUIDE.md) for master prompts and camera recipes to generate photorealistic assets for production facilities and commodities using modern image models (Midjourney, Stable Diffusion, Imagen). Dropping generated images into `frontend/assets/images/facilities/` and `frontend/assets/images/products/` seamlessly populates the cards and dossiers. * Refer to [`PRODUCT_GENERATOR_GUIDE.md`](./PRODUCT_GENERATOR_GUIDE.md) when generating new products, supply chain DAG tiers, or entire industry sectors.