Skip to content

Commit 84ccf38

Browse files
iaretechnicianiaretechnician
authored
Merge pull request #11 from World-Domination-Software/copilot/update-readme-documentation-links
Restructure README project listing by stage; scaffold docs for three upcoming games
2 parents c9150fb + ad657a2 commit 84ccf38

18 files changed

Lines changed: 586 additions & 5 deletions

‎README.md‎

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,14 +36,30 @@ The source code for our projects lives in private or separate repositories. This
3636

3737
## Projects
3838

39+
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.
40+
41+
### Current Projects
42+
3943
| Application | Type | Docs | GitHub Wiki | Discussions |
4044
|---|---|---|---|---|
4145
| 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) |
4246
| 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) |
4347
| 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) |
4448
| 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) |
45-
| 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) |
4649
| 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) |
50+
| 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) |
51+
52+
### Completed Projects
53+
54+
No projects have been marked completed yet.
55+
56+
### Upcoming Projects
57+
58+
| Application | Type | Docs | GitHub Wiki | Discussions |
59+
|---|---|---|---|---|
60+
| 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) |
61+
| 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) |
62+
| 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) |
4763

4864
## How to get help
4965

‎docs/INDEX.md‎

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,32 @@ For shared documentation (FAQ, support, roadmap, troubleshooting), see the [GitH
66

77
---
88

9-
## Applications
9+
## Current Projects
1010

1111
| Application | Type | Docs | GitHub Wiki | Discussions |
1212
|---|---|---|---|---|
13+
| 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) |
1314
| 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) |
1415
| 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) |
1516
| 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) |
16-
| 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) |
1717
| 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) |
18-
| 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) |
18+
| 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) |
19+
20+
---
21+
22+
## Completed Projects
23+
24+
No projects have been marked completed yet.
25+
26+
---
27+
28+
## Upcoming Projects
29+
30+
| Application | Type | Docs | GitHub Wiki | Discussions |
31+
|---|---|---|---|---|
32+
| 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) |
33+
| 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) |
34+
| 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) |
1935

2036
---
2137

@@ -43,4 +59,4 @@ docs/applications/<application-name>/
4359
Gameplay.md (if applicable)
4460
```
4561

46-
Then add a row to the table above and follow the conventions in [.github/copilot-instructions.md](../.github/copilot-instructions.md).
62+
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).

‎docs/applications/castle-walls/Gameplay.md‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Castle Walls – Gameplay
2+
3+
← [Back to README](./README.md)
4+
5+
---
6+
7+
> **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.
8+
9+
## Concept
10+
11+
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.
12+
13+
## Core Mechanics
14+
15+
- **Construction** – Place walls, towers, traps, and support structures on a grid-based map.
16+
- **Wave defense** – Repel attackers between build phases, using your fortifications and any active defenses.
17+
- **Resource management** – Gather and spend resources to build, repair, and upgrade your defenses.
18+
- **Upgrades** – Strengthen existing structures or unlock new building types as you progress.
19+
20+
## Game Modes
21+
22+
Details on available modes and map types will be added as development continues.
23+
24+
## Controls
25+
26+
Full control scheme documentation will be added when the game approaches release.
27+
28+
## Progression
29+
30+
Details on campaign structure, unlock trees, and difficulty scaling will be added as development continues.
31+
32+
---
33+
34+
**→ [README](./README.md) · [Overview](./Overview.md) · [Getting Started](./Getting-Started.md) · [Implementation Notes](./Implementation-Notes.md)**

‎docs/applications/castle-walls/Getting-Started.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Castle Walls – Getting Started
2+
3+
← [Back to README](./README.md)
4+
5+
---
6+
7+
> **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.
8+
9+
## When Available
10+
11+
Installation and setup instructions will cover:
12+
13+
- Downloading and installing the game on supported platforms.
14+
- Launching the game for the first time.
15+
- Navigating the main menu and starting your first campaign.
16+
- Basic tips for building your first defenses and surviving early waves.
17+
18+
## Stay Updated
19+
20+
- Follow the [Roadmap discussions](https://github.com/World-Domination-Software/Projects/discussions/categories/roadmap) for release updates.
21+
- Join the [Castle Walls discussions](https://github.com/World-Domination-Software/Projects/discussions/categories/castle-walls-general) for community conversation.
22+
23+
---
24+
25+
**→ [README](./README.md) · [Overview](./Overview.md) · [Gameplay](./Gameplay.md) · [Implementation Notes](./Implementation-Notes.md)**

‎docs/applications/castle-walls/Implementation-Notes.md‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Castle Walls – Implementation Notes
2+
3+
← [Back to README](./README.md)
4+
5+
---
6+
7+
> **Note:** Castle Walls is currently in development. Implementation details will be expanded as the project progresses.
8+
9+
## Overview
10+
11+
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.
12+
13+
## Components
14+
15+
| Component | Description |
16+
|---|---|
17+
| **Game client** | Core application handling rendering, input, construction, and wave logic. |
18+
| **Backend services** | Optional cloud services for save sync and leaderboards. |
19+
20+
## Platform Targets
21+
22+
| Platform | Status |
23+
|---|---|
24+
| PC – Windows | Planned |
25+
| PC – Linux | Planned |
26+
| Steam Deck | Under consideration |
27+
28+
## Development Status
29+
30+
| Area | Status |
31+
|---|---|
32+
| Core gameplay | In development |
33+
| Construction system | In development |
34+
| Wave simulation | In development |
35+
| Online leaderboards | Planned |
36+
| Additional maps | Planned |
37+
38+
For current priorities and timelines, see the [Roadmap discussions](https://github.com/World-Domination-Software/Projects/discussions/categories/roadmap).
39+
40+
---
41+
42+
**→ [README](./README.md) · [Overview](./Overview.md) · [Getting Started](./Getting-Started.md) · [Gameplay](./Gameplay.md)**

‎docs/applications/castle-walls/Overview.md‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# Castle Walls – Overview
2+
3+
**Type:** Game | **Developer:** World Domination Software LLC
4+
5+
← [Back to README](./README.md)
6+
7+
---
8+
9+
## What Is Castle Walls?
10+
11+
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.
12+
13+
## Purpose
14+
15+
Castle Walls is built for players who want:
16+
17+
- Deep strategic decision-making within a defense and construction framework.
18+
- Progressive challenge as enemy waves grow in number, speed, and capability.
19+
- A satisfying loop of building, defending, and upgrading over time.
20+
21+
## Features
22+
23+
| Feature | Description |
24+
|---|---|
25+
| **Construction system** | Place and upgrade walls, towers, traps, and support structures. |
26+
| **Wave-based defense** | Defend against increasingly varied and powerful attacking forces. |
27+
| **Resource management** | Gather and allocate resources between offense, defense, and repairs. |
28+
| **Multiple maps** | Different terrain layouts with unique strategic challenges. |
29+
| **Progression** | Unlock new structures and upgrades as you advance. |
30+
| **Platform support** | PC (Windows and Linux). |
31+
32+
## Architecture
33+
34+
Castle Walls is a standalone single-player application with optional cloud save support.
35+
36+
Key components:
37+
38+
- **Game client** – Core application handling rendering, input, and game logic.
39+
- **Backend services** – Optional cloud services for saves and leaderboards.
40+
41+
## Development Status
42+
43+
| Area | Status |
44+
|---|---|
45+
| Core gameplay | In development |
46+
| PC (Windows/Linux) support | Planned |
47+
| Additional maps | Planned |
48+
| Online leaderboards | Planned |
49+
50+
For current priorities, see the [Roadmap discussions](https://github.com/World-Domination-Software/Projects/discussions/categories/roadmap).
51+
52+
---
53+
54+
**→ [README](./README.md) · [Getting Started](./Getting-Started.md) · [Gameplay](./Gameplay.md) · [Implementation Notes](./Implementation-Notes.md)**

‎docs/applications/castle-walls/README.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Castle Walls
2+
3+
A strategy and defense game where players construct, upgrade, and defend fortifications against escalating waves of attackers.
4+
5+
**Type:** Game | **Developer:** World Domination Software LLC
6+
7+
## Documentation
8+
9+
- [Overview](./Overview.md) – What the game is, key features, architecture, and development status.
10+
- [Getting Started](./Getting-Started.md) – Installation, first launch, and basic gameplay tips.
11+
- [Gameplay](./Gameplay.md) – Game mechanics, controls, and progression.
12+
- [Implementation Notes](./Implementation-Notes.md) – Architecture, platform details, and development status.
13+
14+
## Public Links
15+
16+
- [GitHub Wiki](https://github.com/World-Domination-Software/Projects/wiki/Castle-Walls) – Public wiki page for Castle Walls.
17+
- [Bug Reports](https://github.com/World-Domination-Software/Projects/issues) – Report bugs and issues.
18+
- [Discussions](https://github.com/World-Domination-Software/Projects/discussions/categories/castle-walls-general) – General discussion, support, and feature requests.
19+
20+
## Notes
21+
22+
This folder contains application-specific documentation only.
23+
Shared FAQ, support, roadmap, and shared troubleshooting are maintained in the [GitHub Wiki](https://github.com/World-Domination-Software/Projects/wiki).

‎docs/applications/do-not-shoot-aliens/Gameplay.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Do Not Shoot Aliens – Gameplay
2+
3+
← [Back to README](./README.md)
4+
5+
---
6+
7+
> **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.
8+
9+
## Concept
10+
11+
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.
12+
13+
## Core Mechanics
14+
15+
- **Target identification** – Evaluate each entity based on visual cues, movement patterns, and contextual clues before firing.
16+
- **Trigger discipline** – Firing on a friendly target deducts points and may end the run.
17+
- **Time pressure** – Encounters grow faster and more crowded as the game progresses.
18+
- **Scoring** – Points are awarded for correct shots and correct holds; penalties apply for mistakes.
19+
20+
## Controls
21+
22+
Full control scheme documentation will be added when the game approaches release.
23+
24+
## Progression
25+
26+
Details on level structure, difficulty scaling, and unlock progression will be added as development continues.
27+
28+
---
29+
30+
**→ [README](./README.md) · [Overview](./Overview.md) · [Getting Started](./Getting-Started.md) · [Implementation Notes](./Implementation-Notes.md)**

‎docs/applications/do-not-shoot-aliens/Getting-Started.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Do Not Shoot Aliens – Getting Started
2+
3+
← [Back to README](./README.md)
4+
5+
---
6+
7+
> **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.
8+
9+
## When Available
10+
11+
Installation and setup instructions will cover:
12+
13+
- Downloading and installing the game on supported platforms.
14+
- Launching the game for the first time.
15+
- Navigating the main menu and starting your first session.
16+
- Basic tips for understanding the identification mechanics.
17+
18+
## Stay Updated
19+
20+
- Follow the [Roadmap discussions](https://github.com/World-Domination-Software/Projects/discussions/categories/roadmap) for release updates.
21+
- Join the [Do Not Shoot Aliens discussions](https://github.com/World-Domination-Software/Projects/discussions/categories/do-not-shoot-aliens-general) for community conversation.
22+
23+
---
24+
25+
**→ [README](./README.md) · [Overview](./Overview.md) · [Gameplay](./Gameplay.md) · [Implementation Notes](./Implementation-Notes.md)**

‎docs/applications/do-not-shoot-aliens/Implementation-Notes.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Do Not Shoot Aliens – Implementation Notes
2+
3+
← [Back to README](./README.md)
4+
5+
---
6+
7+
> **Note:** Do Not Shoot Aliens is currently in development. Implementation details will be expanded as the project progresses.
8+
9+
## Overview
10+
11+
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.
12+
13+
## Components
14+
15+
| Component | Description |
16+
|---|---|
17+
| **Game client** | Core application handling rendering, input, and game logic. |
18+
| **Scoring service** | Optional cloud-side service for leaderboards and personal bests. |
19+
20+
## Platform Targets
21+
22+
| Platform | Status |
23+
|---|---|
24+
| PC – Windows | Planned |
25+
| PC – Linux | Planned |
26+
| Steam Deck | Under consideration |
27+
28+
## Development Status
29+
30+
| Area | Status |
31+
|---|---|
32+
| Core gameplay | In development |
33+
| Target identification system | In development |
34+
| Scoring and leaderboards | Planned |
35+
| Additional environments | Planned |
36+
37+
For current priorities and timelines, see the [Roadmap discussions](https://github.com/World-Domination-Software/Projects/discussions/categories/roadmap).
38+
39+
---
40+
41+
**→ [README](./README.md) · [Overview](./Overview.md) · [Getting Started](./Getting-Started.md) · [Gameplay](./Gameplay.md)**

0 commit comments

Comments
 (0)