Skip to content

About

Forge3D is an early C++20 3D engine.

Topics

Resources

Stars

1 star

Watchers

0 watching

Forks

Repository files navigation

Forge3D

Forge3D is an early C++20 3D engine with a scene editor and player for Windows, Linux and macOS.

Forge3D scene editor with cubes and a ground plane

What works

  • Editor: create and delete cubes; edit properties, parenting and dynamic box physics; undo/redo; import glTF; save/load scenes; preview physics with Play/Stop.

  • Rendering: OpenGL editor and player with directional shadows; an experimental SDL GPU player using Vulkan or Metal, with textured metallic/roughness shading. SDL GPU does not yet render shadows.

  • Assets and animation: static glTF triangle meshes, base-color textures and transform animation. Skins, morph targets, cubic interpolation and several PBR maps are not supported.

  • Gameplay: fixed-step updates, Jolt box physics, WAV playback in the OpenGL path, Sky Islands, and two reusable arcade examples: Circuit Sprint racing and Plaza Partners with selectable man/woman characters.

See release notes for the complete limitations. This is a developer preview; physical hardware certification and signed releases remain outstanding.

Build

Install Git, CMake 3.24+, a C++20 compiler and OpenGL 3.3 development libraries. CMake downloads pinned SDL3, Dear ImGui and Jolt sources. Windows requires Visual Studio with the C++ desktop workload; macOS requires Xcode Command Line Tools.

On Ubuntu:

sudo apt-get update
sudo apt-get install -y build-essential cmake git libx11-dev libxext-dev libxrandr-dev libxcursor-dev libxi-dev libxfixes-dev libxss-dev libxtst-dev libwayland-dev libxkbcommon-dev libegl1-mesa-dev libgl1-mesa-dev libasound2-dev libpulse-dev libudev-dev

From the repository root:

cmake -S . -B build -DCMAKE_BUILD_TYPE=Release
cmake --build build --config Release --parallel 3
ctest --test-dir build -C Release --output-on-failure

On Linux the executables are build/forge_editor and build/forge_player. Visual Studio uses build/Release/forge_editor.exe and build/Release/forge_player.exe. On macOS CMake produces app bundles; run their executable inside build/forge_editor.app/Contents/MacOS/forge_editor and the corresponding player bundle (multi-configuration generators may add a configuration directory).

Try the editor and samples

Run these Linux examples from the repository root; substitute the paths above for your platform:

build/forge_editor
build/forge_editor --scene samples/sky-islands.forge
build/forge_player --game samples/sky-islands.forge
build/forge_player --backend gpu --game samples/sky-islands.forge
build/forge_player --backend gpu --scene samples/textured.forge

In Sky Islands use A/D to move, Space to jump, and R to restart. Collect both crystals, then reach the green goal. The game state is reported in the window title.

In the editor, select an entity to edit it. Play starts physics; Stop restores the pre-play scene. Save/Load uses scene.forge in the working directory by default; --scene opens an existing file and sets the save path. Asset paths are saved relative to the scene when possible. Keep the referenced assets alongside it when moving a project.

Two playable game examples

Both include editable scenes, original importable glTF models, shared C++ controllers, win/restart logic and tests. Example guide, controls, screenshots and reuse instructions.

Circuit Sprint — three-lap arcade racer Plaza Partners — switch characters and collect stars
Circuit Sprint running in Forge3D Plaza Partners running in Forge3D
build/forge_player --example racing --scene samples/examples/circuit-sprint.forge
build/forge_player --example characters --scene samples/examples/plaza-partners.forge

Use W/S to accelerate/brake and A/D to steer in the racer. In the plaza use WASD, Space to jump and Tab to switch between man and woman. R restarts either game. Add --backend gpu for the experimental SDL GPU player; the default OpenGL player includes an in-game HUD. These are small arcade teaching examples with static stylized models.

Testing and distribution

For core tests without desktop dependencies:

cmake -S . -B build-core -DFORGE_BUILD_DESKTOP=OFF -DFORGE_SANITIZERS=ON -DCMAKE_BUILD_TYPE=Debug
cmake --build build-core
ctest --test-dir build-core --output-on-failure

The sanitizer option is supported with GCC/Clang. CI builds and tests all three platforms; Linux also runs software-rendered graphics smoke checks. Create a ZIP with cpack -C Release inside build. The archive includes documentation, screenshots, samples, libraries and dependency licenses. It is not a signed installer or a relocatable CMake SDK.

License

Forge3D is MIT licensed. Bundled dependencies have their own license notices.

About

Forge3D is an early C++20 3D engine.

Topics

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Contributors

Languages