Skip to content
This repository was archived by the owner on Apr 13, 2025. It is now read-only.

Commit a7ae69f

Browse files
committed
Simplify the sample bundles even further
- Remove mentions of monaco & automatic selection - Revise descriptions of setting dependencies in the GUI Tim Signed-off-by: Tim_Tech_Dev <[email protected]>
1 parent a0df3ef commit a7ae69f

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+233
-541
lines changed

docs/samples/ahk.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,8 @@ will also tell you how to log in and how to use the GUI.
1717

1818
### Configure the AutoHotkey sample bundle
1919

20-
1. In NodeCG, create a new ahk service instance using the left upper menu.
21-
2. Enter the host and port of the HotkeylessAHK Server.
22-
The created instance should be automatically selected, if not select it in
23-
the upper left menu. Enter your host and port in monaco (the text-editor on
24-
the right) in this format:
20+
1. In NodeCG, create a new ahk service instance.
21+
2. Enter the host and port of the HotkeylessAHK Server:
2522

2623
```json
2724
{
@@ -32,6 +29,6 @@ will also tell you how to log in and how to use the GUI.
3229

3330
After entering it, click save.
3431

35-
3. Set the created ahk service instance to the service dependency of the ahk
36-
bundle.
32+
3. Set the sample's (`ahk-sendcommand`) dependency to be the newly created
33+
service instance (of type `ahk`).
3734
4. A small window with the text “Hello World” should have popped up.

docs/samples/android.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ will also tell you how to log in and how to use the GUI.
4040
The hexadecimal number in the first column is your device ID. You'll need
4141
this later.
4242
43-
10. In NodeCG, create a new android service instance using the left upper menu.
43+
10. In NodeCG, create a new android service instance.
4444
11. Enter the following:
4545
4646
```json
@@ -51,9 +51,8 @@ will also tell you how to log in and how to use the GUI.
5151
5252
Replace `device_id` with your device ID.
5353
54-
12. Set the created android service instance to the service dependency of the
55-
android sample bundle.
56-
Select the android bundle and the android service in the left bottom menu.
57-
Then select the service instance that should be used by the android sample
58-
bundle (in this case the name of the previously created android instance).
54+
After entering it, click save.
55+
56+
12. Set the sample's (`android`) dependency to be the newly created service
57+
instance (of type `android`).
5958
13. You should see that WLAN is now activated on your device.

docs/samples/artnet.md

Lines changed: 7 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,8 @@ will also tell you how to log in and how to use the GUI.
2121

2222
### Configure the Art-Net sample bundle
2323

24-
1. In NodeCG, create a new Art-Net service instance using the left upper menu.
25-
2. Enter the needed option.
26-
27-
The created instance should be automatically selected, if not select it in
28-
the upper left dropdown. Enter your universe in monaco (the text-editor on
29-
the right) in this format:
24+
1. In NodeCG, create a new Art-Net service instance.
25+
2. Enter the host to witch the service should broadcast:
3026

3127
**Host**
3228

@@ -38,19 +34,14 @@ will also tell you how to log in and how to use the GUI.
3834
}
3935
```
4036

41-
After entering it, click save.
37+
After entering it, click save.
38+
4239
You may overwrite this broadcast address in code with
4340
`client.bind("host address");`.
4441

45-
3. Set the created Art-Net service instance to the service dependency of the
46-
artnet-console bundle.
47-
Select the artnet-console bundle and the Art-Net service in the left bottom
48-
dropdown and then select the service instance that should be used by the
49-
artnet-console bundle (in this case the name of the previously created
50-
Art-Net instance).
51-
52-
4. Check the NodeCG logs
53-
You should see data logged.
42+
3. Set the sample's (`artnet-console`) dependency to be the newly created
43+
service instance (of type `artnet`).
44+
4. Check the NodeCG logs. You should see data logged.
5445

5546
### Explanations
5647

docs/samples/curseforge.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,7 @@ will also tell you how to log in and how to use the GUI.
1414

1515
### Configure the CurseForge bundle
1616

17-
1. In NodeCG, create a new CurseForge service instance using the left upper
18-
menu.
19-
2. Set the CurseForge service instance to the service dependency of the
20-
CurseForge bundle. Select the CurseForge bundle and the CurseForge service in
21-
the left bottom menu. Then select the service instance that should be used by
22-
the CurseForge bundle (in this case the name of the previously created
23-
CurseForge instance).
17+
1. In NodeCG, create a new CurseForge service instance.
18+
2. Set the sample's (`curseforge`) dependency to be the newly created service
19+
instance (of type `curseforge`).
2420
3. Check the NodeCG logs. You should see two lists of add-ons.

docs/samples/dbus-ratbagd.md

Lines changed: 10 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -18,23 +18,15 @@ will also tell you how to log in and how to use the GUI.
1818

1919
### Configure the DBus ratbagd sample bundle
2020

21-
1. In NodeCG, create a new D-Bus service instance using the left upper menu.
21+
1. In NodeCG, create a new D-Bus service instance.
2222
2. Configure the D-Bus service
2323
There should not be any additional configuration needed for the D-Bus
24-
service. Just enter an empty JSON object like this:
25-
26-
```json
27-
{}
28-
```
29-
30-
After entering it, click save.
31-
32-
3. Set the created D-Bus service instance to the service dependency of the
33-
`dbus-ratbagd` bundle.
34-
Select the `dbus-ratbagd` bundle and the D-Bus service in the left bottom
35-
menu. Then select the service instance that should be used by the
36-
`dbus-ratbagd` sample bundle (in this case the name of the previously created
37-
D-Bus instance).
38-
4. Check the NodeCG logs
39-
You should see an error or a success message and a list of connected device
40-
names.
24+
service.
25+
26+
3. Set the sample's (`dbus-ratbagd`) dependency to be the newly created service
27+
instance (of type `dbus`).
28+
29+
4. Check the NodeCG logs:
30+
31+
You should see an error or a success message and a list of connected device
32+
names.

docs/samples/debug.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,9 @@ will also tell you how to log in and how to use the GUI.
1414

1515
### Configure the Debug sample bundle
1616

17-
1. In NodeCG, create a new Debug service instance using the left upper menu.
18-
2. Set the Debug service instance to the service dependency of the Debug sample
19-
bundle. Select the Debug sample bundle and the Debug service in the left
20-
bottom menu. Then select the service instance that should be used by the
21-
Debug sample bundle (in this case the name of the previously created Debug
22-
instance).
17+
1. In NodeCG, create a new Debug service instance.
18+
2. Set the sample's (`debug`) dependency to be the newly created service
19+
instance (of type `debug`).
2320
3. Go to the nodecg-io-debug dashboard and use some buttons or other inputs.
2421
4. Check the NodeCG log. It should contain a message for each action you did and
2522
the passed values.

docs/samples/discord-rpc.md

Lines changed: 8 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,8 @@ _Note:_ If you don't have an application yet, you can create one
2121

2222
### Configure the Discord RPC sample bundle
2323

24-
1. In NodeCG, create a new `discord-rpc` service instance using the left upper
25-
menu.
26-
2. Enter required information.
27-
The created instance should be automatically selected, if not select it in
28-
the upper left menu. Enter your information in monaco (the text-editor on the
29-
right) in this format:
24+
1. In NodeCG, create a new `discord-rpc` service instance.
25+
2. Enter the `clientId` and `clientSecret` for the service:
3026

3127
```json
3228
{
@@ -37,12 +33,9 @@ _Note:_ If you don't have an application yet, you can create one
3733

3834
After entering it, click save.
3935

40-
3. Set the created `discord-rpc` service instance to the service dependency of
41-
the `discord-rpc` bundle.
42-
Select the `discord-rpc` bundle and the `discord-rpc` service in the left
43-
bottom menu. Then select the service instance that should be used by the
44-
`discord-rpc` sample bundle (in this case the name of the previously created
45-
`discord-rpc` instance).
46-
4. Check the NodeCG logs
47-
You should see an error or a success message displaying your discord
48-
username.
36+
3. Set the sample's (`discord-rpc`) dependency to be the newly created service
37+
instance (of type `discord-rpc`).
38+
4. Check the NodeCG logs:
39+
40+
You should see an error or a success message displaying your discord
41+
username.

docs/samples/discord.md

Lines changed: 7 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,8 @@ guide.
2222

2323
### Configure the Discord sample bundle
2424

25-
1. In NodeCG, create a new discord service instance using the left upper menu.
26-
2. Enter your bot token.
27-
The created instance should be automatically selected, if not select it in
28-
the upper left menu. Enter your Bot token in monaco (the text-editor on the
29-
right) in this format:
25+
1. In NodeCG, create a new discord service instance.
26+
2. Enter your bot token:
3027

3128
```json
3229
{
@@ -36,11 +33,8 @@ guide.
3633

3734
After entering it, click save.
3835

39-
3. Set the created discord service instance to the service dependency of the
40-
Discord-guild-chat bundle.
41-
Select the Discord-guild-chat bundle and the Discord service in the left
42-
bottom menu. Then select the service instance that should be used by the
43-
Discord-guild-chat bundle (in this case the name of the previously created
44-
discord instance).
45-
4. Check the NodeCG logs.
46-
You should see an error or a Login message.
36+
3. Set the sample's (`discord-guild-chat`) dependency to be the newly created
37+
service instance (of type `discord`).
38+
4. Check the NodeCG logs:
39+
40+
You should see an error or a Login message.

docs/samples/github.md

Lines changed: 7 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,8 @@ _Note:_ If you don't have a token yet, you can create one
2121

2222
### Configure the GitHub sample bundle
2323

24-
1. In NodeCG, create a new GitHub service instance using the left upper menu.
25-
2. Enter the GitHub token.
26-
The created instance should be automatically selected, if not select it in
27-
the upper left menu. Enter your GitHub token in monaco (the text-editor on
28-
the right) in this format:
24+
1. In NodeCG, create a new GitHub service instance.
25+
2. Enter the GitHub token:
2926

3027
```json
3128
{
@@ -35,12 +32,9 @@ _Note:_ If you don't have a token yet, you can create one
3532

3633
After entering it, click save.
3734

38-
3. Set the created GitHub service instance to the service dependency of the
39-
GitHub bundle.
40-
Select the GitHub bundle and the GitHub service in the left bottom menu. Then
41-
select the service instance that should be used by the GitHub sample bundle
42-
(in this case the name of the previously created GitHub instance).
35+
3. Set the sample's (`github`) dependency to be the newly created service
36+
instance (of type `github`).
37+
4. Check the NodeCG logs:
4338

44-
4. Check the NodeCG logs
45-
You should see an error or a success message and a list of all your
46-
repositories.
39+
You should see an error or a success message and a list of all your
40+
repositories.

docs/samples/gsheets.md

Lines changed: 7 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,8 @@ As the redirect URI add
2525

2626
### Configure the gsheets sample bundle
2727

28-
1. In NodeCG, create a new googleapis service instance using the left upper
29-
menu.
30-
2. Enter credentials for googleapis.
31-
The created instance should be automatically selected, if not select it in
32-
the upper left menu. Enter your gsheets OAuth credentials in monaco (the
33-
text-editor on the right) in this format:
28+
1. In NodeCG, create a new googleapis service instance.
29+
2. Enter the credentials for googleapis:
3430

3531
```json
3632
{
@@ -45,12 +41,9 @@ As the redirect URI add
4541
_Note:_ You can add multiple scopes if the googleapis instance is used for
4642
multiple bundles.
4743

48-
3. Set the created googleapis service instance to the service dependency of the
49-
gsheets bundle.
50-
Select the gsheets bundle and the googleapis service in the left bottom menu.
51-
Then select the service instance that should be used by the gsheets bundle
52-
(in this case the name of the previously created googleapis instance).
44+
3. Set the sample's (`gsheets`) dependency to be the newly created service
45+
instance (of type `googleapis`).
46+
4. Check the NodeCG logs:
5347

54-
4. Check the NodeCG logs
55-
You should see an error or a success message that is hardcoded in
56-
`samples/gsheets/extension/index.ts`.
48+
You should see an error or a success message that is hardcoded in
49+
`samples/gsheets/extension/index.ts`.

0 commit comments

Comments
 (0)