lorenzo/sideros
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Create design.md

Browse source
This commit is contained in:
Lorenzo Torres 2025-03-12 11:25:44 +01:00 • committed by GitHub
parent 3436954704
commit 8c87cc3e36
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 20 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

20
documentation/design.md Normal file
View file

@ -0,0 +1,20 @@
# Design
This document contains all the design decisions and features that are and will be implemented in the game.
# Engine
## Rendering
The game engine uses Vulkan as the default graphics API but also implements an OpenGL backend for compatibility with older devices (some of them, while having Vulkan support, have better performance with OpenGL).
An abstraction over the graphics API allows clean utilization of the renderer in the engine, but also exposes a simple interface for mods.
glTF models are used for assets, but once loaded as the game starts, they are going to be converted to an internal intermediate representation format to increase loading performance.
A Metal backend might be implemented in the future for better MacOS integration.
## Logic
An entity component system (ECS) internal API allows better usage of CPU cache lines while also providing a simple interface for the engine internals and mods.
## OS interactions
The OS APIs are abstracted in a platform agnostic interface, used to make usual OS operations like opening files, creating network sockets, creating windows (X11, Wayland, Win32, Cocoa) and so on.
## Mods
Modding is implemented using a custom Wasm (WebAssembly) virtual machine. The VM makes a sandbox for each mod so that they can't directly interact with each other nor accessing main memory or filesystem.
This safety features allow to download mods bytecode when joining a multiplayer game on the fly without worrying and without needing to install them locally before joining.
While not every language will be supported officaly, community projects can easily implement bindings for the engine modding API and then compile to a Wasm target.