Getting Started
Get OpenReality running on your machine and render your first scene.
# Prerequisites
- •Julia 1.10+ — Install via julialang.org or
juliaup - •OpenGL 3.3+ — Available on most modern GPUs. Metal and Vulkan backends available for macOS and Linux/Windows respectively.
- •Git — For cloning the repository.
# Installation
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 default OpenGL 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 656 tests should pass.