You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
> A broadcast graphics dashboard for controlling Splatoon tournament overlays
3
4
4
5
![License][license-shield]
@@ -15,8 +16,11 @@ This bundle was originally designed for [Off the Dial's overlays](https://github
15
16
- Preload team data, round data, and commentator block data into the dashboard
16
17
17
18
## Usage <!-- Using the product -->
19
+
18
20
### Installing NodeCG with this bundle
21
+
19
22
#### For Programmers
23
+
20
24
1. Prerequisites
21
25
1. Make sure you have [Node (with NPM)](https://nodejs.org) installed
22
26
2. Make sure you have the NodeCG CLI installed: `npm i -g nodecg`
@@ -29,14 +33,17 @@ This bundle was originally designed for [Off the Dial's overlays](https://github
29
33
7. Run NodeCG: `nodecg start`
30
34
31
35
#### For Non-Programmers
36
+
32
37
1. Find the version you're looking for on the [releases](https://github.com/cq-overlays/dashboard/releases) page, and download `cq-nodecg.zip`, a NodeCG instance with this bundle pre-installed, and unzip.
33
38
2. You can now install other bundles by dragging them into the `bundles/` subdirectory.
34
39
3. Run NodeCG by double-clicking `run.bat`, This is only for windows.
35
40
36
41
The dashboard should now be accessible! If you run into any issues or have any questions, feel free to contact me!
37
42
38
43
### Using the dashboard
44
+
39
45
The dashboard is mainly self-explanatory and can be easily learned with just a bit playing with it. For those who want a quick run-down, here are some general tips and tricks:
46
+
40
47
- Each panel is draggable and positionable, although NodeCG doesn't give you much flexibility with that
41
48
- Buttons with colored backgrounds usually update the overlays immediately. Buttons with no color or background usually need their changes to be applied using an "Update" button with a colored background
42
49
- On the `Teams` panel, there is a button in the middle of the 2 scores that will reset them
@@ -47,9 +54,11 @@ The upload file for `Loaded Data` is a JSON file, which you can find the schema
47
54
If you run into any issues or have any questions, feel free to contact me!
48
55
49
56
### Making your own overlays with this bundle
57
+
50
58
I've tried to design this bundle to make it simple and easy to connect your own overlay bundles. If you don't know how to code, and/or would be interested in commissioning me to make overlays for you, please see my [ko-fi](https://ko-fi.com/leptoflare/commissions)!
51
59
52
60
The way you connect to the stored dashboard data is with just replicants.
@@ -58,15 +67,17 @@ The way you connect to the stored dashboard data is with just replicants.
58
67
> }
59
68
>```
60
69
61
-
The documented list of all the avaliable replicants are avaliable in the [schemas](/schemas) folder. Each file is the [JSON Schema](https://json-schema.org) for the corresponding replicant. Don't worry if you can't understand it though, there's also a `"default"` key in the schema which shows you an example of what the replicant value might look like.
70
+
The documented list of all the available replicants are available in the [schemas](/schemas) folder. Each file is the [JSON Schema](https://json-schema.org) for the corresponding replicant. Don't worry if you can't understand it though, there's also a `"default"` key in the schema which shows you an example of what the replicant value might look like.
62
71
63
72
For more information on how to build your own bundles, see the [NodeCG documentation](https://www.nodecg.dev/docs/creating-bundles). If you run into any issues or have any questions, feel free to contact me!
64
73
65
74
## Contributing <!-- Using the source -->
75
+
66
76
1. Fork the repository and clone it.
67
77
2. Make a new branch to submit your pull request from.
68
78
69
79
### Running locally
80
+
70
81
1. Follow the steps in [Installing NodeCG](#installing-nodecg-with-this-bundle), **stop after step 3**
71
82
2. Install this bundle for development: `nodecg install cq-overlays/dashboard --dev`
72
83
3. CD into the bundle directory: `cd bundles/dashboard`
@@ -83,5 +94,6 @@ As always, distributed under the MIT license. See `LICENSE` for more information
0 commit comments