A next-gen work-in-progress 2D and 3D graphical rendering engine written in Rust utilizing WGPU
  • Rust 91.2%
  • WGSL 5.9%
  • Jupyter Notebook 1.2%
  • JavaScript 1.1%
  • Nix 0.5%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
SakulFlee c175453508
All checks were successful
Lint / lint (push) Successful in 1m38s
PR / test (push) Successful in 17m40s
Merge pull request 'fix(iced): track the fork's master branch' (#1127) from sakulflee/fix/iced-dependency-master into main
Reviewed-on: #1127
2026-11-14 04:14:44 +01:00
.cargo Cargo updated config.toml 2026-08-28 23:44:33 +02:00
.config ci: run changed crate tests and publish PR test reports (#839) 2026-10-22 02:41:28 +02:00
.forgejo chore(ci): drop the remaining global asset references 2026-11-14 00:31:57 +01:00
.github ci(release): use the all-in-one example's own assets 2026-11-14 00:30:57 +01:00
.teamcity chore(ci): drop the remaining global asset references 2026-11-14 00:31:57 +01:00
Crates chore(ci): drop the obsolete Blender export flag 2026-11-14 00:30:51 +01:00
Examples fix(all-in-one): use the bundled scene in tests 2026-11-14 00:29:05 +01:00
Images Fix: separate cube_index counter for point light cube maps (was sharing layer_index with 2D array), fix max cubes limit 2026-07-20 15:09:54 +02:00
Tools/performance Merge remote-tracking branch 'origin/main' into fix/debug-ui-frame-time 2026-11-12 02:18:27 +01:00
.envrc Added .envrc 2026-06-20 03:17:54 +02:00
.gitignore chore: remove stale ignore rules 2026-11-14 00:30:57 +01:00
.opencodeignore added .opencodeignore as a test 2026-07-18 23:01:49 +02:00
AGENTS.md docs: describe example-owned assets 2026-11-14 00:31:57 +01:00
Cargo.lock fix(iced): track the fork's master branch 2026-11-14 04:10:01 +01:00
Cargo.toml fix(iced): track the fork's master branch 2026-11-14 04:10:01 +01:00
flake.lock fix(ci): pin Rust toolchain and align lint workflows 2026-10-24 02:30:29 +02:00
flake.nix chore(ci): drop the obsolete Blender export flag 2026-11-14 00:30:51 +01:00
LICENSE Fix: separate cube_index counter for point light cube maps (was sharing layer_index with 2D array), fix max cubes limit 2026-07-20 15:09:54 +02:00
NOTE-for-WASM.md Add systems layer with snapshot-merge parallelism 2026-06-22 00:32:11 +02:00
Orbital.toml docs: add signing configuration to Orbital.toml 2026-09-22 03:49:28 +02:00
PERFORMANCE_REPORTING.md feat(debug-ui): report stale GPU timestamp samples 2026-11-13 02:59:47 +01:00
README.md docs: expand performance notebook and remove standalone script 2026-11-04 21:02:09 +01:00
renovate.json chore(deps): replace orbital-iced submodule with git dependency 2026-10-23 01:17:37 +02:00
rust-toolchain.toml fix(ci): install clippy and rustfmt with the pinned toolchain 2026-10-24 19:58:46 +02:00
shell.nix Added shell and flake.nix 2026-06-20 03:03:03 +02:00

Orbital Engine Logo

🛰️ Orbital Engine & Framework

Orbital is a cross-platform real-time graphical rendering engine & framework written in Rust. The goal of this project is to bridge well established industry-standard techniques with upcoming (next-gen) and experimental techniques to form a robust new foundation for next-gen visual computing.

Showcase

glTF demo: Damaged Helmet
A
PBR Grid: Spheres PBR Grid: Cubes
A A

Core Features

Feature Description
PBR Rendering Physically Based Rendering with realistic material properties and lighting
Image-Based Lighting Advanced lighting using HDR environment maps for realistic reflections
GLTF 2.0 Support Full import capabilities for complex 3D scenes, materials, and animations
Cross-Platform Unified rendering across desktop platforms via WGPU abstraction
Modular Architecture Flexible element system with message-based communication
Modern Shaders WGSL-based shaders for cross-platform compatibility

Experiments

Experimental Concept Description
HJAA (Halton-Jitter Anti-Aliasing) Advanced spatial smoothing utilizing the Halton Sequence
IVXGI (Incremental Voxel-based Global Illumination) A evolution of Nvidia's VXGI for high performance dynamic lighting.

Important

Documentation for experimental features will be released once they have been fully validated in practical, non-theoretical environments.

Platform Compatibility

  • ✅ Windows: Full support
  • ✅ Linux: Full support
  • ✅ macOS: Full support
  • ⚠️ Web: Theoretically possible but not currently supported
  • ⚠️ Android: Works but requires frequent updates to keep compatible
  • ⚠️ iOS: Compiles but untested — boilerplate provided, community testing welcome

Getting Started

The official project templates live in the Examples/ directory. They are workspace members and mirror the templates used by orbital init:

  • minimal: A small procedural scene with a camera and a spotlight
  • all-in-one: Procedural scene, glTF import, lighting, shadows, UI, and overlays
  • 2d: A minimal 2D shape rendering example

The examples are self-contained and can be run from their own directories:

(cd Examples/minimal && cargo run)
(cd Examples/all-in-one && cargo run)
(cd Examples/2d && cargo run)

They can also be run from the repository root:

cargo run -p template_minimal
cargo run -p template_all_in_one
cargo run -p template_2d

minimal and 2d need no asset files. all-in-one ships the scene and helmet model it uses in Examples/all-in-one/Assets/.

To create a standalone project from one of these templates, use the Orbital CLI:

orbital init my-game --template all-in-one

To use the engine in your own project, add the following to your Cargo.toml:

orbital = { path = "./Runtime" }

Performance Reporting

The debug UI can write FPS, frame-stage timings and cache counters to Logs/performance.csv. See PERFORMANCE_REPORTING.md for enabling capture and retrieving the file on desktop, Android and iOS, plus the bundled analysis notebook.

Engine Concepts

Elements

The primary way to add interactive objects to your world is through Elements. Elements are the core game objects that exist in the world and handle their own behavior. Each element can register itself with the world to define what resources it needs (models, cameras, etc.), and can respond to various events during the application lifecycle such as updates and messages from other elements.

Messaging System

Elements communicate with each other and the world through a message-passing system rather than shared memory. This ensures loose coupling between elements and enables flexible, modular game design. Rather than sharing memory or directly accessing other elements, elements send messages to communicate. This approach is easily scalable - tags can be used multiple times, so messages will be automatically sent to all elements with a matching tag.

World Architecture

The world manages resource stores (models, cameras, environments, lights), handles the asset import system, and creates the global bind group used by shaders. Resources follow a specific lifecycle involving creation, realization, caching, and cleanup.

History

The Orbital engine has a rich history spanning multiple iterations and rewrites. The project originally started as "Akimo" and was written in Java as a pure CPU renderer for 2D graphics. Over the years, it evolved through multiple iterations:

  • Akimo (Java): Started as a CPU-based 2D renderer, then upgraded to use LWJGL for OpenGL and Vulkan support
  • Akimo (C++): A complete rewrite in C++ with Vulkan bindings, still under the "Akimo" name
  • Orbital (Rust/Vulkan): A rewrite in Rust but still using Vulkan bindings
  • Orbital (Rust/WGPU/WGSL): The current iteration using Rust with WGPU and WGSL, moving away from GLSL to a more modern shader language

Each version learned from the previous ones, with the current implementation built in Rust leveraging the WGPU graphics API abstraction layer for cross-platform support.

Contributing

Forgejo is the canonical repository; GitHub is a mirror. Please open pull requests on Forgejo. If you can only use GitHub, treat a GitHub pull request as a proposal that will be ported to Forgejo before merge.

AI tools are welcome, but the contributor owns the result:

  • Inspect and understand every line you submit.
  • Verify that it builds and that relevant tests, lints, and examples pass.
  • Do not add AI/model attribution to code, commits, documentation, or pull-request metadata. AI tools are not authors, co-authors, owners, or contributors.
  • The person opening the pull request is responsible for correctness, licensing, security, and follow-up maintenance.

See AGENTS.md for the full contribution contract, architecture map, tooling, and pre-PR checklist.

License

This project is dual licensed in Rust's fashion:

For your own project you can chose whichever fits you better. For templates/examples we recommend to also dual-licensing.

We highly encourage everyone to share their sub-crates with the community so that others can benefit from it too!