Skip to content

Commit aba46bb

Browse files
committed
Update readme
1 parent 0e5b82a commit aba46bb

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# <img src="cq-overlaysdashboard.png" alt="cq-overlays/dashboard" height="36" />
2+
23
> A broadcast graphics dashboard for controlling Splatoon tournament overlays
34
45
![License][license-shield]
@@ -15,8 +16,11 @@ This bundle was originally designed for [Off the Dial's overlays](https://github
1516
- Preload team data, round data, and commentator block data into the dashboard
1617

1718
## Usage <!-- Using the product -->
19+
1820
### Installing NodeCG with this bundle
21+
1922
#### For Programmers
23+
2024
1. Prerequisites
2125
1. Make sure you have [Node (with NPM)](https://nodejs.org) installed
2226
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
2933
7. Run NodeCG: `nodecg start`
3034

3135
#### For Non-Programmers
36+
3237
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.
3338
2. You can now install other bundles by dragging them into the `bundles/` subdirectory.
3439
3. Run NodeCG by double-clicking `run.bat`, This is only for windows.
3540

3641
The dashboard should now be accessible! If you run into any issues or have any questions, feel free to contact me!
3742

3843
### Using the dashboard
44+
3945
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+
4047
- Each panel is draggable and positionable, although NodeCG doesn't give you much flexibility with that
4148
- 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
4249
- 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
4754
If you run into any issues or have any questions, feel free to contact me!
4855

4956
### Making your own overlays with this bundle
57+
5058
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)!
5159

5260
The way you connect to the stored dashboard data is with just replicants.
61+
5362
> ```js
5463
> const currentTeams = nodecg.Replicant("currentTeams", "cq-dashboard");
5564
>
@@ -58,15 +67,17 @@ The way you connect to the stored dashboard data is with just replicants.
5867
> }
5968
> ```
6069
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.
6271
6372
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!
6473
6574
## Contributing <!-- Using the source -->
75+
6676
1. Fork the repository and clone it.
6777
2. Make a new branch to submit your pull request from.
6878
6979
### Running locally
80+
7081
1. Follow the steps in [Installing NodeCG](#installing-nodecg-with-this-bundle), **stop after step 3**
7182
2. Install this bundle for development: `nodecg install cq-overlays/dashboard --dev`
7283
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
8394
_[https://github.com/cq-overlays/dashboard](https://github.com/cq-overlays/dashboard)_
8495
8596
<!-- markdown links & imgs -->
97+
8698
[stars-shield]: https://img.shields.io/github/stars/cq-overlays/dashboard.svg?style=social
8799
[license-shield]: https://img.shields.io/github/license/cq-overlays/dashboard.svg?style=flat

0 commit comments

Comments
 (0)