Mercurial > games > semicongine

annotate README.md @ 202:9bb3fdbecc52

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
add: documentation
author Sam <sam@basx.dev>
date Mon, 08 May 2023 00:48:11 +0700
parents e4ba91da416b
children b5d9410a8184
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
41
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
6 This is a very simplistic little game engine, mainly trying to wrap around vulkan and the operating system's windowing, input and audio system.
95
8011e4d6372d add: consistent way to define platform-specific code
Sam <sam@basx.dev>
parents: 73
diff changeset
7 I am using the last 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
8
48
8305f8619a27 add: some more instructions
Sam <sam@basx.dev>
parents: 45
diff changeset
9 Building
8305f8619a27 add: some more instructions
Sam <sam@basx.dev>
parents: 45
diff changeset
10 --------
8305f8619a27 add: some more instructions
Sam <sam@basx.dev>
parents: 45
diff changeset
11
95
8011e4d6372d add: consistent way to define platform-specific code
Sam <sam@basx.dev>
parents: 73
diff changeset
12 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
13 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
14 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
15 https://github.com/KhronosGroup/glslang/releases/.
45
2378ada1a14e add: some build instructions for windows
Sam <sam@basx.dev>
parents: 41
diff changeset
16
95
8011e4d6372d add: consistent way to define platform-specific code
Sam <sam@basx.dev>
parents: 73
diff changeset
17 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
18
41
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
19 Roadmap
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
20 -------
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
21
194
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
22 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
23 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
24
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
25 Rendering:
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
26
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
27 - [x] Vertex attributes, vertex data
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
28 - [x] Shaders (allow for predefined and custom shaders)
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
29 - [x] Uniforms
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
30 - [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
31 - [x] Fixed framerate
130
ff345f9e4eb7 did: update readme
Sam <sam@basx.dev>
parents: 119
diff changeset
32 - [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
33 - [x] Textures
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
34 - [ ] Multisampling
202
9bb3fdbecc52 add: documentation
Sam <sam@basx.dev>
parents: 198
diff changeset
35 - [ ] Materials (vertices with material indices)
198
e4ba91da416b add: more todoooooo
Sam <sam@basx.dev>
parents: 194
diff changeset
36 - [ ] Viewport scaling (e.g. framebuffer resolution != window resolution
194
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
37 - [ ] 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
38
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
39 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
40
41
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
41 - [ ] Depth buffering
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
42 - [ ] Mipmaps
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
43
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
44 Asset handling:
170
c1a9a988b9e3 did: update progress
Sam <sam@basx.dev>
parents: 130
diff changeset
45 - [ ] Resource concept: load from directory, zip or in-memory-zip, select "mod" as root
41
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
46 - [ ] Mesh files (Wavefront OBJ, MTL) (use something from sketchfab for testing, https://sketchfab.com/)
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
47 - [ ] Image files (BMP RGB + BMP Graysscale for transparency)
95
8011e4d6372d add: consistent way to define platform-specific code
Sam <sam@basx.dev>
parents: 73
diff changeset
48 - [ ] Audio files (AU)
41
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
49
119
5cd1b42127ba did: update progress
Sam <sam@basx.dev>
parents: 117
diff changeset
50 Other (required for alpha release):
5cd1b42127ba did: update progress
Sam <sam@basx.dev>
parents: 117
diff changeset
51 - [x] Config files ala \*.ini files (use std/parsecfg)
41
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
52 - [x] Mouse/Keyboard input handling
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
53 - [x] X11
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
54 - [x] Win32
170
c1a9a988b9e3 did: update progress
Sam <sam@basx.dev>
parents: 130
diff changeset
55 - [x] Enable/disable hardware cursor
187
b14e078690dc add: progress update
Sam <sam@basx.dev>
parents: 182
diff changeset
56 - [x] Fullscreen mode + switch between modes
b14e078690dc add: progress update
Sam <sam@basx.dev>
parents: 182
diff changeset
57 - [x] Linux
b14e078690dc add: progress update
Sam <sam@basx.dev>
parents: 182
diff changeset
58 - [x] Window
182
315c809c8e60 did: update progress
Sam <sam@basx.dev>
parents: 179
diff changeset
59 - [x] Audio playing
187
b14e078690dc add: progress update
Sam <sam@basx.dev>
parents: 182
diff changeset
60 - [x] Linux
b14e078690dc add: progress update
Sam <sam@basx.dev>
parents: 182
diff changeset
61 - [x] Windows Waveform API
b14e078690dc add: progress update
Sam <sam@basx.dev>
parents: 182
diff changeset
62 - [ ] Generic configuration concept (engine defaults, per-user, etc)
41
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
63 - [ ] Input-mapping configuration
101
f0ceb8c17d2c add: really need telemetry at some point
Sam <sam@basx.dev>
parents: 95
diff changeset
64 - [ ] Telemetry
194
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
65 - [x] Add simple event logging service
187
b14e078690dc add: progress update
Sam <sam@basx.dev>
parents: 182
diff changeset
66 - [ ] Add exception reporting
b14e078690dc add: progress update
Sam <sam@basx.dev>
parents: 182
diff changeset
67 - [ ] Documentation?
41
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
68
119
5cd1b42127ba did: update progress
Sam <sam@basx.dev>
parents: 117
diff changeset
69 Advanced features (very low priority):
41
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
70 - [ ] Text rendering
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
71 - [ ] Animation system
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
72 - [ ] Sprite system
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
73 - [ ] Particle system
182
315c809c8e60 did: update progress
Sam <sam@basx.dev>
parents: 179
diff changeset
74 - [ ] Query and display rendering information from Vulkan?
315c809c8e60 did: update progress
Sam <sam@basx.dev>
parents: 179
diff changeset
75 - [ ] Game controller input handling?
315c809c8e60 did: update progress
Sam <sam@basx.dev>
parents: 179
diff changeset
76 - [ ] Allow multipel Uniform blocks?
119
5cd1b42127ba did: update progress
Sam <sam@basx.dev>
parents: 117
diff changeset
77
5cd1b42127ba did: update progress
Sam <sam@basx.dev>
parents: 117
diff changeset
78 Quality improvments:
5cd1b42127ba did: update progress
Sam <sam@basx.dev>
parents: 117
diff changeset
79
5cd1b42127ba did: update progress
Sam <sam@basx.dev>
parents: 117
diff changeset
80 - [x] Better scenegraph API
5cd1b42127ba did: update progress
Sam <sam@basx.dev>
parents: 117
diff changeset
81 - [x] Better rendering pipeline API
5cd1b42127ba did: update progress
Sam <sam@basx.dev>
parents: 117
diff changeset
82
5cd1b42127ba did: update progress
Sam <sam@basx.dev>
parents: 117
diff changeset
83 Build-system:
5cd1b42127ba did: update progress
Sam <sam@basx.dev>
parents: 117
diff changeset
84 - [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
85
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
86
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
87 Documentation
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
88 =============
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
89
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
90 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
91
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
92 Engine parts
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 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
96
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
97 - 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
98 - 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
99 - 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
100 - Input: events.nim
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
101 - Settings: settings.nim
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
102 - Meshes: mesh.nim
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
103 - Math: math/*
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
104 - Telemetry: telemetry.nim (wip)
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
105 - Resources/mods: resources.nim (wip)
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
106
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
107 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
108
202
9bb3fdbecc52 add: documentation
Sam <sam@basx.dev>
parents: 198
diff changeset
109 Handling of assets
9bb3fdbecc52 add: documentation
Sam <sam@basx.dev>
parents: 198
diff changeset
110 ------------------
9bb3fdbecc52 add: documentation
Sam <sam@basx.dev>
parents: 198
diff changeset
111
9bb3fdbecc52 add: documentation
Sam <sam@basx.dev>
parents: 198
diff changeset
112 A short description how I want to handle assets.
9bb3fdbecc52 add: documentation
Sam <sam@basx.dev>
parents: 198
diff changeset
113
9bb3fdbecc52 add: documentation
Sam <sam@basx.dev>
parents: 198
diff changeset
114 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
115
9bb3fdbecc52 add: documentation
Sam <sam@basx.dev>
parents: 198
diff changeset
116 - Images: BMP
9bb3fdbecc52 add: documentation
Sam <sam@basx.dev>
parents: 198
diff changeset
117 - Audio: AU
9bb3fdbecc52 add: documentation
Sam <sam@basx.dev>
parents: 198
diff changeset
118 - Mesh: OBJ + MTL
9bb3fdbecc52 add: documentation
Sam <sam@basx.dev>
parents: 198
diff changeset
119
9bb3fdbecc52 add: documentation
Sam <sam@basx.dev>
parents: 198
diff changeset
120 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
121
9bb3fdbecc52 add: documentation
Sam <sam@basx.dev>
parents: 198
diff changeset
122 - 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
123 - Audio: 2 Channel 16 bit signed little endian, 44100Hz
9bb3fdbecc52 add: documentation
Sam <sam@basx.dev>
parents: 198
diff changeset
124 - Meshes: non-interleaved, lists of values for each vertex, one list per attribute
9bb3fdbecc52 add: documentation
Sam <sam@basx.dev>
parents: 198
diff changeset
125
194
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
126 Configuration
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
127 -------------
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
128
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
129 Or: How to organize s**t that is not code
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
130
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
131 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
132 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
133 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
134 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
135
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
136 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
137 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
138
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
139 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
140 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
141 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
142 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
143
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
144 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
145
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
146 **1. Build configuration**
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
147
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
148
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
149 **2. Runtime settings**
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
150
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
151 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
152 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
153 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
154
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
155 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
156 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
157
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
158 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
159
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
160 ```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
161 ```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
162 ```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
163 ```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
164
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
165 ```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
166 ```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
167 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
168
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
169 **3. Mods**
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
170
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
171 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
172 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
173
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
174 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
175
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
176 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
177 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
178 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
179
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
180 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
181 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
182 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
183
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
184 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
185 resource packaging.
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
186
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
187 **4. Save data**
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
188
93f661a20f74 did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents: 187
diff changeset
189 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
190 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
191 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
192 https://nee.lv/2021/02/28/How-I-cut-GTA-Online-loading-times-by-70/