From 383788b30a245620c504d93b52af406e22ab727f Mon Sep 17 00:00:00 2001 From: Hirek193 Date: Sun, 15 Mar 2026 01:36:17 +0100 Subject: [PATCH] Document directory structure in directoryDescription.md Added a detailed description of the directory structure and its components. --- directoryDescription.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 directoryDescription.md diff --git a/directoryDescription.md b/directoryDescription.md new file mode 100644 index 00000000..eb943fb9 --- /dev/null +++ b/directoryDescription.md @@ -0,0 +1,23 @@ + +# File structure +| Directory| Description| +|--|--| +| McZapkie/ | Train Physics Engine | +| gl/ | OpenGL Abstraction Layer| +| network/ | Multiplayer Support +| launcher/ | Scenario/Vehicle Selection (built in starter)| +| widgets/ | HUD Elements | +| vr/ | Virtual Reality Support | +| Console/ | Hardware I/O | +| application/ | Core simulation loop, time, environment, state serializer, sounds | +| scene/ | Scene graph, scene nodes, scene editor, utilities | +| rendering/ | All renderers (OpenGL legacy and full), geometry banks, particles, lights, frustum | +| audio/ | Sound, audio, and audio renderer | +| environment/ | Sky, sun, moon, stars, skydome | +| application/ | Application modes, UI layers/panels, driver/editor/scenario modes | +| input/ | Keyboard, mouse, gamepad, command, messaging, ZMQ input | +| scripting/ | Lua, Python, ladder logic, screen viewer | +| model/ | 3D models, materials, textures, resource manager | +| utilities/ | Logging, timing, parsing, math, globals, crash reporter | +| world/ | Tracks, traction, events, memory cells, stations | +| vehicle/ | Train, dynamic objects, driver, gauges, camera |