Mercurial > games > semicongine
annotate README.md @ 1032:4d655319431b
fix: wording
| author | sam <sam@basx.dev> |
|---|---|
| date | Thu, 21 Mar 2024 15:50:10 +0700 |
| parents | d8942b65fb30 |
| children | 88ef66ebfaf2 |
| rev | line source |
|---|---|
| 1031 | 1 Note: If you are reading this on Github, please not that this is only a mirror |
| 1032 | 2 repository and the default branch is ```hg```. |
| 1031 | 3 |
| 4 Also, some of the README is a bit out of date, as I am now focusing mostly on | |
| 5 writing my first game. However, developement ist onging and the documentation | |
| 6 will be overhauled once I start working on my next game. | |
| 7 | |
| 289 | 8 # Semicongine |
| 41 | 9 |
| 8 | 10 Hi there |
| 11 | |
|
213
b5d9410a8184
add: resource packaging and loading for different resource types, simplify build commands, update readme
Sam <sam@basx.dev>
parents:
202
diff
changeset
|
12 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
|
13 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
|
14 programming language you will ever need, [Nim](https://nim-lang.org/) |
| 41 | 15 |
| 289 | 16 ## Roadmap |
| 41 | 17 |
|
194
93f661a20f74
did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents:
187
diff
changeset
|
18 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
|
19 updated frequently (marking those checkboxes just feels to good to stop working). |
| 41 | 20 |
| 21 Rendering: | |
| 22 | |
| 23 - [x] Vertex attributes, vertex data | |
| 24 - [x] Shaders (allow for predefined and custom shaders) | |
| 25 - [x] Uniforms | |
| 26 - [x] Per-instance vertex attributes (required to be able to draw scene graph) | |
| 119 | 27 - [x] Fixed framerate |
| 130 | 28 - [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
|
29 - [x] Textures |
|
232
408d68fbcbee
did: restructure roadmap a bit, update progress
Sam <sam@basx.dev>
parents:
223
diff
changeset
|
30 - [x] Materials (vertices with material indices) |
| 337 | 31 - [x] Allow different shaders (ie pipelines) for different meshes |
|
194
93f661a20f74
did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents:
187
diff
changeset
|
32 |
|
93f661a20f74
did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents:
187
diff
changeset
|
33 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
|
34 |
| 41 | 35 - [ ] Depth buffering |
| 289 | 36 - [ ] Mipmaps |
| 41 | 37 |
| 38 Asset handling: | |
| 289 | 39 |
| 40 - [x] Resource loading - [x] Mod/resource-pack concept - [x] Load from directory - [x] Load from zip - [x] Load from exe-embeded | |
|
232
408d68fbcbee
did: restructure roadmap a bit, update progress
Sam <sam@basx.dev>
parents:
223
diff
changeset
|
41 - [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
|
42 - [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
|
43 - [x] Audio files (AU) |
|
232
408d68fbcbee
did: restructure roadmap a bit, update progress
Sam <sam@basx.dev>
parents:
223
diff
changeset
|
44 - [x] API to transform/recalculate mesh data |
| 41 | 45 |
| 119 | 46 Other (required for alpha release): |
| 289 | 47 |
| 119 | 48 - [x] Config files ala \*.ini files (use std/parsecfg) |
| 41 | 49 - [x] Mouse/Keyboard input handling |
| 50 - [x] X11 | |
| 51 - [x] Win32 | |
| 170 | 52 - [x] Enable/disable hardware cursor |
| 289 | 53 - [x] Fullscreen mode + switch between modes - [x] Linux - [x] Window |
| 54 - [x] Audio playing - [x] Linux - [x] Windows Waveform API | |
| 187 | 55 - [ ] Generic configuration concept (engine defaults, per-user, etc) |
| 41 | 56 - [ ] Input-mapping configuration |
| 101 | 57 - [ ] Telemetry |
| 289 | 58 - [x] Add simple event logging service |
| 59 - [ ] Add exception reporting | |
| 41 | 60 |
|
232
408d68fbcbee
did: restructure roadmap a bit, update progress
Sam <sam@basx.dev>
parents:
223
diff
changeset
|
61 Other important features: |
| 289 | 62 |
|
232
408d68fbcbee
did: restructure roadmap a bit, update progress
Sam <sam@basx.dev>
parents:
223
diff
changeset
|
63 - [ ] Multisampling |
|
274
c6bfe0eacb5c
this: feels sooooo good, font rendering working great (for a novice at least)
Sam <sam@basx.dev>
parents:
232
diff
changeset
|
64 - [x] Text rendering |
| 289 | 65 - [x] Animation system |
| 41 | 66 - [ ] Sprite system |
| 67 - [ ] Particle system | |
| 296 | 68 - [ ] Sound-animation |
| 69 - [ ] Paletton-export-loader | |
| 337 | 70 - [ ] Arrange buffer memory types based on per-mesh-attribute type instead of per-shader-attribute type (possible?) |
|
232
408d68fbcbee
did: restructure roadmap a bit, update progress
Sam <sam@basx.dev>
parents:
223
diff
changeset
|
71 |
| 289 | 72 Other less important features: |
| 73 | |
|
232
408d68fbcbee
did: restructure roadmap a bit, update progress
Sam <sam@basx.dev>
parents:
223
diff
changeset
|
74 - [ ] Viewport scaling (e.g. framebuffer resolution != window resolution) |
| 182 | 75 - [ ] Query and display rendering information from Vulkan? |
|
232
408d68fbcbee
did: restructure roadmap a bit, update progress
Sam <sam@basx.dev>
parents:
223
diff
changeset
|
76 - [ ] Game controller input handling |
|
408d68fbcbee
did: restructure roadmap a bit, update progress
Sam <sam@basx.dev>
parents:
223
diff
changeset
|
77 - [ ] Allow multipel Uniform blocks |
|
408d68fbcbee
did: restructure roadmap a bit, update progress
Sam <sam@basx.dev>
parents:
223
diff
changeset
|
78 - [ ] Documentation |
| 119 | 79 |
| 80 Quality improvments: | |
| 81 | |
| 82 - [x] Better scenegraph API | |
| 83 - [x] Better rendering pipeline API | |
| 84 | |
| 85 Build-system: | |
| 289 | 86 |
| 119 | 87 - [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
|
88 |
| 289 | 89 # Documentation |
|
194
93f661a20f74
did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents:
187
diff
changeset
|
90 |
|
93f661a20f74
did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents:
187
diff
changeset
|
91 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
|
92 |
| 289 | 93 ## Engine parts |
|
194
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 |
| 289 | 97 - Rendering: rendering.nim vulkan/\* |
|
194
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 |
| 223 | 103 - Math: math/\* |
|
194
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) |
| 223 | 105 - 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
|
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 |
| 289 | 109 ## Handling of assets |
| 202 | 110 |
| 111 A short description how I want to handle assets. | |
| 112 | |
| 113 Support for file formats (super limited, no external dependencies, uses quite a bit of space, hoping for zip): | |
| 114 | |
| 115 - Images: BMP | |
| 116 - Audio: AU | |
| 223 | 117 - Mesh: glTF (\*.gld) |
| 202 | 118 |
| 119 In-memory layout of assets (everything needs to be converted to those while loading): | |
| 120 | |
| 121 - Images: 4 channel with each uint8 = 32 bit RGBA, little endian (R is low bits, A is high bits) | |
| 122 - Audio: 2 Channel 16 bit signed little endian, 44100Hz | |
| 123 - Meshes: non-interleaved, lists of values for each vertex, one list per attribute | |
| 124 | |
| 289 | 125 ## Configuration |
|
194
93f661a20f74
did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents:
187
diff
changeset
|
126 |
| 223 | 127 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
|
128 |
|
93f661a20f74
did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents:
187
diff
changeset
|
129 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
|
130 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
|
131 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
|
132 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
|
133 |
|
93f661a20f74
did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents:
187
diff
changeset
|
134 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
|
135 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
|
136 |
|
93f661a20f74
did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents:
187
diff
changeset
|
137 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
|
138 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
|
139 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
|
140 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
|
141 |
|
93f661a20f74
did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents:
187
diff
changeset
|
142 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
|
143 |
|
93f661a20f74
did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents:
187
diff
changeset
|
144 **1. Build configuration** |
|
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 **2. Runtime settings** |
|
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 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
|
149 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
|
150 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
|
151 |
|
93f661a20f74
did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents:
187
diff
changeset
|
152 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
|
153 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
|
154 |
|
93f661a20f74
did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents:
187
diff
changeset
|
155 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
|
156 |
| 289 | 157 `a.b` refers to the settings directory `./a/b/` (from the settings-root) |
| 158 `c` refers to the file `c.ini` inside `./a/b/` | |
| 159 `d` refers to the ini-section inside the file `./a/b/c.ini` | |
| 160 `e` refers to the key inside section `d` inside the file `./a/b/c.ini` | |
|
194
93f661a20f74
did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents:
187
diff
changeset
|
161 |
| 289 | 162 `a.b` are optional, they just allow larger configuration trees. |
| 163 `d` is optional, if it is not give, `e` refers to the top-level section | |
|
194
93f661a20f74
did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents:
187
diff
changeset
|
164 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
|
165 |
|
93f661a20f74
did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents:
187
diff
changeset
|
166 **3. Mods** |
|
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 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
|
169 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
|
170 |
|
93f661a20f74
did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents:
187
diff
changeset
|
171 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
|
172 |
|
93f661a20f74
did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents:
187
diff
changeset
|
173 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
|
174 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
|
175 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
|
176 |
|
93f661a20f74
did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents:
187
diff
changeset
|
177 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
|
178 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
|
179 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
|
180 |
|
93f661a20f74
did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents:
187
diff
changeset
|
181 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
|
182 resource packaging. |
|
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 **4. Save data** |
|
93f661a20f74
did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents:
187
diff
changeset
|
185 |
|
93f661a20f74
did: a bit of cleanup with the config, also add some documentation
Sam <sam@basx.dev>
parents:
187
diff
changeset
|
186 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
|
187 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
|
188 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
|
189 https://nee.lv/2021/02/28/How-I-cut-GTA-Online-loading-times-by-70/ |