Skip to content

Commit b29c872

Browse files
committed
Documents that several addons are included with the addons branch
1 parent 064441a commit b29c872

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

doc/add-ons.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
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 inside the `addons.json` file at the root of the Hubs client source. Several are included with the `addons` code branch.
6+
57
## Installation
68

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

1214
```
13-
npm i https://github.com/MozillaReality/hubs-portals-addon.git
15+
npm i https://github.com/Hubs-Foundation/hubs-portals-addon.git
1416
```
1517

1618
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 +60,7 @@ Add-ons can also be enabled/disabled per room independently from the instance co
5860

5961
You can develop Hubs add-ons using Javascript or Typescript.
6062

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).
63+
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).
6264

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

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

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

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

99101
## Currently available add-ons
100102

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
103+
- [Template add-on](https://github.com/Hubs-Foundation/hubs-template-addon). This add-on serves as a foundation for add-on development.
104+
- [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.
105+
- [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.
106+
- [Behavior Graphs add-on](https://github.com/Hubs-Foundation/hubs-behavior-graphs-addon/): Initial Behavior Graphs implementation as an add-on

0 commit comments

Comments
 (0)