diff --git a/docs/d__partials/contributing/develop.md b/docs/d__partials/contributing/develop.md index 1bf9f40d41aa..d0f23e14c4fe 100644 --- a/docs/d__partials/contributing/develop.md +++ b/docs/d__partials/contributing/develop.md @@ -1,2 +1,2 @@ -iR Engine is an open-source project, based on the [CPAL](https://github.com/ir-engine/ir-engine/blob/dev/LICENSE) license. -You can find the source code of the engine on iR Engine's [GitHub](https://github.com/ir-engine/ir-engine) repository, and some guidelines on how to contribute to its codebase in the [Contributing](https://github.com/ir-engine/etherealengine#contributing) section of the repository's readme. +iR Engine is an open-source project, based on the [CPAL](https://github.com/ir-engine/ir-engine/LICENSE) license. +You can find the source code of the engine on iR Engine's [GitHub](https://github.com/ir-engine/ir-engine) repository, and some guidelines on how to contribute to its codebase in the [Contributing](https://github.com/ir-engine/ir-engine#contributing) section of the repository's readme. diff --git a/docs/d__partials/license.md b/docs/d__partials/license.md index 8642acfbc074..f8b17ec7cacf 100644 --- a/docs/d__partials/license.md +++ b/docs/d__partials/license.md @@ -1,7 +1,7 @@ -iR Engine is [open-source](https://github.com/ir-engine/ir-engine), under the terms and conditions of the [CPAL](https://github.com/ir-engine/ir-engine/blob/dev/LICENSE) license. -Attribution is required if you wish to use iR Engine under [CPAL](https://github.com/ir-engine/ir-engine/blob/dev/LICENSE). -Please see the attribution guidelines in iR Engine's [LICENSE](https://github.com/ir-engine/ir-engine/blob/dev/LICENSE) file. +iR Engine is [open-source](https://github.com/ir-engine/ir-engine), under the terms and conditions of the [CPAL](https://github.com/ir-engine/ir-engine/LICENSE) license. +Attribution is required if you wish to use iR Engine under [CPAL](https://github.com/ir-engine/ir-engine/LICENSE). +Please see the attribution guidelines in iR Engine's [LICENSE](https://github.com/ir-engine/ir-engine/LICENSE) file. Other licensing options are available, please contact us for more information. -[CPAL](https://github.com/ir-engine/ir-engine/blob/dev/LICENSE) - Copyright (c) 2021-2023 iR Engine, formerly known as XREngine by XR Foundation +[CPAL](https://github.com/ir-engine/ir-engine/LICENSE) - Copyright (c) 2021-2023 iR Engine, formerly known as XREngine by XR Foundation diff --git a/docs/d_creator/96_tutorials/02_unreal_bridge.md b/docs/d_creator/96_tutorials/02_unreal_bridge.md index bca9c18bb914..8d5070076bd2 100644 --- a/docs/d_creator/96_tutorials/02_unreal_bridge.md +++ b/docs/d_creator/96_tutorials/02_unreal_bridge.md @@ -69,7 +69,7 @@ https://github.com/ir-engine/EE-Bridge-Unreal This bridge is wrapping OpenAPI endpoints presented by iR Engine -https://api-dev.etherealengine.com/openapi/ +https://ir-engine-api.mt-int.theinfinitereality.io/ This first requires a generated bearer token for API autorization. OAuth API app digestion with socpes is coming soon! @@ -96,21 +96,21 @@ This is a ticketing system to be placed into a lobby group and then into a games Match User Relation -https://github.com/etherealengine/etherealengine/blob/dev/packages/server-core/src/matchmaking/match-user/match-user.class.ts +https://github.com/ir-engine/ir-engine/blob/dev/packages/server-core/src/matchmaking/match-user/match-user.class.ts #### Open Match Endpoint Reference Match the ticket for an assignment -https://github.com/etherealengine/etherealengine/blob/dev/packages/server-core/src/matchmaking/match-ticket/match-ticket.class.ts +https://github.com/ir-engine/ir-engine/blob/dev/packages/server-core/src/matchmaking/match-ticket/match-ticket.class.ts Match Gameserver Instance Relation -https://github.com/etherealengine/etherealengine/blob/dev/packages/server-core/src/matchmaking/match-instance/match-instance.class.ts +https://github.com/ir-engine/ir-engine/blob/dev/packages/server-core/src/matchmaking/match-instance/match-instance.class.ts Get a ticket for assignment to a gameserver instance -https://github.com/etherealengine/etherealengine/blob/dev/packages/server-core/src/matchmaking/match-ticket-assignment/match-ticket-assignment.class.ts +https://github.com/ir-engine/ir-engine/blob/dev/packages/server-core/src/matchmaking/match-ticket-assignment/match-ticket-assignment.class.ts @@ -121,7 +121,7 @@ Agones Actions -# Ethereal-Engine-Bridge-Unreal-Example +# iR Engine Bridge Unreal Example https://github.com/ir-engine/EE-Bridge-Unreal-Example @@ -145,7 +145,7 @@ https://github.com/ir-engine/EE-Bridge-Unreal This bridge is wrapping OpenAPI endpoints presented by iR Engine -https://api-dev.etherealengine.com/openapi/ +https://ir-engine-api.mt-int.theinfinitereality.io/ This first requires a generated bearer token for API autorization. OAuth API app digestion with socpes is coming soon! diff --git a/docs/developer/typescript/01_gettingStarted/02_hello/02_engine.md b/docs/developer/typescript/01_gettingStarted/02_hello/02_engine.md index daef0939efd0..96348aba00f4 100644 --- a/docs/developer/typescript/01_gettingStarted/02_hello/02_engine.md +++ b/docs/developer/typescript/01_gettingStarted/02_hello/02_engine.md @@ -35,7 +35,7 @@ They are equivalent to the concept of "projects" in other engines, except they a The engine scans for projects mounted in the `/packages/projects/projects` sub-folder. This means that we can install and run new projects by executing the following commands inside our iR Engine installation folder: ```bash -git clone https://github.com/ir-engine/ee-tutorial-hello packages/projects/projects/ee-tutorial-hello +git clone https://github.com/ir-engine/ir-tutorial-hello packages/projects/projects/ir-tutorial-hello npm run dev ``` :::note @@ -43,11 +43,11 @@ You will need to stop the engine and re-run it whenever you install a new projec ::: -Please note that, in the [Quickstart](../quickstart) guide, we cloned the `Step0` branch from the `ee-tutorial-hello` project specifically, and not the whole project. +Please note that, in the [Quickstart](../quickstart) guide, we cloned the `Step0` branch from the `ir-tutorial-hello` project specifically, and not the whole project. We did this by adding `-b Step0` to the `git clone` command: ```bash -git clone -b Step0 https://github.com/ir-engine/ee-tutorial-hello packages/projects/projects/ee-tutorial-hello +git clone -b Step0 https://github.com/ir-engine/ir-tutorial-hello packages/projects/projects/ir-tutorial-hello ``` This step won't be needed for your own projects. @@ -80,12 +80,12 @@ There are multiple options available, but the important thing to remember is tha -```ts title="ee-tutorial-hello/xrengine.config.ts" -import type { ProjectConfigInterface } from '@etherealengine/projects/ProjectConfigInterface' +```ts title="ir-tutorial-hello/xrengine.config.ts" +import type { ProjectConfigInterface } from '@ir-engine/packages/projects/ProjectConfigInterface' const config: ProjectConfigInterface = { onEvent: undefined, - thumbnail: '/static/etherealengine_thumbnail.jpg', + thumbnail: '/static/IR_thumbnail.jpg', routes: {}, services: undefined, databaseSeed: undefined, @@ -104,17 +104,17 @@ We don't need to know much more about this file for now. We will explore it furt In this minimal tutorial we are adding a sphere primitive to the scene. As this sphere will be a `Spatial` object, we will import a few components from the Spatial engine module: -```ts title="ee-tutorial-hello/src/Hello.ts" -import { NameComponent } from '@etherealengine/spatial/src/common/NameComponent' -import { VisibleComponent } from '@etherealengine/spatial/src/renderer/components/VisibleComponent' -import { TransformComponent } from '@etherealengine/spatial/src/transform/components/TransformComponent' -import { PrimitiveGeometryComponent } from '@etherealengine/engine/src/scene/components/PrimitiveGeometryComponent' +```ts title="ir-tutorial-hello/src/Hello.ts" +import { NameComponent } from '@ir-engine/packages/spatial/src/common/NameComponent' +import { VisibleComponent } from '@ir-engine/packages/spatial/src/renderer/components/VisibleComponent' +import { TransformComponent } from '@ir-engine/packages/spatial/src/transform/components/TransformComponent' +import { PrimitiveGeometryComponent } from '@ir-engine/packages/engine/src/scene/components/PrimitiveGeometryComponent' ``` We will be adding these Components to our Entity, and Components are part of the ECS pattern. As such, we will need to use the iR Engine ECS management functions. The engine provides a convenient way to import all ECS related functions at once through the `ECS` [namespace](https://www.typescriptlang.org/docs/handbook/namespaces.html). -```ts title="ee-tutorial-hello/src/Hello.ts" -import { ECS } from '@etherealengine/ecs' +```ts title="ir-tutorial-hello/src/Hello.ts" +import { ECS } from '@ir-engine/packages/ecs' ``` ## Modifying our Source Code @@ -123,14 +123,14 @@ This will be our first modification to the code of the project. :::important This guide uses [`Project-based Learning`](https://en.wikipedia.org/wiki/Project-based_learning) as its core teaching philosophy. -From now on, you will be actively modifying the source code of the `ee-tutorial-hello` in every step of the way. +From now on, you will be actively modifying the source code of the `ir-tutorial-hello` in every step of the way. ::: Lets start with a simple change. We will modify our Sphere `PrimitiveGeometryComponent` to load our geometry with a name, instead of the hardcoded number `1` that we used before. In order to do this, we need to: -- Open the file `ee-tutorial-hello/src/Hello.ts` with a text editor. +- Open the file `ir-tutorial-hello/src/Hello.ts` with a text editor. - Import the `GeometryTypeEnum` from the `scene/constants/` sub-module inside the `engine` module. - Replace the `1` with a call to the `SphereGeometry` name that is stored inside it `GeometryTypeEnum`. @@ -138,7 +138,7 @@ Try to figure out the changes by yourself before looking at the solution. I don't expect you to know where that enum is stored, so here are some hints to make it easier: ```ts // The full path to the GeometryTypeEnum is: -'@etherealengine/engine/src/scene/constants/GeometryTypeEnum' +'@ir-engine/packages/engine/src/scene/constants/GeometryTypeEnum' // Getting the ID number of a Sphere by its enum name will look like: GeometryTypeEnum.SphereGeometry @@ -158,16 +158,16 @@ VSCode has support for some important features and plugins that make the iR Engi The imports section of our code will now be: -```ts title="ee-tutorial-hello/src/Hello.ts" +```ts title="ir-tutorial-hello/src/Hello.ts" // ... our other imports -import { PrimitiveGeometryComponent } from '@etherealengine/engine/src/scene/components/PrimitiveGeometryComponent' +import { PrimitiveGeometryComponent } from '@ir-engine/packages/engine/src/scene/components/PrimitiveGeometryComponent' import { Vector3 } from 'three' // highlight-start -import { GeometryTypeEnum } from '@etherealengine/engine/src/scene/constants/GeometryTypeEnum' +import { GeometryTypeEnum } from '@ir-engine/packages/engine/src/scene/constants/GeometryTypeEnum' // highlight-end ``` The `PrimitiveGeometryComponent` call will now be: -```ts title="ee-tutorial-hello/src/Hello.ts" +```ts title="ir-tutorial-hello/src/Hello.ts" const entity = ECS.createEntity() // ... our other calls to setComponent // highlight-start @@ -177,14 +177,14 @@ ECS.setComponent(entity, PrimitiveGeometryComponent, { geometryType: GeometryTyp -```ts title="ee-tutorial-hello/src/Hello.ts" showLineNumbers -import { ECS } from '@etherealengine/ecs' -import { NameComponent } from '@etherealengine/spatial/src/common/NameComponent' -import { VisibleComponent } from '@etherealengine/spatial/src/renderer/components/VisibleComponent' -import { TransformComponent } from '@etherealengine/spatial/src/transform/components/TransformComponent' -import { PrimitiveGeometryComponent } from '@etherealengine/engine/src/scene/components/PrimitiveGeometryComponent' +```ts title="ir-tutorial-hello/src/Hello.ts" showLineNumbers +import { ECS } from '@ir-engine/packages/ecs' +import { NameComponent } from '@ir-engine/packages/spatial/src/common/NameComponent' +import { VisibleComponent } from '@ir-engine/packages/spatial/src/renderer/components/VisibleComponent' +import { TransformComponent } from '@ir-engine/packages/spatial/src/transform/components/TransformComponent' +import { PrimitiveGeometryComponent } from '@ir-engine/packages/engine/src/scene/components/PrimitiveGeometryComponent' // highlight-start -import { GeometryTypeEnum } from '@etherealengine/engine/src/scene/constants/GeometryTypeEnum' +import { GeometryTypeEnum } from '@ir-engine/packages/engine/src/scene/constants/GeometryTypeEnum' // highlight-end const entity = ECS.createEntity() diff --git a/docs/developer/typescript/01_gettingStarted/02_hello/03_system.md b/docs/developer/typescript/01_gettingStarted/02_hello/03_system.md index 6c5ac868b743..4b79e1805678 100644 --- a/docs/developer/typescript/01_gettingStarted/02_hello/03_system.md +++ b/docs/developer/typescript/01_gettingStarted/02_hello/03_system.md @@ -121,7 +121,7 @@ The engine will take care of executing our code when it is correct to do so, bas -```ts title="ee-tutorial-hello/src/Hello.ts" +```ts title="ir-tutorial-hello/src/Hello.ts" //highlight-start export const HelloWorldSystem = ECS.defineSystem({ uuid: 'helloworld.system', @@ -137,15 +137,15 @@ This is how our final code will look like after we have completed these tasks. -```ts title="ee-tutorial-hello/src/Hello.ts" showLineNumbers -import { ECS } from '@etherealengine/ecs' -import { PhysicsSystem } from '@etherealengine/spatial/src/physics/PhysicsModule' -import { NameComponent } from '@etherealengine/spatial/src/common/NameComponent' -import { VisibleComponent } from '@etherealengine/spatial/src/renderer/components/VisibleComponent' -import { TransformComponent } from '@etherealengine/spatial/src/transform/components/TransformComponent' -import { PrimitiveGeometryComponent } from '@etherealengine/engine/src/scene/components/PrimitiveGeometryComponent' +```ts title="ir-tutorial-hello/src/Hello.ts" showLineNumbers +import { ECS } from '@ir-engine/packages/ecs' +import { PhysicsSystem } from '@ir-engine/packages/spatial/src/physics/PhysicsModule' +import { NameComponent } from '@ir-engine/packages/spatial/src/common/NameComponent' +import { VisibleComponent } from '@ir-engine/packages/spatial/src/renderer/components/VisibleComponent' +import { TransformComponent } from '@ir-engine/packages/spatial/src/transform/components/TransformComponent' +import { PrimitiveGeometryComponent } from '@ir-engine/packages/engine/src/scene/components/PrimitiveGeometryComponent' import { Vector3 } from 'three' -import { GeometryTypeEnum } from '@etherealengine/engine/src/scene/constants/GeometryTypeEnum' +import { GeometryTypeEnum } from '@ir-engine/packages/engine/src/scene/constants/GeometryTypeEnum' //highlight-start diff --git a/docs/developer/typescript/01_gettingStarted/02_hello/05_query.md b/docs/developer/typescript/01_gettingStarted/02_hello/05_query.md index 44c3125a21d9..6b48c7069db2 100644 --- a/docs/developer/typescript/01_gettingStarted/02_hello/05_query.md +++ b/docs/developer/typescript/01_gettingStarted/02_hello/05_query.md @@ -149,15 +149,15 @@ function hello() { ``` -```ts title="ee-tutorial-hello/src/Hello.ts" showLineNumbers -import { ECS } from '@etherealengine/ecs' -import { NameComponent } from '@etherealengine/spatial/src/common/NameComponent' -import { VisibleComponent } from '@etherealengine/spatial/src/renderer/components/VisibleComponent' -import { TransformComponent } from '@etherealengine/spatial/src/transform/components/TransformComponent' -import { PrimitiveGeometryComponent } from '@etherealengine/engine/src/scene/components/PrimitiveGeometryComponent' +```ts title="ir-tutorial-hello/src/Hello.ts" showLineNumbers +import { ECS } from '@ir-engine/packages/ecs' +import { NameComponent } from '@ir-engine/packages/spatial/src/common/NameComponent' +import { VisibleComponent } from '@ir-engine/packages/spatial/src/renderer/components/VisibleComponent' +import { TransformComponent } from '@ir-engine/packages/spatial/src/transform/components/TransformComponent' +import { PrimitiveGeometryComponent } from '@ir-engine/packages/engine/src/scene/components/PrimitiveGeometryComponent' import { Vector3 } from 'three' -import { GeometryTypeEnum } from '@etherealengine/engine/src/scene/constants/GeometryTypeEnum' -import { PhysicsSystem } from '@etherealengine/spatial' +import { GeometryTypeEnum } from '@ir-engine/packages/engine/src/scene/constants/GeometryTypeEnum' +import { PhysicsSystem } from '@ir-engine/packages/spatial' // Define our component //highlight-start @@ -216,7 +216,7 @@ We don't know how to add a Component to an entity through the Studio yet, or how And we have gone through two entire pages with a LOT of theory but not a whole lot of practice. So I already solved this problem for you. -When you open the `ee-tutorial-hello` project... there is a scene called `hello-final` in there. +When you open the `ir-tutorial-hello` project... there is a scene called `hello-final` in there. That's what we are looking for :) Thanks to how the `hello-final` scene is setup, our Component will work in that Scene... but it will not work anywhere else! Really neat. diff --git a/docs/developer/typescript/01_gettingStarted/02_hello/90_congrats.md b/docs/developer/typescript/01_gettingStarted/02_hello/90_congrats.md index c14dd7cfcebe..69b6faae09a3 100644 --- a/docs/developer/typescript/01_gettingStarted/02_hello/90_congrats.md +++ b/docs/developer/typescript/01_gettingStarted/02_hello/90_congrats.md @@ -25,7 +25,7 @@ Make sure to skim-read the basics section at least once, as it gives an overview #### Advanced The [Manual](/manual) is where iR Engine is presented in all of its complexity, without any guard-rails or hand-holding. -You will also find the [Reference API](https://etherealengine.github.io/etherealengine-docs/api) really useful when writing the code of your application. +You will also find the [Reference API](https://ir-engine-api.mt-int.theinfinitereality.io/) really useful when writing the code of your application. :::note[Advanced Note] Make sure to read the `Mastery Toolkit` section at least once. It contains a list of important tools that you will need when working with advanced projects. diff --git a/docs/developer/typescript/01_gettingStarted/02_hello/index.md b/docs/developer/typescript/01_gettingStarted/02_hello/index.md index 5d271a13e6d0..998a750cb421 100644 --- a/docs/developer/typescript/01_gettingStarted/02_hello/index.md +++ b/docs/developer/typescript/01_gettingStarted/02_hello/index.md @@ -12,12 +12,12 @@ The purpose of the next few pages of this tutorial is to teach you how these con ## Hello World Code This is how the code for our project looks like at the moment. -```ts title="ee-tutorial-hello/src/Hello.ts" showLineNumbers -import { ECS } from '@etherealengine/ecs' -import { NameComponent } from '@etherealengine/spatial/src/common/NameComponent' -import { VisibleComponent } from '@etherealengine/spatial/src/renderer/components/VisibleComponent' -import { TransformComponent } from '@etherealengine/spatial/src/transform/components/TransformComponent' -import { PrimitiveGeometryComponent } from '@etherealengine/engine/src/scene/components/PrimitiveGeometryComponent' +```ts title="ir-tutorial-hello/src/Hello.ts" showLineNumbers +import { ECS } from '@ir-engine/packages/ecs' +import { NameComponent } from '@ir-engine/packages/spatial/src/common/NameComponent' +import { VisibleComponent } from '@ir-engine/packages/spatial/src/renderer/components/VisibleComponent' +import { TransformComponent } from '@ir-engine/packages/spatial/src/transform/components/TransformComponent' +import { PrimitiveGeometryComponent } from '@ir-engine/packages/engine/src/scene/components/PrimitiveGeometryComponent' import { Vector3 } from 'three' const entity = ECS.createEntity() diff --git a/docs/developer/typescript/01_gettingStarted/index.md b/docs/developer/typescript/01_gettingStarted/index.md index f9f8bf5c3dde..24256efdd7af 100644 --- a/docs/developer/typescript/01_gettingStarted/index.md +++ b/docs/developer/typescript/01_gettingStarted/index.md @@ -53,11 +53,11 @@ A local version of the engine is required to follow this introductory tutorial. The previous commands will have the engine running locally. Lets stop it by pressing `Ctrl+C`, and then run these commands to install and run the tutorial's template project: ```bash -git clone -b Step0 https://github.com/ir-engine/ee-tutorial-hello packages/projects/projects/ee-tutorial-hello +git clone -b Step0 https://github.com/ir-engine/ir-tutorial-hello packages/projects/projects/ir-tutorial-hello npm run dev ``` -You should now be able to see the `ee-tutorial-hello` project listed in iR Engine's Studio by navigating to https://localhost:3000/studio. +You should now be able to see the `ir-tutorial-hello` project listed in iR Engine's Studio by navigating to https://localhost:3000/studio. ## Confirm the installation Lets make sure that our `hello world` code is running: diff --git a/docs/developer/typescript/02_basics/01_recap/01_styling.md b/docs/developer/typescript/02_basics/01_recap/01_styling.md index 5619a184a400..da94b394ffae 100644 --- a/docs/developer/typescript/02_basics/01_recap/01_styling.md +++ b/docs/developer/typescript/02_basics/01_recap/01_styling.md @@ -114,15 +114,15 @@ export const HelloSystem = ECS.defineSystem({ ``` -```ts title="ee-tutorial-basics/src/step1.ts" showLineNumbers -import { ECS } from '@etherealengine/ecs' -import { NameComponent } from '@etherealengine/spatial/src/common/NameComponent' -import { VisibleComponent } from '@etherealengine/spatial/src/renderer/components/VisibleComponent' -import { TransformComponent } from '@etherealengine/spatial/src/transform/components/TransformComponent' -import { PrimitiveGeometryComponent } from '@etherealengine/engine/src/scene/components/PrimitiveGeometryComponent' +```ts title="ir-tutorial-basic/src/step1.ts" showLineNumbers +import { ECS } from '@ir-engine/packages/ecs' +import { NameComponent } from '@ir-engine/packages/spatial/src/common/NameComponent' +import { VisibleComponent } from '@ir-engine/packages/spatial/src/renderer/components/VisibleComponent' +import { TransformComponent } from '@ir-engine/packages/spatial/src/transform/components/TransformComponent' +import { PrimitiveGeometryComponent } from '@ir-engine/packages/engine/src/scene/components/PrimitiveGeometryComponent' import { Vector3 } from 'three' -import { GeometryTypeEnum } from '@etherealengine/engine/src/scene/constants/GeometryTypeEnum' -import { PhysicsSystem } from '@etherealengine/spatial' +import { GeometryTypeEnum } from '@ir-engine/packages/engine/src/scene/constants/GeometryTypeEnum' +import { PhysicsSystem } from '@ir-engine/packages/spatial' // Define our component export const HelloComponent = ECS.defineComponent({ diff --git a/docs/developer/typescript/02_basics/02_physics.md b/docs/developer/typescript/02_basics/02_physics.md index 46bdcc7a8c51..e8745fe6066a 100644 --- a/docs/developer/typescript/02_basics/02_physics.md +++ b/docs/developer/typescript/02_basics/02_physics.md @@ -36,7 +36,7 @@ Lets also change the position of ball so that it spawns some distance above the Here are your hints for this tutorial: ```ts // Both the RigidBody and Collider components are part of the `Spatial/physics` engine module -'@etherealengine/spatial/src/physics/components/.....' +'@ir-engine/packages/spatial/src/physics/components/.....' // We can specify the dynamic type with: { type: 'dynamic' } // We can specify the shape with: @@ -53,8 +53,8 @@ You will know that your code is correct if: ```ts // Import both components from the Spatial/physics module -import { RigidBodyComponent } from '@etherealengine/spatial/src/physics/components/RigidBodyComponent' -import { ColliderComponent } from '@etherealengine/spatial/src/physics/components/ColliderComponent' +import { RigidBodyComponent } from '@ir-engine/packages/spatial/src/physics/components/RigidBodyComponent' +import { ColliderComponent } from '@ir-engine/packages/spatial/src/physics/components/ColliderComponent' ``` ```ts // Set both components to our entity @@ -68,19 +68,19 @@ ECS.setComponent(entity, TransformComponent, { position: new Vector3(0, 3, 0) }) -```ts title="ee-tutorial-basics/Step2.ts" showLineNumbers -import { ECS } from '@etherealengine/ecs' -import { NameComponent } from '@etherealengine/spatial/src/common/NameComponent' -import { VisibleComponent } from '@etherealengine/spatial/src/renderer/components/VisibleComponent' -import { TransformComponent } from '@etherealengine/spatial/src/transform/components/TransformComponent' -import { PrimitiveGeometryComponent } from '@etherealengine/engine/src/scene/components/PrimitiveGeometryComponent' +```ts title="ir-tutorial-basic/Step2.ts" showLineNumbers +import { ECS } from '@ir-engine/packages/ecs' +import { NameComponent } from '@ir-engine/packages/spatial/src/common/NameComponent' +import { VisibleComponent } from '@ir-engine/packages/spatial/src/renderer/components/VisibleComponent' +import { TransformComponent } from '@ir-engine/packages/spatial/src/transform/components/TransformComponent' +import { PrimitiveGeometryComponent } from '@ir-engine/packages/engine/src/scene/components/PrimitiveGeometryComponent' import { Vector3 } from 'three' -import { GeometryTypeEnum } from '@etherealengine/engine/src/scene/constants/GeometryTypeEnum' -import { PhysicsSystem } from '@etherealengine/spatial' +import { GeometryTypeEnum } from '@ir-engine/packages/engine/src/scene/constants/GeometryTypeEnum' +import { PhysicsSystem } from '@ir-engine/packages/spatial' // Import both components from the Spatial/physics module //highlight-start -import { RigidBodyComponent } from '@etherealengine/spatial/src/physics/components/RigidBodyComponent' -import { ColliderComponent } from '@etherealengine/spatial/src/physics/components/ColliderComponent' +import { RigidBodyComponent } from '@ir-engine/packages/spatial/src/physics/components/RigidBodyComponent' +import { ColliderComponent } from '@ir-engine/packages/spatial/src/physics/components/ColliderComponent' //highlight-end export const BasicsComponent = ECS.defineComponent({ diff --git a/docs/developer/typescript/04_state/d_50_state.md b/docs/developer/typescript/04_state/d_50_state.md index ecd8a9522f91..e658897f0110 100644 --- a/docs/developer/typescript/04_state/d_50_state.md +++ b/docs/developer/typescript/04_state/d_50_state.md @@ -26,10 +26,10 @@ const MyComponent = () => { ## Global State Global state definitions are wrapped in a 'store' which allows for automatic creation and cleanup as needed. -This API, as well as the underlying hookstate API, can be imported from `@etherealengine/hyperflux`. +This API, as well as the underlying hookstate API, can be imported from `@ir-engine/packages/hyperflux`. ```ts title="MyState.ts" -import { defineState } from '@etherealengine/hyperflux' +import { defineState } from '@ir-engine/packages/hyperflux' const MyState = defineState({ name: 'MyState', @@ -48,7 +48,7 @@ When accessing the state, `getState` returns the underlying object typed as read This is useful for reading state values, but should not be used to write to state. ```ts -import { getState } from '@etherealengine/hyperflux' +import { getState } from '@ir-engine/packages/hyperflux' import { MyState } from './MyState' const state = getState(MyState) @@ -63,7 +63,7 @@ The proxy returned can be wrapped in Hookstate's reactive hook `useHookstate`. This will cause the component to re-render when any state values are changed. ```tsx -import { getMutableState, useHookstate } from '@etherealengine/hyperflux' +import { getMutableState, useHookstate } from '@ir-engine/packages/hyperflux' import { MyState } from './MyState' const MyComponent = () => { diff --git a/docs/developer/typescript/49_networking/_50_networking.md b/docs/developer/typescript/49_networking/_50_networking.md index 9a6a41f19ba6..4cc40ac73c6c 100644 --- a/docs/developer/typescript/49_networking/_50_networking.md +++ b/docs/developer/typescript/49_networking/_50_networking.md @@ -77,7 +77,7 @@ const ArtifactReactor = ({ entityUUID }: { entityUUID: EntityUUID }) => { ## Closing This example is simple, but these are the building blocks and foundations for creating richer and more complex experiences. -The source code for this example from https://github.com/etherealengine/ee-tutorial-basic +The source code for this example from https://github.com/ir-engine/ir-tutorial-basic @@ -96,25 +96,25 @@ import { getState, none, useHookstate -} from '@etherealengine/hyperflux' - -import { EntityUUID } from '@etherealengine/common/src/interfaces/EntityUUID' - -import { NetworkTopics } from '@etherealengine/spatial/src/networking/classes/Network' -import { WorldNetworkAction } from '@etherealengine/spatial/src/networking/functions/WorldNetworkAction' - -import { isClient } from '@etherealengine/common/src/utils/getEnvironment' -import { PresentationSystemGroup, defineSystem, getComponent, setComponent } from '@etherealengine/ecs' -import { ECSState } from '@etherealengine/ecs/src/ECSState' -import { PrimitiveGeometryComponent } from '@etherealengine/engine/src/scene/components/PrimitiveGeometryComponent' -import { GeometryTypeEnum } from '@etherealengine/engine/src/scene/constants/GeometryTypeEnum' -import { NameComponent } from '@etherealengine/spatial/src/common/NameComponent' -import { UUIDComponent } from '@etherealengine/spatial/src/common/UUIDComponent' -import { NetworkState } from '@etherealengine/spatial/src/networking/NetworkState' -import { ColliderComponent } from '@etherealengine/spatial/src/physics/components/ColliderComponent' -import { RigidBodyComponent } from '@etherealengine/spatial/src/physics/components/RigidBodyComponent' -import { VisibleComponent } from '@etherealengine/spatial/src/renderer/components/VisibleComponent' -import { TransformComponent } from '@etherealengine/spatial/src/transform/components/TransformComponent' +} from '@ir-engine/packages/hyperflux' + +import { EntityUUID } from '@ir-engine/packages/common/src/interfaces/EntityUUID' + +import { NetworkTopics } from '@ir-engine/packages/spatial/src/networking/classes/Network' +import { WorldNetworkAction } from '@ir-engine/packages/spatial/src/networking/functions/WorldNetworkAction' + +import { isClient } from '@ir-engine/packages/common/src/utils/getEnvironment' +import { PresentationSystemGroup, defineSystem, getComponent, setComponent } from '@ir-engine/packages/ecs' +import { ECSState } from '@ir-engine/packages/ecs/src/ECSState' +import { PrimitiveGeometryComponent } from '@ir-engine/packages/engine/src/scene/components/PrimitiveGeometryComponent' +import { GeometryTypeEnum } from '@ir-engine/packages/engine/src/scene/constants/GeometryTypeEnum' +import { NameComponent } from '@ir-engine/packages/spatial/src/common/NameComponent' +import { UUIDComponent } from '@ir-engine/packages/spatial/src/common/UUIDComponent' +import { NetworkState } from '@ir-engine/packages/spatial/src/networking/NetworkState' +import { ColliderComponent } from '@ir-engine/packages/spatial/src/physics/components/ColliderComponent' +import { RigidBodyComponent } from '@ir-engine/packages/spatial/src/physics/components/RigidBodyComponent' +import { VisibleComponent } from '@ir-engine/packages/spatial/src/renderer/components/VisibleComponent' +import { TransformComponent } from '@ir-engine/packages/spatial/src/transform/components/TransformComponent' import { Vector3 } from 'three' /** diff --git a/docs/developer/typescript/98_contributing/index.md b/docs/developer/typescript/98_contributing/index.md index f0e31b85483a..b5634822be23 100644 --- a/docs/developer/typescript/98_contributing/index.md +++ b/docs/developer/typescript/98_contributing/index.md @@ -43,8 +43,8 @@ Talk about the engine with people you know. Let them know about those cool proje ## Contribute to iR Engine's development -iR Engine is an open-source project, based on the [CPAL](https://github.com/ir-engine/ir-engine/blob/dev/LICENSE) license. -You can find the source code of the engine on iR Engine's [GitHub](https://github.com/ir-engine/ir-engine) repository, and some guidelines on how to contribute to its codebase in the [Contributing](https://github.com/ir-engine/etherealengine#contributing) section of the repository's readme. +iR Engine is an open-source project, based on the [CPAL](https://github.com/ir-engine/ir-engine/LICENSE) license. +You can find the source code of the engine on iR Engine's [GitHub](https://github.com/ir-engine/ir-engine) repository, and some guidelines on how to contribute to its codebase in the [Contributing](https://github.com/ir-engine/ir-engine#contributing) section of the repository's readme. diff --git a/docs/manual/01_install/01_linux.md b/docs/manual/01_install/01_linux.md index ca220c510230..3611bfc085c9 100644 --- a/docs/manual/01_install/01_linux.md +++ b/docs/manual/01_install/01_linux.md @@ -22,7 +22,7 @@ To avoid cloning everything, use this command: ```bash -git clone https://github.com/etherealengine/etherealengine --depth 1 +git clone https://github.com/ir-engine/ir-engine --depth 1 ``` > **Warning**: > Adding `--depth=1` will significantly reduce the amount of data downloaded when cloning, but it will also create a `Shallow Copy` of the engine's repository. @@ -53,7 +53,7 @@ If you don't wish to use Docker, you will need to setup mariadb and redis on you If you are lucky, this will just work. However, you may encounter some issues. Make sure you are running Node 18, and check your dependencies. ``` -cd path/to/etherealengine +cd path/to/ir-engine cp .env.local.default .env.local npm install npm run dev-docker @@ -76,8 +76,8 @@ When loading the engine's website for the first time you'll have to tell your br - Reload your iR Engine's tab You need to do this for the following domains: -- `wss://api-local.etherealengine.org` -> https://api-local.etherealengine.org -- `wss://instanceserver-local.etherealengine.org` -> https://instanceserver-local.etherealengine.org +- `` -> https://api-local.theinfinitereality.io +- `wss://instanceserver-local.theinfinitereality.io` -> https://instanceserver-local.theinfinitereality.io - https://localhost:9000 > If the engine's website keeps displaying `loading routes` progress for a long time, it means that you have to allow the engine's certificates. diff --git a/docs/manual/01_install/03_windows.md b/docs/manual/01_install/03_windows.md index c3cecf25c5d4..da0dfd323cf2 100644 --- a/docs/manual/01_install/03_windows.md +++ b/docs/manual/01_install/03_windows.md @@ -14,7 +14,7 @@ > 8. _(Optional):_ you can use `docker-compose` to start the `scripts/docker-compose.yml` file, or install MariaDB and copy the credentials _(database name, username, password)_ from docker-compose or `.env.local`. You will need to create an empty database with the matching name. > Note: `./start-db.sh` only needs to be run once. If the docker image has stopped, start it again with: - `docker container start etherealengine_db` + `docker container start ir-engine_db` > 9. Check your WSL config for any incorrect networking settings. > https://docs.microsoft.com/en-us/windows/wsl/wsl-config#network diff --git a/docs/manual/01_install/03_windowsWSL.md b/docs/manual/01_install/03_windowsWSL.md index a313cccc61b8..67b898716933 100644 --- a/docs/manual/01_install/03_windowsWSL.md +++ b/docs/manual/01_install/03_windowsWSL.md @@ -84,7 +84,7 @@ You can verify that Make is installed correctly with the command: `make --versio Clone iR Engine repo on your machine by running the following command from your WSL Ubuntu terminal: ```bash -git clone https://github.com/etherealengine/etherealengine --depth 1 +git clone https://github.com/ir-engine/ir-engine --depth 1 ``` > **Warning**: > Adding `--depth=1` will significantly reduce the amount of data downloaded when cloning, but it will also create a `Shallow Copy` of the engine's repository. @@ -92,10 +92,10 @@ If you need to download any branch other than `dev`, or go back in git history i -Change directory to the location where `etherealengine` repository is cloned with: +Change directory to the location where `ir-engine` repository is cloned with: ```bash pwd # Prints the current working directory -cd etherealengine # Change directory to `etherealengine` +cd ir-engine # Change directory to `ir-engine` ``` 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 @@ -110,7 +110,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 iR Engine's source code. > - Run `npm install` again. -> - Run: `npm install mediasoup@3 -w @etherealengine/instanceserver` +> - Run: `npm install mediasoup@3 -w @ir-engine/packages/instanceserver` ## Initialize MariaDB server You will need to initialize the engine's database with tables and data if you are running the engine for the first time. You can do so with: @@ -139,8 +139,8 @@ When loading the engine's website for the first time you'll have to tell your br - Reload your iR Engine's tab You need to do this for the following domains: -- `wss://api-local.etherealengine.org` -> https://api-local.etherealengine.org -- `wss://instanceserver-local.etherealengine.org` -> https://instanceserver-local.etherealengine.org +- `wss://api-local.theinfinitereality.io` -> https://api-local.theinfinitereality.io +- `wss://instanceserver-local.theinfinitereality.io` -> https://instanceserver-local.theinfinitereality.io - https://localhost:9000 > If the engine's website keeps displaying `loading routes` progress for a long time, it means that you have to allow the engine's certificates. diff --git a/docs/manual/01_install/050_advanced/07_troubleshooting.md b/docs/manual/01_install/050_advanced/07_troubleshooting.md index 6c459649881e..177e4d8be3e7 100644 --- a/docs/manual/01_install/050_advanced/07_troubleshooting.md +++ b/docs/manual/01_install/050_advanced/07_troubleshooting.md @@ -90,7 +90,7 @@ typing ```thisisunsafeā€``` or ```"iknowwhatiamdoing"``` then reload original p Type in terminal ```bash - npm i -w @etherealengine/editor + npm i -w @ir-engine/packages/editor ``` ### Using Local Storage instead of MinIO @@ -139,8 +139,8 @@ npm run dev-reinit ``` or ```bash -docker container stop etherealengine_db -docker container rm etherealengine_db +docker container stop ir-engine_db +docker container rm ir-engine_db docker container prune --force npm run dev-docker npm run dev-reinit diff --git a/docs/manual/01_install/050_advanced/09_elasticKibana.md b/docs/manual/01_install/050_advanced/09_elasticKibana.md index 76fc47d5a285..bae192b5c558 100644 --- a/docs/manual/01_install/050_advanced/09_elasticKibana.md +++ b/docs/manual/01_install/050_advanced/09_elasticKibana.md @@ -17,8 +17,8 @@ When loading the engine's website for the first time you'll have to tell your br - Reload your iR Engine's tab You need to do this for the following domains: -- `wss://api-local.etherealengine.org` -> https://api-local.etherealengine.org -- `wss://instanceserver-local.etherealengine.org` -> https://instanceserver-local.etherealengine.org +- `wss://api-local.theinfinitereality.io` -> https://api-local.theinfinitereality.io +- `wss://instanceserver-local.theinfinitereality.io` -> https://instanceserver-local.theinfinitereality.io - https://localhost:9000 > If the engine's website keeps displaying `loading routes` progress for a long time, it means that you have to allow the engine's certificates. diff --git a/docs/manual/01_install/050_advanced/index.md b/docs/manual/01_install/050_advanced/index.md index a83e9a9499b9..ccaf77b01d4d 100644 --- a/docs/manual/01_install/050_advanced/index.md +++ b/docs/manual/01_install/050_advanced/index.md @@ -7,7 +7,7 @@ These instructions will explain how to manually setup iR Engine docker instances ## 1. Install dependencies ```bash -cd path/to/etherealengine +cd path/to/ir-engine npm install ``` _Note how you don't need to use sudo for any of these commands._ @@ -20,7 +20,7 @@ _Note how you don't need to use sudo for any of these commands._ ## 2. Start the MySQL database Make sure you have a MySQL database installed and running. Our recommendation is `MariaDB`. -We provide a docker container for easily setting up the database. This command will create a Docker container of MariaDB named `etherealengine_db`: +We provide a docker container for easily setting up the database. This command will create a Docker container of MariaDB named `ir-engine_db`: ```bash npm run dev-docker ``` @@ -33,7 +33,7 @@ The default database information is: |-|-| | Username | `server` | | Password | `password` | -| Database | `etherealengine` | +| Database | `ir-engine` | | Hostname | `127.0.0.1` | | Port | `3306` | > Note: If you have errors connecting to the local database, you might need to shut off your local firewall. @@ -70,7 +70,7 @@ Open a new terminal and start the Agones sidecar in local mode ```bash npm run dev-agones ``` -Alternatively, you can also go to `etherealengine/vendor/agones/` and run: +Alternatively, you can also go to `ir-engine/vendor/agones/` and run: - Linux: `./sdk-server.linux.amd64 --local` - Windows: `sdk-server.windows.amd64.exe --local` - Mac: `./sdk-server.darwin.amd64 --local` @@ -118,8 +118,8 @@ When loading the engine's website for the first time you'll have to tell your br - Reload your iR Engine's tab You need to do this for the following domains: -- `wss://api-local.etherealengine.org` -> https://api-local.etherealengine.org -- `wss://instanceserver-local.etherealengine.org` -> https://instanceserver-local.etherealengine.org +- `wss://api-local.theinfinitereality.io` -> https://api-local.theinfinitereality.io +- `wss://instanceserver-local.theinfinitereality.io` -> https://instanceserver-local.theinfinitereality.io - https://localhost:9000 > If the engine's website keeps displaying `loading routes` progress for a long time, it means that you have to allow the engine's certificates. diff --git a/docs/manual/01_install/d_04_controlCenter.md b/docs/manual/01_install/d_04_controlCenter.md index e89a5210ee20..d2922f9e1e50 100644 --- a/docs/manual/01_install/d_04_controlCenter.md +++ b/docs/manual/01_install/d_04_controlCenter.md @@ -20,11 +20,11 @@ The iR Engine Control Center app provides access to various functionalities whic - See realtime logs of different actions being performed. ## 1. Downloading Control Center App -In order to download iR Engine Control Center App, navigate to [releases](https://github.com/ir-engine/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/ir-engine/ir-engine-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. - > You can do so by running following command in Powershell with admin privileges ([reference](https://github.com/ir-engine/etherealengine-control-center#2-windows-permission-to-run-ps1-scripts)). + > You can do so by running following command in Powershell with admin privileges ([reference](https://github.com/ir-engine/ir-engine-control-center#2-windows-permission-to-run-ps1-scripts)). > ```Powershell > Set-ExecutionPolicy -ExecutionPolicy Unrestricted >``` @@ -35,7 +35,7 @@ In order to download iR Engine Control Center App, navigate to [releases](https: > Afterwards, double click on AppImage to launch the app. > Ubuntu 22.04 or later: - > If you are unable to launch the AppImage, you might have to install Fuse with the following command _([reference](https://github.com/ir-engine/etherealengine-control-center#1-app-not-launching-in-ubuntu-2204))_. + > If you are unable to launch the AppImage, you might have to install Fuse with the following command _([reference](https://github.com/ir-engine/ir-engine-control-center#1-app-not-launching-in-ubuntu-2204))_. > ```bash > sudo apt-get install fuse libfuse2 >``` @@ -187,8 +187,8 @@ In this step you will need to provide the following deployment information: - **Release Name**: This is the name of your release in selected kubernetes deployment. It can be `dev`, `prod`, `local`, etc, and will be used to prefix the workloads of your cluster. - > `{RELEASE_NAME}-etherealengine-client` - > eg: `prod-etherealengine-client` + > `{RELEASE_NAME}-ir-engine-client` + > eg: `prod-ir-engine-client` ### 2.3.3. Summary ![Create Cluster - Summary](../images/controlCenter/create-cluster-8.jpg) @@ -394,7 +394,7 @@ you will now be able to `Launch` the engine from the [options panel](#33-options 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). +Make sure to allow certificates as explained [here](https://etherealengine.github.io/ir-engine-docs/docs/devops_deployment/microk8s_linux#accept-invalid-certs). ::: ## 6. Workloads diff --git a/docs/manual/02_concepts/01_projects.md b/docs/manual/02_concepts/01_projects.md index 2b3e52c91882..6cda1ad3dd53 100644 --- a/docs/manual/02_concepts/01_projects.md +++ b/docs/manual/02_concepts/01_projects.md @@ -34,7 +34,7 @@ A project must also have a package.json to provide custom dependencies, and to d 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. -`@etherealengine/*` monorepo dependencies will be symlinked and not needed, but some package managers _(such as pnpm)_ require these to be defined. +`@ir-engine/*` monorepo dependencies will be symlinked and not needed, but some package managers _(such as pnpm)_ require these to be defined. If so, they should be defined in `peerDependencies` and kept up to date with the current engine version. ## Config @@ -120,4 +120,4 @@ The `databaseSeed` property is: ### Internationalization _(i18n)_ Internationalization can be added by using the pattern `./i18n//.json`. -An example of the format can be found in [the base i18n files](https://github.com/etherealengine/etherealengine/tree/dev/packages/client-core/i18n). +An example of the format can be found in [the base i18n files](https://github.com/ir-engine/ir-engine/tree/dev/packages/client-core/i18n). diff --git a/docs/manual/02_scene/01_studio/01_overview/index.md b/docs/manual/02_scene/01_studio/01_overview/index.md index cdf11dfb2454..3c036ca50fa6 100644 --- a/docs/manual/02_scene/01_studio/01_overview/index.md +++ b/docs/manual/02_scene/01_studio/01_overview/index.md @@ -4,7 +4,7 @@ # Studio Overview 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`_ +> _eg: When the engine is hosted at `ir-engine-mt-dev.theinfinitereality.io`, the studio would be accessed from `ir-engine-mt-dev.theinfinitereality.io/studio`_ Opening a project will open the editor, from which you can then load any scenes contained in your project. diff --git a/docs/manual/03_modules/01_engine/08_debugging/03_deployedInstanceServers.md b/docs/manual/03_modules/01_engine/08_debugging/03_deployedInstanceServers.md index daabb57a2fa5..c1eb32fb7086 100644 --- a/docs/manual/03_modules/01_engine/08_debugging/03_deployedInstanceServers.md +++ b/docs/manual/03_modules/01_engine/08_debugging/03_deployedInstanceServers.md @@ -19,7 +19,7 @@ e.g. `kubectl logs prod-instanceserver-vhwh2-9vqrv -c prod-instanceserver -f`. I and instanceserver pod: ``` -> @etherealengine/instanceserver@1.3.0 start +> @ir-engine/packages/instanceserver@1.3.0 start > cross-env APP_ENV=production ts-node --swc src/index.ts šŸ‘¾ bitECS - resizing all data stores from 100000 to 5000 diff --git a/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/01_microk8s_linux.md b/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/01_microk8s_linux.md index 1559934e1f18..4d71e2104f58 100644 --- a/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/01_microk8s_linux.md +++ b/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/01_microk8s_linux.md @@ -44,7 +44,7 @@ Another alternative is to follow the instructions for how to [install Kubernetes ## Download iR Engine To build the iR Engine Docker image locally, and to have a pre-tested way to run various local services, you'll need to download the iR Engine repository to your device. The easiest way to do this is by running the following command in your Ubuntu terminal: ```bash -git clone https://github.com/etherealengine/etherealengine.git +git clone https://github.com/ir-engine/ir-engine.git ``` You can create an `.env.local` file by duplicating `.env.local.default` if it does not already exist in the root folder of iR Engine's repository. @@ -155,7 +155,7 @@ These are some possible warnings and their potential fixes: You'll need to edit your `hosts` file to redirect certain domains to your host machine IP address. Add or update the following line into your `/etc/hosts` file: ``` -127.0.0.1 local.etherealengine.org api-local.etherealengine.org instanceserver-local.etherealengine.org 00000.instanceserver-local.etherealengine.org 00001.instanceserver-local.etherealengine.org 00002.instanceserver-local.etherealengine.org 00003.instanceserver-local.etherealengine.org +127.0.0.1 local.etherealengine.org api-local.theinfinitereality.io instanceserver-local.theinfinitereality.io 00000.instanceserver-local.theinfinitereality.io 00001.instanceserver-local.theinfinitereality.io 00002.instanceserver-local.theinfinitereality.io 00003.instanceserver-local.theinfinitereality.io ``` > On Linux this can be done by running `sudo gedit /etc/hosts` > Make sure to save the file after editing. You will need administrator permissions to do so. @@ -283,13 +283,13 @@ This will use a Helm config file titled `local.values.yaml` to configure the dep There is a [template](https://github.com/ir-engine/ir-engine-ops/blob/master/configs/local.microk8s.template.values.yaml) for this file in [ir-engine-ops](https://github.com/ir-engine/ir-engine-ops/) repo. If you are using a local file server, as explained in one of the previous steps, you will need to update the variable `api.fileServer.hostUploadFolder` in the `local.values.yaml` file with a value similar to `ENGINE_FULL_PATH/packages/server/upload`. -_e.g. `/home/username/etherealengine/packages/server/upload`._ +_e.g. `/home/username/ir-engine/packages/server/upload`._ It is mandatory that it points to the `/packages/server/upload` folder of your iR Engine folder. ## Deploy iR Engine Helm chart Run the following command: ```bash -helm install -f -f local etherealengine/etherealengine +helm install -f -f local ir-engine/ir-engine ``` > Important: > Make sure to change `/path/to/local.values.yaml` and `/path/to/db-refresh-true.values.yaml` with the actual path of the files. @@ -300,7 +300,7 @@ After a minute or so, running `kubectl get pods` should show one or more instanc Setting the option `FORCE_DB_REFRESH=true` made the api servers (re)initialize the database. Since you don't want that to happen every time a new api pod starts, run the following command to restart the API pods and configure them to not reinit the database on boot. ```bash -helm upgrade --reuse-values -f local etherealengine/etherealengine +helm upgrade --reuse-values -f local ir-engine/ir-engine ``` > Important: > Make sure to change `/path/to/db-refresh-true.values.yaml` with the actual path of the file. @@ -322,8 +322,8 @@ When loading the engine's website for the first time you'll have to tell your br - Reload your iR Engine's tab You need to do this for the following domains: -- `wss://api-local.etherealengine.org` -> https://api-local.etherealengine.org -- `wss://instanceserver-local.etherealengine.org` -> https://instanceserver-local.etherealengine.org +- `wss://api-local.theinfinitereality.io` -> https://api-local.theinfinitereality.io +- `wss://instanceserver-local.theinfinitereality.io` -> https://instanceserver-local.theinfinitereality.io - https://localhost:9000 > If the engine's website keeps displaying `loading routes` progress for a long time, it means that you have to allow the engine's certificates. diff --git a/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/01_microk8s_windows.md b/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/01_microk8s_windows.md index 31d00ca9774b..946dfa471c7c 100644 --- a/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/01_microk8s_windows.md +++ b/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/01_microk8s_windows.md @@ -139,7 +139,7 @@ While you can follow the demo instructions there about starting MicroK8s, deploy To build the iR Engine Docker image locally, and to have a pre-tested way to run various local services, you'll need to get the iR Engine repo on your machine. This is most easily done by running following command in WSL Ubuntu terminal. ```bash -git clone https://github.com/etherealengine/etherealengine.git etherealengine +git clone https://github.com/ir-engine/ir-engine.git etherealengine ``` If `.env.local` file does not exist in the root of your repo folder then create it by duplicating `.env.local.default`. @@ -246,7 +246,7 @@ From the above output, use `172.31.89.133` as `{WSL_IP}`. Next, edit your Windows hostfile, this is done by editing `C:\Windows\System32\drivers\etc\hosts`. Add/Update the following lines: ```conf -{WSL_IP} local.etherealengine.org api-local.etherealengine.org instanceserver-local.etherealengine.org 00000.instanceserver-local.etherealengine.org 00001.instanceserver-local.etherealengine.org 00002.instanceserver-local.etherealengine.org 00003.instanceserver-local.etherealengine.org +{WSL_IP} local.etherealengine.org api-local.theinfinitereality.io instanceserver-local.theinfinitereality.io 00000.instanceserver-local.theinfinitereality.io 00001.instanceserver-local.theinfinitereality.io 00002.instanceserver-local.theinfinitereality.io 00003.instanceserver-local.theinfinitereality.io {WSL_IP} microk8s.registry ``` @@ -351,12 +351,12 @@ kubectl get pods Run the following command: ```bash -helm install -f -f local etherealengine/etherealengine +helm install -f -f local ir-engine/ir-engine ``` > [db-refresh-true.values.yaml](https://github.com/ir-engine/ir-engine-ops/blob/master/configs/db-refresh-true.values.yaml) can be found in [ir-engine-ops](https://github.com/ir-engine/ir-engine-ops/) repo. -After a minute or so, running `kubectl get pods` should show one or more instanceservers, one or more api servers, and one client server in the Running state. Setting `FORCE_DB_REFRESH=true` made the api servers (re)initialize the database. Since you don't want that to happen every time a new api pod starts, run `helm upgrade --reuse-values -f local etherealengine/etherealengine`. The API pods will restart and will now not attempt to reinit the database on boot. +After a minute or so, running `kubectl get pods` should show one or more instanceservers, one or more api servers, and one client server in the Running state. Setting `FORCE_DB_REFRESH=true` made the api servers (re)initialize the database. Since you don't want that to happen every time a new api pod starts, run `helm upgrade --reuse-values -f local ir-engine/ir-engine`. The API pods will restart and will now not attempt to reinit the database on boot. > [db-refresh-false.values.yaml](https://github.com/ir-engine/ir-engine-ops/blob/master/configs/db-refresh-false.values.yaml) can be found in [ir-engine-ops](https://github.com/ir-engine/ir-engine-ops/) repo. @@ -367,8 +367,8 @@ Since there are no valid certificates for this domain, you'll have to tell your Go to \, you should see a warning about an invalid certificate; accept this invalid cert to get to the home page. Next if it keeps displaying 'loading routes' progress for a long time, it is due to the fact that you have to allow certificates. You'll have to open the dev tools for your browser and go to the 'Console' tab. You will see some errors in URL address starting with 'wss'. Replace 'wss' with 'https' and open it in new tab. Accept the certificate and reload your iR Engine tab. You need to do this for following domains: -- wss://api-local.etherealengine.org -> https://api-local.etherealengine.org -- wss://instanceserver-local.etherealengine.org -> https://instanceserver-local.etherealengine.org +- wss://api-local.theinfinitereality.io -> https://api-local.theinfinitereality.io +- wss://instanceserver-local.theinfinitereality.io -> https://instanceserver-local.theinfinitereality.io - https://localhost:9000 > You can open Developer tools in Chrome by clicking the side menu with three dots, then More tools > Developer tools (or use Ctrl+Shift+I) diff --git a/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/02_dockerDesktop.md b/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/02_dockerDesktop.md index db928ee724f7..658045e73725 100644 --- a/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/02_dockerDesktop.md +++ b/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/02_dockerDesktop.md @@ -11,7 +11,7 @@ You may also need to install [Docker Compose](https://docs.docker.com/compose/in ## Clone iR Engine repo to your local machine To build the iR Engine Docker image locally, and to have a pre-tested way to run various local services, you'll need to get the iR Engine repo on your machine. This is most easily -done by running `git clone https://github.com/etherealengine/etherealengine.git` +done by running `git clone https://github.com/ir-engine/ir-engine.git` ## Start MinIO & MariaDB server locally via Docker @@ -34,7 +34,7 @@ to its Kubernetes cluster. On Linux, this is done by running `sudo gedit /etc/ho Add the following line: ``` -127.0.0.1 local.etherealengine.org api-local.etherealengine.org instanceserver-local.etherealengine.org 00000.instanceserver-local.etherealengine.org 00001.instanceserver-local.etherealengine.org 00002.instanceserver-local.etherealengine.org 00003.instanceserver-local.etherealengine.org +127.0.0.1 local.etherealengine.org api-local.theinfinitereality.io instanceserver-local.theinfinitereality.io 00000.instanceserver-local.theinfinitereality.io 00001.instanceserver-local.theinfinitereality.io 00002.instanceserver-local.theinfinitereality.io 00003.instanceserver-local.theinfinitereality.io ``` You should also see a section that looks like this: @@ -119,14 +119,14 @@ a [template](https://github.com/ir-engine/ir-engine-ops/blob/master/configs/loca If you are using local file server as explained a couple of steps earlier then, update 'local.values.yaml' variable `api.fileServer.hostUploadFolder` with value e.g. '/hosthome/\/\/packages/server/upload'. The folder must be in home folder and make sure to use /hosthome/ instead of home in path. It's mandatory to point to `/packages/server/upload` folder of your engine folder. ## Deploy iR Engine Helm chart -Run the following command: `helm install -f -f local etherealengine/etherealengine`. +Run the following command: `helm install -f -f local ir-engine/ir-engine`. > [db-refresh-true.values.yaml](https://github.com/ir-engine/ir-engine-ops/blob/master/configs/db-refresh-true.values.yaml) can be found in [ir-engine-ops](https://github.com/ir-engine/ir-engine-ops/) repo. After a minute or so, running `kubectl get pods` should show one or more instanceservers, one or more api servers, and one client server in the Running state. Setting `FORCE_DB_REFRESH=true` made the api servers (re)initialize the database. Since you don't want that to happen every time a new api pod starts, run -`helm upgrade --reuse-values -f local etherealengine/etherealengine`. +`helm upgrade --reuse-values -f local ir-engine/ir-engine`. The API pods will restart and will now not attempt to reinit the database on boot. > [db-refresh-false.values.yaml](https://github.com/ir-engine/ir-engine-ops/blob/master/configs/db-refresh-false.values.yaml) can be found in [ir-engine-ops](https://github.com/ir-engine/ir-engine-ops/) repo. @@ -138,8 +138,8 @@ Since there are no valid certificates for this domain, you'll have to tell your Go to \, you should see a warning about an invalid certificate; accept this invalid cert to get to the home page. Next if it keeps displaying 'loading routes' progress for a long time, it is due to the fact that you have to allow certificates. You'll have to open the dev tools for your browser and go to the 'Console' tab. You will see some errors in URL address starting with 'wss'. Replace 'wss' with 'https' and open it in new tab. Accept the certificate and reload your iR Engine tab. You need to do this for following domains: -- wss://api-local.etherealengine.org -> https://api-local.etherealengine.org -- wss://instanceserver-local.etherealengine.org -> https://instanceserver-local.etherealengine.org +- wss://api-local.theinfinitereality.io -> https://api-local.theinfinitereality.io +- wss://instanceserver-local.theinfinitereality.io -> https://instanceserver-local.theinfinitereality.io - https://localhost:9000 > You can open Developer tools in Chrome by clicking the side menu with three dots, then More tools > Developer tools (or use Ctrl+Shift+I) diff --git a/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/02_minikube.md b/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/02_minikube.md index 1c6e3046b7c6..8a2d76787d46 100644 --- a/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/02_minikube.md +++ b/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/02_minikube.md @@ -19,7 +19,7 @@ your minikube cluster, since we have some specific starting requirements. ## Clone iR Engine repo to your local machine To build the iR Engine Docker image locally, and to have a pre-tested way to run various local services, you'll need to get the iR Engine repo on your machine. This is most easily -done by running `git clone https://github.com/etherealengine/etherealengine.git` +done by running `git clone https://github.com/ir-engine/ir-engine.git` ## Start MinIO & MariaDB server locally via Docker @@ -60,7 +60,7 @@ this is done by running `sudo gedit /etc/hosts`. Add the following lines: ```conf - local.etherealengine.org api-local.etherealengine.org instanceserver-local.etherealengine.org 00000.instanceserver-local.etherealengine.org 00001.instanceserver-local.etherealengine.org 00002.instanceserver-local.etherealengine.org 00003.instanceserver-local.etherealengine.org + local.etherealengine.org api-local.theinfinitereality.io instanceserver-local.theinfinitereality.io 00000.instanceserver-local.theinfinitereality.io 00001.instanceserver-local.theinfinitereality.io 00002.instanceserver-local.theinfinitereality.io 00003.instanceserver-local.theinfinitereality.io 10.0.2.2 host.minikube.internal ``` @@ -172,14 +172,14 @@ a [template](https://github.com/ir-engine/ir-engine-ops/blob/master/configs/loca If you are using local file server as explained couple of steps earlier then, update 'local.values.yaml' variable `api.fileServer.hostUploadFolder` with value e.g. '/hosthome/\/\/packages/server/upload'. The folder must be in home folder and make sure to use /hosthome/ instead of home in path. Its mandatory to point to `/packages/server/upload` folder of your engine folder. ## Deploy iR Engine Helm chart -Run the following command: `helm install -f -f local etherealengine/etherealengine`. +Run the following command: `helm install -f -f local ir-engine/ir-engine`. > [db-refresh-true.values.yaml](https://github.com/ir-engine/ir-engine-ops/blob/master/configs/db-refresh-true.values.yaml) can be found in [ir-engine-ops](https://github.com/ir-engine/ir-engine-ops/) repo. After a minute or so, running `kubectl get pods` should show one or more instanceservers, one or more api servers, and one client server in the Running state. Setting `FORCE_DB_REFRESH=true` made the api servers (re)initialize the database. Since you don't want that to happen every time a new api pod starts, run -`helm upgrade --reuse-values -f local etherealengine/etherealengine`. +`helm upgrade --reuse-values -f local ir-engine/ir-engine`. The API pods will restart and will now not attempt to reinit the database on boot. > [db-refresh-false.values.yaml](https://github.com/ir-engine/ir-engine-ops/blob/master/configs/db-refresh-false.values.yaml) can be found in [ir-engine-ops](https://github.com/ir-engine/ir-engine-ops/) repo. @@ -191,8 +191,8 @@ Since there are no valid certificates for this domain, you'll have to tell your Go to \, you should see a warning about an invalid certificate; accept this invalid cert to get to the home page. Next if it keeps displaying 'loading routes' progress for a long time, it is due to the fact that you have to allow certificates. You'll have to open the dev tools for your browser and go to the 'Console' tab. You will see some errors in URL address starting with 'wss'. Replace 'wss' with 'https' and open it in new tab. Accept the certificate and reload your iR Engine tab. You need to do this for following domains: -- wss://api-local.etherealengine.org -> https://api-local.etherealengine.org -- wss://instanceserver-local.etherealengine.org -> https://instanceserver-local.etherealengine.org +- wss://api-local.theinfinitereality.io -> https://api-local.theinfinitereality.io +- wss://instanceserver-local.theinfinitereality.io -> https://instanceserver-local.theinfinitereality.io - https://localhost:9000 > You can open Developer tools in Chrome by clicking the side menu with three dots, then More tools > Developer tools (or use Ctrl+Shift+I) diff --git a/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/03_AWSSetup/02_EKS.md b/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/03_AWSSetup/02_EKS.md index ebcc7342514e..599ff47db9f7 100644 --- a/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/03_AWSSetup/02_EKS.md +++ b/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/03_AWSSetup/02_EKS.md @@ -57,7 +57,7 @@ the recent high traffic picking up again. The OIDC provider that was created in the prior step, installing the EBS CSI Addon, can be re-used in this step. #### Create launch template -Go to EC2 -> Launch Templates and make a new one. Name it something like 'etherealengine-production-instanceserver'. +Go to EC2 -> Launch Templates and make a new one. Name it something like 'ir-engine-production-instanceserver'. Most settings can be left as-is, except for the following: * Storage -> Add a volume, set the size to ~20GB, and for Device name select '/dev/xvda'. * Network Interfaces -> Add one, and under 'Auto-assign public IP' select 'Enable' diff --git a/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/03_AWSSetup/03_ECR.md b/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/03_AWSSetup/03_ECR.md index 18931f86a299..a50ab63e2b19 100644 --- a/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/03_AWSSetup/03_ECR.md +++ b/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/03_AWSSetup/03_ECR.md @@ -8,20 +8,20 @@ iR Engine project codebase(s) getting out, you can choose Private for Visibility You'll be needing to create multiple repositories for each deployment, e.g. several repos for a `dev` deployment, several more for a `prod` deployment, etc. -Assuming you're first doing a `dev` deployment, name the first repo `etherealengine--builder` under Repository -Name, e.g. `etherealengine-dev-builder`. You shouldn't need to change any other settings, though if you're using a Private +Assuming you're first doing a `dev` deployment, name the first repo `ir-engine--builder` under Repository +Name, e.g. `ir-engine-dev-builder`. You shouldn't need to change any other settings, though if you're using a Private repo and want to turn on Tag Immutability, that's fine. The image tags that are generated should never collide, but it will prevent any manual overwriting of a tag. Click Create Repository. You will need to make four more repos for each of the services that are deployed as part of the iR Engine stack - -`api`, `client`, `instanceserver` and `taskserver`, which are also in the form `etherealengine--`. -e.g. `etherealengine-dev-api`, `etherealengine-dev-client`, `etherealengine-dev-instanceserver` and `etherealengine-dev-taskserver`. +`api`, `client`, `instanceserver` and `taskserver`, which are also in the form `ir-engine--`. +e.g. `ir-engine-dev-api`, `ir-engine-dev-client`, `ir-engine-dev-instanceserver` and `ir-engine-dev-taskserver`. Everything else can be left alone for those, too. On the [repositories page](https://us-west-1.console.aws.amazon.com/ecr/repositories), you should see all of the repositories you made. If you don't see any, you may be on the wrong tab up top - click Private or Public to switch between them. Also check that you're in the right AWS region. You'll see a column 'URI'. If you made public repos, -the URIs should be in the form `public.ecr.aws//etherealengine-(-builder)`; if you made private -repos, the URIs should be in the form `.dkr.ecr..amazonaws.com/etherealengine-(-builder)`. -Take note of everything before the `/etherealengine-` - you'll need to add that as a variable in later steps. +the URIs should be in the form `public.ecr.aws//ir-engine-(-builder)`; if you made private +repos, the URIs should be in the form `.dkr.ecr..amazonaws.com/ir-engine-(-builder)`. +Take note of everything before the `/ir-engine-` - you'll need to add that as a variable in later steps. It will be called `ECR_URL` there. diff --git a/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/03_AWSSetup/04_IAM.md b/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/03_AWSSetup/04_IAM.md index a6a6aa13f9b3..b81f42c465e1 100644 --- a/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/03_AWSSetup/04_IAM.md +++ b/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/03_AWSSetup/04_IAM.md @@ -59,15 +59,15 @@ mapRoles: - groups: - system:bootstrappers - system:nodes - rolearn: arn:aws:iam:::role/eksctl-etherealengine-test-nodegro-NodeInstanceRole-dXwOpisgTD1e + rolearn: arn:aws:iam:::role/eksctl-ir-engine-test-nodegro-NodeInstanceRole-dXwOpisgTD1e username: system:node:{{EC2PrivateDNSName}} mapUsers: ---- - groups: - system:masters - userarn: arn:aws:iam:::user/etherealengine-eks - username: etherealengine-eks + userarn: arn:aws:iam:::user/ir-engine-eks + username: ir-engine-eks ``` Copy the value of `rolearn` in the entry for mapRoles and paste that in the template copy to replace ``. @@ -77,13 +77,13 @@ In the mapUsers section, you'll need to make as many copies of the following as ```yaml - groups: - system:masters - userarn: arn:aws:iam:::user/etherealengine-eks - username: etherealengine-eks + userarn: arn:aws:iam:::user/ir-engine-eks + username: ir-engine-eks ``` :::important Make sure to have an entry for the user who made the cluster. -In the example above, that's `etherealengine-eks`. +In the example above, that's `ir-engine-eks`. ::: Replace `` with the AWS account ID, and both instances of `` with the username you want to grant access. diff --git a/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/03_AWSSetup/11_S3Cloudfront.md b/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/03_AWSSetup/11_S3Cloudfront.md index 4f2bd716f153..93a164083a51 100644 --- a/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/03_AWSSetup/11_S3Cloudfront.md +++ b/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/03_AWSSetup/11_S3Cloudfront.md @@ -6,7 +6,7 @@ from the Storage Provider, then all client files will be stored and served from ### Create S3 bucket In the AWS web client, go to S3 -> Buckets and click Create Bucket. -Name the bucket `-static-resources`, e.g. ```etherealengine-static-resources```, and have it be in Region us-east-1. +Name the bucket `-static-resources`, e.g. ```ir-engine-static-resources```, and have it be in Region us-east-1. Under Object Ownership, select 'ACLs enabled', and under that select 'Object Writer'. Under Block Public Access Settings For The Bucket, uncheck the checkbox Block *all* Public Access; you need the bucket to be publicly accessible. diff --git a/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/03_AWSSetup/13_fork.md b/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/03_AWSSetup/13_fork.md index f951093331a7..67de451daa4c 100644 --- a/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/03_AWSSetup/13_fork.md +++ b/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/03_AWSSetup/13_fork.md @@ -4,7 +4,7 @@ The iR Engine codebase is most easily deployed by forking it and configuring som Actions can run the deployment for you. You can run all of the commands that the ``-deploy action runs manually if you so choose, and in that case, you don't need to fork the GH repo. -Go to https://github.com/etherealengine/etherealengine. In the upper right-hand corner, there's a button 'Fork'. Click that, +Go to https://github.com/ir-engine/ir-engine. In the upper right-hand corner, there's a button 'Fork'. Click that, then click the account/organization you wish to fork it to. You should be taken to your fork in a short time. You'll need to set several Secrets (runtime variables) for GitHub Actions. By default GitHub Actions should be fully @@ -19,8 +19,8 @@ this page to make a new one. You will need to make several Secrets with the foll * EKS_AWS_SECRET -> The secret key of the EKSUser IAM user * CLUSTER_NAME -> The name of the EKS cluster * DEPLOYMENTS_ENABLED -> Set to `true` -* DEV_REPO_NAME -> The base name of the dev ECR repository, e.g. `etherealengine-dev` (all references to the builder and service repos will append `-builder`/`-` to this value) -* DEV_REPO_URL -> The root URL for your repos, i.e. everything before the `/etherealengine-dev-builder`, e.g. `11111111111.dkr.ecr.us-west-1.amazonaws.com` or `public.ecr.aws/a1b2c3d4`. If pushing to Docker Hub, this should have `docker.io/` before the organization name, e.g. `docker.io/myorg . +* DEV_REPO_NAME -> The base name of the dev ECR repository, e.g. `ir-engine-dev` (all references to the builder and service repos will append `-builder`/`-` to this value) +* DEV_REPO_URL -> The root URL for your repos, i.e. everything before the `/ir-engine-dev-builder`, e.g. `11111111111.dkr.ecr.us-west-1.amazonaws.com` or `public.ecr.aws/a1b2c3d4`. If pushing to Docker Hub, this should have `docker.io/` before the organization name, e.g. `docker.io/myorg . * PRIVATE_REPO -> Set this to `true` if your repos are private; if they're public you don't need to set this at all. * REPO_PROVIDER -> The provider of the container repos; currently allowed values are `aws` for ECR and `dockerhub` for Docker Hub. diff --git a/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/03_AWSSetup/15_EKSDeploy.md b/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/03_AWSSetup/15_EKSDeploy.md index cbb74cdd5eef..b6628ce8c2e2 100644 --- a/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/03_AWSSetup/15_EKSDeploy.md +++ b/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/03_AWSSetup/15_EKSDeploy.md @@ -51,7 +51,7 @@ initial nodegroup. If you're using a private ECR repo, set this to "true" in the builder config file. #### (everything).image.repository -You'll need to replace every \ with the full ECR_URL of your non-builder repos, e.g. `abcd1234efgh.dkr.ecr.us-west-1.amazonaws.com/etherealengine-dev-api`. +You'll need to replace every \ with the full ECR_URL of your non-builder repos, e.g. `abcd1234efgh.dkr.ecr.us-west-1.amazonaws.com/ir-engine-dev-api`. Each service has to have the proper `-` suffix on it, e.g. `-api`, `-client`, etc. #### GITHUB_CLIENT_ID/GITHUB_CLIENT_SECRET @@ -61,8 +61,8 @@ See [this document](../setupGithubOAuth) for more information, and enter the appropriate ID/secret in these variables. ### Run Helm install -Run ```helm install -f .values.yaml> -builder etherealengine/etherealengine-builder``` -and then run ```helm install -f .values.yaml> etherealengine/etherealengine``` +Run ```helm install -f .values.yaml> -builder ir-engine/ir-engine-builder``` +and then run ```helm install -f .values.yaml> ir-engine/ir-engine``` This will spin up the main and builder deployments using the Helm config file, \.values.yaml. Neither will fully work yet, since there's no valid image in the repos yet. The GitHub diff --git a/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/03_AWSSetup/16_githubActions.md b/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/03_AWSSetup/16_githubActions.md index 1200bc380b7b..21c6b14d23a0 100644 --- a/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/03_AWSSetup/16_githubActions.md +++ b/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/03_AWSSetup/16_githubActions.md @@ -10,7 +10,7 @@ attempt to build and deploy the builder. ### Overview of the build process The full build and deployment process works like this: 1. GitHub Actions builds just enough of the iR Engine monorepo to fetch any installed iR Engine projects. -2. GitHub Actions pushes this builder Docker image to the repo `etherealengine--builder` in ECR +2. GitHub Actions pushes this builder Docker image to the repo `ir-engine--builder` in ECR 3. GitHub Actions updates the builder deployment to point to the builder image it just created. 4. The builder deployment spins up the builder Docker image on its single node 5. The builder connects to the deployment's database and checks if there is a table `user`. This is a proxy @@ -19,7 +19,7 @@ The full build and deployment process works like this: 6. The builder downloads any iR Engine projects that the deployment has added. 7. The builder builds the Docker image for each service concurrently using these projects, building them into the client files as well as copying them so that the api and instanceservers have access to them. If serving client files from the Storage Provider, the client files will be pushed to S3 -8. The builder pushes these final Docker images to the repos `etherealengine--` in ECR (not the client image if serving client files from the Storage Provider) +8. The builder pushes these final Docker images to the repos `ir-engine--` in ECR (not the client image if serving client files from the Storage Provider) 9. The builder caches all of the layers of each Docker file in S3 for faster build times on subsequent builds 10. The builder updates the main deployment to point to the final images it just created. 11. The main deployment spins up the final Docker images for the api, client (optional), instanceserver and taskserver services. diff --git a/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/03_AWSSetup/17_elasticKibana.md b/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/03_AWSSetup/17_elasticKibana.md index d6394af0a35b..eed5b01e9c01 100644 --- a/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/03_AWSSetup/17_elasticKibana.md +++ b/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/03_AWSSetup/17_elasticKibana.md @@ -28,7 +28,7 @@ In order to connect logger with elasticsearch, update config file(values.yml) fo One of the features of Helm is being able to easily upgrade deployments with new values. The command to do this is very similar to the install command: -```helm upgrade --reuse-values -f --set api.image.tag=,client.image.tag=,instanceserver.image.tag= etherealengine/etherealengine``` +```helm upgrade --reuse-values -f --set api.image.tag=,client.image.tag=,instanceserver.image.tag= ir-engine/ir-engine``` ```--reuse-values``` says to carry over all configuration values from the previous deployment. This is most important for tags, since they're usually set inline with the `helm install/upgrade` command, not a Helm config. diff --git a/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/04_AppleSSOSetup/02_generateClientSecret.md b/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/04_AppleSSOSetup/02_generateClientSecret.md index 36acbfa53e68..b8f54912489d 100644 --- a/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/04_AppleSSOSetup/02_generateClientSecret.md +++ b/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/04_AppleSSOSetup/02_generateClientSecret.md @@ -39,7 +39,7 @@ Every 6 months, when the Client Secret expires, you have to get it updated in th 4. Also update the Client Secret value in the "Values.yaml" file for both the main release and builder. You can use the following command as reference for updating the Client Secret in Values.yaml files of the deployments. Run the command separately for Main and Builder release while updating the corresponding values accordingly. ```shell -helm repo update && helm upgrade --reuse-values --set api.extraEnv.APPLE_CALLBACK_URL=\ --set api.extraEnv.APPLE_CLIENT_ID=\ --set api.extraEnv.APPLE_CLIENT_SECRET=\ --set media.extraEnv.APPLE_CALLBACK_URL=\ --set media.extraEnv.APPLE_CLIENT_ID=\ --set media.extraEnv.APPLE_CLIENT_SECRET="\" \
etherealengine/etherealengine +helm repo update && helm upgrade --reuse-values --set api.extraEnv.APPLE_CALLBACK_URL=\ --set api.extraEnv.APPLE_CLIENT_ID=\ --set api.extraEnv.APPLE_CLIENT_SECRET=\ --set media.extraEnv.APPLE_CALLBACK_URL=\ --set media.extraEnv.APPLE_CLIENT_ID=\ --set media.extraEnv.APPLE_CLIENT_SECRET="\" \
ir-engine/ir-engine ``` ## Future Work and Recommendations diff --git a/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/04_databaseMigrations.md b/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/04_databaseMigrations.md index 1297d8cc2e81..ad1fec3c98a2 100644 --- a/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/04_databaseMigrations.md +++ b/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/04_databaseMigrations.md @@ -18,6 +18,6 @@ npm run migrate:make -- {NAME} Our server is set up with Swagger documentation to automatically generate from most endpoints. A few custom routes are not documented, but most of the basic stuff is. -You can see the OpenAPI docs in on our [dev cluster](https://api-dev.etherealengine.com/openapi), or locally for a running iR Engine instance at: +You can see the OpenAPI docs in on our [dev cluster](https://api-ir-engine-mt-dev.theinfinitereality.io/openapi), or locally for a running iR Engine instance at: https://localhost:3030/openapi diff --git a/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/05_setupGithubOAuth.md b/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/05_setupGithubOAuth.md index 2dd3c9488157..c9ead2e950c1 100644 --- a/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/05_setupGithubOAuth.md +++ b/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/05_setupGithubOAuth.md @@ -85,10 +85,10 @@ Open your Helm configuration. Enter the Client ID for `GITHUB_CLIENT_ID` and the double quotes in the .yaml file, so that they are interpreted as strings even if they start with a number, e.g. `GITHUB_CLIENT_ID: "17592577832789234"` -Next, run `helm upgrade --reuse-values -f --set-string api.extraEnv.FORCE_DB_REFRESH=true etherealengine/etherealengine`. +Next, run `helm upgrade --reuse-values -f --set-string api.extraEnv.FORCE_DB_REFRESH=true ir-engine/ir-engine`. This tells Helm to restart the API servers, and for them to wipe the database and reseed it with the values in the configuration file. It should only take a minute or two, and you should then run -`helm upgrade --reuse-values --set-string api.extraEnv.FORCE_DB_REFRESH=false etherealengine/etherealengine` to unset +`helm upgrade --reuse-values --set-string api.extraEnv.FORCE_DB_REFRESH=false ir-engine/ir-engine` to unset the flag telling it to reset the database. Once this is done, you should be able to log in with GitHub and be granted admin status. diff --git a/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/07_releaseHelmChart.md b/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/07_releaseHelmChart.md index cdc318c42874..1e821b4e33eb 100644 --- a/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/07_releaseHelmChart.md +++ b/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/07_releaseHelmChart.md @@ -7,11 +7,11 @@ These are the steps that needs to be taken in order to update an iR Engine Helm > - Have a checked-out copy of https://github.com/ir-engine/ir-engine-ops/ > set to the `master` branch 1. Set working directory to local `ir-engine-ops` folder: `cd ir-engine-ops` -2. Increase the version number in `etherealengine/Chart.yaml` +2. Increase the version number in `ir-engine/Chart.yaml` 3. Run `helm package etherealengine` 4. Run `helm repo index --url https://helm.etherealengine.org .` -5. Copy `etherealengine-X.Y.Z.tgz` that's generated to the root of the `ir-engine-helm` repo, and make sure to `git add` it. +5. Copy `ir-engine-X.Y.Z.tgz` that's generated to the root of the `ir-engine-helm` repo, and make sure to `git add` it. 6. Open `index.yaml`. Under entries.xrengine, there should be an entry for the new version. -7. Copy that entry to `ir-engine-helm`'s `index.yaml`, making sure to put it under the right `entries` section; we've got `etherealengine-builder` and `etherealengine` in the same file, so pay attention to which one you're putting it in. Also make sure that the spacing/indentation matches the other entries. +7. Copy that entry to `ir-engine-helm`'s `index.yaml`, making sure to put it under the right `entries` section; we've got `ir-engine-builder` and `ir-engine` in the same file, so pay attention to which one you're putting it in. Also make sure that the spacing/indentation matches the other entries. 8. Copy the `generated` line from `index.yaml` to `ir-engine-helm/index.yaml`, overwriting the `generated` line that's there. 9. Commit this, and push it to the `gh-pages` branch of `ir-engine-helm`. Within a couple of minutes, you should see the new version appear at https://helm.etherealengine.org/ diff --git a/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/08_upgradeHelmDeployment.md b/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/08_upgradeHelmDeployment.md index 0c0400152ab6..16eabd1f60c5 100644 --- a/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/08_upgradeHelmDeployment.md +++ b/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/08_upgradeHelmDeployment.md @@ -26,9 +26,9 @@ helm plugin install https://github.com/databus23/helm-diff Now that the `helm diff` plugin is installed, you can run the following command: ```bash -helm diff upgrade [DEPLOYMENT_NAME] etherealengine/etherealengine --values [PATH_TO_VALUES_YAML] +helm diff upgrade [DEPLOYMENT_NAME] ir-engine/ir-engine --values [PATH_TO_VALUES_YAML] ``` -> eg: `helm diff upgrade dev etherealengine/etherealengine --values ~/etherealengine-ops/values/dev.ethereal.values.yaml` +> eg: `helm diff upgrade dev ir-engine/ir-engine --values ~/ir-engine-ops/values/dev.ethereal.values.yaml` This will print the differences between the deployed helm release `values.yaml` file and the specified `values.yaml` file. > Note: When the output is empty it means that there are no differences/changes. @@ -36,6 +36,6 @@ This will print the differences between the deployed helm release `values.yaml` ## Upgrading Helm Deployment Now that the local `values.yaml` file is updated, the following command will upgrade the Helm deployment with the correct configuration: ```bash -helm upgrade [DEPLOYMENT_NAME] etherealengine/etherealengine --reuse-values -f [PATH_TO_VALUES_YAML] +helm upgrade [DEPLOYMENT_NAME] ir-engine/ir-engine --reuse-values -f [PATH_TO_VALUES_YAML] ``` -> eg: `helm upgrade dev etherealengine/etherealengine --reuse-values -f ~/etherealengine-ops/values/dev.ethereal.values.yaml` +> eg: `helm upgrade dev ir-engine/ir-engine --reuse-values -f ~/ir-engine-ops/values/dev.ethereal.values.yaml` diff --git a/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/_acceptCertificates.md b/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/_acceptCertificates.md index e13a4d0f17f7..a4023e0b5853 100644 --- a/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/_acceptCertificates.md +++ b/docs/manual/03_modules/05_infrastructure/03_devopsDeployment/_acceptCertificates.md @@ -2,8 +2,8 @@ Since there are no valid certificates for this domain, you'll have to tell your Go to \, you should see a warning about an invalid certificate; accept this invalid cert to get to the home page. Next if it keeps displaying 'loading routes' progress for a long time, it is due to the fact that you have to allow certificates. You'll have to open the dev tools for your browser and go to the 'Console' tab. You will see some errors in URL address starting with 'wss'. Replace 'wss' with 'https' and open it in new tab. Accept the certificate and reload your iR Engine tab. You need to do this for following domains: -- wss://api-local.etherealengine.org -> https://api-local.etherealengine.org -- wss://instanceserver-local.etherealengine.org -> https://instanceserver-local.etherealengine.org +- wss://api-local.theinfinitereality.io -> https://api-local.theinfinitereality.io +- wss://instanceserver-local.theinfinitereality.io -> https://instanceserver-local.theinfinitereality.io - https://localhost:9000 > You can open Developer tools in Chrome by clicking the side menu with three dots, then More tools > Developer tools (or use Ctrl+Shift+I) diff --git a/docs/manual/97_license.md b/docs/manual/97_license.md index 6c8f10e1ca95..33dbfce3ce7c 100644 --- a/docs/manual/97_license.md +++ b/docs/manual/97_license.md @@ -2,12 +2,12 @@ # License -iR Engine is [open-source](https://github.com/ir-engine/ir-engine), under the terms and conditions of the [CPAL](https://github.com/ir-engine/ir-engine/blob/dev/LICENSE) license. -Attribution is required if you wish to use iR Engine under [CPAL](https://github.com/ir-engine/ir-engine/blob/dev/LICENSE). -Please see the attribution guidelines in iR Engine's [LICENSE](https://github.com/ir-engine/ir-engine/blob/dev/LICENSE) file. +iR Engine is [open-source](https://github.com/ir-engine/ir-engine), under the terms and conditions of the [CPAL](https://github.com/ir-engine/ir-engine/LICENSE) license. +Attribution is required if you wish to use iR Engine under [CPAL](https://github.com/ir-engine/ir-engine/LICENSE). +Please see the attribution guidelines in iR Engine's [LICENSE](https://github.com/ir-engine/ir-engine/LICENSE) file. Other licensing options are available, please contact us for more information. -[CPAL](https://github.com/ir-engine/ir-engine/blob/dev/LICENSE) - Copyright (c) 2021-2023 iR Engine, formerly known as XREngine by XR Foundation +[CPAL](https://github.com/ir-engine/ir-engine/LICENSE) - Copyright (c) 2021-2023 iR Engine, formerly known as XREngine by XR Foundation diff --git a/docs/manual/98_contributing/index.md b/docs/manual/98_contributing/index.md index 0f9b73049af7..57a1f6f3818a 100644 --- a/docs/manual/98_contributing/index.md +++ b/docs/manual/98_contributing/index.md @@ -54,8 +54,8 @@ Talk about the engine with people you know. Let them know about those cool proje ## Contribute to iR Engine's development -iR Engine is an open-source project, based on the [CPAL](https://github.com/ir-engine/ir-engine/blob/dev/LICENSE) license. -You can find the source code of the engine on iR Engine's [GitHub](https://github.com/ir-engine/ir-engine) repository, and some guidelines on how to contribute to its codebase in the [Contributing](https://github.com/ir-engine/etherealengine#contributing) section of the repository's readme. +iR Engine is an open-source project, based on the [CPAL](https://github.com/ir-engine/ir-engine/LICENSE) license. +You can find the source code of the engine on iR Engine's [GitHub](https://github.com/ir-engine/ir-engine) repository, and some guidelines on how to contribute to its codebase in the [Contributing](https://github.com/ir-engine/ir-engine#contributing) section of the repository's readme. diff --git a/docs/manual/d__partials/acceptCertificates.md b/docs/manual/d__partials/acceptCertificates.md index 5912525f2729..9207babbf0d1 100644 --- a/docs/manual/d__partials/acceptCertificates.md +++ b/docs/manual/d__partials/acceptCertificates.md @@ -10,8 +10,8 @@ When loading the engine's website for the first time you'll have to tell your br - Reload your iR Engine's tab You need to do this for the following domains: -- `wss://api-local.etherealengine.org` -> https://api-local.etherealengine.org -- `wss://instanceserver-local.etherealengine.org` -> https://instanceserver-local.etherealengine.org +- `wss://api-local.theinfinitereality.io` -> https://api-local.theinfinitereality.io +- `wss://instanceserver-local.theinfinitereality.io` -> https://instanceserver-local.theinfinitereality.io - https://localhost:9000 > If the engine's website keeps displaying `loading routes` progress for a long time, it means that you have to allow the engine's certificates. diff --git a/docs/manual/d__partials/cloneInstructions.md b/docs/manual/d__partials/cloneInstructions.md index 8cb02a79f177..f11ce3aa75e7 100644 --- a/docs/manual/d__partials/cloneInstructions.md +++ b/docs/manual/d__partials/cloneInstructions.md @@ -1,5 +1,5 @@ ```bash -git clone https://github.com/etherealengine/etherealengine --depth 1 +git clone https://github.com/ir-engine/ir-engine --depth 1 ``` > **Warning**: > Adding `--depth=1` will significantly reduce the amount of data downloaded when cloning, but it will also create a `Shallow Copy` of the engine's repository. diff --git a/package.json b/package.json index f9fbd2a5853e..efd6da9b63d4 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "name": "@etherealengine/docs", + "name": "@ir-engine/docs", "version": "0.0.0", "private": true, "scripts": { diff --git a/src/pages/overview.md b/src/pages/overview.md index c9f1a0dbfcf6..71f11bc0dccd 100644 --- a/src/pages/overview.md +++ b/src/pages/overview.md @@ -82,11 +82,11 @@ The Studio is fully integrated with the engine. It is a heavily modified version ## Project API The Project API is the core of what makes Ethereal Engine shine - the ability to load your own scenes, assets & code with a click of a button. Using github, we allow users to have fully version controlled access to extend the base functionality. You can see examples of the Project API in action [here](https://etherealengine.com/explore) and [here](https://github.com/EtherealEngine/ee-development-test-suite) ```ts -import type { ProjectConfigInterface } from '@etherealengine/projects/ProjectConfigInterface' +import type { ProjectConfigInterface } from '@ir-engine/packages/projects/ProjectConfigInterface' const config: ProjectConfigInterface = { onEvent: './projectEventHooks.ts', - thumbnail: '/static/etherealengine_thumbnail.jpg', + thumbnail: '/static/IR_thumbnail.jpg', routes: { '/examples': { component: () => import('./examplesRoute')