Skip to content
This repository has been archived by the owner on Aug 19, 2024. It is now read-only.

Latest commit

 

History

History
177 lines (114 loc) · 7.54 KB

README.md

File metadata and controls

177 lines (114 loc) · 7.54 KB
Raw

Ethereal Engine is now Infinite Reality Engine and has been moved!

You can find the project now at https://github.com/ir-engine/ir-engine-launcher

Infinite Reality Engine Launcher

Want to build the spatial web on your website? Looking for a place to start? Run a web metaverse on your own computer.

The Infinite Reality Engine Launcher is a self-contained Metaverse world in a box. Take what you need or launch the full stack. iR Engine Launcher is a desktop app to manage a metaverse cluster.

We know it's been complicated to build with #EtherealEngine and we've made this tool to give the community easy access to the engine for development and creation. The full Kubernetes cluster can run on Windows and any Debian Linux distro with at least 16 GB of ram.

We would love to see your creations and invite you all to come build with us. We've got a long backlog and need your help to build the Open Metaverse. Come build with us!

DOWNLOAD HERE

XREngine-Control-Center.mp4

DOWNLOAD HERE

Getting Started

You can find complete getting started guide here.

Additionally, there are iR Engine Launcher video tutorials which you can find here. Although some of them might be outdated.

Install Released

Download latest version of the iR Engine Launcher app from here.

  1. (Windows) Directly download the .exe file.
  2. (Linux) For AppImage: Once downloaded, right click and go to Properties. In Permissions tab check 'Allow executing file as program'. Then, double click on AppImage to launch the app.

Note: Currently the app is tested on Windows 11 and Ubuntu 20.04 & 22.04.

Troubleshooting

1. App not launching in Ubuntu 22.04

Install Fuse:

sudo apt-get install fuse libfuse2 -y

2. Windows permission to run ps1 scripts

On Windows, if you get following error in logs:

.ps1 cannot be loaded because running scripts is disabled on this system. For more information, see about_Execution_Policies at https:/go.microsoft.com/fwlink/?LinkID=135170.

You need to allow running unsigned powershell scripts on your machine. You follow below steps to do so:

  1. Open Powershell as administrator.
  2. Run following command to find out your current execution policy.
Get-ExecutionPolicy
  1. Run following command to set the execution policy to allow unsigned scripts.
Set-ExecutionPolicy -ExecutionPolicy Unrestricted

You can read more on powershell execution policy.

3. Snap & MicroK8s k8s commands showing 'incorrect number of tail fields' error in Windows WSL

On Windows, if you get error in logs like below:

system_key.go:129: cannot determine nfs usage in generateSystemKey: cannot parse mountinfo: incorrect number of tail fields, expected 3 but found 4
cmd_run.go:1046: WARNING: cannot create user data directory: cannot determine SELinux status: failed to obtain SELinux mount path: incorrect number of tail fields, expected 3 but found 4

This is due to Docker Desktop default installation location issue. You can read more on Microk8s Issue #3911 & Docker Issue #13318.

This issue is mainly due to Docker Desktop being installed in default location. Here are the steps you can follow to fix this:

  1. Uninstall existing installation of Docker Desktop in Windows.
  2. Download latest version of Docker Desktop for Windows.
  3. Open Command Prompt (cmd).
  4. Change current working directory to downloaded Docker Desktop folder. i.e.
cd "C:\Users\%USERNAME%\Downloads"
  1. Run following command to install Docker Desktop in a folder other than default one.
"Docker Desktop Installer.exe" install --accept-license --installation-dir=C:\Docker

4. Git status unavailable on Windows

On Windows, if you are unable to see Git status after cluster configuration and getting following error in logs:

git configs - "fatal: detected dubious ownership in repository at <path to engine directory>\nTo add an exception for this directory, call:\n\n\tgit config --global --add safe.directory <path to engine directory>\n"

This is due to the app not having permissions to read the Git config file. To fix this, run the iR Engine Launcher as administrator.

5. Reporting an Issue

If you face an issue please report it to Issues or reach out to us on Discord. Also please share following log files:

  1. Non-UI logs found at following path:

    • on Linux: ~/.config/etherealengine-control-center/logs/main.log
    • on macOS: ~/Library/Logs/etherealengine-control-center/main.log
    • on Windows: %USERPROFILE%\AppData\Roaming\etherealengine-control-center\logs\main.log

  2. UI logs found using download button in app as shown in below image. LogsDownload

Install Development Release

Clone this repository:

git clone https://github.com/etherealengine/ir-engine-launcher.git ir-engine-launcher

Go inside the folder:

cd ir-engine-launcher

Install the dependencies:

npm install

Starting Development

Start the app in the dev environment:

npm run dev

Packaging for Production

To package apps for the local platform:

npm run package

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.

Join our Discord Discord Chat

Your own sandbox in the Metaverse. Take what you need, or launch the full stack. iR Engine Launcher is a desktop app for managing an iR Engine cluster.

Electron based Ethereal Engine Server Cluster Creator app

  • Ability to fully manage an on premises server.
  • Electron K8S Cluster Creator and Manager App
  • Easy setup and install deps (microk8s / minikube, docker etc) https://microk8s.io/
  • Wrap all K8S CLI into a GUI
  • Electron app with client for access to admin panel, supply link to open location in browser
  • Multiple electron apps with same k8s control plane
  • Benchmark tool - minimum specs of 4 CPU cores and 16-24GB of ram.

We Ethereal Engine believe that the Metaverse, Web AR, VR. XR should be easy.

Sponsorship Open Collective