Getting up and running requires just a few steps. Find the instructions for your specific environment here.

Installation on Linux

Installing on macOS

Installing on Windows with WSL2

Running on static IP under WSL2

Troubleshooting

Logging with Opensearch on Docker

Setup Elastic Search & Kibana

Advanced setup

Installation

Projects

Locations

Concepts

Studio

Scene Management

Scene composition

Entities, components and systems

Networking

Event sourcing

Debugging

Engine module

Turning entities into spatialized objects

Spatial input & WebXR

Objects

Rendering scenes

Spatial module

Asset import pipeline

World module

API architecture

Documenting endpoints

API documentation

iR Engine deployment

Infrastructure module

Modules

Code formatting

Source code

Submit workflow

Markdown standards

Website structure

Writing style

Documentation

Get involved

Community

Frequently asked questions

License

Technical manual

Defines logic and modifies entities with specific components.

System

Stores data (no behavior). Multiple components define an entity.

Component

A unique identifier that groups components together.

Entity

developer-docs

Developer Docs

Introduction

Quickstart guide

Initial setup

Project overview

The ECS pattern

Start working with the engine

Define a system

Create a scene component

Define a Query

Recap and next steps

Hello World tutorial

Coding style and best practices

Defining components

Add physics to an entity

State Management

Managing Locations

Engine basics tutorial

Testing

Mastery Toolkit

Get Involved

TypeScript guides