Skip to content

iR Engine - Bringing us together on the open social spatial web. πŸ€– πŸš€ πŸ‘“ πŸ•ΉοΈ πŸ§‘πŸΏβ€πŸš€

License

Notifications You must be signed in to change notification settings

ir-engine/ir-engine

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

IR-engine-black-square

Manifest your dreams on the open social spatial web.

Background

Universal.Volumetric.Video.Web.Player.mp4

We (Infinite Reality Engine) believe that the Metaverse, Web AR, VR, and XR should be easy.

We want a Star Trek future where participating in immersive communication technology and shared simulations should be as easy and natural as making a website.

  • Includes a self-deployable platform, UI, worlds, avatars, and games
  • Fully customizable for any kind of game, social experience, event or spatial web site
  • Social features like avatars, chat, groups, friends, blocking and moderation
  • Complete world editing and administration
  • 2D, 3D and XR Avatars with full inverse kinematics and facial expressions
  • Fully networked physics using Rapier Physics
  • Voice and video over WebRTC server & peer-to-peer
  • Instant login and location sharing with phone number or email
  • Modular- Use the engine, server, client, editor and scalable devops infrastructure as needed
  • OAuth login with Meta, Apple, X, Google, Github or instant login with email or phone
  • WebGL client deployable to iOS, Android and desktop
  • Free, open source, CPAL licensed

Project API

Create composable plug-ins for iR Engine experiences with the plugin system (Projects API)

Launch iR Engine with Control Center Install

Best for simple self hosting.

Advanced Development Install

Pre-Requisites

To install iR Engine locally, the following pre-reqs are required.

  • Linux (many of us develop on Ubuntu), Mac OS X, or Windows (we recommend WSL2)
  • Node.js v18 or later (we recommend installing via nvm or asdf.)
  • C++ (for node-gyp), Python >=3.6 + PIP, make and other build tools, for compiling Mediasoup. Although most of iR Engine is written in TypeScript, it uses a Mediasoup engine for WebRTC conferencing. See the Mediasoup install instructions for more details.
  • Docker. (Although Docker is technically optional, running iR Engine requires starting up half a dozen different services, and using Docker Compose will make your life dramatically easier.)
  • MariaDB and Redis. (If you're using Docker, containers for MariaDB and Redis will automatically be started up.)

Getting Started

See the Installation instructions for more details.

Usage

Documentation

[WIP Aug 30, 2024]

Contributing

Let's build it together

We believe that projects like this are extremely complex and difficult, and can only be built when large groups of people work together, out in the open. If you believe that your calling is to build a free, open network that everyone, everywhere can get value from, then you are welcome in our community, and we'll do our best to get you set up.

We are always hiring talented people who want to be leaders in what is to come. Inquire with anyone who seems like they know what's going on and they'll help you find who you need to talk to.

msf-member-badge-small

License

CPAL - Copyright (c) 2021-2024 Infinite Reality. iR Engine, formerly known as Ethereal Engine and XREngine

If you wish to use iR Engine under the open-source CPAL license, attribution is required. Please see attribution guidelines in the LICENSE file. Other licensing options are available, please contact us for more information.

Release History and Author Archive