annotate README.md @ 244:f52fccedf5ab

did: adjust to new API
author Sam <sam@basx.dev>
date Mon, 22 May 2023 00:51:41 +0700
parents 408d68fbcbee
children c6bfe0eacb5c
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
41
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
1 Semicongine
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
2 ===========
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
3
8
1134f41a49e9 add: a few missing changes
Sam <sam@basx.dev>
parents:
diff changeset
4 Hi there
1134f41a49e9 add: a few missing changes
Sam <sam@basx.dev>
parents:
diff changeset
5
213
b5d9410a8184 add: resource packaging and loading for different resource types, simplify build commands, update readme
Sam <sam@basx.dev>
parents: 202
diff changeset
6 This is a little game engine, mainly trying to wrap around vulkan and the
b5d9410a8184 add: resource packaging and loading for different resource types, simplify build commands, update readme
Sam <sam@basx.dev>
parents: 202
diff changeset
7 operating system's windowing, input and audio system. I am using the last
b5d9410a8184 add: resource packaging and loading for different resource types, simplify build commands, update readme
Sam <sam@basx.dev>
parents: 202
diff changeset
8 programming language you will ever need, [Nim](https://nim-lang.org/)
41
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
9
48
8305f8619a27 add: some more instructions
Sam <sam@basx.dev>
parents: 45
diff changeset
10 Building
8305f8619a27 add: some more instructions
Sam <sam@basx.dev>
parents: 45
diff changeset
11 --------
8305f8619a27 add: some more instructions
Sam <sam@basx.dev>
parents: 45
diff changeset
12
95
8011e4d6372d add: consistent way to define platform-specific code
Sam <sam@basx.dev>
parents: 73
diff changeset
13 Requires Nim to be installed and ```glslangValidator``` to be downloaded to the
8011e4d6372d add: consistent way to define platform-specific code
Sam <sam@basx.dev>
parents: 73
diff changeset
14 directory of the main compilation file (e.g. into ```examples/``` in order to
8011e4d6372d add: consistent way to define platform-specific code
Sam <sam@basx.dev>
parents: 73
diff changeset
15 compile the examples). It can be downloaded at
8011e4d6372d add: consistent way to define platform-specific code
Sam <sam@basx.dev>
parents: 73
diff changeset
16 https://github.com/KhronosGroup/glslang/releases/.
45
2378ada1a14e add: some build instructions for windows
Sam <sam@basx.dev>
parents: 41
diff changeset
17
95
8011e4d6372d add: consistent way to define platform-specific code
Sam <sam@basx.dev>
parents: 73
diff changeset
18 Run ```nim help``` to see a list of available build commands.
48
8305f8619a27 add: some more instructions
Sam <sam@basx.dev>
parents: 45
diff changeset
19
41
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
20 Roadmap
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
21 -------
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
22
194
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
23 Here a bit to see what has been planed and what is done already. Is being
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
24 updated frequently (marking those checkboxes just feels to good to stop working).
41
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
25
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
26 Rendering:
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
27
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
28 - [x] Vertex attributes, vertex data
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
29 - [x] Shaders (allow for predefined and custom shaders)
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
30 - [x] Uniforms
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
31 - [x] Per-instance vertex attributes (required to be able to draw scene graph)
119
5cd1b42127ba did: update progress
Sam <sam@basx.dev>
parents: 117
diff changeset
32 - [x] Fixed framerate
130
ff345f9e4eb7 did: update readme
Sam <sam@basx.dev>
parents: 119
diff changeset
33 - [x] Instanced drawing (currently can use instance attributes, but we only support a single instance per draw call)
194
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
34 - [x] Textures
232
408d68fbcbee did: restructure roadmap a bit, update progress
Sam <sam@basx.dev>
parents: 223
diff changeset
35 - [x] Materials (vertices with material indices)
194
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
36 - [ ] Allow different shaders (ie pipelines) for different meshes
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
37
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
38 Required for 3D rendering:
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
39
41
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
40 - [ ] Depth buffering
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
41 - [ ] Mipmaps
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
42
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
43 Asset handling:
216
22122b64f09f add: sekeleton to start working on resource loading, updated readme
Sam <sam@basx.dev>
parents: 213
diff changeset
44 - [x] Resource loading
213
b5d9410a8184 add: resource packaging and loading for different resource types, simplify build commands, update readme
Sam <sam@basx.dev>
parents: 202
diff changeset
45 - [x] Mod/resource-pack concept
b5d9410a8184 add: resource packaging and loading for different resource types, simplify build commands, update readme
Sam <sam@basx.dev>
parents: 202
diff changeset
46 - [x] Load from directory
b5d9410a8184 add: resource packaging and loading for different resource types, simplify build commands, update readme
Sam <sam@basx.dev>
parents: 202
diff changeset
47 - [x] Load from zip
b5d9410a8184 add: resource packaging and loading for different resource types, simplify build commands, update readme
Sam <sam@basx.dev>
parents: 202
diff changeset
48 - [x] Load from exe-embeded
232
408d68fbcbee did: restructure roadmap a bit, update progress
Sam <sam@basx.dev>
parents: 223
diff changeset
49 - [x] Mesh/material files (glTF, but incomplete, not all features supported)
221
2a2367d289dd did: update progress, change roadmap to use glTF instead of OBJ (this seems to be super cool!)
Sam <sam@basx.dev>
parents: 216
diff changeset
50 - [x] Image files (BMP RGBA)
2a2367d289dd did: update progress, change roadmap to use glTF instead of OBJ (this seems to be super cool!)
Sam <sam@basx.dev>
parents: 216
diff changeset
51 - [x] Audio files (AU)
232
408d68fbcbee did: restructure roadmap a bit, update progress
Sam <sam@basx.dev>
parents: 223
diff changeset
52 - [x] API to transform/recalculate mesh data
41
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
53
119
5cd1b42127ba did: update progress
Sam <sam@basx.dev>
parents: 117
diff changeset
54 Other (required for alpha release):
5cd1b42127ba did: update progress
Sam <sam@basx.dev>
parents: 117
diff changeset
55 - [x] Config files ala \*.ini files (use std/parsecfg)
41
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
56 - [x] Mouse/Keyboard input handling
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
57 - [x] X11
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
58 - [x] Win32
170
c1a9a988b9e3 did: update progress
Sam <sam@basx.dev>
parents: 130
diff changeset
59 - [x] Enable/disable hardware cursor
187
b14e078690dc add: progress update
Sam <sam@basx.dev>
parents: 182
diff changeset
60 - [x] Fullscreen mode + switch between modes
b14e078690dc add: progress update
Sam <sam@basx.dev>
parents: 182
diff changeset
61 - [x] Linux
b14e078690dc add: progress update
Sam <sam@basx.dev>
parents: 182
diff changeset
62 - [x] Window
182
315c809c8e60 did: update progress
Sam <sam@basx.dev>
parents: 179
diff changeset
63 - [x] Audio playing
187
b14e078690dc add: progress update
Sam <sam@basx.dev>
parents: 182
diff changeset
64 - [x] Linux
b14e078690dc add: progress update
Sam <sam@basx.dev>
parents: 182
diff changeset
65 - [x] Windows Waveform API
b14e078690dc add: progress update
Sam <sam@basx.dev>
parents: 182
diff changeset
66 - [ ] Generic configuration concept (engine defaults, per-user, etc)
41
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
67 - [ ] Input-mapping configuration
101
f0ceb8c17d2c add: really need telemetry at some point
Sam <sam@basx.dev>
parents: 95
diff changeset
68 - [ ] Telemetry
194
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
69 - [x] Add simple event logging service
187
b14e078690dc add: progress update
Sam <sam@basx.dev>
parents: 182
diff changeset
70 - [ ] Add exception reporting
41
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
71
232
408d68fbcbee did: restructure roadmap a bit, update progress
Sam <sam@basx.dev>
parents: 223
diff changeset
72 Other important features:
408d68fbcbee did: restructure roadmap a bit, update progress
Sam <sam@basx.dev>
parents: 223
diff changeset
73 - [ ] Multisampling
41
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
74 - [ ] Text rendering
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
75 - [ ] Animation system
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
76 - [ ] Sprite system
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
77 - [ ] Particle system
232
408d68fbcbee did: restructure roadmap a bit, update progress
Sam <sam@basx.dev>
parents: 223
diff changeset
78
408d68fbcbee did: restructure roadmap a bit, update progress
Sam <sam@basx.dev>
parents: 223
diff changeset
79 Other less features:
408d68fbcbee did: restructure roadmap a bit, update progress
Sam <sam@basx.dev>
parents: 223
diff changeset
80 - [ ] Viewport scaling (e.g. framebuffer resolution != window resolution)
182
315c809c8e60 did: update progress
Sam <sam@basx.dev>
parents: 179
diff changeset
81 - [ ] Query and display rendering information from Vulkan?
232
408d68fbcbee did: restructure roadmap a bit, update progress
Sam <sam@basx.dev>
parents: 223
diff changeset
82 - [ ] Game controller input handling
408d68fbcbee did: restructure roadmap a bit, update progress
Sam <sam@basx.dev>
parents: 223
diff changeset
83 - [ ] Allow multipel Uniform blocks
408d68fbcbee did: restructure roadmap a bit, update progress
Sam <sam@basx.dev>
parents: 223
diff changeset
84 - [ ] Documentation
119
5cd1b42127ba did: update progress
Sam <sam@basx.dev>
parents: 117
diff changeset
85
5cd1b42127ba did: update progress
Sam <sam@basx.dev>
parents: 117
diff changeset
86 Quality improvments:
5cd1b42127ba did: update progress
Sam <sam@basx.dev>
parents: 117
diff changeset
87
5cd1b42127ba did: update progress
Sam <sam@basx.dev>
parents: 117
diff changeset
88 - [x] Better scenegraph API
5cd1b42127ba did: update progress
Sam <sam@basx.dev>
parents: 117
diff changeset
89 - [x] Better rendering pipeline API
5cd1b42127ba did: update progress
Sam <sam@basx.dev>
parents: 117
diff changeset
90
5cd1b42127ba did: update progress
Sam <sam@basx.dev>
parents: 117
diff changeset
91 Build-system:
5cd1b42127ba did: update progress
Sam <sam@basx.dev>
parents: 117
diff changeset
92 - [x] move all of Makefile to config.nims
194
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
93
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
94
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
95 Documentation
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
96 =============
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
97
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
98 Okay, here is first quick-n-dirty documentation, the only purpose to organize my thoughts a bit.
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
99
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
100 Engine parts
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
101 ------------
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
102
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
103 Currently we have at least the following:
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
104
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
105 - Rendering: rendering.nim vulkan/*
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
106 - Scene graph: entity.nim
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
107 - Audio: audio.nim audiotypes.nim
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
108 - Input: events.nim
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
109 - Settings: settings.nim
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
110 - Meshes: mesh.nim
223
4c0a4b6902ff did: update progress
Sam <sam@basx.dev>
parents: 221
diff changeset
111 - Math: math/\*
194
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
112 - Telemetry: telemetry.nim (wip)
223
4c0a4b6902ff did: update progress
Sam <sam@basx.dev>
parents: 221
diff changeset
113 - Resources (loading, mods): resources.nim
194
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
114
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
115 Got you: Everything is wip, but (wip) here means work has not started yet.
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
116
202
9bb3fdbecc52 add: documentation
Sam <sam@basx.dev>
parents: 198
diff changeset
117 Handling of assets
9bb3fdbecc52 add: documentation
Sam <sam@basx.dev>
parents: 198
diff changeset
118 ------------------
9bb3fdbecc52 add: documentation
Sam <sam@basx.dev>
parents: 198
diff changeset
119
9bb3fdbecc52 add: documentation
Sam <sam@basx.dev>
parents: 198
diff changeset
120 A short description how I want to handle assets.
9bb3fdbecc52 add: documentation
Sam <sam@basx.dev>
parents: 198
diff changeset
121
9bb3fdbecc52 add: documentation
Sam <sam@basx.dev>
parents: 198
diff changeset
122 Support for file formats (super limited, no external dependencies, uses quite a bit of space, hoping for zip):
9bb3fdbecc52 add: documentation
Sam <sam@basx.dev>
parents: 198
diff changeset
123
9bb3fdbecc52 add: documentation
Sam <sam@basx.dev>
parents: 198
diff changeset
124 - Images: BMP
9bb3fdbecc52 add: documentation
Sam <sam@basx.dev>
parents: 198
diff changeset
125 - Audio: AU
223
4c0a4b6902ff did: update progress
Sam <sam@basx.dev>
parents: 221
diff changeset
126 - Mesh: glTF (\*.gld)
202
9bb3fdbecc52 add: documentation
Sam <sam@basx.dev>
parents: 198
diff changeset
127
9bb3fdbecc52 add: documentation
Sam <sam@basx.dev>
parents: 198
diff changeset
128 In-memory layout of assets (everything needs to be converted to those while loading):
9bb3fdbecc52 add: documentation
Sam <sam@basx.dev>
parents: 198
diff changeset
129
9bb3fdbecc52 add: documentation
Sam <sam@basx.dev>
parents: 198
diff changeset
130 - Images: 4 channel with each uint8 = 32 bit RGBA, little endian (R is low bits, A is high bits)
9bb3fdbecc52 add: documentation
Sam <sam@basx.dev>
parents: 198
diff changeset
131 - Audio: 2 Channel 16 bit signed little endian, 44100Hz
9bb3fdbecc52 add: documentation
Sam <sam@basx.dev>
parents: 198
diff changeset
132 - Meshes: non-interleaved, lists of values for each vertex, one list per attribute
9bb3fdbecc52 add: documentation
Sam <sam@basx.dev>
parents: 198
diff changeset
133
194
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
134 Configuration
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
135 -------------
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
136
223
4c0a4b6902ff did: update progress
Sam <sam@basx.dev>
parents: 221
diff changeset
137 Or: How to organize s\*\*t that is not code
194
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
138
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
139 Not sure why, but this feels super important to get done right. The engine is
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
140 being designed with a library-mindset, not a framework mindset. And with that,
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
141 ensuring the configuration of the build, runtime and settings in general
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
142 becomes a bit less straight-forward.
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
143
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
144 So here is the idea: There are three to four different kinds of configurations
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
145 that the engine should be able to handle:
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
146
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
147 1. Build configuration: Engine version, project name, log level, etc.
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
148 2. Runtime engine/project settings: Video/audio settings, telemetry, log-output, etc.
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
149 3. Mods: Different sets of assets and configuration to allow easy testing of different scenarios
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
150 4. Save data: Saving world state of the game
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
151
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
152 Okay, let's look at each of those and how I plan to implement them:
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
153
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
154 **1. Build configuration**
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
155
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
156
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
157 **2. Runtime settings**
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
158
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
159 This is mostly implemented already. I am using the Nim module std/parsecfg.
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
160 There is also the option to watch the filesystem and update values at runtime,
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
161 mostly usefull for development.
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
162
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
163 The engine scans all files in the settings-root directory and builds a
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
164 settings tree that can be access via a setting-hierarchy like this:
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
165
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
166 setting("a.b.c.d.e")
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
167
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
168 ```a.b``` refers to the settings directory ```./a/b/``` (from the settings-root)
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
169 ```c``` refers to the file ```c.ini``` inside ```./a/b/```
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
170 ```d``` refers to the ini-section inside the file ```./a/b/c.ini```
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
171 ```e``` refers to the key inside section ```d``` inside the file ```./a/b/c.ini```
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
172
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
173 ```a.b``` are optional, they just allow larger configuration trees.
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
174 ```d``` is optional, if it is not give, ```e``` refers to the top-level section
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
175 of the ini-file.
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
176
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
177 **3. Mods**
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
178
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
179 A mod is just a collection of resources for a game. Can maybe switched from
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
180 inside a game. Current mod can be defined via "2. Runtime settings"
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
181
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
182 I want to support mods from:
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
183
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
184 a) a directory on the filesystem
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
185 b) a zip-file on the filesystem
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
186 c) a zip-file that is embeded in the executable
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
187
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
188 The reasoning is simple: a) is helpfull for development, testing of
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
189 new/replaced assets, b) is the default deployment with mod-support and c) is
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
190 deployment without mod-support, demo-versions and similar.
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
191
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
192 Should not be that difficult but give us everything we ever need in terms of
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
193 resource packaging.
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
194
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
195 **4. Save data**
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
196
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
197 Not too much thought here yet. Maybe we can use Nim's std/marshal module. It
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
198 produces JSON from nim objects. Pretty dope, but maybe pretty slow. However, we
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
199 are indie-JSON here, not 10M of GTA Online JSON:
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
200 https://nee.lv/2021/02/28/How-I-cut-GTA-Online-loading-times-by-70/