docs: update README.md to reflect latest architecture, unit detail dossier, and full-width executive UI
This commit is contained in:
Christian
parent
2960400f1e
commit
b8ac21d373
1 changed files with 82 additions and 21 deletions
103
README.md
103
README.md
|
|
@ -2,37 +2,61 @@
|
|||
|
||||
> **"Build the Ultimate Global Supply Chain Empire."**
|
||||
|
||||
**Production - The Idle Game** is an expansive, strategic incremental/idle web game inspired by *Capitalism*, *Factorio-lite*, and modern idle tycoon simulators. 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 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.
|
||||
|
||||
The game is packaged as a lightweight, turnkey **Docker Compose stack** powered by a fast Python FastAPI backend with SQLite persistence and an Nginx reverse-proxy frontend.
|
||||
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.
|
||||
|
||||
---
|
||||
|
||||
## 🌟 Key Features
|
||||
|
||||
* **Real Supply Chain Dependencies (DAG Pipeline):**
|
||||
* Higher-tier industrial goods require and consume physical stockpiles of lower-tier commodities.
|
||||
* Real-time bottleneck warnings when upstream inputs run short.
|
||||
* 6 Interconnected Industry Sectors:
|
||||
* **True Supply Chain Dependencies (Directed Acyclic Graph - DAG Pipeline):**
|
||||
* Higher-tier industrial goods require and physically consume stockpiles of lower-tier commodities.
|
||||
* Real-time bottleneck detection and alerts when upstream inputs run short.
|
||||
* **Fine-Tuned Operational Controls:**
|
||||
* **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.
|
||||
5. **High-Tech & Electronics:** Silicon Microchips, PCB Motherboards, Consumer Smartphones.
|
||||
6. **Heavy Industry & Vehicles:** Industrial Engines, Commercial Logistics Trucks.
|
||||
|
||||
* **Dedicated Facility Intelligence Dossier (Unit Detail View):**
|
||||
* Clicking any facility card opens a comprehensive, full-page analytics dossier tailored for data and numbers enthusiasts.
|
||||
* **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).
|
||||
* **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.
|
||||
|
||||
* **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.
|
||||
* **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 reputation.
|
||||
* **B2B Procurement Contracts Board:** Bid on time-sensitive procurement tenders from MegaCorps and industrial clients 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).
|
||||
* **Responsive Executive UI:**
|
||||
* **Desktop Command Station:** 3-column workstation layout (Departments & Sectors sidebar, main Production Floor, and live Supply Chain Inspector with instant spot-market liquidation).
|
||||
* **Mobile Optimization:** Ergonomic single-column interface with bottom navigation tabs and thumb-friendly controls.
|
||||
|
||||
* **Cloud & Offline Sync:**
|
||||
* Plays instantly as a Guest with local persistence.
|
||||
* Instant Guest play with local persistence.
|
||||
* Optional lightweight account system (username + password with anti-bot honeypot protection).
|
||||
* Authoritative offline tick engine: when you return, your automated lines calculate production and logistics sales up to 8 hours.
|
||||
* Authoritative offline tick engine: when you return, automated lines calculate production and logistics sales up to 8 hours.
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -50,7 +74,7 @@ The game is packaged as a lightweight, turnkey **Docker Compose stack** powered
|
|||
│ (Reverse Proxy) │
|
||||
└─────┬────────────┬─────┘
|
||||
│ │
|
||||
/ (Statiske aktiver) │ /api/*
|
||||
/ (Static Assets) │ /api/*
|
||||
│ ▼
|
||||
│ ┌───────────────┐
|
||||
│ │ Python FastAPI│
|
||||
|
|
@ -68,6 +92,7 @@ The game is packaged as a lightweight, turnkey **Docker Compose stack** powered
|
|||
|
||||
### 1. Prerequisites
|
||||
* [Docker](https://docs.docker.com/get-docker/) & [Docker Compose](https://docs.docker.com/compose/)
|
||||
* (Optional for standalone testing) Python 3.10+
|
||||
|
||||
### 2. Configuration (.env)
|
||||
Create a `.env` file from the example:
|
||||
|
|
@ -81,7 +106,13 @@ docker compose up -d --build
|
|||
```
|
||||
|
||||
The game is live in your browser at:
|
||||
👉 **`http://localhost:8080`** (or the port defined in `.env`).
|
||||
👉 **`http://localhost:8081`** (or the port defined in `.env`).
|
||||
|
||||
### 4. Running Backend Verification Tests
|
||||
To run the automated Python backend engine simulation tests:
|
||||
```bash
|
||||
python backend/test_engine.py
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -91,6 +122,7 @@ The game is live in your browser at:
|
|||
.
|
||||
├── .env.example
|
||||
├── docker-compose.yml
|
||||
├── FACILITY_PHOTO_PROMPT_GUIDE.md # Photographic generation guide for all 24 units & goods
|
||||
├── backend/
|
||||
│ ├── Dockerfile
|
||||
│ ├── requirements.txt
|
||||
|
|
@ -98,29 +130,58 @@ The game is live in your browser at:
|
|||
│ ├── database.py # SQLite connection and migration setup
|
||||
│ ├── engine.py # Authoritative DAG simulation and offline calculations
|
||||
│ ├── main.py # FastAPI endpoints
|
||||
│ └── models.py # Pydantic schemas
|
||||
│ ├── models.py # Pydantic schemas
|
||||
│ └── test_engine.py # Comprehensive backend regression test suite
|
||||
├── frontend/
|
||||
│ ├── index.html # Responsive executive layout
|
||||
│ ├── index.html # Full-width executive workspace layout
|
||||
│ ├── assets/
|
||||
│ │ └── images/
|
||||
│ │ ├── facilities/ # Facility architectural blueprints/photos
|
||||
│ │ └── products/ # Commodity and material specimen photos
|
||||
│ ├── css/
|
||||
│ │ └── style.css # Modern corporate design system
|
||||
│ │ ├── style.css # Central stylesheet orchestrator
|
||||
│ │ ├── base/
|
||||
│ │ │ ├── reset.css # Typography, normalize and box model
|
||||
│ │ │ └── theme.css # Light & Dark theme tokens, form elements & scrollbars
|
||||
│ │ ├── layout/
|
||||
│ │ │ ├── header.css # Full-width sticky executive header & HUD
|
||||
│ │ │ ├── workspace.css# Responsive content canvas
|
||||
│ │ │ └── responsive.css# Breakpoints & mobile navigation
|
||||
│ │ └── views/
|
||||
│ │ ├── production.css # Facility cards & sector summaries
|
||||
│ │ ├── unitDetail.css # Full facility intelligence dossier
|
||||
│ │ ├── contracts.css # B2B contracts board
|
||||
│ │ ├── boardroom.css # Executive suite & IPO perks
|
||||
│ │ └── achievements.css# Milestones & badges
|
||||
│ └── js/
|
||||
│ ├── app.js # Application orchestrator & game loop
|
||||
│ ├── app.js # Application orchestrator, theme manager & event loop
|
||||
│ ├── core/
|
||||
│ │ ├── engine.js # Client-side DAG tick simulation
|
||||
│ │ ├── formatters.js# Number notations (Standard K/M/B/T, Scientific)
|
||||
│ │ ├── formatters.js# Number notations (Standard K/M/B/T, Scientific, Currency)
|
||||
│ │ ├── state.js # State manager, schema handling & IPO reset
|
||||
│ │ └── sync.js # Backend synchronization & auth handling
|
||||
│ ├── data/
|
||||
│ │ ├── products.js # 24+ commodities across 6 sectors
|
||||
│ │ ├── sectors/ # Modular sector & product definitions
|
||||
│ │ ├── contracts.js # B2B procurement tenders
|
||||
│ │ ├── boardroom.js # IPO perks and Venture Share logic
|
||||
│ │ └── achievements.js
|
||||
│ └── ui/
|
||||
│ ├── productionView.js
|
||||
│ ├── unitDetailView.js
|
||||
│ ├── contractsView.js
|
||||
│ ├── boardroomView.js
|
||||
│ ├── inspectorView.js
|
||||
│ └── achievementsView.js
|
||||
│ ├── achievementsView.js
|
||||
│ └── production/
|
||||
│ ├── facilityCard.js
|
||||
│ ├── ratesCalculator.js
|
||||
│ └── sectorBar.js
|
||||
└── nginx/
|
||||
└── default.conf.template
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🎨 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 all 24 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.
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue