Skip to content

Commit 5013dc9

Browse files
committed
docs: add TOPOLOGY.md
1 parent 0b2b3fb commit 5013dc9

1 file changed

Lines changed: 34 additions & 0 deletions

File tree

TOPOLOGY.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
<!-- SPDX-License-Identifier: PMPL-1.0-or-later -->
2+
<!-- Copyright (c) 2026 Jonathan D.A. Jewell (hyperpolymath) <j.d.a.jewell@open.ac.uk> -->
3+
# TOPOLOGY.md — game-server-admin
4+
5+
## Purpose
6+
7+
Universal game server probe, configuration management, and administration panel. Attaches to any game server, fingerprints it via protocol probing, extracts its configuration into A2ML format, and provides a rich GUI for viewing, editing, and tracking config changes with full provenance. Built on Gossamer (linearly-typed webview shell) with VeriSimDB underpinning.
8+
9+
## Module Map
10+
11+
```
12+
game-server-admin/
13+
├── src/
14+
│ ├── gui/ # Gossamer GUI layer (Ephapax + HTML/JS)
15+
│ │ ├── panels/ # 7 Clade-citizen UI panels
16+
│ │ ├── main.eph # Ephapax entry point
17+
│ │ └── host.html # Webview host
18+
│ ├── core/ # Protocol probing + config extraction
19+
│ ├── interface/ # IPC bridge (gossamer://)
20+
│ └── (aspects, bridges, contracts, definitions, errors)
21+
├── assets/ # Icons and static assets
22+
├── docs/ # Architecture and usage docs
23+
└── game-server-admin.desktop # Linux desktop integration
24+
```
25+
26+
## Data Flow
27+
28+
```
29+
[Game server] ──► [Protocol probe] ──► [Config extraction] ──► [A2ML format]
30+
31+
[VeriSimDB storage]
32+
33+
[Gossamer GUI / panels] ──► [User]
34+
```

0 commit comments

Comments
 (0)