1.9 KiB
Faset Engine Manual
Faset is a C++ engine for desktop 2D and 3D games on Linux and Windows. This manual focuses on writing gameplay: small working examples, the functions they use, and how those functions interact with scenes, physics, and the editor.
!!! warning "Development status" MVP implementation is in progress. A planned feature is not a working feature. Individual guides state their prerequisites and validation status. The current Editor, gameplay tutorials, two playable sample games and Linux export can be built and tested. Final Windows graphics/export acceptance is still in progress.
Start with how C++ gameplay works, then read frame and physics updates. See Build from source for the toolchain and build commands.
The engine, editor, built-in diagnostics, and API identifiers use English. Your game content and project text can use other languages.
Learning path
The manual grows alongside tested engine capabilities, in this order:
- Build and run an example game.
- Create a C++ behavior and expose a property in the Inspector.
- Handle input and move a character.
- Use physics, collision events, and deferred object creation.
- Work with scene templates, assets, and references.
- Import from Blender and export a standalone game.
Lua is planned after the C++ foundation. It is not a current scripting option.
Preview this manual
From the repository root, create a Python virtual environment and install the pinned documentation tools:
python3 -m venv .cache/docs-venv
.cache/docs-venv/bin/python -m pip install -r docs/requirements.txt
.cache/docs-venv/bin/python -m mkdocs serve
On Windows, use py -m venv .cache/docs-venv and
.cache/docs-venv/Scripts/python.exe in place of the Unix interpreter path.
The manual also remains readable directly as Markdown in the repository.