A

docs/components/event.md

@@ -0,0 +1,17 @@
+Event
+=====
+
+Fields:
+| Type | Name | Description |
+|------|------|-------------|
+| String  | constantName | The name of the constant event to reference. If this is set then all the other fields in this event are ignored |
+| Array   | conditions | List of conditions required to trigger the event |
+| Array   | outcomes | List of outcomes to trigger if the event meets the conditions |
+| Boolean | triggersFromAnyConditionMet | Does this event trigger from any condition that is met? |
+| Boolean | allowsOtherEventsToTrigger | Does triggering this event still allow other events to trigger? |
+| Boolean | singleOutcomeOnly | If there are multiple outcomes for the event, only the first outcome that succeeds? |
+| Integer | playTime | How long to play the event, in ticks. Only if the event type has been registered a queue. Set to -1 to skip the queue.
+| Integer | delay | How long of a delay, in ticks, before playing the event |
+| Integer | cooldown | How often this event can be triggered, in ticks |
+
+Removing unnecessary fields or setting them to null is allowed/recommended to minimise file size. Booleans will default to false, numbers will default to 0.

docs/components/eventconfig.md

@@ -0,0 +1,26 @@
+Event Configuration & Configuration
+===================================
+
+## Event Configuration
+
+Event Configuration stores configurations for events.
+
+Fields:
+| Type | Name | Description |
+|------|------|-------------|
+| Array  | configs | An array of `Configuration` type objects |
+| Array  | init | An array of `Event` type objects. These events are tested with the current global variables when the `EventConfiguration` is loaded |
+| String | type | _Online Source Only:_ The type that this `EventConfiguration` is for. EG: `streamlabs/streamelements/chat`. Ignored if file is loaded from a local source. |
+| String | from | _Online Source Only:_ The online source of this `EventConfiguration`. Ignored if file is loaded from a local source. |
+
+
+## Configuration
+
+Configuration filters by account type and event type. Also defines queues for types.
+
+Fields:
+| Type | Name | Description |
+|------|------|-------------|
+| Map  | types | Key-Value pair of the stream event type and an array of events to try it against |
+| Array | queue | Array of types of events to queue. More than one event type can be put in a single queue. EG: `bits+donations` will put events of type `bits` and `donations` in the same queue. Events will only be queued if the `playTime` field is larger than or equal to 0 |
+| String | for | The account type that this configuration is for. EG: `mixer/twitch` for chat events. Leave this as null for it to apply to all account types |

docs/gettingstarted/settingup.md

@@ -30,7 +30,9 @@ Unfortunately, not much of the stream events are documented on their end, so the
 
 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.
 
-Just try and remember, this is how things flow (normally): Stream Event -> Socket -> Event Configuration -> Filter by Configuration -> Filter by type -> Event 1 -> Condition (not met) -> Event 2 -> Condition (met) -> Outcome(s)
+Just try and remember, this is how things flow (normally): Stream Event -> Socket -> Event Configuration -> Filter by Configuration -> Filter by type -> Event 1 -> Condition (not met) -> Event 2 -> Condition (met) -> Outcome
+
+<br>
 
 ### That's all folks
 

mkdocs.yml

@@ -7,6 +7,9 @@ pages:
     - Opening the Config Editor: 'gettingstarted/openingconfigeditor.md'
     - Important Definitions: 'gettingstarted/importantdefinitions.md'
     - Setting Up The Event Configuration: 'gettingstarted/settingup.md'
+  - Components:
+    - Event Configuration & Configuration: 'components/eventconfig.md'
+    - Event: 'components/event.md'
 
 # Do not edit in PRs below here
 site_name: Content Creator Integration Documentation