Mercurial > games > semicongine
annotate README.md @ 640:232290881c87
add: stupid note
| author | Sam <sam@basx.dev> |
|---|---|
| date | Tue, 02 May 2023 16:29:20 +0700 |
| parents | 42ad7e6208e9 |
| children | 315c809c8e60 |
| rev | line source |
|---|---|
| 502 | 1 Semicongine |
| 2 =========== | |
| 3 | |
| 469 | 4 Hi there |
| 5 | |
| 502 | 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 | 8 |
| 509 | 9 Building |
| 10 -------- | |
| 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 | 18 |
| 502 | 19 Roadmap |
| 20 ------- | |
| 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 |
| 640 | 24 quite a bit of work, no experience there (note: audio was super easy to implement) |
| 502 | 25 |
| 26 Rendering: | |
| 27 | |
| 28 - [x] Vertex attributes, vertex data | |
| 29 - [x] Shaders (allow for predefined and custom shaders) | |
| 30 - [x] Uniforms | |
| 31 - [x] Per-instance vertex attributes (required to be able to draw scene graph) | |
| 580 | 32 - [x] Fixed framerate |
| 591 | 33 - [x] Instanced drawing (currently can use instance attributes, but we only support a single instance per draw call) |
| 502 | 34 - [ ] Textures |
| 35 - [ ] Depth buffering | |
| 36 - [ ] Mipmaps | |
| 37 - [ ] Multisampling | |
| 38 | |
| 39 Asset handling: | |
| 631 | 40 - [ ] Resource concept: load from directory, zip or in-memory-zip, select "mod" as root |
| 502 | 41 - [ ] Mesh files (Wavefront OBJ, MTL) (use something from sketchfab for testing, https://sketchfab.com/) |
| 42 - [ ] 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
|
43 - [ ] Audio files (AU) |
| 502 | 44 |
| 580 | 45 Other (required for alpha release): |
| 46 - [x] Config files ala \*.ini files (use std/parsecfg) | |
| 502 | 47 - [x] Mouse/Keyboard input handling |
| 48 - [x] X11 | |
| 49 - [x] Win32 | |
| 631 | 50 - [x] Enable/disable hardware cursor |
| 580 | 51 - [ ] Fullscreen mode + switch between modes |
| 631 | 52 - [x] Linux (works well enough, I hope) |
| 53 - [ ] Window | |
| 502 | 54 - [ ] Input-mapping configuration |
| 631 | 55 - [ ] Audio playing |
|
632
42ad7e6208e9
add: audio subsystem, windows backend still missing
Sam <sam@basx.dev>
parents:
631
diff
changeset
|
56 - [x] Linux (Alsa) |
| 631 | 57 - [ ] Windows Waveform API? |
|
562
bfb75f2cd493
add: really need telemetry at some point
Sam <sam@basx.dev>
parents:
556
diff
changeset
|
58 - [ ] Telemetry |
| 631 | 59 - [ ] Documentation? |
| 502 | 60 |
| 580 | 61 Advanced features (very low priority): |
|
562
bfb75f2cd493
add: really need telemetry at some point
Sam <sam@basx.dev>
parents:
556
diff
changeset
|
62 - [ ] Allow multipel Uniform blocks? |
| 502 | 63 - [ ] Text rendering |
| 64 - [ ] Animation system | |
| 65 - [ ] Sprite system | |
| 66 - [ ] 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
|
67 - [ ] 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
|
68 - [ ] Game controller input handling |
| 580 | 69 |
| 70 Quality improvments: | |
| 71 | |
| 72 - [x] Better scenegraph API | |
| 73 - [x] Better rendering pipeline API | |
| 74 | |
| 75 Build-system: | |
| 76 - [x] move all of Makefile to config.nims |