Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/d__partials/contributing/develop.md
Original file line number Diff line number Diff line change
@@ -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.
8 changes: 4 additions & 4 deletions docs/d__partials/license.md
Original file line number Diff line number Diff line change
@@ -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
14 changes: 7 additions & 7 deletions docs/d_creator/96_tutorials/02_unreal_bridge.md
Original file line number Diff line number Diff line change
Expand Up @@ -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!

Expand All @@ -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



Expand All @@ -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

Expand All @@ -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!

Expand Down
54 changes: 27 additions & 27 deletions docs/developer/typescript/01_gettingStarted/02_hello/02_engine.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,19 +35,19 @@ 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
You will need to stop the engine and re-run it whenever you install a new project.
:::

<TechnicalNote>
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.
Expand Down Expand Up @@ -80,12 +80,12 @@ There are multiple options available, but the important thing to remember is tha

<TechnicalNote title="Config File">

```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,
Expand All @@ -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
Expand All @@ -123,22 +123,22 @@ 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`.

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
Expand All @@ -158,16 +158,16 @@ VSCode has support for some important features and plugins that make the iR Engi
<TechnicalNote title="Solution">

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
Expand All @@ -177,14 +177,14 @@ ECS.setComponent(entity, PrimitiveGeometryComponent, { geometryType: GeometryTyp

<UnstyledDetails title="Full Solution">

```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()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ The engine will take care of executing our code when it is correct to do so, bas

<TechnicalNote title="Solution">

```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',
Expand All @@ -137,15 +137,15 @@ This is how our final code will look like after we have completed these tasks.

<TechnicalNote title="Full Solution">

```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
Expand Down
18 changes: 9 additions & 9 deletions docs/developer/typescript/01_gettingStarted/02_hello/05_query.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,15 +149,15 @@ function hello() {
```
<UnstyledDetails title="Full Solution">

```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
Expand Down Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
12 changes: 6 additions & 6 deletions docs/developer/typescript/01_gettingStarted/02_hello/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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()
Expand Down
4 changes: 2 additions & 2 deletions docs/developer/typescript/01_gettingStarted/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Loading