Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replacing the instances where Ethereal Engine is mentioned in the Manual #178

Merged
merged 6 commits into from
May 24, 2024
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/manual/01_install/01_linux.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ npm run dev-docker
npm run dev-reinit
npm run dev
```
Now run Ethereal Engine in your browser by navigating to [this link](https://localhost:3000/location/default).
Now run iR Engine in your browser by navigating to [this link](https://localhost:3000/location/default).

### Accept Certificates
<AcceptCertificates />
Expand All @@ -66,7 +66,7 @@ You can administrate many features from the admin panel found at the `/admin` ro
_eg: `https://localhost:3000/admin` when working in a local deployment._

To give administration rights to a user:
- Open any page in your Ethereal Engine deployment
- Open any page in your iR Engine deployment
- Open the user menu _(icon at the top-right of the screen)_
- Click on `Show API key`
- Copy that key to your clipboard _(note: there is an icon to the right of this box for this purpose)_
Expand Down
2 changes: 1 addition & 1 deletion docs/manual/01_install/03_windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ sidebar_label: Windows 10+
4. Add the path to `MSbuild.exe` _(which stored in Visual Studio's folder)_ into the `PATH` env variable
_eg: `C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\MSBuild\Current\Bin`_
5. Make sure to install all windows prerequisites for Mediasoup as mentioned on: [https://mediasoup.org/documentation/v3/mediasoup/installation/#windows](https://mediasoup.org/documentation/v3/mediasoup/installation/#windows)
6. Install all dependencies using `npm install` from the root folder where you cloned Ethereal Engine.
6. Install all dependencies using `npm install` from the root folder where you cloned iR Engine.

> Troubleshooting:

Expand Down
12 changes: 6 additions & 6 deletions docs/manual/01_install/03_windowsWSL.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,16 +66,16 @@ You can verify your Node version with the command: `node --version`.

<MakeUbuntu />

## Clone Ethereal Engine repo to your local machine
Clone Ethereal Engine repo on your machine by running the following command from your WSL Ubuntu terminal:
## Clone iR Engine repo to your local machine
Clone iR Engine repo on your machine by running the following command from your WSL Ubuntu terminal:
<CloneInstructions />

Change directory to the location where `etherealengine` repository is cloned with:
```bash
pwd # Prints the current working directory
cd etherealengine # Change directory to `etherealengine`
```
If an `.env.local` file does not exist in the root of your Ethereal Engine repository folder, then create it by duplicating the `.env.local.default` file:
If an `.env.local` file does not exist in the root of your iR Engine repository folder, then create it by duplicating the `.env.local.default` file:
```bash
cp .env.local.default .env.local
```
Expand All @@ -86,7 +86,7 @@ npm install
```

> Note: If you find issues related to `mediasoup` when running `npm install`, then:
> - Remove the `mediasoup` package from `packages/instanceserver/package.json` file of Ethereal Engine's source code.
> - Remove the `mediasoup` package from `packages/instanceserver/package.json` file of iR Engine's source code.
> - Run `npm install` again.
> - Run: `npm install mediasoup@3 -w @etherealengine/instanceserver`

Expand All @@ -97,11 +97,11 @@ npm run dev-reinit
```

## Start the Engine
Run the Ethereal Engine's stack with:
Run the iR Engine's stack with:
```bash
npm run dev
```
If everything went well, you will now be able to open Ethereal Engine in your browser by navigating to [this link](https://localhost:3000/location/default).
If everything went well, you will now be able to open iR Engine in your browser by navigating to [this link](https://localhost:3000/location/default).

## Accept Certificates
<AcceptCertificates />
44 changes: 22 additions & 22 deletions docs/manual/01_install/04_controlCenter.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,23 +8,23 @@ import StepVariables from '../_partials/controlCenter/step_variables.md'
import StepSummary from '../_partials/controlCenter/step_summary.md'

# Control Center: Getting Started
Ethereal Engine's Control Center is a self-contained Metaverse world in a box. Take what you need or launch the full stack.
The Control Center is a desktop app to manage an Ethereal Engine cluster.
iR Engine's Control Center is a self-contained Metaverse world in a box. Take what you need or launch the full stack.
The Control Center is a desktop app to manage an iR Engine cluster.

We know it's been complicated to build with Ethereal Engine and we've made this tool to give the community easy access to the engine. We would love to see your creations and invite you all to come build with us.
We know it's been complicated to build with iR Engine and we've made this tool to give the community easy access to the engine. We would love to see your creations and invite you all to come build with us.

## Overview
The Ethereal Engine Control Center app provides access to various functionalities which includes:
- Configure your Ethereal Engine in a cluster in just a few clicks.
- View status of Ethereal Engine dependencies on your local system.
- Manage an Ethereal Engine deployment through admin panel.
The iR Engine Control Center app provides access to various functionalities which includes:
- Configure your iR Engine in a cluster in just a few clicks.
- View status of iR Engine dependencies on your local system.
- Manage an iR Engine deployment through admin panel.
- Manage kubernetes cluster through its dashboard.
- Manage IPFS node running in the cluster.
- Execute commands against rippled server.
- See realtime logs of different actions being performed.

## 1. Downloading Control Center App
In order to download Ethereal Engine Control Center App, navigate to [releases](https://github.com/EtherealEngine/etherealengine-control-center/releases) page and download the latest version of the App.
In order to download iR Engine Control Center App, navigate to [releases](https://github.com/EtherealEngine/etherealengine-control-center/releases) page and download the latest version of the App.
- **Windows** _(and WSL)_: Download the `.exe` file

> You will need to allow permission for executing ps1 scripts.
Expand Down Expand Up @@ -67,7 +67,7 @@ In this step, you will need to provide the following information:
- **Cluster Type:**
This will be the kubernetes distribution you want to use.
There are two local distributions at the time of this writing: MicroK8s(recommended) and Minikube.
There is also a Custom type which allows you to connect to an existing Ethereal Engine cluster.
There is also a Custom type which allows you to connect to an existing iR Engine cluster.
> Currently, `MicroK8s` is supported on Windows & Linux while `Minikube` is supported on Linux only.

- **Prerequisites:**
Expand Down Expand Up @@ -129,7 +129,7 @@ In this step, you will need to provide following information regarding desired c
- **Config Type: Text**
Loads kubeconfig from a text.
- **Context**:
This is the selected kube context of the cluster in which your Ethereal Engine deployment exists.
This is the selected kube context of the cluster in which your iR Engine deployment exists.
The dropdown will show all contexts that exist for the selected config type.

### 2.3.2. Deployment
Expand Down Expand Up @@ -183,7 +183,7 @@ The Navbar allows navigation and various utility options.
Navigates to [workloads](#6-workloads) screen of selected cluster.

- **Admin**:
Navigates to ethereal engine [admin](#7-admin-dashboard) panel of selected cluster.
Navigates to iR Engine [admin](#7-admin-dashboard) panel of selected cluster.

- **K8 Dashboard**:
Navigates to kubernetes [web dashboard](#8-k8-dashboard) of selected kubernetes distribution.
Expand All @@ -196,7 +196,7 @@ The Navbar allows navigation and various utility options.
Visible only when ripple stack is enabled.

- **Change Theme Icon**: ![Change Theme Icon](../images/controlCenter/navbar-theme.jpg)
Allows to toggle between vaporware, light & dark themes. The color scheme of these themes are similar to ethereal engine.
Allows to toggle between vaporware, light & dark themes. The color scheme of these themes are similar to iR Engine.

- **Support Icon**: ![Support Icon](../images/controlCenter/navbar-support.jpg)
Opens a dropdown menu to allow reaching out to support via Discord or Github.
Expand All @@ -216,11 +216,11 @@ This section shows various actions that can be activated on the currently select
Name that you entered in create cluster dialog. _eg: `Local`_

- **Engine Git Status**: ![Cluster Icon](../images/controlCenter/options-panel-git-engine.jpg)
View and change the state of your local Ethereal Engine GitHub repo.
View and change the state of your local iR Engine GitHub repo.
View current branch, pull incoming changes and push outgoing changes.

- **Ops Git Status**: ![Cluster Icon](../images/controlCenter/options-panel-git-ops.jpg)
View the current status of your local Ethereal Engine ops GitHub repo.
View the current status of your local iR Engine ops GitHub repo.
You can perform the same actions explained in the previous bullet point _(Engine Git Status)_.

- **Refresh Icon**: ![Refresh Icon](../images/controlCenter/options-panel-refresh.jpg)
Expand All @@ -241,7 +241,7 @@ This section shows various actions that can be activated on the currently select
It will be disabled and have a spinner in it when a configuration is already running.

- **Launch Button**: ![Launch Button](../images/controlCenter/options-panel-launch.jpg)
This button will open Ethereal Engine's default location in your browser as [discussed](#5-launch-ethereal-engine) later.
This button will open iR Engine's default location in your browser as [discussed](#5-launch-ethereal-engine) later.
heysokam marked this conversation as resolved.
Show resolved Hide resolved

### 3.4. System Status
This section will show whether or not the system requirements are currently met.
Expand All @@ -264,11 +264,11 @@ Otherwise you will need to use the configure dialog.
:::

### 3.5. Apps Status
This section shows the current status of all the apps required to run an Ethereal Engine deployment.
This section shows the current status of all the apps required to run an iR Engine deployment.
![Apps Status](../images/controlCenter/status-apps.jpg)

### 3.6. Engine Status
This section shows the current status of various components of an Ethereal Engine deployment in your local kubernetes distribution.
This section shows the current status of various components of an iR Engine deployment in your local kubernetes distribution.
![Engine Status](../images/controlCenter/status-engine.jpg)

### 3.7. Logs
Expand Down Expand Up @@ -328,19 +328,19 @@ Always clear your logs before running the configure script to trace its output e
Pay close attention to last few lines of the [logs](#37-logs). They will contain the reason why the script failed.
:::

## 5. Launch Ethereal Engine
![Launch Ethereal Engine](../images/controlCenter/engine-launch.jpg)
## 5. Launch iR Engine
![Launch iR Engine](../images/controlCenter/engine-launch.jpg)

If everything was configured correctly and all ticks are green on the "config" page _(aka [Cluster Screen](#3-cluster-screen))_,
you will now be able to `Launch` the engine from the [options panel](#33-options-panel).
This button will open Ethereal Engine's default location in your browser.
This button will open iR Engine's default location in your browser.

:::important
Make sure to allow certificates as explained [here](https://etherealengine.github.io/etherealengine-docs/docs/devops_deployment/microk8s_linux#accept-invalid-certs).
:::

## 6. Workloads
Workloads are the k8s pods of the components of an Ethereal Engine deployment.
Workloads are the k8s pods of the components of an iR Engine deployment.

![Workloads](../images/controlCenter/workloads-screen.jpg)

Expand Down Expand Up @@ -372,7 +372,7 @@ Beside these icons there is also a container drop down through which user can se

![Admin Dashboard](../images/controlCenter/admin-dashboard.jpg)

Once, everything is configured correctly and all ticks are green on config page ([Cluster Screen](#3-cluster-screen)) then you can click on `Admin` button in [navbar](#32-navbar). This will show the admin dashboard of ethereal engine deployed in your local k8s cluster.
Once, everything is configured correctly and all ticks are green on config page ([Cluster Screen](#3-cluster-screen)) then you can click on `Admin` button in [navbar](#32-navbar). This will show the admin dashboard of iR Engine deployed in your local k8s cluster.

You can perform various actions from admin dashboard including installing projects, managing users, groups, locations, instances, resources, etc.

Expand Down
2 changes: 1 addition & 1 deletion docs/manual/01_install/050_advanced/07_troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
`p key` debug colliders view

### Invalid Certificate errors in local environment
As of this writing, the cert provided in the ethereal engine package for local use is not adequately signed.
As of this writing, the cert provided in the iR Engine 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'.

Expand Down
2 changes: 1 addition & 1 deletion docs/manual/01_install/050_advanced/09_elasticKibana.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@ import AcceptCertificates from '../../_partials/acceptCertificates.md'

# Setup Elastic Search & Kibana

Elastic Search and Kibana will be automatically launched with `npm run dev` and will be running on `localhost` ports `9200` & `5601` respectively. This will automatically set up and run Redis/MariaDB docker containers, and Ethereal Engine client/server/instance-server instances.
Elastic Search and Kibana will be automatically launched with `npm run dev` and will be running on `localhost` ports `9200` & `5601` respectively. This will automatically set up and run Redis/MariaDB docker containers, and iR Engine client/server/instance-server instances.

<AcceptCertificates />
6 changes: 3 additions & 3 deletions docs/manual/01_install/050_advanced/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ import AcceptCertificates from '../../_partials/acceptCertificates.md'

# Advanced Setup

The advanced setup is recommended for users who want to understand the internals of how the Ethereal Engine's deployment stack works.
These instructions will explain how to manually setup Ethereal Engine docker instances, client, server and/or instance-server.
The advanced setup is recommended for users who want to understand the internals of how the iR Engine's deployment stack works.
These instructions will explain how to manually setup iR Engine docker instances, client, server and/or instance-server.

## 1. Install dependencies
```bash
Expand All @@ -15,7 +15,7 @@ _Note how you don't need to use sudo for any of these commands._
> If you find errors with mediasoup:
> - Follow the [Mediasoup Installation](https://mediasoup.org/documentation/v3/mediasoup/installation/) instructions
> - Check that your version of python is up to date: `python --version`
> - Make sure that the path where you installed Ethereal Engine has no whitespaces
> - Make sure that the path where you installed iR Engine has no whitespaces

## 2. Start the MySQL database
Make sure you have a MySQL database installed and running. Our recommendation is `MariaDB`.
Expand Down
6 changes: 3 additions & 3 deletions docs/manual/02_concepts/01_projects.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Projects have a few conventions.
- `sceneName.thumbnail.png` is an auto-generated scene thumbnail file
- `xrengine.config.ts` the project configuration, where client routes, database models, feathers services and the project thumbnail can be defined

A project must also have a package.json to provide custom dependencies, and to define the project name, project version, and Ethereal Engine version it is known to work with.
A project must also have a package.json to provide custom dependencies, and to define the project name, project version, and iR Engine version it is known to work with.

Systems imported from a scene MUST have their filename end with `System.ts` and be in the `/src/systems` folder.
This is to optimize vite's code-splitting bundling process, as each potentially dynamically importable file will result in a new bundle with it's own copy of all of it's import dependencies.
Expand All @@ -38,7 +38,7 @@ This is to optimize vite's code-splitting bundling process, as each potentially
If so, they should be defined in `peerDependencies` and kept up to date with the current engine version.

## Config
The ethereal engine config file has the following options:
The iR Engine config file has the following options:

```ts
export interface ProjectConfigInterface {
Expand Down Expand Up @@ -82,7 +82,7 @@ export interface ProjectEventHooks {

These functions are called when the project they belong to are installed,
updated (such as scenes saved) or uninstalled respectively. This is used in the
default ethereal engine project to install the default avatars.
default iR Engine project to install the default avatars.
See `/packages/projects/default-project/projectEventHooks.ts`.

### Thumbnail
Expand Down
2 changes: 1 addition & 1 deletion docs/manual/02_concepts/03_locations.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Media instances can be tied to a location, or exist ephemerally as a group call
Instances can also be customised with the `matchmaker` functionality to create private rooms.

Locations can be loaded via the `/location/<locationName>` route, where `locationName` is the name of the location.
Ethereal Engine always adds locations `default`, `apartment` and `sky-station` by default to new projects.
iR Engine always adds locations `default`, `apartment` and `sky-station` by default to new projects.

Adding a new location is done from the `/admin/locations` route, and live instances can be viewed from `/admin/instances`.

2 changes: 1 addition & 1 deletion docs/manual/02_concepts/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import DocCardList from '@theme/DocCardList'

# Concepts
In this section you will learn how to use Ethereal Engine.
In this section you will learn how to use iR Engine.

<DocCardList />
2 changes: 1 addition & 1 deletion docs/manual/02_scene/01_studio/01_overview/08_profile.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_label: "User Profile"
import StudioOverview from './_studio_overview.md'

# 8. User Profile
Your Ethereal Engine account settings and linked account information
Your iR Engine account settings and linked account information
The settings wheel icon allows you to turn up your scene resolution.
If you notice the scene looks blurry, go to the Graphics tab inside Settings and turn the Resolution tab all the way up.

Expand Down
2 changes: 1 addition & 1 deletion docs/manual/02_scene/01_studio/01_overview/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import StudioOverview from './_studio_overview.md'

# Studio Overview

Navigating to the `/studio` route in any Ethereal Engine deployment will show you the projects page, where you can open existing projects or create a new one.
Navigating to the `/studio` route in any iR Engine deployment will show you the projects page, where you can open existing projects or create a new one.
> _eg: When the engine is hosted at `dev.etherealengine.com`, the studio would be accessed from `dev.etherealengine.com/studio`_

Opening a project will open the editor, from which you can then load any scenes contained in your project.
Expand Down
4 changes: 2 additions & 2 deletions docs/manual/02_scene/02_visualscript/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@ Widely embraced for implementing visual scripting languages, behavior graphs hav
Notable examples include Unreal Engine's Blueprints, Unity's Visual Scripting, and NVIDIA Omniverse's OmniGraph.
These engines leverage behavior graphs to empower game designers and developers in crafting sophisticated behaviors without delving into direct code writing.

In the context of Ethereal Engine, Behavior Graphs hold a pivotal role by offering a visual scripting interface to the engine.
In the context of iR Engine, Behavior Graphs hold a pivotal role by offering a visual scripting interface to the engine.
It provides seamless interaction with the engine, facilitating the modeling, organization, control, and assignment of intricate behaviors to entities with unparalleled ease.

## Audience
VisualScript is designed for developers, designers, artists, and non-technical users.
This visual scripting feature streamlines the implementation of complex logic and actions for entities without script writing.
It promotes collaboration and empowers a diverse range of individuals to craft immersive experiences and interactive content for Ethereal Engine.
It promotes collaboration and empowers a diverse range of individuals to craft immersive experiences and interactive content for iR Engine.
2 changes: 1 addition & 1 deletion docs/manual/02_scene/05_management/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ In the File menu, click the save or save as button to save your scene.
Some projects require time to save so don't exit this window until a few minutes have passed.

## Editing Materials
Ethereal Engine supports PBR workflow and Vertex Colors. The material properties supported are:
iR Engine supports PBR workflow and Vertex Colors. The material properties supported are:
- Diffuse or Base Color Map
- Metalness Map
- Roughness Map
Expand Down
Loading
Loading