-
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
6 changed files
with
114 additions
and
3 deletions.
There are no files selected for viewing
Empty file.
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,75 @@ | ||
Important Definitions | ||
===================== | ||
|
||
All across CCI, there will be a few terms that are brought up again and again. This page aims to explain briefly what they are. Some of these terms will have their own page explaining what they are in greater detail. | ||
|
||
## Event Configuration | ||
|
||
An event configuration is essentially the JSON files stored in the `/configs/contentcreatorintegration/` folder, in a format that is understood by CCI. | ||
|
||
It keeps everything in one place. Read about it in more detail [here](http://url.tbd). | ||
|
||
## Variables | ||
|
||
Variables are, as the name implies, variables. They are essentially a key -> value mapping and are called using the $ symbol. | ||
|
||
For example: | ||
A chat message comes in: | ||
``` | ||
Toto: I bless the rains down in Africa. | ||
``` | ||
|
||
The stream event comes in and gets processed, `Toto` is put in the `user` variable, and `I bless the rains down in Africa` is put in the `message` variable. | ||
|
||
So you get something like this: | ||
``` | ||
user => Toto | ||
message => I bless the rains down in Africa. | ||
``` | ||
|
||
You can then check if the message is from Toto by checking the `user` variable for `Toto` (or use the Specific User Condition), or you tell the streamer that Toto said something using variable insertion such as `Hey $streamer, $user said something!`. Bear in mind that variable names are case-sensitive. | ||
|
||
Not everything in CCI supports variable insertion however, look out in their descriptions to see if they do. | ||
|
||
### Global Variables | ||
|
||
Now global variables function on the same concept, but they are always available. Normally, when a stream event happens, information gets put into variables, and once processed, are discarded. | ||
|
||
Global variables allow these information to persist so you can reference them in different Events. | ||
|
||
These are some global variables that are created when the mod is started | ||
|
||
| Variable Name | | ||
|---------------| | ||
| streamer | | ||
|
||
|
||
## Condition | ||
|
||
A Condition is something used to check variables for the right value. If fitting, the condition is passed. | ||
|
||
There is a variation which is "unconditional", despite being a Condition. These conditions are used to manipulate variables before they are checked or used in other conditions or outcomes. | ||
|
||
## Outcome | ||
|
||
An Outcome is something, when triggered, would normall cause something to happen in the game. A sound being played, or a command being executed, that sort of thing. | ||
|
||
## Stream Event | ||
|
||
A Stream Event is an event that gets sent from the layer you are connected to. Examples: | ||
|
||
* Someone subscribes to the streamer on Twitch | ||
* Someone says something in Mixer chat | ||
* Someone drops a tip using Streamlabs | ||
|
||
These stream events will be received on the CCI end and will be parsed into something a little more uniform and understandable for the user. | ||
|
||
Bear in mind that Stream Events are different from Events, explained below. | ||
|
||
## Event | ||
|
||
An event is something that can potentially trigger from a Stream Event. Once the stream event is processed by CCI, it is filtered to the right Event Configuration and into the right configuration type. | ||
|
||
Then, depending on the information from the stream event, conditions, if set, are checked, and depending on the Event's setup, the outcomes of the event will be triggered. | ||
|
||
Bear in mind that Events are different from Stream Events, explained above. |
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,26 @@ | ||
Opening the Config Editor | ||
========================= | ||
|
||
So you've set up the mod config with the necessary options and restarted the game. | ||
|
||
Presuming everything was done correctly and the service is working, CCI is now connected to your layer of choice. If you enabled information toasts, you should see them when you get to the main menu. The mod will also spit this information into the console. | ||
|
||
With the sockets connected, CCI is ready to receive events, but CCI doesn't know what to do with them yet. Therefore, you need to set up the event configuration. | ||
|
||
Every type of layer in CCI has their own configuration, with exception of the chat layers. If things worked correctly, CCI should have generated the default event config and you can now see it in the config edit GUI. | ||
|
||
## The Config Editor | ||
|
||
There are two ways to open the GUI: | ||
|
||
* Open the mods list, select CCI and click on the Config button. | ||
* In-game, do `/cci edit` in the chat. | ||
|
||
Now, you should be looking at the Config Editor. Because this documentation lacks pictures at this point, I will try and explain what things are through text. Some of these elements may have tooltips so it would be worth hovering over them. | ||
|
||
* Top: Address bar/Breadcrumb trail | ||
* Center: Tree-style browser, with controls header | ||
* Bottom Left: Variables (and values) of the last few events | ||
* Bottom Right: Descriptions and helpful information, with accompanying sidebar controls. | ||
|
||
With this editor, you will be able to browse and edit the contents of various Event Configurations. However, before we get started, there are some things that you need to know first. |
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