From 4bec9e9117f49e69cddf8877b7c6faacf57626bb Mon Sep 17 00:00:00 2001 From: Extrem Techniker Date: Sun, 31 Oct 2021 19:59:29 +0100 Subject: [PATCH 1/4] Add documentation --- docs/index.md | 1 + docs/services.md | 9 +++++++++ 2 files changed, 10 insertions(+) diff --git a/docs/index.md b/docs/index.md index 0733d280..4e59aaf5 100644 --- a/docs/index.md +++ b/docs/index.md @@ -29,6 +29,7 @@ If that's no problem you can head over to the [installation guide](./getting_sta - AutoHotkey - Android (using adb) - Art-Net +- Atem - CurseForge - DBus - Discord diff --git a/docs/services.md b/docs/services.md index bd126e64..a56179ae 100644 --- a/docs/services.md +++ b/docs/services.md @@ -37,6 +37,15 @@ See the [sample implementation](samples/artnet.md) Depends on [nodecg-io-core](https://github.com/codeoverflow-org/nodecg-io/tree/master/nodecg-io-core) @ ^0.2.0
Depends on [artnet-protocol](https://www.npmjs.com/package/artnet-protocol) @ ^0.2.1
+## [nodecg-io-atem](https://github.com/codeoverflow-org/nodecg-io/tree/master/services/nodecg-io-atem) + +**Allows you to communicate with atem protocol** + +See the [sample implementation](samples/atem.md) + +Depends on [nodecg-io-core](https://github.com/codeoverflow-org/nodecg-io/tree/master/nodecg-io-core) @ ^0.2.0
+Depends on [atem-connection](https://www.npmjs.com/package/atem-connection) @ ^2.3.1
+ ## [nodecg-io-curseforge](https://github.com/codeoverflow-org/nodecg-io/tree/master/services/nodecg-io-curseforge) **A service to communicate with the CurseForge API.** From 84d72bfc96cf9c5e5fa2df1bf60a6f9612a1fd4a Mon Sep 17 00:00:00 2001 From: Extrem Techniker Date: Mon, 1 Nov 2021 20:27:58 +0100 Subject: [PATCH 2/4] Add sample documentation for atem --- docs/samples/atem.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 docs/samples/atem.md diff --git a/docs/samples/atem.md b/docs/samples/atem.md new file mode 100644 index 00000000..338beea4 --- /dev/null +++ b/docs/samples/atem.md @@ -0,0 +1,36 @@ +## Using the Atem sample bundle + +The Atem sample bundle in `samples/atem` shows how to listen to commands. + +### Prerequisites + +You will need a working `nodecg-io` installation. If you have non yet take a +look at [installation guide](../getting_started/install.md). You may need to +install this bundle, so take a look at the +[“Try an included sample”](../getting_started/try_example_bundle.md)-Guide. It +will also tell you how to log in and how to use the GUI. + + +### Configure the AutoHotkey sample bundle + +1. In NodeCG, create a new atem service instance. +2. Enter the address and optional a port of the Atem server: + + ```json + { + "address": "0.0.0.0" + } + or + + ```json + { + "address": "0.0.0.0", + "port": 9910 + } + ``` + + After entering it, click save. + +3. Set the sample's (`atem`) dependency to be the newly created + service instance (of type `atem`). +4. Now all commands sended through the atem protocol should be logged in the console. From 347375e6530caf7c0c8994a304a6d1e23502a745 Mon Sep 17 00:00:00 2001 From: Extrem Techniker Date: Mon, 1 Nov 2021 20:28:42 +0100 Subject: [PATCH 3/4] Fix typo --- docs/samples/atem.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/samples/atem.md b/docs/samples/atem.md index 338beea4..59085c24 100644 --- a/docs/samples/atem.md +++ b/docs/samples/atem.md @@ -11,7 +11,7 @@ install this bundle, so take a look at the will also tell you how to log in and how to use the GUI. -### Configure the AutoHotkey sample bundle +### Configure the Atem sample bundle 1. In NodeCG, create a new atem service instance. 2. Enter the address and optional a port of the Atem server: From 9a4c117e536c4d58ca327a8bbe10024532757278 Mon Sep 17 00:00:00 2001 From: Daniel <30466471+daniel0611@users.noreply.github.com> Date: Mon, 1 Nov 2021 21:59:38 +0100 Subject: [PATCH 4/4] Fix atem sample syntax error and add it to the nav bar --- docs/samples/atem.md | 2 ++ mkdocs.yml | 1 + 2 files changed, 3 insertions(+) diff --git a/docs/samples/atem.md b/docs/samples/atem.md index 59085c24..10496c72 100644 --- a/docs/samples/atem.md +++ b/docs/samples/atem.md @@ -20,6 +20,8 @@ will also tell you how to log in and how to use the GUI. { "address": "0.0.0.0" } + ``` + or ```json diff --git a/mkdocs.yml b/mkdocs.yml index 4c30b4d0..e678dc80 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -52,6 +52,7 @@ nav: - Available services: services.md - AHK sample: samples/ahk.md - Art-Net sample: samples/artnet.md + - Atem sample: samples/atem.md - Curseforge sample: samples/curseforge.md - Android: samples/android.md - DBus: samples/dbus-ratbagd.md