diff --git a/README.md b/README.md index bf108b9..9f646e3 100644 --- a/README.md +++ b/README.md @@ -36,14 +36,30 @@ The source code for our projects lives in private or separate repositories. This ## Projects +All project documentation lives in the [`docs/applications/`](docs/applications/) folder of this repository. Each project has its own subfolder with dedicated pages covering an overview, getting started guide, gameplay details (for games), and implementation notes. To move a project between stages, only the section in this table needs to change — the documentation stays in its folder. + +### Current Projects + | Application | Type | Docs | GitHub Wiki | Discussions | |---|---|---|---|---| | Game Servers Panel | Hosting / Infrastructure | [Docs](docs/applications/game-servers-panel/README.md) | [Wiki](https://github.com/World-Domination-Software/Projects/wiki/Game-Servers-Panel) | [Discussions](https://github.com/World-Domination-Software/Projects/discussions/categories/game-servers-panel-general) | | Hostile Planets | Game | [Docs](docs/applications/hostile-planets/README.md) | [Wiki](https://github.com/World-Domination-Software/Projects/wiki/Hostile-Planets) | [Discussions](https://github.com/World-Domination-Software/Projects/discussions/categories/hostile-planets-general) | | Optimization Protocol | Utility | [Docs](docs/applications/optimization-protocol/README.md) | [Wiki](https://github.com/World-Domination-Software/Projects/wiki/Optimization-Protocol) | [Discussions](https://github.com/World-Domination-Software/Projects/discussions/categories/optimization-protocol-general) | | Pure OPS | Game | [Docs](docs/applications/pure-ops/README.md) | [Wiki](https://github.com/World-Domination-Software/Projects/wiki/Pure-OPS) | [Discussions](https://github.com/World-Domination-Software/Projects/discussions/categories/pure-ops-general) | -| Van Inventory | Business Tool | [Docs](docs/applications/van-inventory/README.md) | [Wiki](https://github.com/World-Domination-Software/Projects/wiki/Van-Inventory) | [Discussions](https://github.com/World-Domination-Software/Projects/discussions/categories/van-inventory-general) | | Roadkill | Game | [Docs](docs/applications/roadkill/README.md) | [Wiki](https://github.com/World-Domination-Software/Projects/wiki/Roadkill) | [Discussions](https://github.com/World-Domination-Software/Projects/discussions/categories/roadkill-general) | +| Van Inventory | Business Tool | [Docs](docs/applications/van-inventory/README.md) | [Wiki](https://github.com/World-Domination-Software/Projects/wiki/Van-Inventory) | [Discussions](https://github.com/World-Domination-Software/Projects/discussions/categories/van-inventory-general) | + +### Completed Projects + +No projects have been marked completed yet. + +### Upcoming Projects + +| Application | Type | Docs | GitHub Wiki | Discussions | +|---|---|---|---|---| +| Castle Walls | Game | [Docs](docs/applications/castle-walls/README.md) | [Wiki](https://github.com/World-Domination-Software/Projects/wiki/Castle-Walls) | [Discussions](https://github.com/World-Domination-Software/Projects/discussions/categories/castle-walls-general) | +| Do Not Shoot Aliens | Game | [Docs](docs/applications/do-not-shoot-aliens/README.md) | [Wiki](https://github.com/World-Domination-Software/Projects/wiki/Do-Not-Shoot-Aliens) | [Discussions](https://github.com/World-Domination-Software/Projects/discussions/categories/do-not-shoot-aliens-general) | +| Space Sim | Game | [Docs](docs/applications/space-sim/README.md) | [Wiki](https://github.com/World-Domination-Software/Projects/wiki/Space-Sim) | [Discussions](https://github.com/World-Domination-Software/Projects/discussions/categories/space-sim-general) | ## How to get help diff --git a/docs/INDEX.md b/docs/INDEX.md index 653f245..8584a69 100644 --- a/docs/INDEX.md +++ b/docs/INDEX.md @@ -6,16 +6,32 @@ For shared documentation (FAQ, support, roadmap, troubleshooting), see the [GitH --- -## Applications +## Current Projects | Application | Type | Docs | GitHub Wiki | Discussions | |---|---|---|---|---| +| Game Servers Panel | Hosting / Infrastructure | [docs/applications/game-servers-panel/](applications/game-servers-panel/README.md) | [Wiki](https://github.com/World-Domination-Software/Projects/wiki/Game-Servers-Panel) | [Discussions](https://github.com/World-Domination-Software/Projects/discussions/categories/game-servers-panel-general) | | Hostile Planets | Game | [docs/applications/hostile-planets/](applications/hostile-planets/README.md) | [Wiki](https://github.com/World-Domination-Software/Projects/wiki/Hostile-Planets) | [Discussions](https://github.com/World-Domination-Software/Projects/discussions/categories/hostile-planets-general) | | Optimization Protocol | Utility | [docs/applications/optimization-protocol/](applications/optimization-protocol/README.md) | [Wiki](https://github.com/World-Domination-Software/Projects/wiki/Optimization-Protocol) | [Discussions](https://github.com/World-Domination-Software/Projects/discussions/categories/optimization-protocol-general) | | Pure OPS | Game | [docs/applications/pure-ops/](applications/pure-ops/README.md) | [Wiki](https://github.com/World-Domination-Software/Projects/wiki/Pure-OPS) | [Discussions](https://github.com/World-Domination-Software/Projects/discussions/categories/pure-ops-general) | -| Van Inventory | Business Tool | [docs/applications/van-inventory/](applications/van-inventory/README.md) | [Wiki](https://github.com/World-Domination-Software/Projects/wiki/Van-Inventory) | [Discussions](https://github.com/World-Domination-Software/Projects/discussions/categories/van-inventory-general) | | Roadkill | Game | [docs/applications/roadkill/](applications/roadkill/README.md) | [Wiki](https://github.com/World-Domination-Software/Projects/wiki/Roadkill) | [Discussions](https://github.com/World-Domination-Software/Projects/discussions/categories/roadkill-general) | -| Game Servers Panel | Hosting / Infrastructure | [docs/applications/game-servers-panel/](applications/game-servers-panel/README.md) | [Wiki](https://github.com/World-Domination-Software/Projects/wiki/Game-Servers-Panel) | [Discussions](https://github.com/World-Domination-Software/Projects/discussions/categories/game-servers-panel-general) | +| Van Inventory | Business Tool | [docs/applications/van-inventory/](applications/van-inventory/README.md) | [Wiki](https://github.com/World-Domination-Software/Projects/wiki/Van-Inventory) | [Discussions](https://github.com/World-Domination-Software/Projects/discussions/categories/van-inventory-general) | + +--- + +## Completed Projects + +No projects have been marked completed yet. + +--- + +## Upcoming Projects + +| Application | Type | Docs | GitHub Wiki | Discussions | +|---|---|---|---|---| +| Castle Walls | Game | [docs/applications/castle-walls/](applications/castle-walls/README.md) | [Wiki](https://github.com/World-Domination-Software/Projects/wiki/Castle-Walls) | [Discussions](https://github.com/World-Domination-Software/Projects/discussions/categories/castle-walls-general) | +| Do Not Shoot Aliens | Game | [docs/applications/do-not-shoot-aliens/](applications/do-not-shoot-aliens/README.md) | [Wiki](https://github.com/World-Domination-Software/Projects/wiki/Do-Not-Shoot-Aliens) | [Discussions](https://github.com/World-Domination-Software/Projects/discussions/categories/do-not-shoot-aliens-general) | +| Space Sim | Game | [docs/applications/space-sim/](applications/space-sim/README.md) | [Wiki](https://github.com/World-Domination-Software/Projects/wiki/Space-Sim) | [Discussions](https://github.com/World-Domination-Software/Projects/discussions/categories/space-sim-general) | --- @@ -43,4 +59,4 @@ docs/applications// Gameplay.md (if applicable) ``` -Then add a row to the table above and follow the conventions in [.github/copilot-instructions.md](../.github/copilot-instructions.md). +Then add a row to the **Upcoming Projects** table above (or the appropriate stage table). To advance a project to a different stage, move its row from one section to another — no documentation needs to move. Follow the conventions in [.github/copilot-instructions.md](../.github/copilot-instructions.md). diff --git a/docs/applications/castle-walls/Gameplay.md b/docs/applications/castle-walls/Gameplay.md new file mode 100644 index 0000000..877bed7 --- /dev/null +++ b/docs/applications/castle-walls/Gameplay.md @@ -0,0 +1,34 @@ +# Castle Walls – Gameplay + +← [Back to README](./README.md) + +--- + +> **Note:** Castle Walls is currently in development. Detailed gameplay documentation will be added closer to release. Check the [Roadmap](https://github.com/World-Domination-Software/Projects/discussions/categories/roadmap) for updates. + +## Concept + +Players construct and upgrade fortifications to defend against waves of attackers. Strategic placement of walls, towers, and traps, combined with careful resource management, determines whether the castle stands or falls. + +## Core Mechanics + +- **Construction** – Place walls, towers, traps, and support structures on a grid-based map. +- **Wave defense** – Repel attackers between build phases, using your fortifications and any active defenses. +- **Resource management** – Gather and spend resources to build, repair, and upgrade your defenses. +- **Upgrades** – Strengthen existing structures or unlock new building types as you progress. + +## Game Modes + +Details on available modes and map types will be added as development continues. + +## Controls + +Full control scheme documentation will be added when the game approaches release. + +## Progression + +Details on campaign structure, unlock trees, and difficulty scaling will be added as development continues. + +--- + +**→ [README](./README.md) · [Overview](./Overview.md) · [Getting Started](./Getting-Started.md) · [Implementation Notes](./Implementation-Notes.md)** diff --git a/docs/applications/castle-walls/Getting-Started.md b/docs/applications/castle-walls/Getting-Started.md new file mode 100644 index 0000000..435189d --- /dev/null +++ b/docs/applications/castle-walls/Getting-Started.md @@ -0,0 +1,25 @@ +# Castle Walls – Getting Started + +← [Back to README](./README.md) + +--- + +> **Note:** Castle Walls is currently in development. Installation and launch instructions will be added when the game becomes available. Check the [Roadmap](https://github.com/World-Domination-Software/Projects/discussions/categories/roadmap) for updates. + +## When Available + +Installation and setup instructions will cover: + +- Downloading and installing the game on supported platforms. +- Launching the game for the first time. +- Navigating the main menu and starting your first campaign. +- Basic tips for building your first defenses and surviving early waves. + +## Stay Updated + +- Follow the [Roadmap discussions](https://github.com/World-Domination-Software/Projects/discussions/categories/roadmap) for release updates. +- Join the [Castle Walls discussions](https://github.com/World-Domination-Software/Projects/discussions/categories/castle-walls-general) for community conversation. + +--- + +**→ [README](./README.md) · [Overview](./Overview.md) · [Gameplay](./Gameplay.md) · [Implementation Notes](./Implementation-Notes.md)** diff --git a/docs/applications/castle-walls/Implementation-Notes.md b/docs/applications/castle-walls/Implementation-Notes.md new file mode 100644 index 0000000..092365d --- /dev/null +++ b/docs/applications/castle-walls/Implementation-Notes.md @@ -0,0 +1,42 @@ +# Castle Walls – Implementation Notes + +← [Back to README](./README.md) + +--- + +> **Note:** Castle Walls is currently in development. Implementation details will be expanded as the project progresses. + +## Overview + +Castle Walls is a standalone application targeting PC platforms. Core game logic, wave simulation, and construction mechanics run client-side, with optional cloud services for save sync and leaderboards. + +## Components + +| Component | Description | +|---|---| +| **Game client** | Core application handling rendering, input, construction, and wave logic. | +| **Backend services** | Optional cloud services for save sync and leaderboards. | + +## Platform Targets + +| Platform | Status | +|---|---| +| PC – Windows | Planned | +| PC – Linux | Planned | +| Steam Deck | Under consideration | + +## Development Status + +| Area | Status | +|---|---| +| Core gameplay | In development | +| Construction system | In development | +| Wave simulation | In development | +| Online leaderboards | Planned | +| Additional maps | Planned | + +For current priorities and timelines, see the [Roadmap discussions](https://github.com/World-Domination-Software/Projects/discussions/categories/roadmap). + +--- + +**→ [README](./README.md) · [Overview](./Overview.md) · [Getting Started](./Getting-Started.md) · [Gameplay](./Gameplay.md)** diff --git a/docs/applications/castle-walls/Overview.md b/docs/applications/castle-walls/Overview.md new file mode 100644 index 0000000..f81230c --- /dev/null +++ b/docs/applications/castle-walls/Overview.md @@ -0,0 +1,54 @@ +# Castle Walls – Overview + +**Type:** Game | **Developer:** World Domination Software LLC + +← [Back to README](./README.md) + +--- + +## What Is Castle Walls? + +Castle Walls is a strategy and defense game where players design, build, and upgrade fortifications to withstand escalating waves of attackers. Resource management, strategic placement, and timely upgrades are the keys to survival. + +## Purpose + +Castle Walls is built for players who want: + +- Deep strategic decision-making within a defense and construction framework. +- Progressive challenge as enemy waves grow in number, speed, and capability. +- A satisfying loop of building, defending, and upgrading over time. + +## Features + +| Feature | Description | +|---|---| +| **Construction system** | Place and upgrade walls, towers, traps, and support structures. | +| **Wave-based defense** | Defend against increasingly varied and powerful attacking forces. | +| **Resource management** | Gather and allocate resources between offense, defense, and repairs. | +| **Multiple maps** | Different terrain layouts with unique strategic challenges. | +| **Progression** | Unlock new structures and upgrades as you advance. | +| **Platform support** | PC (Windows and Linux). | + +## Architecture + +Castle Walls is a standalone single-player application with optional cloud save support. + +Key components: + +- **Game client** – Core application handling rendering, input, and game logic. +- **Backend services** – Optional cloud services for saves and leaderboards. + +## Development Status + +| Area | Status | +|---|---| +| Core gameplay | In development | +| PC (Windows/Linux) support | Planned | +| Additional maps | Planned | +| Online leaderboards | Planned | + +For current priorities, see the [Roadmap discussions](https://github.com/World-Domination-Software/Projects/discussions/categories/roadmap). + +--- + +**→ [README](./README.md) · [Getting Started](./Getting-Started.md) · [Gameplay](./Gameplay.md) · [Implementation Notes](./Implementation-Notes.md)** diff --git a/docs/applications/castle-walls/README.md b/docs/applications/castle-walls/README.md new file mode 100644 index 0000000..3ded34d --- /dev/null +++ b/docs/applications/castle-walls/README.md @@ -0,0 +1,23 @@ +# Castle Walls + +A strategy and defense game where players construct, upgrade, and defend fortifications against escalating waves of attackers. + +**Type:** Game | **Developer:** World Domination Software LLC + +## Documentation + +- [Overview](./Overview.md) – What the game is, key features, architecture, and development status. +- [Getting Started](./Getting-Started.md) – Installation, first launch, and basic gameplay tips. +- [Gameplay](./Gameplay.md) – Game mechanics, controls, and progression. +- [Implementation Notes](./Implementation-Notes.md) – Architecture, platform details, and development status. + +## Public Links + +- [GitHub Wiki](https://github.com/World-Domination-Software/Projects/wiki/Castle-Walls) – Public wiki page for Castle Walls. +- [Bug Reports](https://github.com/World-Domination-Software/Projects/issues) – Report bugs and issues. +- [Discussions](https://github.com/World-Domination-Software/Projects/discussions/categories/castle-walls-general) – General discussion, support, and feature requests. + +## Notes + +This folder contains application-specific documentation only. +Shared FAQ, support, roadmap, and shared troubleshooting are maintained in the [GitHub Wiki](https://github.com/World-Domination-Software/Projects/wiki). diff --git a/docs/applications/do-not-shoot-aliens/Gameplay.md b/docs/applications/do-not-shoot-aliens/Gameplay.md new file mode 100644 index 0000000..7c68985 --- /dev/null +++ b/docs/applications/do-not-shoot-aliens/Gameplay.md @@ -0,0 +1,30 @@ +# Do Not Shoot Aliens – Gameplay + +← [Back to README](./README.md) + +--- + +> **Note:** Do Not Shoot Aliens is currently in development. Detailed gameplay documentation will be added closer to release. Check the [Roadmap](https://github.com/World-Domination-Software/Projects/discussions/categories/roadmap) for updates. + +## Concept + +Players face waves of mixed targets — some hostile, some friendly, some neutral. The goal is to correctly identify threats and fire only on those targets, while holding fire when encountering allies or non-combatants. + +## Core Mechanics + +- **Target identification** – Evaluate each entity based on visual cues, movement patterns, and contextual clues before firing. +- **Trigger discipline** – Firing on a friendly target deducts points and may end the run. +- **Time pressure** – Encounters grow faster and more crowded as the game progresses. +- **Scoring** – Points are awarded for correct shots and correct holds; penalties apply for mistakes. + +## Controls + +Full control scheme documentation will be added when the game approaches release. + +## Progression + +Details on level structure, difficulty scaling, and unlock progression will be added as development continues. + +--- + +**→ [README](./README.md) · [Overview](./Overview.md) · [Getting Started](./Getting-Started.md) · [Implementation Notes](./Implementation-Notes.md)** diff --git a/docs/applications/do-not-shoot-aliens/Getting-Started.md b/docs/applications/do-not-shoot-aliens/Getting-Started.md new file mode 100644 index 0000000..6e9142f --- /dev/null +++ b/docs/applications/do-not-shoot-aliens/Getting-Started.md @@ -0,0 +1,25 @@ +# Do Not Shoot Aliens – Getting Started + +← [Back to README](./README.md) + +--- + +> **Note:** Do Not Shoot Aliens is currently in development. Installation and launch instructions will be added when the game becomes available. Check the [Roadmap](https://github.com/World-Domination-Software/Projects/discussions/categories/roadmap) for updates. + +## When Available + +Installation and setup instructions will cover: + +- Downloading and installing the game on supported platforms. +- Launching the game for the first time. +- Navigating the main menu and starting your first session. +- Basic tips for understanding the identification mechanics. + +## Stay Updated + +- Follow the [Roadmap discussions](https://github.com/World-Domination-Software/Projects/discussions/categories/roadmap) for release updates. +- Join the [Do Not Shoot Aliens discussions](https://github.com/World-Domination-Software/Projects/discussions/categories/do-not-shoot-aliens-general) for community conversation. + +--- + +**→ [README](./README.md) · [Overview](./Overview.md) · [Gameplay](./Gameplay.md) · [Implementation Notes](./Implementation-Notes.md)** diff --git a/docs/applications/do-not-shoot-aliens/Implementation-Notes.md b/docs/applications/do-not-shoot-aliens/Implementation-Notes.md new file mode 100644 index 0000000..da31a50 --- /dev/null +++ b/docs/applications/do-not-shoot-aliens/Implementation-Notes.md @@ -0,0 +1,41 @@ +# Do Not Shoot Aliens – Implementation Notes + +← [Back to README](./README.md) + +--- + +> **Note:** Do Not Shoot Aliens is currently in development. Implementation details will be expanded as the project progresses. + +## Overview + +Do Not Shoot Aliens is a standalone single-player application targeting PC platforms. All core game logic runs client-side, with optional cloud services for leaderboards and personal bests. + +## Components + +| Component | Description | +|---|---| +| **Game client** | Core application handling rendering, input, and game logic. | +| **Scoring service** | Optional cloud-side service for leaderboards and personal bests. | + +## Platform Targets + +| Platform | Status | +|---|---| +| PC – Windows | Planned | +| PC – Linux | Planned | +| Steam Deck | Under consideration | + +## Development Status + +| Area | Status | +|---|---| +| Core gameplay | In development | +| Target identification system | In development | +| Scoring and leaderboards | Planned | +| Additional environments | Planned | + +For current priorities and timelines, see the [Roadmap discussions](https://github.com/World-Domination-Software/Projects/discussions/categories/roadmap). + +--- + +**→ [README](./README.md) · [Overview](./Overview.md) · [Getting Started](./Getting-Started.md) · [Gameplay](./Gameplay.md)** diff --git a/docs/applications/do-not-shoot-aliens/Overview.md b/docs/applications/do-not-shoot-aliens/Overview.md new file mode 100644 index 0000000..fe043e0 --- /dev/null +++ b/docs/applications/do-not-shoot-aliens/Overview.md @@ -0,0 +1,53 @@ +# Do Not Shoot Aliens – Overview + +**Type:** Game | **Developer:** World Domination Software LLC + +← [Back to README](./README.md) + +--- + +## What Is Do Not Shoot Aliens? + +Do Not Shoot Aliens is a game that flips the standard shooter premise on its head. Rather than eliminating every target in sight, players must distinguish allies from threats and hold their fire when confronted with friendly or neutral entities. Quick identification, situational awareness, and trigger discipline determine success. + +## Purpose + +Do Not Shoot Aliens is designed for players who want: + +- A precision challenge that rewards careful observation over reflexive shooting. +- Escalating difficulty as encounter speed and visual complexity increase. +- A fresh take on the action genre built around restraint rather than aggression. + +## Features + +| Feature | Description | +|---|---| +| **Identification mechanics** | Players must evaluate targets under time pressure before firing. | +| **Escalating wave design** | Encounters grow faster and more visually complex as the game progresses. | +| **Score system** | Points awarded for correct holds and correct shots; deducted for friendly fire. | +| **Multiple environments** | Different backdrops and alien designs challenge visual recognition. | +| **Platform support** | PC (Windows and Linux). | + +## Architecture + +Do Not Shoot Aliens is a standalone single-player application. All game logic runs client-side. + +Key components: + +- **Game client** – Core application handling rendering, input, and game logic. +- **Scoring service** – Optional cloud-side service for leaderboards and personal bests. + +## Development Status + +| Area | Status | +|---|---| +| Core gameplay | In development | +| PC (Windows/Linux) support | Planned | +| Leaderboards | Planned | +| Additional environments | Planned | + +For current priorities, see the [Roadmap discussions](https://github.com/World-Domination-Software/Projects/discussions/categories/roadmap). + +--- + +**→ [README](./README.md) · [Getting Started](./Getting-Started.md) · [Gameplay](./Gameplay.md) · [Implementation Notes](./Implementation-Notes.md)** diff --git a/docs/applications/do-not-shoot-aliens/README.md b/docs/applications/do-not-shoot-aliens/README.md new file mode 100644 index 0000000..d51ba17 --- /dev/null +++ b/docs/applications/do-not-shoot-aliens/README.md @@ -0,0 +1,23 @@ +# Do Not Shoot Aliens + +A game built around restraint and precision: the challenge is identifying friend from foe and avoiding friendly fire in chaotic, fast-moving encounters. + +**Type:** Game | **Developer:** World Domination Software LLC + +## Documentation + +- [Overview](./Overview.md) – What the game is, key features, architecture, and development status. +- [Getting Started](./Getting-Started.md) – Installation, first launch, and basic gameplay tips. +- [Gameplay](./Gameplay.md) – Game mechanics, controls, and progression. +- [Implementation Notes](./Implementation-Notes.md) – Architecture, platform details, and development status. + +## Public Links + +- [GitHub Wiki](https://github.com/World-Domination-Software/Projects/wiki/Do-Not-Shoot-Aliens) – Public wiki page for Do Not Shoot Aliens. +- [Bug Reports](https://github.com/World-Domination-Software/Projects/issues) – Report bugs and issues. +- [Discussions](https://github.com/World-Domination-Software/Projects/discussions/categories/do-not-shoot-aliens-general) – General discussion, support, and feature requests. + +## Notes + +This folder contains application-specific documentation only. +Shared FAQ, support, roadmap, and shared troubleshooting are maintained in the [GitHub Wiki](https://github.com/World-Domination-Software/Projects/wiki). diff --git a/docs/applications/space-sim/Gameplay.md b/docs/applications/space-sim/Gameplay.md new file mode 100644 index 0000000..61abec4 --- /dev/null +++ b/docs/applications/space-sim/Gameplay.md @@ -0,0 +1,34 @@ +# Space Sim – Gameplay + +← [Back to README](./README.md) + +--- + +> **Note:** Space Sim is currently in development. Detailed gameplay documentation will be added closer to release. Check the [Roadmap](https://github.com/World-Domination-Software/Projects/discussions/categories/roadmap) for updates. + +## Concept + +Players pilot a spacecraft through procedurally generated star systems, exploring planets, gathering resources, managing ship systems, and surviving the hazards of deep space. + +## Core Mechanics + +- **Exploration** – Navigate between star systems, survey planets, and scan anomalies. +- **Resource gathering** – Mine asteroids and harvest planetary deposits to fuel upgrades and repairs. +- **Ship management** – Monitor and maintain hull integrity, fuel, life support, and crew status. +- **Survival** – Manage limited resources across long voyages, making decisions that balance risk and reward. + +## Ship Systems + +Details on ship classes, customization options, and upgrade trees will be added as development continues. + +## Controls + +Full control scheme documentation will be added when the game approaches release. + +## Progression + +Details on star map structure, discovery mechanics, and long-term progression will be added as development continues. + +--- + +**→ [README](./README.md) · [Overview](./Overview.md) · [Getting Started](./Getting-Started.md) · [Implementation Notes](./Implementation-Notes.md)** diff --git a/docs/applications/space-sim/Getting-Started.md b/docs/applications/space-sim/Getting-Started.md new file mode 100644 index 0000000..ad02240 --- /dev/null +++ b/docs/applications/space-sim/Getting-Started.md @@ -0,0 +1,25 @@ +# Space Sim – Getting Started + +← [Back to README](./README.md) + +--- + +> **Note:** Space Sim is currently in development. Installation and launch instructions will be added when the game becomes available. Check the [Roadmap](https://github.com/World-Domination-Software/Projects/discussions/categories/roadmap) for updates. + +## When Available + +Installation and setup instructions will cover: + +- Downloading and installing the game on supported platforms. +- Launching the game for the first time. +- Navigating the main menu and starting your first voyage. +- Basic tips for managing your ship and exploring your first star system. + +## Stay Updated + +- Follow the [Roadmap discussions](https://github.com/World-Domination-Software/Projects/discussions/categories/roadmap) for release updates. +- Join the [Space Sim discussions](https://github.com/World-Domination-Software/Projects/discussions/categories/space-sim-general) for community conversation. + +--- + +**→ [README](./README.md) · [Overview](./Overview.md) · [Gameplay](./Gameplay.md) · [Implementation Notes](./Implementation-Notes.md)** diff --git a/docs/applications/space-sim/Implementation-Notes.md b/docs/applications/space-sim/Implementation-Notes.md new file mode 100644 index 0000000..3f8c3b7 --- /dev/null +++ b/docs/applications/space-sim/Implementation-Notes.md @@ -0,0 +1,43 @@ +# Space Sim – Implementation Notes + +← [Back to README](./README.md) + +--- + +> **Note:** Space Sim is currently in development. Implementation details will be expanded as the project progresses. + +## Overview + +Space Sim is a standalone application targeting PC platforms. Procedural generation and core simulation logic run client-side; optional cloud services support save sync and leaderboards. + +## Components + +| Component | Description | +|---|---| +| **Game client** | Core application handling rendering, simulation, and input. | +| **Procedural engine** | System for generating star maps, planets, and encounter content. | +| **Backend services** | Optional cloud services for save sync and leaderboards. | + +## Platform Targets + +| Platform | Status | +|---|---| +| PC – Windows | Planned | +| PC – Linux | Planned | +| Steam Deck | Under consideration | + +## Development Status + +| Area | Status | +|---|---| +| Core gameplay | In development | +| Procedural star system generation | In development | +| Ship management systems | In development | +| Cloud saves | Planned | +| Additional star system types | Planned | + +For current priorities and timelines, see the [Roadmap discussions](https://github.com/World-Domination-Software/Projects/discussions/categories/roadmap). + +--- + +**→ [README](./README.md) · [Overview](./Overview.md) · [Getting Started](./Getting-Started.md) · [Gameplay](./Gameplay.md)** diff --git a/docs/applications/space-sim/Overview.md b/docs/applications/space-sim/Overview.md new file mode 100644 index 0000000..de0576f --- /dev/null +++ b/docs/applications/space-sim/Overview.md @@ -0,0 +1,56 @@ +# Space Sim – Overview + +**Type:** Game | **Developer:** World Domination Software LLC + +← [Back to README](./README.md) + +--- + +## What Is Space Sim? + +Space Sim is a space exploration and survival game set across procedurally generated star systems. Players navigate the cosmos, gather resources, manage their ship, and uncover what lies beyond each new horizon. + +## Purpose + +Space Sim is designed for players who want: + +- Open-ended exploration in a vast, procedurally generated universe. +- A balance of discovery, resource management, and survival challenge. +- Emergent storytelling shaped by the choices players make across star systems. + +## Features + +| Feature | Description | +|---|---| +| **Procedural generation** | Each playthrough features a unique arrangement of star systems, planets, and hazards. | +| **Exploration** | Survey planets, scan anomalies, and chart unknown space. | +| **Resource gathering** | Mine asteroids and harvest planetary resources to fuel and upgrade your ship. | +| **Ship management** | Maintain, repair, and customize your vessel to survive deep space. | +| **Survival mechanics** | Manage fuel, hull integrity, crew, and life support across long voyages. | +| **Platform support** | PC (Windows and Linux). | + +## Architecture + +Space Sim is a standalone application. Procedural generation runs client-side; optional cloud features support save sync and leaderboards. + +Key components: + +- **Game client** – Core application handling rendering, simulation, and input. +- **Procedural engine** – System for generating star maps, planets, and encounter content. +- **Backend services** – Optional cloud services for save sync and leaderboards. + +## Development Status + +| Area | Status | +|---|---| +| Core gameplay | In development | +| Procedural generation | In development | +| PC (Windows/Linux) support | Planned | +| Cloud saves | Planned | +| Additional star system types | Planned | + +For current priorities, see the [Roadmap discussions](https://github.com/World-Domination-Software/Projects/discussions/categories/roadmap). + +--- + +**→ [README](./README.md) · [Getting Started](./Getting-Started.md) · [Gameplay](./Gameplay.md) · [Implementation Notes](./Implementation-Notes.md)** diff --git a/docs/applications/space-sim/README.md b/docs/applications/space-sim/README.md new file mode 100644 index 0000000..9c8bdb1 --- /dev/null +++ b/docs/applications/space-sim/README.md @@ -0,0 +1,23 @@ +# Space Sim + +A space simulation game featuring exploration, resource gathering, and survival across procedurally generated star systems. + +**Type:** Game | **Developer:** World Domination Software LLC + +## Documentation + +- [Overview](./Overview.md) – What the game is, key features, architecture, and development status. +- [Getting Started](./Getting-Started.md) – Installation, first launch, and basic gameplay tips. +- [Gameplay](./Gameplay.md) – Game mechanics, controls, and progression. +- [Implementation Notes](./Implementation-Notes.md) – Architecture, platform details, and development status. + +## Public Links + +- [GitHub Wiki](https://github.com/World-Domination-Software/Projects/wiki/Space-Sim) – Public wiki page for Space Sim. +- [Bug Reports](https://github.com/World-Domination-Software/Projects/issues) – Report bugs and issues. +- [Discussions](https://github.com/World-Domination-Software/Projects/discussions/categories/space-sim-general) – General discussion, support, and feature requests. + +## Notes + +This folder contains application-specific documentation only. +Shared FAQ, support, roadmap, and shared troubleshooting are maintained in the [GitHub Wiki](https://github.com/World-Domination-Software/Projects/wiki). diff --git a/mkdocs.yml b/mkdocs.yml index 5dc5e97..c400c2e 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -20,6 +20,18 @@ nav: - Getting Started: getting-started.md - Applications: - Index: INDEX.md + - Castle Walls: + - README: applications/castle-walls/README.md + - Overview: applications/castle-walls/Overview.md + - Getting Started: applications/castle-walls/Getting-Started.md + - Gameplay: applications/castle-walls/Gameplay.md + - Implementation Notes: applications/castle-walls/Implementation-Notes.md + - Do Not Shoot Aliens: + - README: applications/do-not-shoot-aliens/README.md + - Overview: applications/do-not-shoot-aliens/Overview.md + - Getting Started: applications/do-not-shoot-aliens/Getting-Started.md + - Gameplay: applications/do-not-shoot-aliens/Gameplay.md + - Implementation Notes: applications/do-not-shoot-aliens/Implementation-Notes.md - Game Servers Panel: - README: applications/game-servers-panel/README.md - Overview: applications/game-servers-panel/Overview.md @@ -52,6 +64,12 @@ nav: - Getting Started: applications/roadkill/Getting-Started.md - Gameplay: applications/roadkill/Gameplay.md - Implementation Notes: applications/roadkill/Implementation-Notes.md + - Space Sim: + - README: applications/space-sim/README.md + - Overview: applications/space-sim/Overview.md + - Getting Started: applications/space-sim/Getting-Started.md + - Gameplay: applications/space-sim/Gameplay.md + - Implementation Notes: applications/space-sim/Implementation-Notes.md - Multiplayer: multiplayer.md - Troubleshooting: troubleshooting.md - Bug Reporting: bug-reporting.md