Mercurial > games > semicongine

annotate README.md @ 565:a0b01e84607d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
did: some refactoring
author Sam <sam@basx.dev>
date Mon, 20 Mar 2023 23:48:46 +0700
parents bfb75f2cd493
children 40ff2453855e
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
556
21f15523fda0 add: consistent way to define platform-specific code
Sam <sam@basx.dev>
parents: 534
diff changeset
22 Still tons to do. Making render pipeline and scenegraph somewhat compatible
21f15523fda0 add: consistent way to define platform-specific code
Sam <sam@basx.dev>
parents: 534
diff changeset
23 seems like it will require quite a bit more of work. Also, audio might require
21f15523fda0 add: consistent way to define platform-specific code
Sam <sam@basx.dev>
parents: 534
diff changeset
24 quite a bit of work, no experience there.
502
e52bfb0b98ce fix: organize notes a bit
Sam <sam@basx.dev>
parents: 469
diff changeset
25
e52bfb0b98ce fix: organize notes a bit
Sam <sam@basx.dev>
parents: 469
diff changeset
26 Rendering:
e52bfb0b98ce fix: organize notes a bit
Sam <sam@basx.dev>
parents: 469
diff changeset
27
e52bfb0b98ce fix: organize notes a bit
Sam <sam@basx.dev>
parents: 469
diff changeset
28 - [x] Vertex attributes, vertex data
e52bfb0b98ce fix: organize notes a bit
Sam <sam@basx.dev>
parents: 469
diff changeset
29 - [x] Shaders (allow for predefined and custom shaders)
e52bfb0b98ce fix: organize notes a bit
Sam <sam@basx.dev>
parents: 469
diff changeset
30 - [x] Uniforms
e52bfb0b98ce fix: organize notes a bit
Sam <sam@basx.dev>
parents: 469
diff changeset
31 - [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
32 - [ ] Textures
e52bfb0b98ce fix: organize notes a bit
Sam <sam@basx.dev>
parents: 469
diff changeset
33 - [ ] Depth buffering
e52bfb0b98ce fix: organize notes a bit
Sam <sam@basx.dev>
parents: 469
diff changeset
34 - [ ] Mipmaps
e52bfb0b98ce fix: organize notes a bit
Sam <sam@basx.dev>
parents: 469
diff changeset
35 - [ ] Multisampling
556
21f15523fda0 add: consistent way to define platform-specific code
Sam <sam@basx.dev>
parents: 534
diff changeset
36 - [~] Instanced drawing (currently can use instance attributes, but we only support a single instance per draw call)
518
5d406c17bbcb did: refactor Vector names
Sam <sam@basx.dev>
parents: 509
diff changeset
37 - [ ] Fullscreen mode + switch between modes
534
e1b60a09d7dc did: update readme
Sam <sam@basx.dev>
parents: 531
diff changeset
38 - [x] Fixed framerate
502
e52bfb0b98ce fix: organize notes a bit
Sam <sam@basx.dev>
parents: 469
diff changeset
39
e52bfb0b98ce fix: organize notes a bit
Sam <sam@basx.dev>
parents: 469
diff changeset
40 Build-system:
e52bfb0b98ce fix: organize notes a bit
Sam <sam@basx.dev>
parents: 469
diff changeset
41 - [x] move all of Makefile to config.nims
e52bfb0b98ce fix: organize notes a bit
Sam <sam@basx.dev>
parents: 469
diff changeset
42
e52bfb0b98ce fix: organize notes a bit
Sam <sam@basx.dev>
parents: 469
diff changeset
43 Asset handling:
e52bfb0b98ce fix: organize notes a bit
Sam <sam@basx.dev>
parents: 469
diff changeset
44 - [ ] 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
45 - [ ] 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
46 - [ ] Audio files (AU)
502
e52bfb0b98ce fix: organize notes a bit
Sam <sam@basx.dev>
parents: 469
diff changeset
47
e52bfb0b98ce fix: organize notes a bit
Sam <sam@basx.dev>
parents: 469
diff changeset
48 Quality improvments:
e52bfb0b98ce fix: organize notes a bit
Sam <sam@basx.dev>
parents: 469
diff changeset
49
531
140222601389 did: update readme (this single X was a ton of work)
Sam <sam@basx.dev>
parents: 521
diff changeset
50 - [x] Better scenegraph API
502
e52bfb0b98ce fix: organize notes a bit
Sam <sam@basx.dev>
parents: 469
diff changeset
51 - [ ] Better rendering pipeline API
e52bfb0b98ce fix: organize notes a bit
Sam <sam@basx.dev>
parents: 469
diff changeset
52
e52bfb0b98ce fix: organize notes a bit
Sam <sam@basx.dev>
parents: 469
diff changeset
53 Other:
e52bfb0b98ce fix: organize notes a bit
Sam <sam@basx.dev>
parents: 469
diff changeset
54 - [x] Mouse/Keyboard input handling
e52bfb0b98ce fix: organize notes a bit
Sam <sam@basx.dev>
parents: 469
diff changeset
55 - [x] X11
e52bfb0b98ce fix: organize notes a bit
Sam <sam@basx.dev>
parents: 469
diff changeset
56 - [x] Win32
e52bfb0b98ce fix: organize notes a bit
Sam <sam@basx.dev>
parents: 469
diff changeset
57 - [ ] Config files ala \*.ini files (use std/parsecfg)
e52bfb0b98ce fix: organize notes a bit
Sam <sam@basx.dev>
parents: 469
diff changeset
58 - [ ] Input-mapping configuration
556
21f15523fda0 add: consistent way to define platform-specific code
Sam <sam@basx.dev>
parents: 534
diff changeset
59 - [ ] Audio playing (Alsa, Windows Waveform API?)
562
bfb75f2cd493 add: really need telemetry at some point
Sam <sam@basx.dev>
parents: 556
diff changeset
60 - [ ] Telemetry
502
e52bfb0b98ce fix: organize notes a bit
Sam <sam@basx.dev>
parents: 469
diff changeset
61
e52bfb0b98ce fix: organize notes a bit
Sam <sam@basx.dev>
parents: 469
diff changeset
62 Advanced features:
562
bfb75f2cd493 add: really need telemetry at some point
Sam <sam@basx.dev>
parents: 556
diff changeset
63 - [ ] Allow multipel Uniform blocks?
502
e52bfb0b98ce fix: organize notes a bit
Sam <sam@basx.dev>
parents: 469
diff changeset
64 - [ ] Text rendering
e52bfb0b98ce fix: organize notes a bit
Sam <sam@basx.dev>
parents: 469
diff changeset
65 - [ ] Animation system
e52bfb0b98ce fix: organize notes a bit
Sam <sam@basx.dev>
parents: 469
diff changeset
66 - [ ] Sprite system
e52bfb0b98ce fix: organize notes a bit
Sam <sam@basx.dev>
parents: 469
diff changeset
67 - [ ] Particle system
521
a25325bec7f2 did: deep refactoring of handling vertrex attribute and buffer updates, don't ask ;(
Sam <sam@basx.dev>
parents: 518
diff changeset
68 - [ ] Query and display rendering information from Vulkan
556
21f15523fda0 add: consistent way to define platform-specific code
Sam <sam@basx.dev>
parents: 534
diff changeset
69 - [ ] Game controller input handling