xr3ngine | end solution for hosting humans | Augmented Reality library

Getting up and running requires only a few steps.
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 npm install -g node-gypPYTHON=python3 yarn install npm config set python /usr/bin/python PYTHON=python3 yarn install
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'. Seeing errors connecting to the local DB? Shut off your local firewall.
Have redis installed and running redis must be running in order for feathers-sync to function; it coordinates feathers actions across servers, e.g. the API server can be notified that the gameserver patched a user. scrips/docker-compose is configured to start a redis container using Docker. Run docker-compose up from the /scripts directory to build + start it, and after that you can run docker start xr3ngine_redis to restart the redis container.
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
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.
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.
Open two/three separate tabs and start the API server (non-seeding), gameserver (if using gameservers), and the client In /packages/server, run sudo yarn dev. If you are using gameservers, in another tab go to /packages/gameserver and run sudo yarn dev. In the final tab, go to /packages/client and run sudo yarn dev.
Open a new tab and start local file server (optional) If the .env.local file you have has the line STORAGE_PROVIDER=local then the scene editor will save components, models, scenes, etc. locally (as opposed to storing them on S3). You will need to start a local server to serve these files, and make sure that .env.local has the line LOCAL_STORAGE_PROVIDER="localhost:8642". In a new tab, go to packages/server and run yarn serve-local-files. This will start up http-server to serve files from packages/server/upload on localhost:8642. You may have to accept the invalid self-signed certificate for it in the browser; see 'Allow local file http-server connection with invalid certificate' below.
In a browser, navigate to https://127.0.0.1:3000/location/test 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/test'. See the sections below about invalid certificates if you are encountering errors connecting to the client, API, or gameserver.