Player rigs to support 2D, 3D and XR interaction

High-performance ECS engine

Full-featured world editor

Fully networked player controller, physics, vehicles and particles

Fully data-oriented design

Chat, groups, parties and friends

Voice and video over WebRTC

Instant login with phone number or email

OAuth login with Facebook, Google, Steam and Github

User management, avatars and inventory

Authorative realtime gameserver

Reliable messaging and signaling with socket.io

Fast, unreliable messaging with SCTP data channels

Built end-to-end in Typescript

Free, open source, MIT-licensed

Getting up and running requires only a few steps. Supported on OSX / Linux / WSL2 for Windows

First, make sure you have NodeJS and npm installed (and if you are using it, docker).

1. Install your dependencies

   cd path/to/xr3ngine
   yarn install
   

   Error with mediasoup? Optional: https://mediasoup.org/documentation/v3/mediasoup/installation/ If on WSL2: sudo apt-get update ; sudo apt-get install build-essential

2. Make sure you have a mysql database installed and running -- our recommendation is Mariadb. We've provided a docker container for easy setup:

   cd scripts && sudo bash start-db.sh
   

   This creates a Docker container of mariadb named xr3ngine_db. You must have docker installed on your machine for this script to work. If you do not have Docker installed and do not wish to install it, you'll have to manually create a MariaDB server.

   The default username is 'server', the default password is 'password', the default database name is 'xr3ngine', the default hostname is '127.0.0.1', and the default port is '3306'.

3. Open a new tab and start the Agones sidecar in local mode

   cd scripts
   sudo bash start-agones.sh
   

   You can also go to vendor/agones/ and run

   ./sdk-server.linux.amd64 --local

   If you are using a Windows machine, run

   sdk-server.windows.amd64.exe --local

   and for mac, run

   ./sdk-server.darwin.amd64 --local

4. Obtain .env.local file with configuration variable. Many parts of XR3ngine are configured using environment variables. For simplicity, it's recommended that you create a file called .env.local in the top level of xr3ngine, and have all of your ENV_VAR definitions here in the form <VAR_NAME>=<VALUE>. If you are actively working on this project, contact one of the developers for a copy of the file that has all of the development settings and keys in it.

5. Start the server in database seed mode

   Several tables in the database need to be seeded with default values. Run cd packages/server, then run yarn dev-reinit-db. After several seconds, there should be no more logging. Some of the final lines should read like this: Executing (default): SELECT 'id', 'name', 'sceneId', 'locationSettingsId', 'slugifiedName', 'maxUsersPerInstance', 'createdAt', 'updatedAt' FROM 'location' AS 'location' WHERE ('location'.'id' = '98cbcc30-fd2d-11ea-bc7c-cd4cac9a8d61') AND 'location'.'id' IN ('98cbcc30-fd2d-11ea-bc7c-cd4cac9a8d61'); Seeded

   At this point, the database has been seeded. You can shut down the server with CTRL+C.

6. Open two separate tabs and start the server (non-seeding) and the client In /packages/server, run sudo yarn dev. In the other tab, go to /packages/client and run sudo yarn dev.

7. In a browser, navigate to https://127.0.0.1:3000/location/home The database seeding process creates a test empty location called 'test'. It can be navigated to by going to 'https://127.0.0.1:3000/location/home'. See the sections below about invalid certificates if you are encountering errors connecting to the client, API, or gameserver.

If you are on Windows, you can use docker-compose to start the scripts/docker-compose.yml file, or install mariadb and copy the login/pass and database name from docker-compose or .env.local -- you will need to create the database with the matching name, but you do not need to populate it

./start-db.sh only needs to be run once. If the docker image has stopped, start it again with:

    docker container start xr3ngine_db

brew install mysql

mysql_secure_installation server password

mysql -uroot -ppassword mysql -userver -ppassword

create database xr3ngine; create user 'server'@'127.0.0.1' identified by 'password'; grant all on xr3ngine.* to 'server'@'127.0.0.1';

show databases;

mysql.server start mysql.server stop

As of this writing, the cert provided in the xr3ngine package for local use is not adequately signed. Browsers will throw up warnings about going to insecure pages. You should be able to tell the browser to ignore it, usually by clicking on some sort of 'advanced options' button or link and then something along the lines of 'go there anyway'.

Chrome sometimes does not show a clickable option on the warning. If so, just type badidea or thisisunsafe when on that page. You don't enter that into the address bar or into a text box, Chrome is just passively listening for those commands.

The gameserver functionality is hosted on an address other than 127.0.0.1 in the local environment. Accepting an invalid certificate for 127.0.0.1 will not apply to this address. Open the dev console for Chrome/Firefox by pressing Ctrl+Shift+i simultaneously, and go to the Console or Network tabs.

If you see errors about not being able to connect to something like https://192.168.0.81/socket.io/?location=<foobar>, right click on that URL and open it in a new tab. You should again get a warning page about an invalid certificate, and you again need to allow it.

Make sure you don't have another instance of mariadb running on port 3306

    lsof -i :3306

On Linux, you can also check if any processes are running on port 3306 with sudo netstat -utlp | grep 3306 The last column should look like <ID>/<something You can kill any running process with sudo kill <ID>

check which process is using port 3030 and kill

    killall -9 node

OR

    lsof -i :3030
	kill -3 <proccessIDfromPreviousCommand>

As of this writing, there's a bug with the default seeded test location.
Go to /editor/projects and open the 'Test' project. Save the project, and
the error should go away.

Try

yarn run dev-reinit-db // in server package

Simply run yarn test and all your tests in the test/ directory will be run.

yarn run lint

You can run it using docker, if you don't have node installed or need to test.

# Build the image
docker build --tag xr3ngine .

# Run the image (deletes itself when you close it)
docker run -d --rm --name server -e "MYSQL_URL=mysql://server:password@db:3306/xr3ngine" -p "3030:3030"  xr3ngine

# Stop the server
docker stop server

Enviroment variables:

• NODE_ENV controls the config/*.js file for feathers.js to load [default: production]
• PORT controls the listening port [default: 3030]
• MYSQL_URL e.g. mysql://<user>:<pass>@<host>:<port>/<db> points to MariaDB server with a username and password

First, you'll need minikube installed and running, as well as kubectl. Next, you'll want to point your shell to minikube's docker-env so that you don't need to push the Docker image to an external repository. Run the following:

eval $(minikube docker-env)

For now, this process will use a separate Dockerfile called 'Dockerfile-dev'. You'll have to build the image using it by running the following command:

docker build -t xr3ngine/xr3ngine:v0.0.0 -f Dockerfile-dev .

Once that image is built, make sure that kubectl is pointed to minikube. Run kubectl config get-contexts and there should be a '*' next to minikube; alternatively, run kubectl config current-context, and it should show minikube. If it's not, run kubectl config set-context minikube to change to it.

You'll need to deploy two Kustomize scripts to Minikube. The first one is the nginx-ingress setup. Run kubectl apply -k kubernetes/nginx/base.

You'll need to have a file called 'xr3ngine-dev-secrets.env' in kubernetes/xr3ngine/base. This is in the gitignore to demonstrate that these sorts of files should never be committed. The production one is expected to be called 'xr3ngine-secrets.env' and is also in the gitignore. As these are very sensitive files, they should be transmitted to you securely.

Finally run kubectl apply -k kubernetes/xr3ngine/base to deploy the MariaDB server and xr3ngine. The server is set up in dev mode to be behind the domain 'api.dev.xr3ngine.dev' and is secured by a self-signed certificate. If you wanted to call one of the endpoints with curl, you could run the following and get a 401 error: curl https://192.168.99.109/user -H HOST:api.dev.xr3ngine.dev --insecure

NOTE: As of this writing, the MariaDB server sometimes finishes initializing after xr3ngine has already tried to connect to it. To reboot xr3ngine, run the following:

kubectl rollout restart -n xr3ngine deployments/xr3ngine

https://mailtrap.io/inboxes

add credentials in packages/server/.env

SMTP_HOST=smtp.mailtrap.io
SMTP_PORT=2525
SMTP_USER=<mailtrap-user>
SMTP_PASS=<mailtrap-password>

Feathers.js has a powerful command line interface. Here are a few things it can do:

$ yarn install -g @feathersjs/cli          # Install Feathers CLI

$ feathers generate service               # Generate a new Service
$ feathers generate hook                  # Generate a new Hook
$ feathers help                           # Show all commands

For more information on all the things you can do with Feathers visit docs.feathersjs.com.

node_modules/.bin/sequelize migration:generate --name "migration_name"

Before run the server, you should migrate the db. To do this, please run as following. yarn run compile node_modules/.bin/sequelize db:migrate

For more information, please visit here https://github.com/douglas-treadwell/sequelize-cli-typescript