Skip to content
This repository was archived by the owner on Mar 5, 2021. It is now read-only.

Commit e49e772

Browse files
committed
Update for new core repository URL
1 parent ae56d8e commit e49e772

File tree

4 files changed

+18
-18
lines changed

4 files changed

+18
-18
lines changed

Diff for: pages/en/4_development/1_roadmap.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ Before migrating to GitHub, the core development team used [a Trello board](http
44

55
## Superpowers v2.0 or later
66

7-
* [Allow enabling/disabling plugins on a per-project basis](https://github.com/superpowers/superpowers/issues/73) and only export enabled plugins for shorter load times
8-
* [Authentication, access rights and user settings](https://github.com/superpowers/superpowers/issues/55)
9-
* [Support exporting for various platforms right from Superpowers](https://github.com/superpowers/superpowers/issues/35)
7+
* [Allow enabling/disabling plugins on a per-project basis](https://github.com/superpowers/superpowers-core/issues/73) and only export enabled plugins for shorter load times
8+
* [Authentication, access rights and user settings](https://github.com/superpowers/superpowers-core/issues/55)
9+
* [Support exporting for various platforms right from Superpowers](https://github.com/superpowers/superpowers-core/issues/35)
1010
* Superpowers Game:
1111
* [Allow choosing which assets to load on startup and loading the rest dynamically](https://github.com/superpowers/superpowers-game/issues/33) for shorter load times
1212
* [Typed asset tree](https://github.com/superpowers/superpowers-game/issues/35) to increase confidence when reorganizing assets
@@ -25,7 +25,7 @@ This release will focus on making it easy to release and upgrade the major parts
2525

2626
Release notes for all releases can be found on GitHub:
2727

28-
* [Client/Server releases](https://github.com/superpowers/superpowers/releases)
28+
* [Client/Server releases](https://github.com/superpowers/superpowers-core/releases)
2929
* [Launcher releases](https://github.com/superpowers/superpowers-app/releases)
3030
* [Superpowers Game releases](https://github.com/superpowers/superpowers-game/releases)
3131

Diff for: pages/en/4_development/2_how-to-contribute.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ There are many ways you can help advance Superpowers!
55

66
## Preamble
77

8-
Superpowers adheres to the [Contributor Covenant](https://github.com/superpowers/superpowers/tree/master/CODE_OF_CONDUCT.md).
8+
Superpowers adheres to the [Contributor Covenant](https://github.com/superpowers/superpowers-core/tree/master/CODE_OF_CONDUCT.md).
99
By participating, you are expected to honor this code.
1010

1111
As a new contributor, we want you to feel welcome and comfortable.
@@ -18,7 +18,7 @@ and someone will point you to the right one if needed.
1818

1919
GitHub is a website for collaborating on projects. Superpowers is split over several repositories:
2020

21-
* [superpowers/superpowers](https://github.com/superpowers/superpowers) — The main client/server
21+
* [superpowers/superpowers](https://github.com/superpowers/superpowers-core) — The core (client/server)
2222
* [superpowers/superpowers-app](https://github.com/superpowers/superpowers-app) — The desktop app
2323
* [superpowers/superpowers-game](https://github.com/superpowers/superpowers-game) — The Superpowers Game system
2424
* [superpowers/superpowers-html5.com](https://github.com/superpowers/superpowers-html5.com) — Superpowers's website
@@ -27,7 +27,7 @@ Other systems and plugins might be hosted elsewhere by developers unaffiliated w
2727

2828
## Reporting and triaging bugs
2929

30-
Bugs should be reported on GitHub. When in doubt, feel free to [open an issue in the core repository](https://github.com/superpowers/superpowers/issues/new).
30+
Bugs should be reported on GitHub. When in doubt, feel free to [open an issue in the core repository](https://github.com/superpowers/superpowers-core/issues/new).
3131

3232
You can help triage bugs and make them more useful by:
3333

Diff for: pages/en/4_development/3_building-superpowers.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ In a terminal, run the following commands:
1717

1818
```bash
1919
# Clone the core repository in superpowers/core
20-
git clone https://github.com/superpowers/superpowers superpowers/core
20+
git clone https://github.com/superpowers/superpowers-core superpowers/core
2121
cd superpowers/core
2222

2323
# Clone the Superpowers Game system in superpowers/core/systems/game

Diff for: pages/en/4_development/5_extending-superpowers.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ A plugin can do 3 types of things:
8989
## Building your plugin
9090

9191
[Gulp](http://gulpjs.com/) is the build tool used throughout Superpowers,
92-
and [`pluginGulpfile.js`](https://github.com/superpowers/superpowers/blob/master/scripts/pluginGulpfile.js)
92+
and [`pluginGulpfile.js`](https://github.com/superpowers/superpowers-core/blob/master/scripts/pluginGulpfile.js)
9393
is a shared build file for your plugins that ships as part of Superpowers's main repository.
9494

9595
It assumes you're using Jade, Stylus and TypeScript to build your plugin. If you'd rather use something else,
@@ -128,9 +128,9 @@ An SVG icon for each editor should be placed in `public/editors/*/icon.svg`.
128128
Superpowers projects are basically made of a tree of assets.
129129
Your plugin can define one or more asset types.
130130

131-
Each asset type is a class that inherits from [`SupCore.Data.Base.Asset`](https://github.com/superpowers/superpowers/blob/master/SupCore/Data/Base/Asset.ts) ([example](https://github.com/superpowers/superpowers-game/blob/master/plugins/default/sprite/data/SpriteAsset.ts)).
131+
Each asset type is a class that inherits from [`SupCore.Data.Base.Asset`](https://github.com/superpowers/superpowers-core/blob/master/SupCore/Data/Base/Asset.ts) ([example](https://github.com/superpowers/superpowers-game/blob/master/plugins/default/sprite/data/SpriteAsset.ts)).
132132

133-
The `Asset` base class itself inherits from [`SupCore.Data.Base.Hash`](https://github.com/superpowers/superpowers/blob/master/SupCore/Data/Base/Hash.ts),
133+
The `Asset` base class itself inherits from [`SupCore.Data.Base.Hash`](https://github.com/superpowers/superpowers-core/blob/master/SupCore/Data/Base/Hash.ts),
134134
which stores a dictionary of data in its `.pub` property, with a schema for validating data.
135135
Properties can be marked as `mutable` in the schema, allowing clients to edit them directly through `setProperty` (more on editing below).
136136

@@ -152,7 +152,7 @@ In order to allow editing the project's assets and resources, editors must subsc
152152

153153
First of all, your editor should open a connection to the server through `SupClient.connect` ([example](https://github.com/superpowers/superpowers-game/blob/7ac686ab4e08681e90abb6d6b8de83bf8a1fec1f/plugins/default/sound/editors/sound/index.ts#L16)).
154154

155-
Once connected, you'll probably want to create an instance of [`SupClient.ProjectClient`](https://github.com/superpowers/superpowers/blob/master/SupClient/src/ProjectClient.ts)
155+
Once connected, you'll probably want to create an instance of [`SupClient.ProjectClient`](https://github.com/superpowers/superpowers-core/blob/master/SupClient/src/ProjectClient.ts)
156156
([example](https://github.com/superpowers/superpowers-game/blob/7ac686ab4e08681e90abb6d6b8de83bf8a1fec1f/plugins/default/sound/editors/sound/index.ts#L43)).
157157
It can be used to manage subscriptions to the project's assets tree (name of each asset, type, parent, order, etc.), or to particular assets and resources
158158
and it's easier than sending raw socket.io messages and keeping track of things yourself.
@@ -163,16 +163,16 @@ The callbacks on your subscriber object will be called when various events are r
163163

164164
To edit an asset, you can use `projectClient.editAsset(assetId, command, args..., callback);`.
165165

166-
The server, [through `RemoteProjectClient`](https://github.com/superpowers/superpowers/blob/60145c1aba13f7ffd8056cdcf1aac6117999b2c3/server/RemoteProjectClient.ts#L325)
166+
The server, [through `RemoteProjectClient`](https://github.com/superpowers/superpowers-core/blob/60145c1aba13f7ffd8056cdcf1aac6117999b2c3/server/RemoteProjectClient.ts#L325)
167167
will call a method starting with `server_` followed by the command you specified.
168168

169-
If the command's callback doesn't return an error, the server [will emit back the command to every client subscribed to the asset](https://github.com/superpowers/superpowers/blob/60145c1aba13f7ffd8056cdcf1aac6117999b2c3/server/RemoteProjectClient.ts#L346).
170-
In turn, on the client-side, `ProjectClient` [will call the corresponding `client_` method on your asset](https://github.com/superpowers/superpowers/blob/60145c1aba13f7ffd8056cdcf1aac6117999b2c3/SupClient/src/ProjectClient.ts#L157), applying the changes provided by the server.
169+
If the command's callback doesn't return an error, the server [will emit back the command to every client subscribed to the asset](https://github.com/superpowers/superpowers-core/blob/60145c1aba13f7ffd8056cdcf1aac6117999b2c3/server/RemoteProjectClient.ts#L346).
170+
In turn, on the client-side, `ProjectClient` [will call the corresponding `client_` method on your asset](https://github.com/superpowers/superpowers-core/blob/60145c1aba13f7ffd8056cdcf1aac6117999b2c3/SupClient/src/ProjectClient.ts#L157), applying the changes provided by the server.
171171
Then it will notify all subscribers of the change.
172172

173173
In `server_` methods, whenever the asset is edited, you should call `this.emit("change");`
174-
to let the project server know that the asset has changed and should be [scheduled for a write to disk soon](https://github.com/superpowers/superpowers/blob/60145c1aba13f7ffd8056cdcf1aac6117999b2c3/server/ProjectServer.ts#L249).
175-
The server saves a particular asset to disk [no more often than once every 60s](https://github.com/superpowers/superpowers/blob/60145c1aba13f7ffd8056cdcf1aac6117999b2c3/server/ProjectServer.ts#L11).
174+
to let the project server know that the asset has changed and should be [scheduled for a write to disk soon](https://github.com/superpowers/superpowers-core/blob/60145c1aba13f7ffd8056cdcf1aac6117999b2c3/server/ProjectServer.ts#L249).
175+
The server saves a particular asset to disk [no more often than once every 60s](https://github.com/superpowers/superpowers-core/blob/60145c1aba13f7ffd8056cdcf1aac6117999b2c3/server/ProjectServer.ts#L11).
176176

177177
`TODO: We still need to design a way to stream large assets.`
178178

@@ -181,7 +181,7 @@ The server saves a particular asset to disk [no more often than once every 60s](
181181
You can place JSON localization files in `public/locales/$LANGUAGE_CODE/$NAMESPACE.json` ([example](https://github.com/superpowers/superpowers-game/tree/master/plugins/default/sound/public/locales/en)).
182182

183183
They will be made available through the `t("namespace:path.to.key")` function to your Jade templates.
184-
You can also load them up at runtime with [`SupClient.i18n.load`](https://github.com/superpowers/superpowers/blob/master/SupClient/src/i18n.ts)
184+
You can also load them up at runtime with [`SupClient.i18n.load`](https://github.com/superpowers/superpowers-core/blob/master/SupClient/src/i18n.ts)
185185
and use them with `SupClient.i18n.t("namespace:path.to.key")`.
186186
([example](https://github.com/superpowers/superpowers-game/blob/master/plugins/default/sound/editors/sound/index.ts#L130))
187187

0 commit comments

Comments
 (0)