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

Commit 41bbb81

Browse files
Update docs for Melan (#1)
* Update docs for Melan * Update docs for Melan II
1 parent e516353 commit 41bbb81

File tree

3 files changed

+87
-18
lines changed

3 files changed

+87
-18
lines changed

docs/dependencies.md

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,12 @@ FontStyle Underline
1616
[<u>nodecg-io-core] as nodecg_io_core <<core>> [[https://github.com/codeoverflow-org/nodecg-io/tree/master/nodecg-io-core]]
1717
[<u>ajv] as ajv <<lib>> [[https://www.npmjs.com/package/ajv]]
1818
[<u>crypto-js] as crypto_js <<lib>> [[https://www.npmjs.com/package/crypto-js]]
19-
[<u>tslib] as tslib <<lib>> [[https://www.npmjs.com/package/tslib]]
20-
[<u>typescript] as typescript <<lib>> [[https://www.npmjs.com/package/typescript]]
2119
[<u>nodecg-io-ahk] as nodecg_io_ahk <<service>> [[https://github.com/codeoverflow-org/nodecg-io/tree/master/nodecg-io-ahk]]
2220
[<u>node-fetch] as node_fetch <<lib>> [[https://www.npmjs.com/package/node-fetch]]
21+
[<u>nodecg-io-android] as nodecg_io_android <<service>> [[https://github.com/codeoverflow-org/nodecg-io/tree/master/nodecg-io-android]]
22+
[<u>@rauschma/stringio] as rauschma_stringio <<lib>> [[https://www.npmjs.com/package/@rauschma/stringio]]
23+
[<u>get-stream] as get_stream <<lib>> [[https://www.npmjs.com/package/get-stream]]
24+
[<u>nodecg-io-curseforge] as nodecg_io_curseforge <<service>> [[https://github.com/codeoverflow-org/nodecg-io/tree/master/nodecg-io-curseforge]]
2325
[<u>nodecg-io-discord] as nodecg_io_discord <<service>> [[https://github.com/codeoverflow-org/nodecg-io/tree/master/nodecg-io-discord]]
2426
[<u>discord.js] as discord_js <<lib>> [[https://www.npmjs.com/package/discord.js]]
2527
[<u>nodecg-io-intellij] as nodecg_io_intellij <<service>> [[https://github.com/codeoverflow-org/nodecg-io/tree/master/nodecg-io-intellij]]
@@ -29,6 +31,7 @@ FontStyle Underline
2931
[<u>nodecg-io-midi-input] as nodecg_io_midi_input <<service>> [[https://github.com/codeoverflow-org/nodecg-io/tree/master/nodecg-io-midi-input]]
3032
[<u>easymidi] as easymidi <<lib>> [[https://www.npmjs.com/package/easymidi]]
3133
[<u>nodecg-io-midi-output] as nodecg_io_midi_output <<service>> [[https://github.com/codeoverflow-org/nodecg-io/tree/master/nodecg-io-midi-output]]
34+
[<u>nodecg-io-nanoleaf] as nodecg_io_nanoleaf <<service>> [[https://github.com/codeoverflow-org/nodecg-io/tree/master/nodecg-io-nanoleaf]]
3235
[<u>nodecg-io-obs] as nodecg_io_obs <<service>> [[https://github.com/codeoverflow-org/nodecg-io/tree/master/nodecg-io-obs]]
3336
[<u>obs-websocket-js] as obs_websocket_js <<lib>> [[https://www.npmjs.com/package/obs-websocket-js]]
3437
[<u>nodecg-io-philipshue] as nodecg_io_philipshue <<service>> [[https://github.com/codeoverflow-org/nodecg-io/tree/master/nodecg-io-philipshue]]
@@ -60,11 +63,14 @@ FontStyle Underline
6063
[<u>nodecg-io-telegram] as nodecg_io_telegram <<service>> [[https://github.com/codeoverflow-org/nodecg-io/tree/master/nodecg-io-telegram]]
6164
[<u>@types/node-telegram-bot-api] as types_node_telegram_bot_api <<lib>> [[https://www.npmjs.com/package/@types/node-telegram-bot-api]]
6265
[<u>node-telegram-bot-api] as node_telegram_bot_api <<lib>> [[https://www.npmjs.com/package/node-telegram-bot-api]]
66+
[<u>nodecg-io-template] as nodecg_io_template <<service>> [[https://github.com/codeoverflow-org/nodecg-io/tree/master/nodecg-io-template]]
6367
[<u>nodecg-io-tiane] as nodecg_io_tiane <<service>> [[https://github.com/codeoverflow-org/nodecg-io/tree/master/nodecg-io-tiane]]
6468
[<u>ws] as ws <<lib>> [[https://www.npmjs.com/package/ws]]
65-
[<u>nodecg-io-twitch-chat] as nodecg_io_twitch_chat <<service>> [[https://github.com/codeoverflow-org/nodecg-io/tree/master/nodecg-io-twitch-chat]]
69+
[<u>nodecg-io-twitch-addons] as nodecg_io_twitch_addons <<service>> [[https://github.com/codeoverflow-org/nodecg-io/tree/master/nodecg-io-twitch-addons]]
70+
[<u>nodecg-io-twitch-api] as nodecg_io_twitch_api <<service>> [[https://github.com/codeoverflow-org/nodecg-io/tree/master/nodecg-io-twitch-api]]
6671
[<u>twitch] as twitch <<lib>> [[https://www.npmjs.com/package/twitch]]
6772
[<u>twitch-auth] as twitch_auth <<lib>> [[https://www.npmjs.com/package/twitch-auth]]
73+
[<u>nodecg-io-twitch-chat] as nodecg_io_twitch_chat <<service>> [[https://github.com/codeoverflow-org/nodecg-io/tree/master/nodecg-io-twitch-chat]]
6874
[<u>twitch-chat-client] as twitch_chat_client <<lib>> [[https://www.npmjs.com/package/twitch-chat-client]]
6975
[<u>nodecg-io-twitch-pubsub] as nodecg_io_twitch_pubsub <<service>> [[https://github.com/codeoverflow-org/nodecg-io/tree/master/nodecg-io-twitch-pubsub]]
7076
[<u>twitch-pubsub-client] as twitch_pubsub_client <<lib>> [[https://www.npmjs.com/package/twitch-pubsub-client]]
@@ -75,16 +81,18 @@ FontStyle Underline
7581
[<u>@types/ws] as types_ws <<lib>> [[https://www.npmjs.com/package/@types/ws]]
7682
[<u>nodecg-io-websocket-server] as nodecg_io_websocket_server <<service>> [[https://github.com/codeoverflow-org/nodecg-io/tree/master/nodecg-io-websocket-server]]
7783
[<u>nodecg-io-xdotool] as nodecg_io_xdotool <<service>> [[https://github.com/codeoverflow-org/nodecg-io/tree/master/nodecg-io-xdotool]]
78-
[<u>@rauschma/stringio] as rauschma_stringio <<lib>> [[https://www.npmjs.com/package/@rauschma/stringio]]
7984
[<u>nodecg-io-youtube] as nodecg_io_youtube <<service>> [[https://github.com/codeoverflow-org/nodecg-io/tree/master/nodecg-io-youtube]]
8085
[<u>@types/gapi] as types_gapi <<lib>> [[https://www.npmjs.com/package/@types/gapi]]
8186
[<u>googleapis] as googleapis <<lib>> [[https://www.npmjs.com/package/googleapis]]
8287
nodecg_io_core ...> ajv
8388
nodecg_io_core ...> crypto_js
84-
nodecg_io_core ...> tslib
85-
nodecg_io_core ...> typescript
8689
nodecg_io_ahk --> nodecg_io_core
8790
nodecg_io_ahk ...> node_fetch
91+
nodecg_io_android --> nodecg_io_core
92+
nodecg_io_android ...> rauschma_stringio
93+
nodecg_io_android ...> get_stream
94+
nodecg_io_curseforge --> nodecg_io_core
95+
nodecg_io_curseforge ...> node_fetch
8896
nodecg_io_discord ...> discord_js
8997
nodecg_io_discord --> nodecg_io_core
9098
nodecg_io_intellij --> nodecg_io_core
@@ -96,6 +104,8 @@ nodecg_io_midi_input --> nodecg_io_core
96104
nodecg_io_midi_input ...> easymidi
97105
nodecg_io_midi_output --> nodecg_io_core
98106
nodecg_io_midi_output ...> easymidi
107+
nodecg_io_nanoleaf --> nodecg_io_core
108+
nodecg_io_nanoleaf ...> node_fetch
99109
nodecg_io_obs --> nodecg_io_core
100110
nodecg_io_obs ...> obs_websocket_js
101111
nodecg_io_philipshue ...> is_ip
@@ -128,8 +138,14 @@ nodecg_io_streamelements ...> socket_io_client
128138
nodecg_io_telegram ...> types_node_telegram_bot_api
129139
nodecg_io_telegram ...> node_telegram_bot_api
130140
nodecg_io_telegram --> nodecg_io_core
141+
nodecg_io_template --> nodecg_io_core
131142
nodecg_io_tiane --> nodecg_io_core
132143
nodecg_io_tiane ...> ws
144+
nodecg_io_twitch_addons --> nodecg_io_core
145+
nodecg_io_twitch_addons ...> node_fetch
146+
nodecg_io_twitch_api --> nodecg_io_core
147+
nodecg_io_twitch_api ...> twitch
148+
nodecg_io_twitch_api ...> twitch_auth
133149
nodecg_io_twitch_chat --> nodecg_io_core
134150
nodecg_io_twitch_chat ...> twitch
135151
nodecg_io_twitch_chat ...> twitch_auth

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
<!-- Do not set the 'Services implemented' value manually. It's inserted automatically. -->
88

9-
[![Sevices](https://img.shields.io/static/v1?label=Services%20implemented&message=26&color=blue&style=flat-square)](services.md)
9+
[![Sevices](https://img.shields.io/static/v1?label=Services%20implemented&message=32&color=blue&style=flat-square)](services.md)
1010
[![License](https://img.shields.io/github/license/codeoverflow-org/nodecg-io?label=License&style=flat-square)](https://github.com/codeoverflow-org/nodecg-io/blob/master/LICENSE)
1111
[![Discord](https://img.shields.io/badge/discord-join-7289DA.svg?logo=discord&style=flat-square)](https://discord.gg/sX2Gjbs/)
1212

docs/services.md

Lines changed: 64 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,6 @@
77

88
Depends on [ajv](https://www.npmjs.com/package/ajv) @ ^6.12.6 <br>
99
Depends on [crypto-js](https://www.npmjs.com/package/crypto-js) @ ^4.0.0 <br>
10-
Depends on [tslib](https://www.npmjs.com/package/tslib) @ ^2.0.3 <br>
11-
Depends on [typescript](https://www.npmjs.com/package/typescript) @ ^4.1.3 <br>
1210

1311
## [nodecg-io-ahk](https://github.com/codeoverflow-org/nodecg-io/tree/master/nodecg-io-ahk)
1412

@@ -19,6 +17,25 @@ See the [sample implementation](samples/ahk.md)
1917
Depends on [nodecg-io-core](https://github.com/codeoverflow-org/nodecg-io/tree/master/nodecg-io-core) @ ^0.1.0 <br>
2018
Depends on [node-fetch](https://www.npmjs.com/package/node-fetch) @ ^2.6.1 <br>
2119

20+
## [nodecg-io-android](https://github.com/codeoverflow-org/nodecg-io/tree/master/nodecg-io-android)
21+
22+
**Allows to connect to an android device via adb.**
23+
24+
There's no sample implementation for this service yet.
25+
26+
Depends on [nodecg-io-core](https://github.com/codeoverflow-org/nodecg-io/tree/master/nodecg-io-core) @ ^0.1.0 <br>
27+
Depends on [@rauschma/stringio](https://www.npmjs.com/package/@rauschma/stringio) @ ^1.4.0 <br>
28+
Depends on [get-stream](https://www.npmjs.com/package/get-stream) @ 6.0.0 <br>
29+
30+
## [nodecg-io-curseforge](https://github.com/codeoverflow-org/nodecg-io/tree/master/nodecg-io-curseforge)
31+
32+
**A service to communicate with the CurseForge API.**
33+
34+
See the [sample implementation](samples/curseforge.md)
35+
36+
Depends on [nodecg-io-core](https://github.com/codeoverflow-org/nodecg-io/tree/master/nodecg-io-core) @ ^0.1.0 <br>
37+
Depends on [node-fetch](https://www.npmjs.com/package/node-fetch) @ ^2.6.1 <br>
38+
2239
## [nodecg-io-discord](https://github.com/codeoverflow-org/nodecg-io/tree/master/nodecg-io-discord)
2340

2441
**Allows to connect to discord via a discord-bot.**
@@ -43,7 +60,7 @@ Depends on [node-fetch](https://www.npmjs.com/package/node-fetch) @ ^2.6.1 <br>
4360

4461
There's no sample implementation for this service yet.
4562

46-
Depends on [@types/irc](https://www.npmjs.com/package/@types/irc) @ ^0.3.33 <br>
63+
Depends on [@types/irc](https://www.npmjs.com/package/@types/irc) @ ^0.5.0 <br>
4764
Depends on [irc](https://www.npmjs.com/package/irc) @ ^0.5.2 <br>
4865
Depends on [nodecg-io-core](https://github.com/codeoverflow-org/nodecg-io/tree/master/nodecg-io-core) @ ^0.1.0 <br>
4966

@@ -65,6 +82,15 @@ See the [sample implementation](samples/midi-output.md)
6582
Depends on [nodecg-io-core](https://github.com/codeoverflow-org/nodecg-io/tree/master/nodecg-io-core) @ ^0.1.0 <br>
6683
Depends on [easymidi](https://www.npmjs.com/package/easymidi) @ ^2.0.1 <br>
6784

85+
## [nodecg-io-nanoleaf](https://github.com/codeoverflow-org/nodecg-io/tree/master/nodecg-io-nanoleaf)
86+
87+
**Allows to connect to a nanoleaf controller and trigger custom lighting effects.**
88+
89+
There's no sample implementation for this service yet.
90+
91+
Depends on [nodecg-io-core](https://github.com/codeoverflow-org/nodecg-io/tree/master/nodecg-io-core) @ ^0.1.0 <br>
92+
Depends on [node-fetch](https://www.npmjs.com/package/node-fetch) @ ^2.6.1 <br>
93+
6894
## [nodecg-io-obs](https://github.com/codeoverflow-org/nodecg-io/tree/master/nodecg-io-obs)
6995

7096
**Allows to control your obs instance to e.g. switch scenes.**
@@ -146,7 +172,7 @@ Depends on [nodecg-io-core](https://github.com/codeoverflow-org/nodecg-io/tree/m
146172

147173
See the [sample implementation](samples/spotify.md)
148174

149-
Depends on [@types/spotify-web-api-node](https://www.npmjs.com/package/@types/spotify-web-api-node) @ ^4.0.2 <br>
175+
Depends on [@types/spotify-web-api-node](https://www.npmjs.com/package/@types/spotify-web-api-node) @ ^5.0.0 <br>
150176
Depends on [express](https://www.npmjs.com/package/express) @ ^4.17.1 <br>
151177
Depends on [nodecg-io-core](https://github.com/codeoverflow-org/nodecg-io/tree/master/nodecg-io-core) @ ^0.1.0 <br>
152178
Depends on [open](https://www.npmjs.com/package/open) @ ^7.3.0 <br>
@@ -169,7 +195,7 @@ There's no sample implementation for this service yet.
169195

170196
Depends on [@types/socket.io-client](https://www.npmjs.com/package/@types/socket.io-client) @ ^1.4.34 <br>
171197
Depends on [nodecg-io-core](https://github.com/codeoverflow-org/nodecg-io/tree/master/nodecg-io-core) @ ^0.1.0 <br>
172-
Depends on [socket.io-client](https://www.npmjs.com/package/socket.io-client) @ ^3.0.4 <br>
198+
Depends on [socket.io-client](https://www.npmjs.com/package/socket.io-client) @ ^2.3.1 <br>
173199

174200
## [nodecg-io-telegram](https://github.com/codeoverflow-org/nodecg-io/tree/master/nodecg-io-telegram)
175201

@@ -181,6 +207,14 @@ Depends on [@types/node-telegram-bot-api](https://www.npmjs.com/package/@types/n
181207
Depends on [node-telegram-bot-api](https://www.npmjs.com/package/node-telegram-bot-api) @ ^0.51.0 <br>
182208
Depends on [nodecg-io-core](https://github.com/codeoverflow-org/nodecg-io/tree/master/nodecg-io-core) @ ^0.1.0 <br>
183209

210+
## [nodecg-io-template](https://github.com/codeoverflow-org/nodecg-io/tree/master/nodecg-io-template)
211+
212+
**Template package.**
213+
214+
There's no sample implementation for this service yet.
215+
216+
Depends on [nodecg-io-core](https://github.com/codeoverflow-org/nodecg-io/tree/master/nodecg-io-core) @ ^0.1.0 <br>
217+
184218
## [nodecg-io-tiane](https://github.com/codeoverflow-org/nodecg-io/tree/master/nodecg-io-tiane)
185219

186220
**Connect to TIANE and make her for example a discord bot. https://github.com/FerdiKr/TIANE**
@@ -190,16 +224,35 @@ See the [sample implementation](samples/tiane.md)
190224
Depends on [nodecg-io-core](https://github.com/codeoverflow-org/nodecg-io/tree/master/nodecg-io-core) @ ^0.1.0 <br>
191225
Depends on [ws](https://www.npmjs.com/package/ws) @ ^7.4.1 <br>
192226

227+
## [nodecg-io-twitch-addons](https://github.com/codeoverflow-org/nodecg-io/tree/master/nodecg-io-twitch-addons)
228+
229+
**Support for the API's of BetterTTV and FrankerFaceZ**
230+
231+
There's no sample implementation for this service yet.
232+
233+
Depends on [nodecg-io-core](https://github.com/codeoverflow-org/nodecg-io/tree/master/nodecg-io-core) @ ^0.1.0 <br>
234+
Depends on [node-fetch](https://www.npmjs.com/package/node-fetch) @ ^2.6.1 <br>
235+
236+
## [nodecg-io-twitch-api](https://github.com/codeoverflow-org/nodecg-io/tree/master/nodecg-io-twitch-api)
237+
238+
**Allows talking to twitch APIs like helix.**
239+
240+
There's no sample implementation for this service yet.
241+
242+
Depends on [nodecg-io-core](https://github.com/codeoverflow-org/nodecg-io/tree/master/nodecg-io-core) @ ^0.1.0 <br>
243+
Depends on [twitch](https://www.npmjs.com/package/twitch) @ ^4.4.7 <br>
244+
Depends on [twitch-auth](https://www.npmjs.com/package/twitch-auth) @ ^4.4.7 <br>
245+
193246
## [nodecg-io-twitch-chat](https://github.com/codeoverflow-org/nodecg-io/tree/master/nodecg-io-twitch-chat)
194247

195-
**Allows to connect to twitch with your account, send and receive messages and much more. It can be used to create Twitch-Bots.**
248+
**Allows to connect to the twitch chat with your account, send and receive messages and much more. It can be used to create Twitch-Bots.**
196249

197250
See the [sample implementation](samples/twitch-chat.md)
198251

199252
Depends on [nodecg-io-core](https://github.com/codeoverflow-org/nodecg-io/tree/master/nodecg-io-core) @ ^0.1.0 <br>
200-
Depends on [twitch](https://www.npmjs.com/package/twitch) @ ^4.3.6 <br>
201-
Depends on [twitch-auth](https://www.npmjs.com/package/twitch-auth) @ ^4.3.6 <br>
202-
Depends on [twitch-chat-client](https://www.npmjs.com/package/twitch-chat-client) @ ^4.3.6 <br>
253+
Depends on [twitch](https://www.npmjs.com/package/twitch) @ ^4.4.7 <br>
254+
Depends on [twitch-auth](https://www.npmjs.com/package/twitch-auth) @ ^4.4.7 <br>
255+
Depends on [twitch-chat-client](https://www.npmjs.com/package/twitch-chat-client) @ ^4.4.7 <br>
203256

204257
## [nodecg-io-twitch-pubsub](https://github.com/codeoverflow-org/nodecg-io/tree/master/nodecg-io-twitch-pubsub)
205258

@@ -208,8 +261,8 @@ Depends on [twitch-chat-client](https://www.npmjs.com/package/twitch-chat-client
208261
There's no sample implementation for this service yet.
209262

210263
Depends on [nodecg-io-core](https://github.com/codeoverflow-org/nodecg-io/tree/master/nodecg-io-core) @ ^0.1.0 <br>
211-
Depends on [twitch](https://www.npmjs.com/package/twitch) @ ^4.3.6 <br>
212-
Depends on [twitch-pubsub-client](https://www.npmjs.com/package/twitch-pubsub-client) @ ^4.3.6 <br>
264+
Depends on [twitch](https://www.npmjs.com/package/twitch) @ ^4.4.7 <br>
265+
Depends on [twitch-pubsub-client](https://www.npmjs.com/package/twitch-pubsub-client) @ ^4.4.7 <br>
213266

214267
## [nodecg-io-twitter](https://github.com/codeoverflow-org/nodecg-io/tree/master/nodecg-io-twitter)
215268

0 commit comments

Comments
 (0)