diff --git a/docs/contribute/contribute.md b/docs/contribute/contribute.md
index 1ab992dc..0fe93aec 100644
--- a/docs/contribute/contribute.md
+++ b/docs/contribute/contribute.md
@@ -3,8 +3,8 @@
There are many ways to contribute to nodecg-io: logging bugs, submitting pull requests, reporting issues, and creating suggestions.
First you'll need an installation of nodecg-io. Please refer to the [installation guide](../getting_started/install.md) and create a development installation.
-The cli asks you whether you want to clone the documentation. It's highly recommended that you do that and update the documentation as you add new services or features.
-To be able to create Pull Requests you should fork the corresponding repositories and add them as a remote (update url for e.g. documentation repository):
+The CLI asks you whether you want to clone the documentation. It's highly recommended that you do that and update the documentation as you add new services or features.
+To be able to create Pull Requests you should fork the corresponding repositories and add them as a remote (update URL for e.g., documentation repository):
```shell
git remote add fork https://github.com/[YOUR_USERNAME]/nodecg-io.git
@@ -27,7 +27,7 @@ The watch builder will watch for file changes and compile those changes incremen
It will even stay running in the background if you close VS Code.
You can resume it by starting the build task with
Ctrl+Shift+B (CMD+Shift+B) again.
-ou can kill the build task by pressing Ctrl+D in the task terminal (CMD+D) on macOS.
+You can kill the build task by pressing Ctrl+D in the task terminal (CMD+D) on macOS.
Errors and warnings will be shown in the status bar at the bottom left of the editor. You can view the error list using `View | Errors and Warnings` or pressing Ctrl+P and then ! (CMD+P and ! on macOS)
### Terminal
@@ -49,7 +49,7 @@ npm run watch
```
_Note:_ Watching all packages requires a lot of RAM.
-Instead, you can watch just the packages you are actively working on e.g. `npm run watch -- --scope nodecg-io-twitch-chat --scope twitch-chat`.
+Instead, you can watch just the packages you are actively working on e.g., `npm run watch -- --scope nodecg-io-twitch-chat --scope twitch-chat`.
This will just spawn a watch process for the twitch-chat sample and service and require way less memory.
## Run
@@ -82,7 +82,7 @@ You may also occasionally need to merge upstream master in a pull request. To do
### Where to Contribute
-After cloning and building the repo, check out the [issues list](https://github.com/codeoverflow-org/nodecg-io/issues). Issues labeled [`help wanted`](https://github.com/codeoverflow-org/nodecg-io/labels/help%20wanted) are good issues to submit a PR for. Issues labeled [`good first issue`](https://github.com/codeoverflow-org/nodecg-io/labels/good%20first%20issue) are great candidates to pick up if you are in the code for the first time. If you are contributing significant changes, please discuss with the assignee of the issue first before starting to work on the issue.
+After cloning and building the repo, check out the [issues list](https://github.com/codeoverflow-org/nodecg-io/issues). Issues labelled [`help wanted`](https://github.com/codeoverflow-org/nodecg-io/labels/help%20wanted) are good issues to submit a PR for. Issues labelled [`good first issue`](https://github.com/codeoverflow-org/nodecg-io/labels/good%20first%20issue) are great candidates to pick up if you are in the code for the first time. If you are contributing significant changes, please discuss with the assignee of the issue first before starting to work on the issue.
## Suggestions
diff --git a/docs/contribute/create_sample.md b/docs/contribute/create_sample.md
index 258d9581..59d15b1d 100644
--- a/docs/contribute/create_sample.md
+++ b/docs/contribute/create_sample.md
@@ -25,9 +25,9 @@ Create a folder in `samples` named after the sample and add a `package.json` and
"dependencies": {
"nodecg-io-": "^0.2.0",
"nodecg-io-core": "^0.2.0",
- "@types/node": "^14.14.13",
- "nodecg": "^1.7.4",
- "typescript": "^4.1.3"
+ "@types/node": "^15.0.2",
+ "nodecg-types": "^1.8.2",
+ "typescript": "^4.2.4"
}
}
```
@@ -41,21 +41,26 @@ Create a folder in `samples` named after the sample and add a `package.json` and
Now you can create a file called `extension/index.ts`. Here's a template. Make sure you replace all the comments with your own code.
```typescript
-import { NodeCG } from "nodecg/types/server";
+import { NodeCG } from "nodecg-types/types/server";
import { requireService } from "nodecg-io-core";
import { TheServicesExportedClient } from "nodecg-io-";
module.exports = function (nodecg: NodeCG) {
nodecg.log.info("Sample bundle for started");
- const service = requireService(nodecg, "");
+ const service = requireService(
+ nodecg,
+ ""
+ );
service?.onAvailable((client) => {
- nodecg.log.info("Client has been updated.");
+ nodecg.log.info(" client has been updated.");
// TODO do something with the client to demonstrate the functionality.
});
- service?.onUnavailable(() => nodecg.log.info("Client has been unset."));
+ service?.onUnavailable(() =>
+ nodecg.log.info(" client has been unset.")
+ );
};
```
diff --git a/docs/contribute/create_service.md b/docs/contribute/create_service.md
index 8cddccbf..22637275 100644
--- a/docs/contribute/create_service.md
+++ b/docs/contribute/create_service.md
@@ -2,9 +2,10 @@
This guide helps you to create a service integration such as _twitch-chat_ or _discord_
-## Find a javascript library
+## Find a JavaScript library
-Go to [npmjs.com](https://www.npmjs.com/) and look whether there's already a package that wraps around the API of your service. If there's no such package you need to create one yourself. This process is not described here.
+Go to [npmjs.com](https://www.npmjs.com/) and look whether there's already a package that wraps around the API of your service. If there's no such package, you need to create one yourself. This process is not described here. You may read the
+[“Contributing packages to the registry” from the npm Docs](https://docs.npmjs.com/packages-and-modules/contributing-packages-to-the-registry).
## Create a package
@@ -12,7 +13,7 @@ From here you will have to replace:
- `YourServiceName` to your service's name in [PascalCase](https://github.com/basarat/typescript-book/blob/master/docs/styleguide/styleguide.md#class).
- `yourServiceName` to your service's name in [carmelCase](https://github.com/basarat/typescript-book/blob/master/docs/styleguide/styleguide.md#variable-and-function).
-- `your-service-name` to your service's name with only lowercase and hyphens ( `-` ) for example: ws-server.
+- `your-service-name` to your service's name with only lowercase and hyphens (`-`) for example: ws-server.
Now you need to create a package. You should call it `nodecg-io-your-service-name`.
@@ -35,6 +36,7 @@ Put the following into it:
"url": "https://github.com/codeoverflow-org/nodecg-io.git",
"directory": "nodecg-io-"
},
+ "files": ["**/*.js", "**/*.js.map", "**/*.d.ts", "*.json"],
"main": "extension",
"scripts": {
"build": "tsc -b",
@@ -50,9 +52,9 @@ Put the following into it:
},
"license": "MIT",
"devDependencies": {
- "@types/node": "^14.14.33",
- "nodecg": "^1.8.1",
- "typescript": "^4.2.3"
+ "@types/node": "^15.0.2",
+ "nodecg-types": "^1.8.2",
+ "typescript": "^4.2.4"
},
"dependencies": {
"nodecg-io-core": "^0.2.0",
@@ -73,19 +75,19 @@ Now run `npm install` and `npm run bootstrap` in the repository root.
## Create a configuration schema
-Next create a file called `your-service-name-schame.json`. This is a json schema file that indicates how the configuration for your service should be structured. If you need help here take a look at [this](https://json-schema.org/understanding-json-schema/) online resource and the schema-files of the other service implementations.
+Next create a file called `your-service-name-schame.json`. This is a JSON schema file that indicates how the configuration for your service should be structured. If you need help here take a look at [this](https://json-schema.org/understanding-json-schema/) online resource and the schema-files of the other service implementations.
## Create the service
-Create a file called `index.ts` in a folder called `extension` inside your services directory. You can then paste the following code and fill in your code instead of the comments.
+Create a file called `index.ts` in a folder called `extension` inside your service's directory. You can then paste the following code and fill in your code instead of the comments.
```typescript
-// TODO: Rename all occurences of "YourServiceName" in PascalCase
-// TODO: Rename all occurences of "yourServiceName" in carmelCase
-// TODO: Rename all occurences of "your-service-name" with only lowercase and hyphens ( - )
+// TODO: Rename all occurrences of "YourServiceName" in PascalCase
+// TODO: Rename all occurrences of "yourServiceName" in carmelCase
+// TODO: Rename all occurrences of "your-service-name" with only lowercase and hyphens ( - )
-import { NodeCG } from "nodecg/types/server";
-import { Result, emptySuccess, success, ServiceBundle, ServiceClient } from "nodecg-io-core";
+import { NodeCG } from "nodecg-types/types/server";
+import { Result,emptySuccess,success,ServiceBundle } from "nodecg-io-core";
// TODO: Replace the "fake" service class with that found on npm etc.
import { ServiceClass } from "./";
@@ -106,7 +108,7 @@ module.exports = (nodecg: NodeCG) => {
new YourServiceNameService(nodecg, "your-service-name", __dirname, "../your-service-name-schema.json").register();
};
-class YourServiceNameService extends ServiceBundle {
+class YourServiceNameService extends ServiceBundle {
async validateConfig(config: YourServiceNameServiceConfig): Promise> {
// TODO You can validate your config here. If this gets called, the schema is correct.
// You should for example check whether oauth keys are valid and servers are online here
@@ -116,17 +118,13 @@ class YourServiceNameService extends ServiceBundle> {
// TODO Here you should return a ServiceClient that is exposed to bundles.
- // If everything is good return 'success({
- // getNativeClient() {
- // return
- // }
- // })'
// Or create a instance of your class if you have any simplifications and return that.
+ // If everything is good return 'success(client)'
// If an error occurs return 'error()'
}
stopClient(client: YourServiceNameServiceClient): void {
- // Here you shuld make sure you disconnect everything here (if possible).
+ // Here you should make sure you disconnect everything here (if possible).
}
}
```
@@ -150,4 +148,4 @@ No sample bundle for service ``.
[You can help us and create one!](https://github.com/codeoverflow-org/nodecg-io/blob/master/docs/docs/contribute.md)
```
-Do not remove the marker in the first line until the bundle is implemented and don't forget to add this file to `mkdocs.yml`.
+Do not remove the marker in the first line until there is a sample bundle, and it is documented there. Don't forget to add this file to `mkdocs.yml`.
diff --git a/docs/contribute/sample_documentation.md b/docs/contribute/sample_documentation.md
index 94ef8d13..3f245963 100644
--- a/docs/contribute/sample_documentation.md
+++ b/docs/contribute/sample_documentation.md
@@ -1,7 +1,7 @@
# Add your sample to the docs
-To document a sample bundle take a look at the name of the service the sample bundle is for. If it's for example `nodecg-io-example` the documentation must go into `docs/samples/example.md` in the docs repository. There you should include a step-by-step manual how to configure the service and get the bundle running.
+To document a sample bundle take a look at the name of the service the sample bundle is for. If it's for example `nodecg-io-example` the documentation must go into `docs/samples/example.md` in the doc's repository. There you should include a step-by-step manual how to configure the service and get the bundle running.
-Don't forget to add the newly created MarkDown file to `mkdocs.yml`. When you create your documentation pull request, please include the id of your PR in the main repository in the description, so the documentation is not merged before the actual code.
+Don't forget to add the newly created Markdown file to `mkdocs.yml`. When you create your documentation pull request, please include the ID of your PR in the main repository in the description, so the documentation will not be merged before the actual code.
-You should make this very detailed so everyone gets it to work because a super-good implementation is worth nothing if there's nobody who can use it. Take a look at the [twitch sample bundle](../samples/twitch-chat.md).
+You should make this very detailed, so everyone gets it to work because a super-good implementation is worth nothing if there's nobody who can use it. Take a look at the [twitch sample bundle](../samples/twitch-chat.md).
diff --git a/docs/getting_started/configuration.md b/docs/getting_started/configuration.md
index 955bafeb..fefee02f 100644
--- a/docs/getting_started/configuration.md
+++ b/docs/getting_started/configuration.md
@@ -1,8 +1,7 @@
# Configuration
-
-
-The configuration file for nodecg-io is at `cfg/nodecg-io-core.json` inside your nodecg installation. This file does not exist by default, you need to create it yourself.
+Since version `0.2.0` nodecg-io has a configuration feature to save some settings without needing to code something or log in. The configuration file for
+this feature is at `cfg/nodecg-io-core.json` inside your nodecg installation. This file does not exist by default, you need to create it yourself.
The currently only thing you can configure is automatic login, but there may be more configurable options in the future.
@@ -10,10 +9,10 @@ The currently only thing you can configure is automatic login, but there may be
Automatic login will automatically load nodecg-io when nodecg starts using the provided password.
-Therefore nodecg-io will be able to decrypt your configuration for your service instances and provide your bundles with service clients without you logging in to nodecg-io using the dashboard.
-This is especially useful if you are running nodecg with nodecg-io on a server which may reboot from time to time to ensure that your bundles are always working without you needing to manually login after each restart.
+Therefore, nodecg-io will be able to decrypt your configuration for your service instances and provide your bundles with service clients without you logging in to nodecg-io using the dashboard.
+This is especially useful if you are running nodecg with nodecg-io on a server which may reboot from time to time to ensure that your bundles are always working without you needing to manually log in after each restart.
-**Security warning:** Having both the encrypted configuration and your used password saved on disk defeats nodecg-ios data-at-rest encryption.
+**Security warning:** Having both the encrypted configuration and your used password saved on disk defeats nodecg-io's data-at-rest encryption.
Any program that can read disk contents can access your credentials of any service instance. We discourage using this and if you really want to use it you should be extra cautious about which bundles you install.
Options of automatic login:
@@ -26,8 +25,8 @@ Options of automatic login:
- `password` (string)
- This is the password that will be used to login. It should be the password you use to login to nodecg-io.
- If this password is wrong a error will be logged after startup.
+ This is the password that will be used to log in. It should be the password you use to log in to nodecg-io.
+ If this password is wrong an error will be logged after startup.
Example config:
diff --git a/docs/getting_started/create_new_bundle.md b/docs/getting_started/create_new_bundle.md
index 5c79dcb9..59dad2fd 100644
--- a/docs/getting_started/create_new_bundle.md
+++ b/docs/getting_started/create_new_bundle.md
@@ -4,9 +4,9 @@ To actually use nodecg-io you need to create a bundle. Here's a step-by-step gui
Think of what services your bundle needs. Take a look at the [service list](../services.md) if to see what services are available. If you need a service that is not yet available consider [creating it](../contribute/create_service.md).
-## Create your bundle using the nodecg-io cli
+## Create your bundle using the nodecg-io CLI
-Automatically generating a bundle that uses nodecg-io requires that you have the nodecg-io cli installed. A guide on how to do this is inside the [install guide](./install.md). Also note that this currently only works when you have installed a release version, not development versions.
+Automatically generating a bundle that uses nodecg-io requires that you have the nodecg-io CLI installed. A guide on how to do this is inside the [installation guide](./install.md). Also note that this currently only works when you have installed a release version, not development versions.
To start run this command while being inside your nodecg installation:
@@ -17,11 +17,11 @@ nodecg-io generate
This will ask you a couple details about your bundle like name, description and used services.
Most questions have a reasonable default that you can choose if you don't care or are not sure about the asked thing.
-After finishing the prompt the cli will generate your bundle, install dependencies and, if you have chosen TypeScript, compile the generated code.
+After finishing the prompt the CLI will generate your bundle, install dependencies and, if you have chosen TypeScript, compile the generated code.
## Test it
-Start NodeCG and make sure that the bundle gets loaded successfully and it is displayed in the nodecg-io dashboard with all service dependencies.
+Start NodeCG and make sure that the bundle gets loaded successfully, and it is displayed in the nodecg-io dashboard with all service dependencies.
## Modify it
@@ -35,7 +35,7 @@ _Note:_ If you need to access another service inside the callback of a `onAvaila
A couple of steps you may want to do after generating a bundle:
- Create a git repository for you bundle (a `.gitignore` is automatically generated for you) and push it to a git platform of your choice
-- Add a [open source license](https://choosealicense.com), don't forget it to also add it to the `package.json` file
+- Add an [open source licence](https://choosealicense.com), don't forget it to also add it to the `package.json` file
- Add code formatters and linting tools like [prettier](https://prettier.io/) and [ESLint](https://eslint.org/)
- Add a README that explains what your bundle does and how it can be used
diff --git a/docs/getting_started/existing_bundle.md b/docs/getting_started/existing_bundle.md
index 495e8b39..4b718d9a 100644
--- a/docs/getting_started/existing_bundle.md
+++ b/docs/getting_started/existing_bundle.md
@@ -1,10 +1,10 @@
# Migrating your existing bundle to nodecg-io
-This guide explains you how to migrate an existing nodecg bundle that already meets your requirements to use nodecg-io.
-nodecg-io manages service configuration and authentication so your bundle doesn't have to bother with it.
+This guide explains to you how to migrate an existing nodecg bundle that already meets your requirements to use nodecg-io.
+nodecg-io manages service configuration and authentication, so your bundle doesn't have to bother with it.
If you are lucky and used the same library as we do for the service you want to migrate, nodecg-io is a drop-in replacement just doing authentication and configuration.
-If you have used another library you'll have to do a little more work to migrate to the library that our service uses.
+If you have used another library, you'll have to do a little more work to migrate to the library that our service uses.
In that case make sure that the migration is worth the effort.
You can use nodecg-io for one service and use your own library of choice for other services if you like to.
@@ -34,10 +34,10 @@ Now that you have `nodecg-io-core` installed in your bundle you can import the `
## Import Service type (TypeScript only)
-If you're using TypeScript you'll also need to install the package of the service that you want to use.
-You need it to be able to import its type for typesafety.
+If you're using TypeScript, you'll also need to install the package of the service that you want to use.
+You need it to be able to import its type for type safety.
-This example uses `twitch-chat` as an example but you can just replace it with the name of the service you need.
+This example uses `twitch-chat` as an example, but you can just replace it with the name of the service you need.
=== "TypeScript"
@@ -73,7 +73,7 @@ In case of TypeScript you'll also need to provide the type of the service.
### Using `onAvailable` and `onUnavailable` handlers
-You can setup handlers that are executed when the user assigns a service instance to your bundle, removes the assignment or when the service client got updated in some way.
+You can set up handlers that are executed when the user assigns a service instance to your bundle, removes the assignment or when the service client got updated in some way.
Handlers added with `onAvailable` will get called if there was a change and you got a client:
@@ -87,7 +87,7 @@ twitchChat.onAvailable(client => {
```
`onAvailable` is especially useful to add event handlers to clients.
-E.g. if you want to react to donations or chat messages you can add event handlers for these here.
+E.g., if you want to react to donations or chat messages you can add event handlers for these here.
Handlers added with `onUnavailable` will get called if your bundle was not assigned a service instance or if there was an error in service client creation:
@@ -105,6 +105,6 @@ Instead of callbacks you can also get access to the client directly:
const twitchChatClient = twitchChat.getClient();
```
-`getClient` will return the client if your bundle has an assigned service instance that has produced an service client without error
+`getClient` will return the client if your bundle has an assigned service instance that has produced a service client without error
and will return `undefined` otherwise.
This is useful for when you want to use the client due to some external event or from `onAvailable` handlers of other services.
diff --git a/docs/getting_started/install.md b/docs/getting_started/install.md
index 3bd8f65f..90c4884a 100644
--- a/docs/getting_started/install.md
+++ b/docs/getting_started/install.md
@@ -2,7 +2,7 @@
## Prerequisites
-In order to download necessary tools and to install nodecg-io using the cli you need network access.
+In order to download necessary tools and to install nodecg-io using the CLI you need network access.
### Required Applications
@@ -17,7 +17,7 @@ You'll need the following tools:
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.
-The services that require these include StreamDeck, Midi and Serial. Please note that this list might not be up to date.
+The services that require these include StreamDeck, Midi and Serial. Please note that this list might not be up-to-date.
Here's how to install the native build tools on the most popular operating systems, if you need them:
@@ -38,9 +38,9 @@ For Linux, you'll need a C++ compiler and some other packages. On Ubuntu/Debian
sudo apt install build-essential libusb-1.0-0-dev libasound2-dev libudev-dev
```
-For other linux distros you'll need the corresponding packages, just search on the internet how the packages are named for your specific distro.
+For other Linux distros you'll need the corresponding packages, just search on the internet how the packages are named for your specific distro.
-#### MacOS
+#### macOS
For macOS, you'll need the Xcode command line tools. To install them run the following command:
@@ -48,20 +48,20 @@ For macOS, you'll need the Xcode command line tools. To install them run the fol
xcode-select --install
```
-## Install the nodecg-io cli
+## Install the nodecg-io CLI
-Install the nodecg-io cli using the following command:
+Install the nodecg-io CLI using the following command:
```shell
npm install -g nodecg-io-cli
```
-_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))
+_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))
-## Install nodecg-io using the nodecg-io cli
+## Install nodecg-io using the nodecg-io CLI
-With the nodecg-io cli installed you can run this command inside a nodecg installation to install nodecg-io:
+With the nodecg-io CLI installed you can run this command inside a nodecg installation to install nodecg-io:
```shell
nodecg-io install
@@ -69,25 +69,25 @@ nodecg-io install
You will get a prompt which asks you which version you want to install.
-- By selecting a 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.
+- 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.
- 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.
-For starters we recommend using the latest non-development version.
+For starters, we recommend using the latest non-development version.
-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.
+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.
-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.
+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.
## Start nodecg
-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.
+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.
-Now you can either install a already existing bundle that uses nodecg-io, [create a new bundle](./create_new_bundle.md) or [integrate an existing bundle](./existing_bundle.md).
+Now you can either install an already existing bundle that uses nodecg-io, [create a new bundle](./create_new_bundle.md) or [integrate an existing bundle](./existing_bundle.md).
## Uninstall nodecg-io
-If you want uninstall nodecg-io you can run the following command:
+If you want to uninstall nodecg-io you can run the following command:
```shell
nodecg-io uninstall
diff --git a/docs/index.md b/docs/index.md
index 4987bcd7..c75740d9 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -18,21 +18,22 @@ nodecg-io is the successor of [ChatOverflow](https://github.com/codeoverflow-org
## How to use nodecg-io
-If you want to use nodecg-io, you should note that it is only a framework for your bundle, so you need at least a basic knowledge of the programming language JavaScript or any other language that compiles to JavaScript like TypeScript.
+If you want to use nodecg-io, you should note that it is only a framework for your bundle.
+So you need at least a basic knowledge of the programming language JavaScript or any other language that compiles to JavaScript like TypeScript.
If that's no problem you can head over to the [installation guide](./getting_started/install.md) and take a look at the [available nodecg-io services](./services.md).
## Implemented Services and Interfaces
- AutoHotkey
- Android (using adb)
-- ArtNet
+- Art-Net
- CurseForge
- DBus
- Discord
- Discord RPC
- Elgato lights
- GitHub
-- Google Apis
+- Google APIs
- IntelliJ IDEs
- IRC (Internet Relay Chat)
- MIDI Input
@@ -46,14 +47,14 @@ If that's no problem you can head over to the [installation guide](./getting_sta
- sACN Sender
- Serial Port (Arduino)
- [Shlink](https://shlink.io/)
-- Slack WebAPI
+- Slack Web API
- Spotify
- SQL (using [knex](https://knexjs.org/))
- Elgato Stream Deck
- StreamElements
- Telegram
- TIANE
-- Twitch Addons
+- Twitch Add-ons
- Twitch API
- Twitch Chat
- Twitch PubSub
@@ -64,4 +65,4 @@ If that's no problem you can head over to the [installation guide](./getting_sta
## How to contribute
-If you want to contribute to this bundle you can implement one of those services or fix an [issue](https://github.com/codeoverflow-org/nodecg-io/issues). Before contributing head over to the [How to contribute](./contribute/contribute.md) - Guide.
+If you want to contribute to this bundle you can implement one of those services or fix an [issue](https://github.com/codeoverflow-org/nodecg-io/issues). Before contributing head over to the [“How to contribute”](./contribute/contribute.md)-Guide.
diff --git a/docs/samples/ahk.md b/docs/samples/ahk.md
index 01f8bd2f..9c6adc83 100644
--- a/docs/samples/ahk.md
+++ b/docs/samples/ahk.md
@@ -9,7 +9,7 @@ The AHK sample bundle in `samples/ahk-sendcommand` shows how to send a command t
### Configure the ahk sample bundle
-1. Start nodecg with nodecg-io installed. The ahk bundle is currently part of it so it should also be loaded.
+1. Start nodecg with nodecg-io installed. The ahk bundle is currently part of it, so it should also be loaded.
2. Go to the `nodecg-io` tab in the nodecg dashboard.
@@ -32,4 +32,4 @@ The AHK sample bundle in `samples/ahk-sendcommand` shows how to send a command t
6. Set the created ahk service instance to the service dependency of the ahk bundle.
-7. A small window with the text "Hello World" should have popped up.
+7. A small window with the text “Hello World” should have popped up.
diff --git a/docs/samples/android.md b/docs/samples/android.md
index 9aa6a0ab..3f7e2a4a 100644
--- a/docs/samples/android.md
+++ b/docs/samples/android.md
@@ -2,21 +2,21 @@
The Android example bundle in `samples/android` shows how to connect to an android device and turn on WLAN.
-1. clone [this](https://github.com/noeppi-noeppi/nodecg-io-android) Git Repository
+1. Clone [this](https://github.com/noeppi-noeppi/nodecg-io-android) Git Repository
-2. Run `gradlew build` (on Windows) or `./gradlew build` (on linux) inside the cloned repository.
+2. Run `gradlew build` (on Windows) or `./gradlew build` (on Linux) inside the cloned repository.
3. There will be an apk file generated in `app/build/outputs/apk/debug/app-debug.apk`. Install it on the device.
-4. Launch the app. You'll be asked to grant the system alert window permission. This is required because the app will do its work in the background. However occasionally when user interaction is required, it needs to launch an activity without the user pressing the app icon in the launcher.
+4. Launch the app. You'll be asked to grant the system alert window permission. This is required because the app will do its work in the background. However, occasionally when user interaction is required, it needs to launch an activity without the user pressing the app icon in the launcher.
5. Install the android developer tools and make sure you have the `adb` command in your `PATH`
-6. Enable developer options on you device and enable USB debugging there. See [here](https://developer.android.com/studio/debug/dev-options)
+6. Enable developer options on you device and enable USB debugging there. See [here](https://developer.android.com/studio/debug/dev-options).
7. Run `adb start-server`
-8. Connect your device via USB. You'll be prompted whether you want to allow USB debugging. Press `Allow`
+8. Connect your device via USB. You'll be prompted whether you want to allow USB debugging. Press `Allow`.
9. Run `adb device -l`. The output might look like this:
@@ -24,9 +24,9 @@ The Android example bundle in `samples/android` shows how to connect to an andro
######## device usb:2-1.7 product:######## model:######## device:######## transport_id:2
```
- The hexadecimal number in the first column is your device id. You'll need this later.
+ The hexadecimal number in the first column is your device ID. You'll need this later.
-10. Start nodecg with nodecg-io installed. The bundle is currently part of it so it should also be loaded.
+10. Start nodecg with nodecg-io installed. The bundle is currently part of it, so it should also be loaded.
11. Go to the `nodecg-io` tab in the nodecg dashboard.
@@ -42,7 +42,7 @@ The Android example bundle in `samples/android` shows how to connect to an andro
}
```
- Replace `device_id` with your device id.
+ Replace `device_id` with your device ID.
15. Set the created android service instance to the service dependency of the android sample bundle.
diff --git a/docs/samples/artnet.md b/docs/samples/artnet.md
index 6a78ca7e..9a4cd16f 100644
--- a/docs/samples/artnet.md
+++ b/docs/samples/artnet.md
@@ -15,7 +15,7 @@ The Art-Net example bundle in `samples/artnet-console` demonstrates the ability
3. Login using your password. If this is your first run, then enter the password with which you want to encrypt your configurations and credentials.
-4. Create a new artnet service instance using the left upper menu.
+4. Create a new Art-Net service instance using the left upper menu.
5. Enter the needed option.
@@ -37,9 +37,9 @@ The Art-Net example bundle in `samples/artnet-console` demonstrates the ability
_Note:_ If you don't see monaco on the right, try reloading the page.
-6. Set the created artnet service instance to the service dependency of the artnet-console bundle.
+6. Set the created Art-Net service instance to the service dependency of the artnet-console bundle.
- Select the artnet-console bundle and the artnet service in the left bottom dropdown and then select the service instance that should be used by the artnet-console bundle (in this case the name of the previously created artnet instance).
+ Select the artnet-console bundle and the Art-Net service in the left bottom dropdown and then select the service instance that should be used by the artnet-console bundle (in this case the name of the previously created Art-Net instance).
7. Check the nodecg logs
diff --git a/docs/samples/curseforge.md b/docs/samples/curseforge.md
index b5125284..7d8f4a07 100644
--- a/docs/samples/curseforge.md
+++ b/docs/samples/curseforge.md
@@ -1,6 +1,6 @@
## Using the CurseForge sample bundle
-The CurseForge example bundle in `samples/curseforge` demonstrates the ability to search for different addons with the id or search with specific values for matching addons. Here is a guide how to get it working.
+The CurseForge example bundle in `samples/curseforge` demonstrates the ability to search for different add-ons with the ID or search with specific values for matching add-ons. Here is a guide how to get it working.
### Prerequisites
@@ -13,4 +13,4 @@ The CurseForge example bundle in `samples/curseforge` demonstrates the ability t
3. Create a new CurseForge service instance using the left upper menu.
4. Set the CurseForge service instance to the service dependency of the CurseForge bundle.
Select the CurseForge bundle and the CurseForge service in the left bottom menu and then select the service instance that should be used by the CurseForge bundle (in this case the name of the previously created CurseForge instance).
-5. Check the NodeCG logs. You should see two lists of addons.
\ No newline at end of file
+5. Check the NodeCG logs. You should see two lists of add-ons.
\ No newline at end of file
diff --git a/docs/samples/discord.md b/docs/samples/discord.md
index 3616e892..a9c6e64c 100644
--- a/docs/samples/discord.md
+++ b/docs/samples/discord.md
@@ -11,7 +11,7 @@ _Note:_ If you don't have such a token yet, you can follow [this](https://discor
### Configure the Discord sample bundle
-1. Start nodecg with nodecg-io installed. The Discord-guild-chat bundle is currently part of it so it should also be loaded.
+1. Start nodecg with nodecg-io installed. The Discord-guild-chat bundle is currently part of it, so it should also be loaded.
2. Go to the `nodecg-io` tab in the nodecg dashboard.
diff --git a/docs/samples/github.md b/docs/samples/github.md
index 76a17aeb..d9660aee 100644
--- a/docs/samples/github.md
+++ b/docs/samples/github.md
@@ -1,6 +1,6 @@
## Using the GitHub sample bundle
-The github example bundle in `samples/github` demonstrates the ability to access the github rest api. Here is a guide to how to get it working.
+The GitHub example bundle in `samples/github` demonstrates the ability to access the GitHub rest API. Here is a guide to how to get it working.
### Prerequisites
@@ -11,17 +11,17 @@ _Note:_ If you don't have a token yet, you can create one [here](https://github.
### Configure the GitHub sample bundle
-1. Start nodecg with nodecg-io installed. The github bundle is currently part of it so it should also be loaded.
+1. Start nodecg with nodecg-io installed. The GitHub bundle is currently part of it, so it should also be loaded.
2. Go to the `nodecg-io` tab in the nodecg dashboard.
3. Login using your password. If this is your first run, then enter the password with which you want to encrypt your configurations and credentials.
-4. Create a new github service instance using the left upper menu.
+4. Create a new GitHub service instance using the left upper menu.
-5. Enter the github token.
+5. Enter the GitHub token.
- The created instance should be automatically selected, if not select it in the upper left menu. Enter your GitHUb token in monaco (the text-editor on the right) in this format:
+ The created instance should be automatically selected, if not select it in the upper left menu. Enter your GitHub token in monaco (the text-editor on the right) in this format:
```json
{
@@ -33,9 +33,9 @@ _Note:_ If you don't have a token yet, you can create one [here](https://github.
_Note:_ If you don't see monaco on the right, try reloading the page.
-6. Set the created github service instance to the service dependency of the github bundle.
+6. Set the created GitHub service instance to the service dependency of the GitHub bundle.
- Select the github bundle and the github service in the left bottom menu and then select the service instance that should be used by the github sample bundle (in this case the name of the previously created github instance).
+ Select the GitHub bundle and the GitHub service in the left bottom menu and then select the service instance that should be used by the GitHub sample bundle (in this case the name of the previously created GitHub instance).
7. Check the nodecg logs
diff --git a/docs/samples/gsheets.md b/docs/samples/gsheets.md
index 52e238a8..4c711629 100644
--- a/docs/samples/gsheets.md
+++ b/docs/samples/gsheets.md
@@ -1,19 +1,19 @@
## Using the gsheets sample bundle
-The gsheets bundle in `samples/gsheets` demonstrates the ability of retrieving all rows where column A is a filled. Here is a guide to how to get it working.
+The gsheets bundle in `samples/gsheets` demonstrates the ability of retrieving all rows where column A is filled. Here is a guide to how to get it working.
### Prerequisites
- Working NodeCG & nodecg-io installation
-- Google cloud API OAuth access (clientID, clientSecret)
+- Google cloud API OAuth access (client ID, client Secret)
- Grant `Google Sheets API v4` access at the project's dashboard.
- - Shortcut URL: https://console.developers.google.com/apis/library/sheets.googleapis.com?project=<project-id>
+ - Shortcut URL:
-_Note:_ If you don't have such a key yet, you can generate them like [this](https://developers.google.com/identity/protocols/oauth2/web-server#creatingcred). As redirect URI add "http://localhost:9090/nodecg-io-googleapis/oauth2callback".
+_Note:_ If you don't have such a key yet, you can generate them like [this](https://developers.google.com/identity/protocols/oauth2/web-server#creatingcred). As the redirect URI add .
### Configure the gsheets sample bundle
-1. Start nodecg with nodecg-io installed. The gsheets bundle is currently part of it so it should also be loaded.
+1. Start nodecg with nodecg-io installed. The gsheets bundle is currently part of it, so it should also be loaded.
2. Go to the `nodecg-io` tab in the nodecg dashboard.
@@ -23,7 +23,7 @@ _Note:_ If you don't have such a key yet, you can generate them like [this](http
5. Enter credentials for googleapis.
- The created instance should be automatically selected, if not select it in the upper left menu. Enter your gsheets oauth credentials in monaco (the text-editor on the right) in this format:
+ The created instance should be automatically selected, if not select it in the upper left menu. Enter your gsheets OAuth credentials in monaco (the text-editor on the right) in this format:
```json
{
diff --git a/docs/samples/intellij.md b/docs/samples/intellij.md
index 413f71c4..2e57d957 100644
--- a/docs/samples/intellij.md
+++ b/docs/samples/intellij.md
@@ -6,7 +6,7 @@ The IntelliJ example bundle in `samples/intellij-integration` Shows how to conne
2. Make sure you've Java 11 or newer installed.
-3. Run `gradlew build` (on Windows) or `./gradlew build` (on linux) inside the cloned repository.
+3. Run `gradlew build` (on Windows) or `./gradlew build` (on Linux) inside the cloned repository.
4. Inside your JetBrains IDE go to `Settings` and then `Plugins`. Click on the little gear in the top right corner. Then click `Install from file`.
@@ -14,13 +14,13 @@ The IntelliJ example bundle in `samples/intellij-integration` Shows how to conne
6. Restart the IDE
-7. Start nodecg with nodecg-io installed. The bundle is currently part of it so it should also be loaded.
+7. Start nodecg with nodecg-io installed. The bundle is currently part of it, so it should also be loaded.
8. Go to the `nodecg-io` tab in the nodecg dashboard.
9. Login using your password. If this is your first run, then enter the password with which you want to encrypt your configurations and credentials.
-10. Create a new intellij service instance using the left upper menu.
+10. Create a new IntelliJ service instance using the left upper menu.
11. Enter the following
@@ -30,11 +30,11 @@ The IntelliJ example bundle in `samples/intellij-integration` Shows how to conne
}
```
- This tells nodecg-io to look for your IDE's HTTP server on your computer at port `19524`. If you want it to run on another port please follow the guidelines [here](https://github.com/noeppi-noeppi/nodecg-io-intellij/blob/master/README.md)
+ This tells nodecg-io to look for your IDE's HTTP server on your computer at port `19524`. If you want it to run on another port, please follow the guidelines [here](https://github.com/noeppi-noeppi/nodecg-io-intellij/blob/master/README.md).
-12. Set the created intellij service instance to the service dependency of the sample-intellij bundle.
+12. Set the created IntelliJ service instance to the service dependency of the sample-intellij bundle.
- Select the sample-intellij bundle and the intellij service in the left bottom menu and then select the service instance that should be used by the sample-intellij bundle (in this case the name of the previously created intellij instance).
+ Select the sample-intellij bundle and the IntelliJ service in the left bottom menu and then select the service instance that should be used by the sample-intellij bundle (in this case the name of the previously created IntelliJ instance).
13. Check the nodecg logs
diff --git a/docs/samples/irc.md b/docs/samples/irc.md
index a333abde..94f7af69 100644
--- a/docs/samples/irc.md
+++ b/docs/samples/irc.md
@@ -8,15 +8,15 @@ The IRC example bundle in `samples/irc` demonstrates the ability to get access t
### Configure the IRC sample bundle
-1. Start nodecg with nodecg-io installed. The irc sample bundle is currently part of it so it should also be loaded.
+1. Start nodecg with nodecg-io installed. The IRC sample bundle is currently part of it, so it should also be loaded.
2. Go to the `nodecg-io` tab in the nodecg dashboard.
3. Login using your password. If this is your first run, then enter the password with which you want to encrypt your configurations and credentials.
-4. Create a new irc service instance using the left upper menu.
+4. Create a new IRC service instance using the left upper menu.
-5. Enter credentials for irc.
+5. Enter credentials for IRC.
The created instance should be automatically selected, if not select it in the upper left menu. In this example we will anonymously connect to the twitch IRC chat. Enter the config in this format:
@@ -34,9 +34,9 @@ The IRC example bundle in `samples/irc` demonstrates the ability to get access t
_Note:_ If you don't see monaco on the right, try reloading the page.
-6. Set the created irc service instance to the service dependency of the irc sample bundle.
+6. Set the created IRC service instance to the service dependency of the IRC sample bundle.
- Select the irc sample bundle and the irc service in the left bottom menu and then select the service instance that should be used by the irc sample bundle (in this case the name of the previously created irc instance).
+ Select the IRC sample bundle and the IRC service in the left bottom menu and then select the service instance that should be used by the IRC sample bundle (in this case the name of the previously created IRC instance).
7. Check the nodecg logs
diff --git a/docs/samples/midi-input.md b/docs/samples/midi-input.md
index 18599746..48d08797 100644
--- a/docs/samples/midi-input.md
+++ b/docs/samples/midi-input.md
@@ -9,7 +9,7 @@ The midi-input example bundle in `samples/midi-input` demonstrates the ability t
### Configure the midi-input sample bundle
-1. Start nodecg with nodecg-io installed. The Twitch-chat bundle is currently part of it so it should also be loaded.
+1. Start nodecg with nodecg-io installed. The Twitch-chat bundle is currently part of it, so it should also be loaded.
2. Go to the `nodecg-io` tab in the nodecg dashboard.
@@ -29,7 +29,7 @@ The midi-input example bundle in `samples/midi-input` demonstrates the ability t
After entering it, click save.
__Note:__ A script is provided to list all inputs and outputs. It can be run from the sample directory `samples/midi-input` using the command `npm run list`. The devices should be listed with their device names and some other stuff.
- under linux this looks for example like this:
+ Under Linux this looks for example like this:
```
nanoKONTROL2:nanoKONTROL2 MIDI 1 28:0
diff --git a/docs/samples/midi-io.md b/docs/samples/midi-io.md
index 183e0471..2aceaef6 100644
--- a/docs/samples/midi-io.md
+++ b/docs/samples/midi-io.md
@@ -9,7 +9,7 @@ The midi-io example bundle in `samples/midi-io` demonstrates the ability to send
### Configure the midi-io sample bundle
-1. Start nodecg with nodecg-io installed. The midi-io bundle is currently part of it so it should also be loaded.
+1. Start nodecg with nodecg-io installed. The midi-io bundle is currently part of it, so it should also be loaded.
2. Go to the `nodecg-io` tab in the nodecg dashboard.
@@ -29,7 +29,7 @@ The midi-io example bundle in `samples/midi-io` demonstrates the ability to send
After entering it, click save.
__Note:__ A script is provided to list all inputs and outputs. It can be run from the sample directory `samples/midi-io` using the command `npm run list`. The devices should be listed with their device names and some other stuff.
- under linux this looks for example like this:
+ Under Linux this looks for example like this:
```
nanoKONTROL2:nanoKONTROL2 MIDI 1 28:0
@@ -51,9 +51,9 @@ The midi-io example bundle in `samples/midi-io` demonstrates the ability to send
10. Check the nodecg logs
- You should see an error or a success message and midi messages that are received and echoed back to the device that is configured. The messages are only modified, if the received Message is a noteon with a velocity of greater than zero or a control change message with a value of at least 64. Noteoff messages are always echoed unmodified.
+ You should see an error or a success message and midi messages that are received and echoed back to the device that is configured. The messages are only modified, if the received Message is a `Noteon` with a velocity of greater than zero or a control change message with a value of at least 64. `Noteoff` messages are always echoed unmodified.
### Note
-A noteon message with a velocity of 0 should be handled like a noteoff message, so they are echoed unmodified. Otherwise, this would get annoying very fast.
-If a control change is assigned to a push-butten values of 64 and up are interpreted as on and values lower than that are interpreted as off. Most somewhat modern Midi devices send 127 as on and 0 as off, but 63 and 64 should also be sufficient.
\ No newline at end of file
+A `Noteon` message with a velocity of 0 should be handled like a `Noteoff` message, so they are echoed unmodified. Otherwise, this would get annoying very fast.
+If a control change is assigned to the push-button values of 64 and up are interpreted as on and values lower than that are interpreted as off. Most somewhat modern Midi devices send 127 as on and 0 as off, but 63 and 64 should also be sufficient.
\ No newline at end of file
diff --git a/docs/samples/midi-output.md b/docs/samples/midi-output.md
index 680287a1..7005f697 100644
--- a/docs/samples/midi-output.md
+++ b/docs/samples/midi-output.md
@@ -9,7 +9,7 @@ The midi-output example bundle in `samples/midi-output` demonstrates the ability
### Configure the midi-output sample bundle
-1. Start nodecg with nodecg-io installed. The midi-output bundle is currently part of it so it should also be loaded.
+1. Start nodecg with nodecg-io installed. The midi-output bundle is currently part of it, so it should also be loaded.
2. Go to the `nodecg-io` tab in the nodecg dashboard.
@@ -29,7 +29,7 @@ The midi-output example bundle in `samples/midi-output` demonstrates the ability
After entering it, click save.
__Note:__ A script is provided to list all inputs and outputs. It can be run from the sample directory `samples/midi-output` using the command `npm run list`. The devices should be listed with their device names and some other stuff.
- under linux this looks for example like this:
+ Under Linux this looks for example like this:
```
nanoKONTROL2:nanoKONTROL2 MIDI 1 28:0
@@ -43,8 +43,8 @@ The midi-output example bundle in `samples/midi-output` demonstrates the ability
7. Check the nodecg logs
- You should see an error or a success message and random midi messages should be sent to the device that is configured. The messages are only "note on" messages and have a random note and velocity value ranging 0-127. The channels they are sent from are either channel 0 or 1, but the midi protocol supports up to 16 channels, so it could technically range from 0-15.
+ You should see an error or a success message and random midi messages should be sent to the device that is configured. The messages are only `Noteon` messages and have a random note and velocity value ranging 0-127. The channels they are sent from are either channel 0 or 1, but the midi protocol supports up to 16 channels, so it could technically range from 0-15.
### Note
-Only sending "note on" messages is sufficient for most midi, because most of them don't really care if you use proper "note off" messages or simply send a "note on" with a velocity of 0. This is due to the early days of midi, when integrated circuits were expensive. Allowing a velocity of 0 as replacement for "note off" made instruments featuring midi more affordable.
\ No newline at end of file
+Only sending `Noteon` messages is sufficient for most midi, because most of them don't really care if you use proper `Noteoff` messages or simply send a `Noteon` with a velocity of 0. This is due to the early days of midi, when integrated circuits were expensive. Allowing a velocity of 0 as replacement for `Noteoff` made instruments featuring midi more affordable.
\ No newline at end of file
diff --git a/docs/samples/nanoleaf.md b/docs/samples/nanoleaf.md
index 9239e25d..0d5d1289 100644
--- a/docs/samples/nanoleaf.md
+++ b/docs/samples/nanoleaf.md
@@ -1,15 +1,15 @@
## Using the Nanoleaf sample bundle
-The Nanoleaf example bundle in `samples/nanoleaf` demonstrates the ability to control your nanoleaf lights. This example code sets all panels to an orange color. Here is a guide to how to get it working.
+The Nanoleaf example bundle in `samples/nanoleaf` demonstrates the ability to control your nanoleaf lights. This example code sets all panels to an orange colour. Here is a guide to how to get it working.
### Prerequisites
-- Working NodeCG & nodecg-io installation
+- Working NodeCG and a nodecg-io installation
- IP address of your nanoleaf controller
### Configure the nanoleaf sample bundle
-1. Start nodecg with nodecg-io installed. The nanoleaf sample bundle is currently part of it so it should also be loaded.
+1. Start nodecg with nodecg-io installed. The nanoleaf sample bundle is currently part of it, so it should also be loaded.
2. Go to the `nodecg-io` tab in the nodecg dashboard.
@@ -37,6 +37,6 @@ The Nanoleaf example bundle in `samples/nanoleaf` demonstrates the ability to co
Select the nanoleaf sample bundle and the nanoleaf service in the left bottom menu and then select the service instance that should be used by the nanoleaf sample bundle (in this case the name of the previously created nanoleaf instance).
-7. If everything worked your nanoleafs should now shine orange.
+7. If everything worked, your nanoleafs should now shine orange.
If not you should check the nodecg logs for any errors.
diff --git a/docs/samples/obs.md b/docs/samples/obs.md
index 8baacee3..de3965b7 100644
--- a/docs/samples/obs.md
+++ b/docs/samples/obs.md
@@ -11,7 +11,7 @@ _Note:_ OBS is available [here](https://obsproject.com/de/download) and obs-webs
### Configure the OBS sample bundle
-1. Start nodecg with nodecg-io installed. The obs-scenelist bundle is currently part of it so it should also be loaded.
+1. Start nodecg with nodecg-io installed. The obs-scenelist bundle is currently part of it, so it should also be loaded.
2. Go to the `nodecg-io` tab in the nodecg dashboard.
@@ -31,7 +31,7 @@ _Note:_ OBS is available [here](https://obsproject.com/de/download) and obs-webs
}
```
- If you don't want to use a password you can just remove the password property from the config.
+ If you don't want to use a password, you can just remove the password property from the config.
After entering it, click save.
diff --git a/docs/samples/philipshue.md b/docs/samples/philipshue.md
index 4f1a74f5..b1d20c15 100644
--- a/docs/samples/philipshue.md
+++ b/docs/samples/philipshue.md
@@ -1,6 +1,6 @@
## Using the Philips Hue sample bundle
-The philipshue-lights example bundle in `samples/philipshue-lights` demonstrates the ability to connect to the Philips Hue bridge and control philips hue accessories.
+The philipshue-lights example bundle in `samples/philipshue-lights` demonstrates the ability to connect to the Philips Hue bridge and control Philips Hue accessories.
### Prerequisites
@@ -9,13 +9,13 @@ The philipshue-lights example bundle in `samples/philipshue-lights` demonstrates
### Configure the Philips Hue sample bundle
-1. Start nodecg with nodecg-io installed. The philipshue-lights sample bundle is currently part of it so it should also be loaded.
+1. Start nodecg with nodecg-io installed. The philipshue-lights sample bundle is currently part of it, so it should also be loaded.
2. Go to the `nodecg-io` tab in the nodecg dashboard.
3. Login using your password. If this is your first run, then enter the password with which you want to encrypt your configurations and credentials.
-4. Create a new philipshue service instance using the left upper menu.
+4. Create a new Philips Hue service instance using the left upper menu.
5. Enter configuration for hue.
@@ -27,7 +27,7 @@ The philipshue-lights example bundle in `samples/philipshue-lights` demonstrates
}
```
- If you want to provide the ip address manually you can provide them like this:
+ If you want to provide the IP address manually you can provide them like this:
```json
{
@@ -42,9 +42,9 @@ The philipshue-lights example bundle in `samples/philipshue-lights` demonstrates
_Note:_ If you don't see monaco on the right, try reloading the page.
-6. Set the created philipshue service instance to the service dependency of the philipshue-lights sample bundle.
+6. Set the created Philips Hue service instance to the service dependency of the philipshue-lights sample bundle.
- Select the philipshue-lights sample bundle and the philipshue service in the left bottom menu and then select the service instance that should be used by the philipshue-lights sample bundle (in this case the name of the previously created philipshue instance).
+ Select the philipshue-lights sample bundle and the Philips Hue service in the left bottom menu and then select the service instance that should be used by the philipshue-lights sample bundle (in this case the name of the previously created Philips Hue instance).
7. Check the nodecg logs
diff --git a/docs/samples/rcon.md b/docs/samples/rcon.md
index 1ab4f8e0..a6e5eef7 100644
--- a/docs/samples/rcon.md
+++ b/docs/samples/rcon.md
@@ -1,6 +1,6 @@
## Using the RCON sample bundle
-The rcon sample bundle in `samples/rcon-minecraft` shows how to send a command to a minecraft server.
+The rcon sample bundle in `samples/rcon-minecraft` shows how to send a command to a Minecraft server.
### Prerequisites
@@ -9,7 +9,7 @@ The rcon sample bundle in `samples/rcon-minecraft` shows how to send a command t
### Configure the rcon sample bundle
-1. Start nodecg with nodecg-io installed. The rcon bundle is currently part of it so it should also be loaded.
+1. Start nodecg with nodecg-io installed. The rcon bundle is currently part of it, so it should also be loaded.
2. Go to the `nodecg-io` tab in the nodecg dashboard.
@@ -17,7 +17,7 @@ The rcon sample bundle in `samples/rcon-minecraft` shows how to send a command t
4. Create a new rcon service instance using the left upper menu.
-5. Enter the host, port and password of the rcon connection. This can be found in the ``server.properties`` file (rcon.port, rcon.password)
+5. Enter the host, port, and password of the rcon connection. This can be found in the ``server.properties`` file (`rcon.port`, `rcon.password`)
The created instance should be automatically selected, if not select it in the upper left menu. Enter your host and port in monaco (the text-editor on the right) in this format:
@@ -33,4 +33,4 @@ The rcon sample bundle in `samples/rcon-minecraft` shows how to send a command t
6. Set the created rcon service instance to the service dependency of the rcon-minecraft bundle.
-7. In the nodecg console you will see a list with all online players. It will also send a /say command to the minecraft server.
+7. In the nodecg console you will see a list with all online players. It will also send a /say command to the Minecraft server.
diff --git a/docs/samples/reddit.md b/docs/samples/reddit.md
index d241f851..844a108d 100644
--- a/docs/samples/reddit.md
+++ b/docs/samples/reddit.md
@@ -11,15 +11,15 @@ _Note:_ If you don't have such an application yet, you can get one [here](https:
### Configure the Reddit sample bundle
-1. Start nodecg with nodecg-io installed. The reddit-message-read bundle is currently part of it so it should also be loaded.
+1. Start nodecg with nodecg-io installed. The reddit-message-read bundle is currently part of it, so it should also be loaded.
2. Go to the `nodecg-io` tab in the nodecg dashboard.
3. Login using your password. If this is your first run, then enter the password with which you want to encrypt your configurations and credentials.
-4. Create a new reddit service instance using the left upper menu.
+4. Create a new Reddit service instance using the left upper menu.
-5. Enter your applications id and secret and your own username and password. Zhe entered username and password must be for the user who registered the application.
+5. Enter your applications ID and secret and your own username and password. The entered username and password must be for the user who registered the application.
The created instance should be automatically selected, if not select it in the upper left menu. Enter your data in monaco (the text-editor on the right) in this format:
@@ -36,9 +36,9 @@ _Note:_ If you don't have such an application yet, you can get one [here](https:
_Note:_ If you don't see monaco on the right, try reloading the page.
-6. Set the created reddit service instance to the service dependency of the reddit-message-read bundle.
+6. Set the created Reddit service instance to the service dependency of the reddit-message-read bundle.
- Select the reddit-message-read bundle and the Reddit service in the left bottom menu and then select the service instance that should be used by the reddit-message-read bundle (in this case the name of the previously created reddit instance).
+ Select the reddit-message-read bundle and the Reddit service in the left bottom menu and then select the service instance that should be used by the reddit-message-read bundle (in this case the name of the previously created Reddit instance).
7. Check the nodecg logs
diff --git a/docs/samples/sacn-receiver.md b/docs/samples/sacn-receiver.md
index e32bdab2..6b183912 100644
--- a/docs/samples/sacn-receiver.md
+++ b/docs/samples/sacn-receiver.md
@@ -1,6 +1,6 @@
## Using the sACN receiver sample bundle
-The sacn-receiver-sample example bundle in `samples/sacn-receiver-sample` demonstrates the ability receive data send via sACN from e.g. professional lighting consoles. Here is a guide to how to get it working.
+The sacn-receiver-sample example bundle in `samples/sacn-receiver-sample` demonstrates the ability receive data send via sACN from e.g., professional lighting consoles. Here is a guide to how to get it working.
### Prerequisites
@@ -9,7 +9,7 @@ The sacn-receiver-sample example bundle in `samples/sacn-receiver-sample` demons
### Configure the sACN sample bundle
-1. Start nodecg with nodecg-io installed. The sacn-receiver-sample bundle is currently part of it so it should also be loaded.
+1. Start nodecg with nodecg-io installed. The sacn-receiver-sample bundle is currently part of it, so it should also be loaded.
2. Go to the `nodecg-io` tab in the nodecg dashboard.
@@ -62,7 +62,7 @@ The sacn-receiver-sample example bundle in `samples/sacn-receiver-sample` demons
}
```
- After entering it/them, click save.
+ After entering them, click save.
_Note:_ If you don't see monaco on the right, try reloading the page.
diff --git a/docs/samples/sacn-sender.md b/docs/samples/sacn-sender.md
index 3112cf1a..3f985b4a 100644
--- a/docs/samples/sacn-sender.md
+++ b/docs/samples/sacn-sender.md
@@ -1,6 +1,6 @@
## Using the sACN sender sample bundle
-The sacn-sender example bundle in `samples/sacn-sender` demonstrates the ability send data via sACN to e.g. open lighting architecture or professional lighting equipment. Here is a guide to how to get it working.
+The sacn-sender example bundle in `samples/sacn-sender` demonstrates the ability send data via sACN to e.g., open lighting architecture or professional lighting equipment. Here is a guide to how to get it working.
### Prerequisites
@@ -9,7 +9,7 @@ The sacn-sender example bundle in `samples/sacn-sender` demonstrates the ability
### Configure the sACN sample bundle
-1. Start nodecg with nodecg-io installed. The sacn-receiver-sample bundle is currently part of it so it should also be loaded.
+1. Start nodecg with nodecg-io installed. The sacn-receiver-sample bundle is currently part of it, so it should also be loaded.
2. Go to the `nodecg-io` tab in the nodecg dashboard.
@@ -52,7 +52,7 @@ The sacn-sender example bundle in `samples/sacn-sender` demonstrates the ability
}
```
- After entering it/them, click save.
+ After entering them, click save.
_Note:_ If you don't see monaco on the right, try reloading the page.
diff --git a/docs/samples/serial.md b/docs/samples/serial.md
index 5cbb738d..e686f02f 100644
--- a/docs/samples/serial.md
+++ b/docs/samples/serial.md
@@ -9,9 +9,9 @@ The serial example bundle in `samples/serial` demonstrates the ability to exchan
### Configure the serial sample bundle
-1. Load a simple serial echo sketch on your microcontroller. You can find a working arduino sketch at the end of this article.
+1. Load a simple serial echo sketch on your microcontroller. You can find a working Arduino sketch at the end of this article.
-2. Start nodecg with nodecg-io installed. The serial bundle is currently part of it so it should also be loaded. Make sure the device is already connected. Otherwise, you won't be able to see the device.
+2. Start nodecg with nodecg-io installed. The serial bundle is currently part of it, so it should also be loaded. Make sure the device is already connected. Otherwise, you won't be able to see the device.
3. Go to the `nodecg-io` tab in the nodecg dashboard.
@@ -21,7 +21,7 @@ The serial example bundle in `samples/serial` demonstrates the ability to exchan
6. Enter the information of your device.
- The created instance should be automatically selected, if not select it in the upper left menu. Enter the com port or other identifying information in one of these formats:
+ The created instance should be automatically selected, if not select it in the upper left menu. Enter the `com port` or other identifying information in one of these formats:
```json
{
@@ -43,7 +43,7 @@ The serial example bundle in `samples/serial` demonstrates the ability to exchan
_Note:_ If you don't see monaco on the right, try reloading the page.
_Note:_ If you want to list all connected devices you can open a terminal in `nodecg-io-serial` and run `npm run list`.
- _Note:_ If you are using multiple devices you might want to use the pnpId, since ports can change between reboots!
+ _Note:_ If you are using multiple devices you might want to use the `pnpId`, since ports can change between reboots!
7. Set the created serial service instance to the service dependency of the serial bundle.
@@ -51,11 +51,11 @@ The serial example bundle in `samples/serial` demonstrates the ability to exchan
8. Check the nodecg logs
- You should see an error or a success message and nodecg-io will send ping to the microcontroller every 10 seconds. The arduino device will respond with pong. You should see the pong message displayed in the log.
+ You should see an error or a success message and nodecg-io will send ping to the microcontroller every 10 seconds. The Arduino device will respond with pong. You should see the pong message displayed in the log.
If you see an error or nothing at all, try making sure your microcontroller is plugged in and recognized correctly. Then restart nodecg, so the service is cleanly restarted.
-### Sample arduino sketch
+### Sample Arduino sketch
```cpp
String inputString = "";
diff --git a/docs/samples/slack.md b/docs/samples/slack.md
index cbfe6b10..283f5cba 100644
--- a/docs/samples/slack.md
+++ b/docs/samples/slack.md
@@ -1,6 +1,6 @@
## Using the Slack sample bundle
-The Slack example bundle in `samples/slack-post` demonstrates the ability to list all channels into the console and sends a message to a channel which you have to configure to your channel id
+The Slack example bundle in `samples/slack-post` demonstrates the ability to list all channels into the console and sends a message to a channel which you have to configure to your channel ID.
### Prerequisites
@@ -11,7 +11,7 @@ _Note:_ If you don't have such a token yet, you can create your own app with tok
### Configure the Slack sample bundle
-1. Start nodecg with nodecg-io installed. The slack bundle is currently part of it so it should also be loaded.
+1. Start nodecg with nodecg-io installed. The slack bundle is currently part of it, so it should also be loaded.
2. Go to the `nodecg-io` tab in the nodecg dashboard.
@@ -19,7 +19,7 @@ _Note:_ If you don't have such a token yet, you can create your own app with tok
4. Create a new slack service instance using the left upper menu.
-5. Enter your slack app token.
+5. Enter your Slack app token.
The created instance should be automatically selected, if not select it in the upper left menu. Enter your token in monaco (the text-editor on the right) in this format:
diff --git a/docs/samples/spotify.md b/docs/samples/spotify.md
index 661ba00c..20a246f9 100644
--- a/docs/samples/spotify.md
+++ b/docs/samples/spotify.md
@@ -7,21 +7,21 @@ The spotify-current-song example bundle in `samples/spotify-current-song` demons
- Working NodeCG & nodecg-io installation
- A Spotify account and a registered Spotify application and the associated client id/client secret.
-_Note:_ If you don't have a registered application yet you can follow [this guide](https://developer.spotify.com/documentation/general/guides/app-settings/#register-your-app). As a redirect url use [http://localhost:9090/nodecg-io-spotify/spotifycallback](http://localhost:9090/nodecg-io-spotify/spotifycallback).
+_Note:_ If you don't have a registered application, yet you can follow [this guide](https://developer.spotify.com/documentation/general/guides/app-settings/#register-your-app). As a redirect URL use .
### Configure the Spotify sample bundle
-1. Start nodecg with nodecg-io installed. The spotify-current-song bundle is currently part of it so it should also be loaded.
+1. Start nodecg with nodecg-io installed. The spotify-current-song bundle is currently part of it, so it should also be loaded.
2. Go to the `nodecg-io` tab in the nodecg dashboard.
3. Login using your password. If this is your first run, then enter the password with which you want to encrypt your configurations and credentials.
-4. Create a new spotify service instance using the left upper menu.
+4. Create a new Spotify service instance using the left upper menu.
-5. Enter credentials for spotify.
+5. Enter credentials for Spotify.
- The created instance should be automatically selected, if not select it in the upper left menu. Enter your client id and secret in monaco (the text-editor on the right) in this format:
+ The created instance should be automatically selected, if not select it in the upper left menu. Enter your client ID and secret in monaco (the text-editor on the right) in this format:
```json
{
@@ -39,9 +39,9 @@ _Note:_ If you don't have a registered application yet you can follow [this guid
_Note:_ This sample requires the `user-read-playback-state` scope, but you can require other scopes if you want to use functions that require them.
A list of all scopes can be found [here](https://developer.spotify.com/documentation/general/guides/scopes/).
-6. Set the created spotify service instance to the service dependency of the spotify-current-song bundle.
+6. Set the created Spotify service instance to the service dependency of the spotify-current-song bundle.
- Select the spotify-current-song bundle and the spotify service in the left bottom menu and then select the service instance that should be used by the spotify-current-song bundle (in this case the name of the previously created spotify instance).
+ Select the spotify-current-song bundle and the Spotify service in the left bottom menu and then select the service instance that should be used by the spotify-current-song bundle (in this case the name of the previously created Spotify instance).
7. Check the nodecg logs
diff --git a/docs/samples/sql.md b/docs/samples/sql.md
index 39af69b9..3da6291a 100644
--- a/docs/samples/sql.md
+++ b/docs/samples/sql.md
@@ -7,11 +7,11 @@ The SQL example bundle in `samples/sql` demonstrates the ability to access datab
- Working NodeCG & nodecg-io installation
- A database supported by [knex](https://knexjs.org/#Installation)
-_Note:_ If you don't have a database yet and just want to test things you can use sqlite3 and don't need to setup a database server. You can always move to a different database type later.
+_Note:_ If you don't have a database yet and just want to test things you can use sqlite3 and don't need to set up a database server. You can always move to a different database type later.
### Configure the SQL sample bundle
-1. Start nodecg with nodecg-io installed. The SQL sample bundle is currently part of it so it should also be loaded.
+1. Start nodecg with nodecg-io installed. The SQL sample bundle is currently part of it, so it should also be loaded.
2. Go to the `nodecg-io` tab in the nodecg dashboard.
@@ -45,4 +45,4 @@ _Note:_ If you don't have a database yet and just want to test things you can us
Your first run of the sample bundle will probably fail because your database doesn't contain the used tables.
Check `samples/sql/extension/index.ts` and create the tables as used or create your own tables and adapt the sample accordingly.
- You can also use this code as a reference on how to use the sql client to do your queries.
+ You can also use this code as a reference on how to use the SQL client to do your queries.
diff --git a/docs/samples/streamdeck.md b/docs/samples/streamdeck.md
index b4f60eee..94d1c2d9 100644
--- a/docs/samples/streamdeck.md
+++ b/docs/samples/streamdeck.md
@@ -1,14 +1,14 @@
## Using the StreamDeck rainbow sample bundle
-The streamdeck-rainbow bundle paints your streamdeck with different colors. It is located in `samples/streamdeck-rainbow`.
+The streamdeck-rainbow bundle paints your streamdeck with different colours. It is located in `samples/streamdeck-rainbow`.
Sadly you can't access the StreamDeck while another application accesses it. So you need to stop your StreamDeck Software before.
### Configure the Streamdeck Rainbow bundle
-1. If you're on linux follow the instructions listed under Manual Installation [here](https://github.com/timothycrosley/streamdeck-ui/blob/master/README.md). Everything after the `sudo udevadm` command can be omitted.
+1. If you're on Linux, follow the instructions listed under Manual Installation [here](https://github.com/timothycrosley/streamdeck-ui/blob/master/README.md). Everything after the `sudo udevadm` command can be omitted.
-2. Start nodecg with nodecg-io installed. The streamdeck-rainbow bundle is currently part of it so it should also be loaded.
+2. Start nodecg with nodecg-io installed. The streamdeck-rainbow bundle is currently part of it, so it should also be loaded.
3. Go to the `nodecg-io` tab in the nodecg dashboard.
@@ -24,7 +24,7 @@ Sadly you can't access the StreamDeck while another application accesses it. So
}
```
- `default` tells the bundle to automatically find a StreamDeck. If you've multiple StreamDecks you need to put in an id here.
+ `default` tells the bundle to automatically find a StreamDeck. If you use multiple StreamDecks, you need to put in an ID here.
7. Set the created StreamDeck service instance to the service dependency of the streamdeck-rainbow bundle.
diff --git a/docs/samples/streamelements.md b/docs/samples/streamelements.md
index 1b88c760..8c5d7dc5 100644
--- a/docs/samples/streamelements.md
+++ b/docs/samples/streamelements.md
@@ -1,4 +1,4 @@
-## Using the SteamElements sample bundle
+## Using the StreamElements sample bundle
The StreamElements-events example bundle in `samples/streamelements-events` demonstrates the ability to react to events like donations and subs. Here is a guide to how to get it working.
@@ -11,11 +11,11 @@ The StreamElements-events example bundle in `samples/streamelements-events` demo
To use the StreamElements service you need a JWT Token that gives it access to your account.
-To get it goto https://streamelements.com/dashboard/account/channels, login, click on `Show Secrets` and copy it.
+To get it go to , login, click on `Show Secrets` and copy it.
-### Configure the SteamElements sample bundle
+### Configure the StreamElements sample bundle
-1. Start nodecg with nodecg-io installed. The streamelements-events bundle is currently part of it so it should also be loaded.
+1. Start nodecg with nodecg-io installed. The streamelements-events bundle is currently part of it, so it should also be loaded.
2. Go to the `nodecg-io` tab in the nodecg dashboard.
diff --git a/docs/samples/telegram.md b/docs/samples/telegram.md
index 8ac44d5a..f067e443 100644
--- a/docs/samples/telegram.md
+++ b/docs/samples/telegram.md
@@ -9,7 +9,7 @@ The telegram sample bundle in `samples/telegram-bot` shows how to create a simpl
### Configure the telegram sample bundle
-1. Start nodecg with nodecg-io installed. The telegram bundle is currently part of it so it should also be loaded.
+1. Start nodecg with nodecg-io installed. The telegram bundle is currently part of it, so it should also be loaded.
2. Go to the `nodecg-io` tab in the nodecg dashboard.
@@ -32,4 +32,4 @@ The telegram sample bundle in `samples/telegram-bot` shows how to create a simpl
6. Set the created telegram service instance to the service dependency of the telegram bundle.
-7. You can send "/test" to your bot and it should respond with two messages.
+7. You can send `/test` to your bot, and it should respond with two messages.
diff --git a/docs/samples/tiane.md b/docs/samples/tiane.md
index df8fc356..ef2c6096 100644
--- a/docs/samples/tiane.md
+++ b/docs/samples/tiane.md
@@ -1,6 +1,6 @@
## Using the TIANE-Discord sample bundle
-The TIANE-Discord example bundle in `samples/tiane-discord` shows how to make tiane act as a discord bot. TIANE is a german open source smart home assistant written in python. Here is a guide to how to get it working.
+The TIANE-Discord example bundle in `samples/tiane-discord` shows how to make TIANE act as a discord bot. TIANE is a German open source smart home assistant written in python. Here is a guide to how to get it working.
### Prerequisites
@@ -10,13 +10,13 @@ The TIANE-Discord example bundle in `samples/tiane-discord` shows how to make ti
### Configure the TIANE sample bundle
-1. Edit the file `samples/tiane-discord/extension/index.ts`. Look for this line
+1. Edit the file `samples/tiane-discord/extension/index.ts`. Look for this line:
```
const discordChannel = ""; // Insert channel for the discord bot here
```
- Put the channel id of a discord channel where you want to talk to TIANE between the quotation marks. See [here](https://github.com/Chikachi/DiscordIntegration/wiki/How-to-get-a-token-and-channel-ID-for-Discord) to find out how to get a channel id.
+ Put the channel ID of a discord channel where you want to talk to TIANE between the quotation marks. See [here](https://github.com/Chikachi/DiscordIntegration/wiki/How-to-get-a-token-and-channel-ID-for-Discord) to find out how to get a channel ID.
2. Run `npm run build` in the main nodecg-io directory.
@@ -32,7 +32,7 @@ The TIANE-Discord example bundle in `samples/tiane-discord` shows how to make ti
Make sure `websocket` is either set to `enabled` or `secure` and set a port of your desire.
-4. Start nodecg with nodecg-io installed. The TIANE-Discord bundle is currently part of it so it should also be loaded.
+4. Start nodecg with nodecg-io installed. The TIANE-Discord bundle is currently part of it, so it should also be loaded.
5. Go to the `nodecg-io` tab in the nodecg dashboard.
@@ -58,6 +58,6 @@ The TIANE-Discord example bundle in `samples/tiane-discord` shows how to make ti
10. Set the created TIANE and Discord service instances to the service dependency of the TIANE-Discord bundle.
- Select the TIANE-Discord bundle and the TIANE service in the left bottom menu and then select the service instance that should be used by the TIANE-Discord bundle (in this case the name of the previously created twitch instance). Then do the ame for the discord bundle.
+ Select the TIANE-Discord bundle and the TIANE service in the left bottom menu and then select the service instance that should be used by the TIANE-Discord bundle (in this case the name of the previously created twitch instance). Then do the same for the discord bundle.
-11. Ping your discord bot in the channel you set in the first step and ask tiane something.
+11. Ping your discord bot in the channel you set in the first step and ask TIANE something.
diff --git a/docs/samples/twitch-addons.md b/docs/samples/twitch-addons.md
index 377c597c..48de583e 100644
--- a/docs/samples/twitch-addons.md
+++ b/docs/samples/twitch-addons.md
@@ -5,13 +5,13 @@ The Twitch-Addons example bundle in `samples/twitch-addons` demonstrates the abi
### Prerequisites
- Working NodeCG & nodecg-io installation
-- a Twitch oAuth-Key
+- a Twitch OAuth Key
-_Note:_ If you don't have such a key yet, you can generate it on https://twitchapps.com/tmi/. Just log into your Twitch account and copy the token. You can also use any other token. There are no special scope requirements as the token is only used to convert channel names to ids.
+_Note:_ If you don't have such a key yet, you can generate it on . Just log into your Twitch account and copy the token. You can also use any other token. There are no special scope requirements as the token is only used to convert channel names to IDs.
### Configure the Twitch-Addons sample bundle
-1. Start nodecg with nodecg-io installed. The Twitch-Addons bundle is currently part of it so it should also be loaded.
+1. Start nodecg with nodecg-io installed. The Twitch-Addons bundle is currently part of it, so it should also be loaded.
2. Go to the `nodecg-io` tab in the nodecg dashboard.
@@ -21,7 +21,7 @@ _Note:_ If you don't have such a key yet, you can generate it on https://twitcha
5. Enter credentials for twitch.
- The created instance should be automatically selected, if not select it in the upper left menu. Enter your Twitch oauth Key in monaco (the text-editor on the right) in this format:
+ The created instance should be automatically selected, if not select it in the upper left menu. Enter your Twitch OAuth Key in monaco (the text-editor on the right) in this format:
```json
{
diff --git a/docs/samples/twitch-api.md b/docs/samples/twitch-api.md
index d5de3ea2..4ad13738 100644
--- a/docs/samples/twitch-api.md
+++ b/docs/samples/twitch-api.md
@@ -1,17 +1,17 @@
-## Using the Twitch Api sample bundle
+## Using the Twitch API sample bundle
-The twitch-api example bundle in `samples/twitch-api` demonstrates the ability to access the twitch api (kraken/helix). Here is a guide to how to get it working.
+The twitch-api example bundle in `samples/twitch-api` demonstrates the ability to access the twitch API (kraken/helix). Here is a guide to how to get it working.
### Prerequisites
- Working NodeCG & nodecg-io installation
- a Twitch oAuth-Key
-_Note:_ If you don't have such a key yet, you can generate it on https://twitchtokengenerator.com/, select custom scope token and select the scopes you need. For this sample you don't need any additional scopes, so you can leave everything off.
+_Note:_ If you don't have such a key yet, you can generate it on , select custom scope token and select the scopes you need. For this sample you don't need any additional scopes, so you can leave everything off.
-### Configure the Twitch Api sample bundle
+### Configure the Twitch API sample bundle
-1. Start nodecg with nodecg-io installed. The twitch-api bundle is currently part of it so it should also be loaded.
+1. Start nodecg with nodecg-io installed. The twitch-api bundle is currently part of it, so it should also be loaded.
2. Go to the `nodecg-io` tab in the nodecg dashboard.
@@ -19,9 +19,9 @@ _Note:_ If you don't have such a key yet, you can generate it on https://twitcht
4. Create a new twitch-api service instance using the left upper menu.
-5. Enter credentials for the twitch api.
+5. Enter credentials for the twitch API.
- The created instance should be automatically selected, if not select it in the upper left menu. Enter your Twitch oauth Key in monaco (the text-editor on the right) in this format:
+ The created instance should be automatically selected, if not select it in the upper left menu. Enter your Twitch OAuth Key in monaco (the text-editor on the right) in this format:
```json
{
diff --git a/docs/samples/twitch-chat.md b/docs/samples/twitch-chat.md
index 1b905ddc..ae82ebb5 100644
--- a/docs/samples/twitch-chat.md
+++ b/docs/samples/twitch-chat.md
@@ -7,11 +7,11 @@ The Twitch-chat example bundle in `samples/twitch-chat` demonstrates the ability
- Working NodeCG & nodecg-io installation
- a Twitch oAuth-Key
-_Note:_ If you don't have such a key yet, you can generate it on https://twitchapps.com/tmi/. Just log into your Twitch account and copy the token.
+_Note:_ If you don't have such a key yet, you can generate it on . Just log into your Twitch account and copy the token.
### Configure the Twitch sample bundle
-1. Start nodecg with nodecg-io installed. The Twitch-chat bundle is currently part of it so it should also be loaded.
+1. Start nodecg with nodecg-io installed. The Twitch-chat bundle is currently part of it, so it should also be loaded.
2. Go to the `nodecg-io` tab in the nodecg dashboard.
@@ -21,7 +21,7 @@ _Note:_ If you don't have such a key yet, you can generate it on https://twitcha
5. Enter credentials for twitch.
- The created instance should be automatically selected, if not select it in the upper left menu. Enter your Twitch oauth Key in monaco (the text-editor on the right) in this format:
+ The created instance should be automatically selected, if not select it in the upper left menu. Enter your Twitch OAuth Key in monaco (the text-editor on the right) in this format:
```json
{
diff --git a/docs/samples/twitch-pubsub.md b/docs/samples/twitch-pubsub.md
index 2ee9d248..86deaeed 100644
--- a/docs/samples/twitch-pubsub.md
+++ b/docs/samples/twitch-pubsub.md
@@ -1,17 +1,17 @@
## Using the Twitch PubSub sample bundle
-The twitch-pubsub example bundle in `samples/twitch-pubsub` demonstrates the ability to use the Twitch PubSub api. Here is a guide to how to get it working.
+The twitch-pubsub example bundle in `samples/twitch-pubsub` demonstrates the ability to use the Twitch PubSub API. Here is a guide to how to get it working.
### Prerequisites
- Working NodeCG & nodecg-io installation
- a Twitch oAuth-Key
-_Note:_ If you don't have such a key yet, you can generate it on https://twitchtokengenerator.com/, select custom scope token and select these scopes: `channel_subscriptions`, `bits:read` and `channel:read:redemptions`
+_Note:_ If you don't have such a key yet, you can generate it on , select custom scope token and select these scopes: `channel_subscriptions`, `bits:read` and `channel:read:redemptions`
### Configure the Twitch PubSub sample bundle
-1. Start nodecg with nodecg-io installed. The twitch-pubsub sample bundle is currently part of it so it should also be loaded.
+1. Start nodecg with nodecg-io installed. The twitch-pubsub sample bundle is currently part of it, so it should also be loaded.
2. Go to the `nodecg-io` tab in the nodecg dashboard.
@@ -21,7 +21,7 @@ _Note:_ If you don't have such a key yet, you can generate it on https://twitcht
5. Enter credentials for twitch-pubsub.
- The created instance should be automatically selected, if not select it in the upper left menu. Enter your Twitch oauth Key in monaco (the text-editor on the right) in this format:
+ The created instance should be automatically selected, if not select it in the upper left menu. Enter your Twitch OAuth Key in monaco (the text-editor on the right) in this format:
```json
{
diff --git a/docs/samples/twitter.md b/docs/samples/twitter.md
index 252cfdfe..856226fd 100644
--- a/docs/samples/twitter.md
+++ b/docs/samples/twitter.md
@@ -11,11 +11,11 @@ The Twitter timeline bundle retrieves some of the latest tweets from _skate702_
- The _Access token_ here **oauthToken**
- The _Access token secret_ here **oauthTokenSecret**
-_Note:_ You will need a twitter developer account (https://developer.twitter.com/en/apply-for-access) to get the necessary keys and tokens.
+_Note:_ You will need a Twitter developer account () to get the necessary keys and tokens.
### Configure the sample bundle
-1. Start nodecg with nodecg-io installed. The twitter-timeline bundle is currently part of it so it should also be loaded.
+1. Start nodecg with nodecg-io installed. The twitter-timeline bundle is currently part of it, so it should also be loaded.
2. Go to the `nodecg-io` tab in the nodecg dashboard.
diff --git a/docs/samples/websocket-client.md b/docs/samples/websocket-client.md
index cde4d220..ca962e18 100644
--- a/docs/samples/websocket-client.md
+++ b/docs/samples/websocket-client.md
@@ -12,7 +12,7 @@ For simplicity's sake this sample will rely upon the websocket-server sample.
Please set up the WebSocket-server bundle first and then follow these steps:
-1. Start nodecg with nodecg-io installed. The websocket-client bundle is currently part of it so it should also be loaded.
+1. Start nodecg with nodecg-io installed. The websocket-client bundle is currently part of it, so it should also be loaded.
2. Go to the `nodecg-io` tab in the nodecg dashboard.
@@ -20,7 +20,7 @@ Please set up the WebSocket-server bundle first and then follow these steps:
4. Create a new ws-client service instance using the left upper menu.
-5. Enter the address of the sample server. This has to be a url following the pattern `ws://localhost:`.
+5. Enter the address of the sample server. This has to be a URL following the pattern `ws://localhost:`.
The created instance should be automatically selected, if not select it in the upper left menu. Enter your port in monaco (the text-editor on the right) in this format:
diff --git a/docs/samples/websocket-server.md b/docs/samples/websocket-server.md
index 95c8dbd0..74346c8e 100644
--- a/docs/samples/websocket-server.md
+++ b/docs/samples/websocket-server.md
@@ -8,7 +8,7 @@ The WebSocket-server sample bundle in `samples/websocket-server` shows how to se
### Configure the websocket-server sample bundle
-1. Start nodecg with nodecg-io installed. The websocket-server bundle is currently part of it so it should also be loaded.
+1. Start nodecg with nodecg-io installed. The websocket-server bundle is currently part of it, so it should also be loaded.
2. Go to the `nodecg-io` tab in the nodecg dashboard.
diff --git a/docs/samples/xdotool.md b/docs/samples/xdotool.md
index 86dbd76a..486d26be 100644
--- a/docs/samples/xdotool.md
+++ b/docs/samples/xdotool.md
@@ -5,11 +5,11 @@ The Xdotool sample bundle in `samples/xdotool-windowminimize` shows how to use t
### Prerequisites
- Working NodeCG & nodecg-io installation
-- xdotool installed (Only works on linux)
+- xdotool installed (Only works on Linux)
### Configure the Xdotool sample bundle
-1. Start nodecg with nodecg-io installed. The xdotool bundle is currently part of it so it should also be loaded.
+1. Start nodecg with nodecg-io installed. The xdotool bundle is currently part of it, so it should also be loaded.
2. Go to the `nodecg-io` tab in the nodecg dashboard.
diff --git a/docs/samples/youtube.md b/docs/samples/youtube.md
index 24a18e6a..f11b8d15 100644
--- a/docs/samples/youtube.md
+++ b/docs/samples/youtube.md
@@ -1,19 +1,19 @@
-## Using the youtube sample bundle
+## Using the YouTube sample bundle
-The youtube bundle in `samples/youtube-playlist` demonstrates the ability of getting information of a playlist. Here is a guide to how to get it working.
+The YouTube bundle in `samples/youtube-playlist` demonstrates the ability of getting information of a playlist. Here is a guide to how to get it working.
### Prerequisites
- Working NodeCG & nodecg-io installation
-- Google cloud API OAuth access (clientID, clientSecret)
+- Google cloud API OAuth access (client ID, client Secret)
- Grant `YouTube Data API v3` access at the project's dashboard.
- - Shortcut URL: https://console.developers.google.com/apis/library/youtube.googleapis.com?project=<project-id>
+ - Shortcut URL:
-_Note:_ If you don't have such a key yet, you can generate them like [this](https://developers.google.com/identity/protocols/oauth2/web-server#creatingcred). As redirect URI add "http://localhost:9090/nodecg-io-googleapis/oauth2callback".
+_Note:_ If you don't have such a key yet, you can generate them like [this](https://developers.google.com/identity/protocols/oauth2/web-server#creatingcred). As redirect URI add .
-### Configure the youtube sample bundle
+### Configure the YouTube sample bundle
-1. Start nodecg with nodecg-io installed. The youtube bundle is currently part of it so it should also be loaded.
+1. Start nodecg with nodecg-io installed. The YouTube bundle is currently part of it, so it should also be loaded.
2. Go to the `nodecg-io` tab in the nodecg dashboard.
@@ -23,7 +23,7 @@ _Note:_ If you don't have such a key yet, you can generate them like [this](http
5. Enter credentials for googleapis.
- The created instance should be automatically selected, if not select it in the upper left menu. Enter your youtube oauth credentials in monaco (the text-editor on the right) in this format:
+ The created instance should be automatically selected, if not select it in the upper left menu. Enter your YouTube OAuth credentials in monaco (the text-editor on the right) in this format:
```json
{
@@ -38,9 +38,9 @@ _Note:_ If you don't have such a key yet, you can generate them like [this](http
_Note:_ If you don't see monaco on the right, try reloading the page.
_Note:_ You can add multiple scopes if the googleapis instance is used for multiple bundles.
-6. Set the created googleapis service instance to the service dependency of the youtube bundle.
+6. Set the created googleapis service instance to the service dependency of the YouTube bundle.
- Select the youtube bundle and the googleapis service in the left bottom menu and then select the service instance that should be used by the youtube bundle (in this case the name of the previously created googleapis instance).
+ Select the YouTube bundle and the googleapis service in the left bottom menu and then select the service instance that should be used by the YouTube bundle (in this case the name of the previously created googleapis instance).
7. Check the nodecg logs