Repository navigation
Development Guide
Documentation snapshot from README.md at commit
20d7c81. Check the current source for updates.
play.bat start the game from source
config/ the editable settings files (beside the exe once installed)
apps/ Porter's bundled app setups
deploy/ the optional multi-user manifest for a cluster
docs/ admin guide, security notes, licences, screenshots
tools/ setup, packaging, installer, dev cluster, video helpers
scripts/main.gd game loop, tools, input
scripts/world.gd cluster state -> 3D world
scripts/platform.gd node platform scripts/machine.gd pod machine
scripts/hud.gd HUD, panels, datapad, Porter's and Bob's conversations
scripts/viewmodel.gd the first-person tool in your hand
scripts/gfx.gd graphics presets and the hardware recommendation
scripts/scenery.gd the Enhanced / Ultra industrial surroundings
scripts/bench.gd the rendering benchmark (tools\bench.ps1 drives it)
scripts/kutil.gd shared helpers, Bob's diagnoses, sign text fitting
scripts/bob.gd Bob 2.0: log and event reading, its rules, bob.json
scripts/cluster.gd polling, actions, audit log
agent/ kf-agent: the native companion (Go): kubeconfig, Kubernetes client, files, LiveView
assets/ the model library (141 models x 3 tiers) and its catalog
scripts/backend_native.gd real clusters through kf-agent (default)
scripts/agent.gd starts and talks to kf-agent scripts/connections.gd saved kubeconfig profiles
scripts/models.gd model library loading, doors, screens
scripts/pipes.gd Service pipelines from the library's pipe kit
scripts/liveview.gd LiveView sessions
scripts/backend_kubectl.gd real clusters via kubectl (--kubectl-cli) scripts/backend_docker.gd Docker engine
scripts/backend_demo.gd simulated clusters scripts/log_sources.gd log providers
scripts/apps.gd Porter's setups, app lists, install ledger
scripts/sfx.gd synthesised sound apps/ bundled app setups
scripts/krew.gd the Krew's rules and findings scripts/foreman.gd Foreman: incidents, the AI pipeline
scripts/controls.gd key bindings, controller, key hints scripts/minimap.gd the minimap
scripts/backend_komodo.gd Komodo (read-only) scripts/backend_plugin.gd backend plugins (scripts/plugins.gd: trust)
scripts/server.gd server mode scripts/backend_remote.gd a KubeFactory server as a source
examples/plugins/ an example backend plugin
tests/live/ in-game tests on the simulation and against throw-away infrastructure
tests/normalize_test.gd parser test: engine\Godot_v4.3-stable_win64_console.exe --headless --path . -s tests/normalize_test.gd
More tests and checks:
| Command | Checks |
|---|---|
tools\build-agent.ps1 -Test |
the companion's tests (Go) |
tools\live-test.ps1 |
the companion against a real, disposable kube-apiserver (no Docker) |
tools\live-test.ps1 -Grafana [-GrafanaVersion 13.0.0] |
the Grafana provider against a real, disposable Grafana |
tools\live-test.ps1 -Kind |
the companion against a real cluster with running containers (after tools\dev-cluster.ps1) |
tools\live-test.ps1 -Tautulli |
the Tautulli provider against a real, disposable Tautulli |
godot --headless --path . -s tests/live/docker_backend_test.gd |
the Docker backend against a real throw-away container |
godot --headless --path . -s tools/model_audit.gd |
audits every model and writes docs/MODEL_AUDIT.md
|
Run the PowerShell scripts with powershell -ExecutionPolicy Bypass -File <script>;
godot is engine\Godot_v4.3-stable_win64_console.exe.
The model library can be inspected in a browser with the asset reviewer
(tools/model-viewer/index.html, published at
https://dascondor.github.io/kubefactory/model-viewer/): every model at every tier, door open and shut,
with a review checklist you can export.
Want to help? Start with CONTRIBUTING: setup, where things are, the tests and the ground rules.
Design and status documents: ARCHITECTURE, FEATURE_PARITY, KNOWN_LIMITATIONS, MODEL_AUDIT, CHANGELOG, GO_LIVE_2.0.
play.bat --demo --shots=<folder> runs an automated screenshot tour (dev aid).
Against a real context or Docker engine it also deploys and removes throwaway
kf-* apps, scales shop/frontend, deletes one of its pods and, on Docker,
installs Portainer. Only point it at a dev cluster.
Two more dev aids, both read-only: play.bat --demo --toolshots=<folder>
captures each handheld tool, the signs and Bob's stand, and --trailer plays a
scripted 55-second tour for a video. Record it with Godot's movie writer and
convert it with Windows' own encoder:
engine\Godot_v4.3-stable_win64.exe --path . --write-movie out.avi --fixed-fps 60 --resolution 1920x1080 -- --demo --trailer
powershell -ExecutionPolicy Bypass -File tools\to_mp4.ps1 out.avi kubefactory.mp4Start
Visual guides
Operations
- Storage and screens
- LiveView
- Krew and Foreman
- Porter and Bob
- Text editor
- Logs
- Teams
- Administration
- Server mode
- Docker hosts
- Security
- Known limitations
Development and reference