annotate README.md @ 663:af9ab61aa87e

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