You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Apr 13, 2025. It is now read-only.
- Revise try_sample_bundle.md because the CLI does not work as expected
- Move how to install services from try_sample_bundle.md to install.md
- Fix typo in mkdocs.yml
Tim
Signed-off-by: Tim_Tech_Dev <[email protected]>
In order to download necessary tools and to install nodecg-io using the CLI you need network access.
5
+
In order to download necessary tools and to install nodecg-io using the CLI you
6
+
need network access.
6
7
7
8
### Required Applications
8
9
@@ -15,34 +16,43 @@ You'll need the following tools:
15
16
16
17
### Native Build Tools
17
18
18
-
Some services depend on packages that require native build tools. You _ONLY_ need to install these if you want to use a service that depends on native modules or if you want to install a development version.
19
+
Some services depend on packages that require native build tools. You _ONLY_
20
+
need to install these if you want to use a service that depends on native
21
+
modules or if you want to install a development version.
19
22
20
-
The services that require these include StreamDeck, Midi and Serial. Please note that this list might not be up-to-date.
23
+
The services that require these include StreamDeck, Midi and Serial. Please note
24
+
that this list might not be up-to-date.
21
25
22
-
Here's how to install the native build tools on the most popular operating systems, if you need them:
26
+
Here's how to install the native build tools on the most popular operating
27
+
systems, if you need them:
23
28
24
29
#### Windows
25
30
26
-
For Windows, you'll need the Visual Studio Build Tools, if you have Visual Studio installed you should already have them.
27
-
If you don't have Visual Studio just install the Visual Studio Build Tools by running the following command as an **Administrator**:
31
+
For Windows, you'll need the Visual Studio Build Tools, if you have Visual
32
+
Studio installed you should already have them. If you don't have Visual Studio
33
+
just install the Visual Studio Build Tools by running the following command as
34
+
an **Administrator**:
28
35
29
36
```shell
30
37
npm install -g windows-build-tools
31
38
```
32
39
33
40
#### Linux
34
41
35
-
For Linux, you'll need a C++ compiler and some other packages. On Ubuntu/Debian based operating systems run the following command:
42
+
For Linux, you'll need a C++ compiler and some other packages. On Ubuntu/Debian
43
+
based operating systems run the following command:
For other Linux distros you'll need the corresponding packages, just search on the internet how the packages are named for your specific distro.
49
+
For other Linux distros you'll need the corresponding packages, just search on
50
+
the internet how the packages are named for your specific distro.
42
51
43
52
#### macOS
44
53
45
-
For macOS, you'll need the Xcode command line tools. To install them run the following command:
54
+
For macOS, you'll need the Xcode command line tools. To install them run the
55
+
following command:
46
56
47
57
```shell
48
58
xcode-select --install
@@ -56,38 +66,119 @@ Install the nodecg-io CLI using the following command:
56
66
npm install -g nodecg-io-cli
57
67
```
58
68
59
-
_Note:_ If you are running on Linux, you may need to use `sudo` if your npm installation uses a non-writeable path (default on Ubuntu apt packages, usually does not apply to packages installed using [nvm](https://github.com/nvm-sh/nvm))
69
+
_Note:_ If you are running on Linux, you may need to use `sudo` if your npm
70
+
installation uses a non-writeable path (default on Ubuntu apt packages, usually
71
+
does not apply to packages installed using [nvm](https://github.com/nvm-sh/nvm))
60
72
61
73
## Install nodecg-io using the nodecg-io CLI
62
74
63
-
With the nodecg-io CLI installed you can run this command inside a NodeCG installation to install nodecg-io:
75
+
> nodecg-io will always be installed into a `nodecg-io/` directory inside your
76
+
> NodeCG installation so that your bundles and all bundles from nodecg-io are
77
+
> separated. The CLI will add this path to the loaded bundles in your NodeCG
78
+
> configuration automatically, you don't need to worry about it.
79
+
80
+
With the nodecg-io CLI installed you can run this command inside a NodeCG
81
+
installation to install nodecg-io:
64
82
65
83
```shell
66
-
nodecg-io install
84
+
$ nodecg-io install
85
+
Installing nodecg-io...
67
86
```
68
87
69
-
You will get a prompt which asks you which version you want to install.
70
-
71
-
- By selecting an actual version (e.g., `0.1`) you create a production install that downloads the required packages from npm and setups a npm workspace to install all dependencies. Here you can choose which services you want to install.
72
-
73
-
- By selecting `development` you create a development install that clones the nodecg-io git repo and builds everything from scratch. We only recommend a dev install if you are sure that you want to contribute to nodecg-io. Here you always must install all services.
74
-
75
-
For starters, we recommend using the latest non-development version.
76
-
77
-
nodecg-io will always be installed into a `nodecg-io/` directory inside your NodeCG installation so that your bundles and all bundles from nodecg-io are separated. The CLI will add this path to the loaded bundles in your NodeCG configuration automatically, you don't need to worry about it.
78
-
79
-
If you want to every change your nodecg-io installation to add/remove a service or change the version, you can always re-run `nodecg-io install`. If a nodecg-io installation is found, its options will be preselected in the prompt. Re-running `nodecg-io install` will also update all packages to the latest patch version, if you have a production installation, and pull the repository and rebuild, if you have a development installation.
80
-
81
-
## Start NodeCG
82
-
83
-
When starting NodeCG you should see that all nodecg-io related bundles should be loaded and that you can now access nodecg-io in your NodeCG dashboard.
84
-
85
-
There are many example bundles premade for most services, so you may take a
86
-
look at the [“Try an included sample”](../getting_started/try_example_bundle.md)-Guide (It
87
-
will also tell you how to log in and how to use the GUI).
88
-
Or you could directly take a deep dive into our framework and either [create a new bundle](./create_new_bundle.md)
89
-
or [integrate an existing bundle](./existing_bundle.md). There are other bundles
90
-
using nodecg-io, witch you could try, so may take a look around GitHub or GitLab.
88
+
You will get a prompt which asks you which version you want to install:
Detected nodecg installation at /home/user/nodecg.
124
+
<spanstyle="color:#11d116">?</span> <b>Which version do you want to install?</b> <spanstyle="color:#1abc9c">0.1</span>
125
+
<spanstyle="color:#11d116">?</span> <b>Which services do you want to use?</b> (Press <spanstyle="color:#16a085"><space></span> to select, <spanstyle="color:#16a085"><a></span> to toggle all,
126
+
<spanstyle="color:#16a085"><i></span> to invert selection, and <spanstyle="color:#16a085"><enter></span> to proceed)
127
+
<spanstyle="color:#1abc9c">❯◯ ahk</span>
128
+
◯ android
129
+
◯ curseforge
130
+
◯ discord
131
+
◯ intellij
132
+
◯ irc
133
+
◯ midi-input
134
+
(Move up and down to reveal more choices)</pre>
135
+
136
+
If you want to every change your nodecg-io installation to add/remove a service
137
+
or change the version, you can always re-run `nodecg-io install`. If a nodecg-io
138
+
installation is found, its options will be preselected in the prompt. Re-running
139
+
`nodecg-io install` will also update all packages to the latest patch version.
140
+
141
+
</details>
142
+
143
+
### Development install
144
+
145
+
<details>
146
+
<summary>Click to see more!</summary>
147
+
148
+
Because you selected a production install you may select to use the samples and
Detected nodecg installation at /home/user/nodecg.
160
+
<spanstyle="color:#11d116">?</span> <b>Which version do you want to install?</b> <spanstyle="color:#1abc9c">development</span>
161
+
<spanstyle="color:#11d116">?</span> <b>Would you like to use the provided samples?</b> <spanstyle="color:#1abc9c">No</span>
162
+
<spanstyle="color:#11d116">?</span> <b>Would you like to clone the documentation?</b> (y/N) </pre>
163
+
164
+
If you want to every change your nodecg-io installation to add/remove a service
165
+
or change the version, you can always re-run `nodecg-io install`. If a nodecg-io
166
+
installation is found, its options will be preselected in the prompt. Re-running
167
+
`nodecg-io install` will also pull the repository and rebuild it.
168
+
169
+
</details>
170
+
171
+
### Continue reading
172
+
173
+
There are many example bundles premade for most services, so you may take a look
174
+
at the
175
+
[“Try an included sample”](../getting_started/try_example_bundle.md)-Guide (It
176
+
will also tell you how to start NodeCG, log in and how to use the GUI). Or you
177
+
could directly take a deep dive into our framework and either
178
+
[create a new bundle](./create_new_bundle.md) or
179
+
[integrate an existing bundle](./existing_bundle.md). There are other bundles
180
+
using nodecg-io, witch you could try, so may take a look around GitHub or
181
+
GitLab.
91
182
92
183
## Uninstall nodecg-io
93
184
@@ -97,4 +188,5 @@ If you want to uninstall nodecg-io you can run the following command:
97
188
nodecg-io uninstall
98
189
```
99
190
100
-
This will remove the `nodecg-io` directory inside your NodeCG installation and also will remove it from the loaded bundle paths in your NodeCG configuration.
191
+
This will remove the `nodecg-io` directory inside your NodeCG installation and
192
+
also will remove it from the loaded bundle paths in your NodeCG configuration.
Detected nodecg installation at /home/user/nodecg.
36
-
<spanstyle="color:#11d116">?</span> <b>Which version do you want to install?</b> <spanstyle="color:#1abc9c">0.1</span>
37
-
<spanstyle="color:#11d116">?</span> <b>Which services do you want to use?</b> (Press <spanstyle="color:#16a085"><space></span> to select, <spanstyle="color:#16a085"><a></span> to toggle all, <spanstyle="color:#16a085"><i></span> to invert selection, and <spanstyle="color:#16a085"><enter></span> to proceed)
38
-
<spanstyle="color:#1abc9c">❯◯ ahk</span>
39
-
◯ android
40
-
◯ curseforge
41
-
◯ discord
42
-
◯ intellij
43
-
◯ irc
44
-
◯ midi-input
45
-
(Move up and down to reveal more choices)</pre>
46
-
47
-
<!-- prettier-ignore-end -->
48
-
49
-
## Step 2: Run NodeCG
6
+
> In case you installed the **production** branch of nodecg-io, you are out of
7
+
> luck. Because the build process will cause problems if you just take one of
8
+
> the samples and rebuild elsewhere.
9
+
10
+
If you installed **dev** branch via the `nodecg-io-cli` and did not select the
11
+
“use the samples”-option run `nodecg-io install` and select it.
12
+
13
+
In case you cloned the repository directly from GitHub, everything should be
14
+
included. But you may want to pull recent changes and rebuild the project.
15
+
16
+
## Step 1: Run NodeCG
50
17
51
18
Now you need to start NodeCG. There are a couple of different ways to do this:
52
19
@@ -73,9 +40,10 @@ info: [nodecg-io-core] Minzig!
73
40
74
41
info: [nodecg/lib/server] NodeCG running on http://localhost:9090</pre>
75
42
76
-
Now you can open the NodeCG dashboard (by default) under <http://localhost:9090>.
43
+
Now you can open the NodeCG dashboard (by default) under
44
+
<http://localhost:9090>.
77
45
78
-
## Step 3: Log in to nodecg-io
46
+
## Step 2: Log in to nodecg-io
79
47
80
48
Now navigate to the `nodecg-io` tab in the NodeCG dashboard.
81
49
@@ -89,7 +57,7 @@ Now you are looking at the `nodecg-io` config menu. It should look like this:
0 commit comments