RUSTICDOCSSearch documentation

Engine repository

Open the engine repository on GitHub.

Rustic Game Engine is a native 2D/3D game engine and editor under active development. Its Rust workspace lives in Engine/; the repository root is not a Cargo workspace. It includes a project manager, authoring editor, runtime, asset worker, scene model, rendering, and gameplay scripting. It is the starting point for modifying the engine itself or building your own engine version.

Topics

Contributor guide chapters

Follow these chapters in order, or jump to the system you want to change.

ChapterWhat it covers
IntroductionWhat Rustic Engine is, implemented features, and core technologies.
Getting StartedClone, prepare, build, and run the engine from source.
ArchitectureEditor, runtime, rendering, physics, scripting, and asset ownership.
Project StructureNavigate the Rust workspace, applications, crates, and game project files.
Rendering SystemGraphics backends, automatic selection, diagnostics, and performance.
Scripting ArchitectureLanguage adapters, execution, script components, lifecycle, and reload.
Scene SystemScene loading, stable objects, components, versioned storage, and recovery.
Editor DevelopmentDevelop panels, project manager flows, workspaces, and debugging tools.
Building & PackagingBuild profiles, operating-system requirements, and Windows packaging.
Extending the EngineAdd functionality, modules, importers, scripting APIs, and custom tooling.
TroubleshootingDiagnose build failures, graphics initialization, and runtime problems.
ContributingEngine pull requests, coding standards, validation, and bug reports.