Skip to content

Commit 0d9c116

Browse files
authored
Merge pull request #6531 from Hubs-Foundation/addons-doc
Documents that several addons are included with the addons branch
2 parents 2d34e73 + 6f3d92a commit 0d9c116

File tree

1 file changed

+16
-7
lines changed

1 file changed

+16
-7
lines changed

doc/add-ons.md

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
Hubs client add-ons are pluggable libraries that are installed as part of the client and loaded at runtime. Add-ons allow functionality to the Hubs core and allow easy Hubs client extensibility while maintaining the Hubs client core lean and minimal.
44

5+
The currently installed addons are listed in the `addons` array in the `addons.json` file at the root of the Hubs client source.
6+
Several are included by default, see [Add-ons included in `addons` branch](#add-ons-included-in-addons-branch).
7+
58
## Installation
69

710
Installing an addon in your Hubs client is a two step process:
@@ -10,7 +13,7 @@ Installing an addon in your Hubs client is a two step process:
1013
For example if we would want to install the portals add-on we would need to do:
1114

1215
```
13-
npm i https://github.com/MozillaReality/hubs-portals-addon.git
16+
npm i https://github.com/Hubs-Foundation/hubs-portals-addon.git
1417
```
1518

1619
2. After the add-on is installed you'll need to add it to the addons array inside the `addons.json` file at the root of the Hubs client source.
@@ -58,7 +61,7 @@ Add-ons can also be enabled/disabled per room independently from the instance co
5861

5962
You can develop Hubs add-ons using Javascript or Typescript.
6063

61-
If you are developing using Typescript you can use the add-on template as a starting point. You can get the Add-on template from [here](https://github.com/MozillaReality/hubs-template-addon).
64+
If you are developing using Typescript you can use the add-on template as a starting point. You can get the Add-on template from [here](https://github.com/Hubs-Foundation/hubs-template-addon).
6265

6366
The add-on template has the basic dependencies already configured to get started with development as fast as possible.
6467

@@ -94,11 +97,17 @@ The easiest way of iterating over an add-on development is by linking the add-on
9497

9598
Now you can build the client and the add-on should be bundled as part of the client code.
9699

97-
There is a typings library available for Typescript development: [Hubs Client TS Types](https://github.com/MozillaReality/hubs-ts-types)
100+
There is a typings library available for Typescript development: [Hubs Client TS Types](https://github.com/Hubs-Foundation/hubs-ts-types)
98101

99102
## Currently available add-ons
100103

101-
- [Template add-on](https://github.com/MozillaReality/hubs-template-addon). This add-on serves as a foundation for add-on development.
102-
- [Duck add-on](https://github.com/MozillaReality/hubs-duck-addon): Replaces the existing `/duck` chat command and refactors it into a Hubs add-on.
103-
- [Portals add-on](https://github.com/MozillaReality/hubs-portals-addon): Simple portals implementation as an add-on that lets you spawn portals using the `/portal`. It also show how to add key bindings.
104-
- [Behavior Graphs add-on](https://github.com/MozillaReality/hubs-behavior-graphs-addon/): Initial Behavior Graphs implementation as an add-on
104+
### Template
105+
106+
- [Template add-on](https://github.com/Hubs-Foundation/hubs-template-addon). This add-on serves as a foundation for add-on development.
107+
108+
### Add-ons included in `addons` branch
109+
110+
- [Duck add-on](https://github.com/Hubs-Foundation/hubs-duck-addon): Replaces the existing `/duck` chat command and refactors it into a Hubs add-on.
111+
- [Portals add-on](https://github.com/Hubs-Foundation/hubs-portals-addon): Simple portals implementation as an add-on that lets you spawn portals using the `/portal`. It also show how to add key bindings.
112+
- [Behavior Graphs add-on](https://github.com/Hubs-Foundation/hubs-behavior-graphs-addon/): Initial Behavior Graphs implementation as an add-on
113+
- [Post-Processing add-on](https://github.com/Hubs-Foundation/hubs-postprocessing-addon): This add-on adds ThreeJs [post-processing](https://github.com/pmndrs/postprocessing) effects

0 commit comments

Comments
 (0)