-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
54 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
Setting Up The Event Configuration | ||
================================== | ||
|
||
Alright so, we've gotten the important definitions out of the way, and you're looking at the Config Editor right now. Ideally, all editing of the Event Configuration file should be done in this GUI. Only edit by hand if you know what you are doing! | ||
|
||
This doc would be a lot more useful with pictures but text will have to do for now. | ||
|
||
1. Hopefully there is an entry in the left-most panel (that isn't named "Constants"). Click on it. | ||
|
||
2. A new panel should have popped up. You've managed to go one level into the Event Configuration file. | ||
|
||
...You should have noticed by now, on the bottom right panel, there will be useful flavor text that describes what you're looking at or clicking on. | ||
|
||
3. Now you should see a couple of things listed in the second panel. One of these should be called `configs`. Click on it and click on the `+` on the header toolbar. | ||
|
||
4. You should be able to click on `configs` once again and another panel should appear, showing a new Configuration. From here, you can set queues, define what this configuration is for, and set the events by type. More is explained in the Event Configuration class. | ||
|
||
5. Experiment. | ||
|
||
6. ???? | ||
|
||
7. Profit! | ||
|
||
|
||
Remember to hit save. | ||
|
||
|
||
### Disclaimer | ||
|
||
Unfortunately, not much of the stream events are documented on their end, so the best you can do is experiment. CCI already provides you what info it can, particularly in terms of the variables of stream events that have occured on the bottom left of the Config Editor. | ||
|
||
Streamlabs however has [some documentation](https://dev.streamlabs.com/docs/socket-api)(scroll down beyond the javascript code) but it is not 100% accurate to the real world application. CCI was initially designed around Streamlabs so you can see how things fit, following that documentation. | ||
|
||
|
||
### That's all folks | ||
|
||
That concludes our Getting Started category. This should be enough information for you to get the mod up and running and to the point where you yourself can create Events. The rest of the documentation will be more towards actually detailing the objects rather than "How-To"s. Good luck! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters