Skip to content

Latest commit

 

History

History
45 lines (39 loc) · 2.55 KB

00-start-here.md

File metadata and controls

45 lines (39 loc) · 2.55 KB

Why are we building XREngine?

We chose to build a free, open, full-stack MMO engine that anyone could run for any reason - to host events, make games, show art, or just to give a space for your community. There are plenty of platforms you can spend a bit of money on to have a world, but you can't be in complete control of the experience or customise it from the ground up.

When the XREngine stack is deployed, that stack is sovereign, open and cross platform by default. Users can make any kind of game or experience with no limits. And with the tech we're building now, users will be able to seamlessly travel through portals from my worlds to yours, on different servers, and have all their inventory and identity travel with them.

This technology is for everyone, but especially people who want to build or belong to a community.

Table of Contents

Getting started with installing the stack and running the engine

A high level overview of the architecture and the packages that form the XREngine stack

How to use the engine to manage custom code, assets and scenes

Create scenes and launch them with locations

The ECS is what enables the engine to run as fast as it does and will soon support hundreds of cuncurrent users

Fully typed and clear state management using the FLUX pattern

MYSQL and full stack service api

Highly scalable game infrastructure using docker

Run a cluster on your machine

Get your worlds out into the web!

Our API reference is auto-generated from the tsdoc comments in the codebase