Mercurial > games > semicongine

annotate README.md @ 509:330dbc449e96

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
add: some more instructions
author Sam <sam@basx.dev>
date Thu, 19 Jan 2023 00:47:12 +0700
parents b159fcdd36b9
children 547f3a374271
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.
e52bfb0b98ce fix: organize notes a bit
Sam <sam@basx.dev>
parents: 469
diff changeset
7 This is using the last programming language you will ever need, [Nim](https://nim-lang.org/)
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
330dbc449e96 add: some more instructions
Sam <sam@basx.dev>
parents: 506
diff changeset
12 Run ```nim help``` to see a list of available build commands.
330dbc449e96 add: some more instructions
Sam <sam@basx.dev>
parents: 506
diff changeset
13
330dbc449e96 add: some more instructions
Sam <sam@basx.dev>
parents: 506
diff changeset
14 It is required to download the glslangValidator binary into the ```examples/``` directory in order to be able to build.
330dbc449e96 add: some more instructions
Sam <sam@basx.dev>
parents: 506
diff changeset
15 There is a nim command for this that works on linux.
330dbc449e96 add: some more instructions
Sam <sam@basx.dev>
parents: 506
diff changeset
16
506
b159fcdd36b9 add: some build instructions for windows
Sam <sam@basx.dev>
parents: 502
diff changeset
17 Compilation on Windows
b159fcdd36b9 add: some build instructions for windows
Sam <sam@basx.dev>
parents: 502
diff changeset
18 ----------------------
b159fcdd36b9 add: some build instructions for windows
Sam <sam@basx.dev>
parents: 502
diff changeset
19
b159fcdd36b9 add: some build instructions for windows
Sam <sam@basx.dev>
parents: 502
diff changeset
20 Requires a Windows SDK to be installed (e.g. via Visual Studio Build Tools).
b159fcdd36b9 add: some build instructions for windows
Sam <sam@basx.dev>
parents: 502
diff changeset
21 Also, using Nim on Windows with mingw seems to be way faster than with vcc/lc.
b159fcdd36b9 add: some build instructions for windows
Sam <sam@basx.dev>
parents: 502
diff changeset
22 For compilation with vcc/ls, install additionaly (with Visual Studio Build Tools):
b159fcdd36b9 add: some build instructions for windows
Sam <sam@basx.dev>
parents: 502
diff changeset
23 - Windows Universal C Runtime (some important files)
b159fcdd36b9 add: some build instructions for windows
Sam <sam@basx.dev>
parents: 502
diff changeset
24 - Windows CRT SDK (some important header files)
b159fcdd36b9 add: some build instructions for windows
Sam <sam@basx.dev>
parents: 502
diff changeset
25 - Some version of MSVC (the compiler)
b159fcdd36b9 add: some build instructions for windows
Sam <sam@basx.dev>
parents: 502
diff changeset
26
509
330dbc449e96 add: some more instructions
Sam <sam@basx.dev>
parents: 506
diff changeset
27 glslangValidator cannot yet be downloaded automatically on windows, check config.nim for instructions.
330dbc449e96 add: some more instructions
Sam <sam@basx.dev>
parents: 506
diff changeset
28
502
e52bfb0b98ce fix: organize notes a bit
Sam <sam@basx.dev>
parents: 469
diff changeset
29 Roadmap
e52bfb0b98ce fix: organize notes a bit
Sam <sam@basx.dev>
parents: 469
diff changeset
30 -------
e52bfb0b98ce fix: organize notes a bit
Sam <sam@basx.dev>
parents: 469
diff changeset
31
e52bfb0b98ce fix: organize notes a bit
Sam <sam@basx.dev>
parents: 469
diff changeset
32 Still tons to do, but it feels like the worst things (except audio maybe?) are over the hill.
e52bfb0b98ce fix: organize notes a bit
Sam <sam@basx.dev>
parents: 469
diff changeset
33
e52bfb0b98ce fix: organize notes a bit
Sam <sam@basx.dev>
parents: 469
diff changeset
34 Rendering:
e52bfb0b98ce fix: organize notes a bit
Sam <sam@basx.dev>
parents: 469
diff changeset
35
e52bfb0b98ce fix: organize notes a bit
Sam <sam@basx.dev>
parents: 469
diff changeset
36 - [x] Vertex attributes, vertex data
e52bfb0b98ce fix: organize notes a bit
Sam <sam@basx.dev>
parents: 469
diff changeset
37 - [x] Shaders (allow for predefined and custom shaders)
e52bfb0b98ce fix: organize notes a bit
Sam <sam@basx.dev>
parents: 469
diff changeset
38 - [x] Uniforms
e52bfb0b98ce fix: organize notes a bit
Sam <sam@basx.dev>
parents: 469
diff changeset
39 - [x] Per-instance vertex attributes (required to be able to draw scene graph)
e52bfb0b98ce fix: organize notes a bit
Sam <sam@basx.dev>
parents: 469
diff changeset
40 - [ ] Textures
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 - [ ] Multisampling
e52bfb0b98ce fix: organize notes a bit
Sam <sam@basx.dev>
parents: 469
diff changeset
44 - [~] Instanced drawing (using it currently but number of instances is hardcoded to 1
e52bfb0b98ce fix: organize notes a bit
Sam <sam@basx.dev>
parents: 469
diff changeset
45
e52bfb0b98ce fix: organize notes a bit
Sam <sam@basx.dev>
parents: 469
diff changeset
46 Build-system:
e52bfb0b98ce fix: organize notes a bit
Sam <sam@basx.dev>
parents: 469
diff changeset
47 - [x] move all of Makefile to config.nims
e52bfb0b98ce fix: organize notes a bit
Sam <sam@basx.dev>
parents: 469
diff changeset
48
e52bfb0b98ce fix: organize notes a bit
Sam <sam@basx.dev>
parents: 469
diff changeset
49 Asset handling:
e52bfb0b98ce fix: organize notes a bit
Sam <sam@basx.dev>
parents: 469
diff changeset
50 - [ ] 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
51 - [ ] Image files (BMP RGB + BMP Graysscale for transparency)
e52bfb0b98ce fix: organize notes a bit
Sam <sam@basx.dev>
parents: 469
diff changeset
52 - [ ] Audio files (WAV)
e52bfb0b98ce fix: organize notes a bit
Sam <sam@basx.dev>
parents: 469
diff changeset
53
e52bfb0b98ce fix: organize notes a bit
Sam <sam@basx.dev>
parents: 469
diff changeset
54 Quality improvments:
e52bfb0b98ce fix: organize notes a bit
Sam <sam@basx.dev>
parents: 469
diff changeset
55
e52bfb0b98ce fix: organize notes a bit
Sam <sam@basx.dev>
parents: 469
diff changeset
56 - [ ] Better scenegraph API
e52bfb0b98ce fix: organize notes a bit
Sam <sam@basx.dev>
parents: 469
diff changeset
57 - [ ] Better rendering pipeline API
e52bfb0b98ce fix: organize notes a bit
Sam <sam@basx.dev>
parents: 469
diff changeset
58
e52bfb0b98ce fix: organize notes a bit
Sam <sam@basx.dev>
parents: 469
diff changeset
59 Other:
e52bfb0b98ce fix: organize notes a bit
Sam <sam@basx.dev>
parents: 469
diff changeset
60 - [x] Mouse/Keyboard input handling
e52bfb0b98ce fix: organize notes a bit
Sam <sam@basx.dev>
parents: 469
diff changeset
61 - [x] X11
e52bfb0b98ce fix: organize notes a bit
Sam <sam@basx.dev>
parents: 469
diff changeset
62 - [x] Win32
e52bfb0b98ce fix: organize notes a bit
Sam <sam@basx.dev>
parents: 469
diff changeset
63 - [ ] Config files ala \*.ini files (use std/parsecfg)
e52bfb0b98ce fix: organize notes a bit
Sam <sam@basx.dev>
parents: 469
diff changeset
64 - [ ] Input-mapping configuration
e52bfb0b98ce fix: organize notes a bit
Sam <sam@basx.dev>
parents: 469
diff changeset
65 - [ ] Audio (Alsa, Windows Waveform API?)
e52bfb0b98ce fix: organize notes a bit
Sam <sam@basx.dev>
parents: 469
diff changeset
66 - [ ] Game controller input handling
e52bfb0b98ce fix: organize notes a bit
Sam <sam@basx.dev>
parents: 469
diff changeset
67
e52bfb0b98ce fix: organize notes a bit
Sam <sam@basx.dev>
parents: 469
diff changeset
68 Advanced features:
e52bfb0b98ce fix: organize notes a bit
Sam <sam@basx.dev>
parents: 469
diff changeset
69 - [ ] Text rendering
e52bfb0b98ce fix: organize notes a bit
Sam <sam@basx.dev>
parents: 469
diff changeset
70 - [ ] Animation system
e52bfb0b98ce fix: organize notes a bit
Sam <sam@basx.dev>
parents: 469
diff changeset
71 - [ ] Sprite system
e52bfb0b98ce fix: organize notes a bit
Sam <sam@basx.dev>
parents: 469
diff changeset
72 - [ ] Particle system