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.
Copy file name to clipboardExpand all lines: docs/getting_started/install.md
+29-33Lines changed: 29 additions & 33 deletions
Original file line number
Diff line number
Diff line change
@@ -2,18 +2,26 @@
2
2
3
3
## Prerequisites
4
4
5
-
In order to download necessary tools, clone the repository, and install dependencies via `npm` you need network access.
5
+
In order to download necessary tools, and install nodecg-io using the cli you need network access.
6
+
7
+
### Required Applications
6
8
7
9
You'll need the following tools:
8
10
9
11
-[Git](https://git-scm.com)
10
12
-[Node.JS](https://nodejs.org/en/) v12.0.0 or newer
11
13
-[Npm](https://www.npmjs.com/get-npm) 7.0.0 or newer
12
-
-[NodeCG](https://nodecg.dev/) 1.4.0 or newer
14
+
-[NodeCG](https://nodecg.dev/) 1.4.0 or newer (1.7.0 or higher recommended)
15
+
16
+
### Native Build Tools
17
+
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.
13
19
14
-
You'll also need operating system dependant tools for native modules like StreamDeck and Midi:
20
+
The services that require these include StreamDeck, Midi and Serial. Please note that this list might not be up to date.
15
21
16
-
### Windows
22
+
Here's how to install the native build tools on the most popular operating systems, if you need them:
23
+
24
+
#### Windows
17
25
18
26
For Windows, you'll need the Visual Studio Build Tools, if you have Visual Studio installed you should already have them.
19
27
If you don't have Visual Studio just install the Visual Studio Build Tools by running the following command as an __Administrator__:
@@ -22,7 +30,7 @@ If you don't have Visual Studio just install the Visual Studio Build Tools by ru
22
30
npm install -g windows-build-tools
23
31
```
24
32
25
-
### Linux
33
+
####Linux
26
34
27
35
For Linux, you'll need a C++ compiler and some other packages. On Ubuntu/Debian based operating systems run the following command:
_Note:_You should clone nodecg-io to somewhere outside your nodecg bundles/ directory as this repo contains many bundles in subdirectories and nodecg doesn't support nesting of the bundles in other directories. You can clone it to any other path that you wish.
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, does usually not apply to installs using [nvm](https://github.com/nvm-sh/nvm))
50
60
51
-
## Install all the dependencies using `npm`
52
61
53
-
```shell
54
-
cd path/to/nodecg-io
55
-
npm install
56
-
npm run bootstrap
57
-
```
62
+
## Install nodecg-io using the nodecg-io cli
58
63
59
-
## Build nodecg-io:
64
+
With the nodecg-io cli installed you can run this command inside a nodecg installation:
60
65
61
66
```shell
62
-
cd path/to/nodecg-io
63
-
npm run build
67
+
nodecg-io install
64
68
```
65
69
66
-
## Add nodecg-io directory to the nodecg config
67
-
68
-
Modify the nodecg configuration in `path/to/nodecg/cfg/nodecg.json`, here is an example config:
70
+
You will get a prompt which asks you which version you want to install.
- By selecting a version 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.
77
73
78
-
_Note 1:_ This path should point to the root of this repository, not to a bundle inside this repo.
74
+
-`development` 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.
79
75
80
-
_Note 2:_ The second path to the samples is only required if you want to use a sample plugin.
81
-
82
-
_Note 3:_ If nodecg doesn't load nodecg-io for some reason you might want to use an absolute path here.
76
+
For starters we recommend using the latest non-development version.
83
77
84
78
## Start nodecg
85
79
86
-
Now you can use nodecg-io in your own bundle. You can find example code in [./samples/](https://github.com/codeoverflow-org/nodecg-io/tree/master/samples/).
80
+
When starting nodecg you should see that all nodecg-io related bundles should be loaded and that you can you can now access nodecg-io in your nodecg dashboard.
81
+
82
+
Now you can either install a already existing bundle that uses nodecg-io or [create a new bundle](./create_bundle.md).
0 commit comments