Getting Started
Get OpenReality running on your machine and render your first scene.
# Prerequisites
- •Julia 1.10+ — Install via julialang.org or
juliaup - •Vulkan SDK on Linux/Windows (default backend) — or pass
backend=OpenGLBackend()to fall back to the OpenGL 3.3 path. macOS uses the Metal backend automatically. - •Git — For cloning the repository.
# Installation
Install with a single command:
terminal
Build from source
terminal
# Your First Scene
Create a new file hello.jl in the project root with the following content:
hello.jl
This creates a scene with a camera, a directional light, and a green cube. The render(s) call opens a window and starts the render loop using the platform's default backend — Vulkan on Linux/Windows, Metal on macOS — via default_backend().
# Running
terminal
A window should appear rendering your scene. Close it to exit. Use WASD to move if a PlayerComponent is present.
# Running Tests
terminal
The test suite covers ECS, scene graph, physics, rendering abstractions, audio, UI, skeletal animation, particles, and scene export. All 938 tests should pass.