Use this Manual to learn how to use the iR Engine to develop real-time 3D web experiences. It covers installation instructions and guides you through the engine and its features.

This site serves as a reference for understanding complex concepts and configurations for your projects. Learn about the engine's components and advanced settings to enhance your experience.

Introduction

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

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

developer-docs

Developer Docs

Projects

Locations

Concepts

Studio

Scene Management

Scene composition

Engine module

Spatial module

World module

API documentation

Infrastructure module

Modules

Source code

Documentation

Get involved

Community

Frequently asked questions

License

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