Mercurial > games > semicongine

annotate README.md @ 130:ff345f9e4eb7

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
did: update readme
author Sam <sam@basx.dev>
date Tue, 18 Apr 2023 03:06:14 +0700
parents 5cd1b42127ba
children c1a9a988b9e3
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
95
8011e4d6372d add: consistent way to define platform-specific code
Sam <sam@basx.dev>
parents: 73
diff changeset
22 Still tons to do. Making render pipeline and scenegraph somewhat compatible
8011e4d6372d add: consistent way to define platform-specific code
Sam <sam@basx.dev>
parents: 73
diff changeset
23 seems like it will require quite a bit more of work. Also, audio might require
8011e4d6372d add: consistent way to define platform-specific code
Sam <sam@basx.dev>
parents: 73
diff changeset
24 quite a bit of work, no experience there.
41
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
25
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
26 Rendering:
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
27
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
28 - [x] Vertex attributes, vertex data
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
29 - [x] Shaders (allow for predefined and custom shaders)
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
30 - [x] Uniforms
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
31 - [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
32 - [x] Fixed framerate
130
ff345f9e4eb7 did: update readme
Sam <sam@basx.dev>
parents: 119
diff changeset
33 - [x] Instanced drawing (currently can use instance attributes, but we only support a single instance per draw call)
41
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
34 - [ ] Textures
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
35 - [ ] Depth buffering
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
36 - [ ] Mipmaps
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
37 - [ ] Multisampling
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
38
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
39 Asset handling:
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
40 - [ ] 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
41 - [ ] 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
42 - [ ] Audio files (AU)
41
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
43
119
5cd1b42127ba did: update progress
Sam <sam@basx.dev>
parents: 117
diff changeset
44 Other (required for alpha release):
5cd1b42127ba did: update progress
Sam <sam@basx.dev>
parents: 117
diff changeset
45 - [x] Config files ala \*.ini files (use std/parsecfg)
41
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
46 - [x] Mouse/Keyboard input handling
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
47 - [x] X11
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
48 - [x] Win32
117
40ff2453855e did: small changes from refactoring
Sam <sam@basx.dev>
parents: 101
diff changeset
49 - [ ] Enable/disable hardware cursor
119
5cd1b42127ba did: update progress
Sam <sam@basx.dev>
parents: 117
diff changeset
50 - [ ] Fullscreen mode + switch between modes
41
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
51 - [ ] Input-mapping configuration
95
8011e4d6372d add: consistent way to define platform-specific code
Sam <sam@basx.dev>
parents: 73
diff changeset
52 - [ ] Audio playing (Alsa, Windows Waveform API?)
101
f0ceb8c17d2c add: really need telemetry at some point
Sam <sam@basx.dev>
parents: 95
diff changeset
53 - [ ] Telemetry
41
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
54
119
5cd1b42127ba did: update progress
Sam <sam@basx.dev>
parents: 117
diff changeset
55 Advanced features (very low priority):
101
f0ceb8c17d2c add: really need telemetry at some point
Sam <sam@basx.dev>
parents: 95
diff changeset
56 - [ ] Allow multipel Uniform blocks?
41
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
57 - [ ] Text rendering
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
58 - [ ] Animation system
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
59 - [ ] Sprite system
cc8724250d65 fix: organize notes a bit
Sam <sam@basx.dev>
parents: 8
diff changeset
60 - [ ] Particle system
60
c57285d292b6 did: deep refactoring of handling vertrex attribute and buffer updates, don't ask ;(
Sam <sam@basx.dev>
parents: 57
diff changeset
61 - [ ] Query and display rendering information from Vulkan
95
8011e4d6372d add: consistent way to define platform-specific code
Sam <sam@basx.dev>
parents: 73
diff changeset
62 - [ ] Game controller input handling
119
5cd1b42127ba did: update progress
Sam <sam@basx.dev>
parents: 117
diff changeset
63
5cd1b42127ba did: update progress
Sam <sam@basx.dev>
parents: 117
diff changeset
64 Quality improvments:
5cd1b42127ba did: update progress
Sam <sam@basx.dev>
parents: 117
diff changeset
65
5cd1b42127ba did: update progress
Sam <sam@basx.dev>
parents: 117
diff changeset
66 - [x] Better scenegraph API
5cd1b42127ba did: update progress
Sam <sam@basx.dev>
parents: 117
diff changeset
67 - [x] Better rendering pipeline API
5cd1b42127ba did: update progress
Sam <sam@basx.dev>
parents: 117
diff changeset
68
5cd1b42127ba did: update progress
Sam <sam@basx.dev>
parents: 117
diff changeset
69 Build-system:
5cd1b42127ba did: update progress
Sam <sam@basx.dev>
parents: 117
diff changeset
70 - [x] move all of Makefile to config.nims