Docs.

iChun · May 27, 2021 · e8d0617 · e8d0617
1 parent 5d104f3
commit e8d0617
Show file tree

Hide file tree

Showing 25 changed files with 140 additions and 249 deletions.
diff --git a/docs/gettingstarted/configs.md b/docs/gettingstarted/configs.md
diff --git a/docs/gettingstarted/editor.md b/docs/gettingstarted/editor.md
@@ -16,34 +16,37 @@ The editor can be accessed in two different ways:
 1. Hit the `Mods` button in the Main Menu
 
 ![](./images/editor/modsbutton.png){: class="img_center"}
-&nbsp;
+<br />
+<br />
 
 2. Find `Content Creator Integration` in the Mods list and click on it.
 
 ![](./images/editor/modslist.png){: class="img_center"}
-&nbsp;
+<br />
+<br />
 
 3. Click on the `Config` button.
 
 ![](./images/editor/configbutton.png){: class="img_center"}
-&nbsp;
-&nbsp;
+<br />
+<br />
+
 
 #### In-game Command
 
 1. Open chat and type in `/cci`. Do not put in any arguments, and hit `Enter`.
 
 ![](./images/editor/chatcommand.png){: class="img_center"}
-&nbsp;
-&nbsp;
+<br />
+<br />
 
 The CCI Editor
 ==============
 
 This is the CCI Editor. This is where you will spend most of your time setting CCI up. If things look a little squashed, you may have to increase the size of your Minecraft window. There is a **lot** to show here.
 
 ![](./images/editor/editor.png){: class="img_center"}
-&nbsp;
+<br />
 
 Here is a numbered picture and a description of what each element does.
 
@@ -62,12 +65,9 @@ The Toolbar:
 | 8   | Save Configurations   | Saves and applies all your configuration files if changed    |                                                                           |
 | 9   | Exit Button           | Exits the Editor GUI                                         | Shift-clicking saves (and applies) all your configurations before exiting |
 
-&nbsp;
-&nbsp;
-&nbsp;
-&nbsp;
 <br/>
 <br/>
+
 The Navigator:
 ![](./images/editor/editornavigation.png){: class="img_center"}
 
@@ -81,13 +81,10 @@ The Navigator:
 | 6   | Constants             | View constants                                               |                                                                            |
 | 7   | Navigational Area     | Tree-style navigation for navigation                         | You cannot edit anything here. Only navigate. Editing is on the right side |
 
-&nbsp;
-&nbsp;
-&nbsp;
-&nbsp;
 <br/>
 <br/>
-In our example, this window was blank. We've selected something to show in this screenshot to help explain...
+
+In our example, this window was blank. We've selected something to show in this screenshot to help explain...  
 The Content Editor:
 ![](./images/editor/editorcontents.png){: class="img_center"}
 

diff --git a/docs/gettingstarted/images/socketkey/streamelements/dashboard.png b/docs/gettingstarted/images/socketkey/streamelements/dashboard.png
diff --git a/docs/gettingstarted/images/socketkey/streamelements/jwttoken.png b/docs/gettingstarted/images/socketkey/streamelements/jwttoken.png
diff --git a/docs/gettingstarted/images/socketkey/streamelements/showsecrets.png b/docs/gettingstarted/images/socketkey/streamelements/showsecrets.png
diff --git a/docs/gettingstarted/images/socketkey/streamlabs/apisettings.png b/docs/gettingstarted/images/socketkey/streamlabs/apisettings.png
diff --git a/docs/gettingstarted/images/socketkey/streamlabs/apitokens.png b/docs/gettingstarted/images/socketkey/streamlabs/apitokens.png
diff --git a/docs/gettingstarted/images/socketkey/streamlabs/dashboard.png b/docs/gettingstarted/images/socketkey/streamlabs/dashboard.png
diff --git a/docs/gettingstarted/images/socketkey/streamlabs/socketapitoken.png b/docs/gettingstarted/images/socketkey/streamlabs/socketapitoken.png
diff --git a/docs/gettingstarted/images/socketkey/twitchchat/channelname.png b/docs/gettingstarted/images/socketkey/twitchchat/channelname.png
diff --git a/docs/gettingstarted/images/socketkey/twitchchat/url.png b/docs/gettingstarted/images/socketkey/twitchchat/url.png
diff --git a/docs/gettingstarted/images/socketkey/youtubechat/apikey.png b/docs/gettingstarted/images/socketkey/youtubechat/apikey.png
diff --git a/docs/gettingstarted/images/socketkey/youtubechat/apikeyconfig.png b/docs/gettingstarted/images/socketkey/youtubechat/apikeyconfig.png
diff --git a/docs/gettingstarted/images/socketkey/youtubechat/channelid.png b/docs/gettingstarted/images/socketkey/youtubechat/channelid.png
diff --git a/docs/gettingstarted/images/socketkey/youtubechat/googlecloud.png b/docs/gettingstarted/images/socketkey/youtubechat/googlecloud.png
diff --git a/docs/gettingstarted/images/socketkey/youtubechat/youtubechannel.png b/docs/gettingstarted/images/socketkey/youtubechat/youtubechannel.png
diff --git a/docs/gettingstarted/importantdefinitions.md b/docs/gettingstarted/importantdefinitions.md
diff --git a/docs/gettingstarted/index.md b/docs/gettingstarted/index.md
@@ -22,7 +22,7 @@ Throughout these docs there will be a couple of mentions of similarly sounding w
 
 | Stream Event | Event |
 |--------------|-------|
-| These are events that happen on stream. Subscriptions, cheers, chat messages. | These are events configured in CCI to act on Stream Events. These contain conditions, outcomes, etc. More on that later. |
+| These are events that happen on stream. Subscriptions, cheers, chat messages, etc | These are events configured in CCI to act on different things, including Stream Events. These contain conditions, outcomes, etc. More on that later. |
 
 | Mod Config   | Config |
 |--------------|--------|
@@ -39,21 +39,24 @@ When launching CCI on the client for the first time, you should be prompted with
 Clicking on the `CCI` button (in the green circle) should open up the First Launch Setup Wizard.
 
 ![](./images/setupwizard.png){: class="img_center"}
-&nbsp;
+<br />
+<br />
 
 Click on any of the buttons for the services to add a registry for that service. The input window will look similar to this. To find the key for the service you've selected, we have instructions on a different page. Check the sidebar for your selected service's page.
 
-In this example, we're using a Twitch Chat and already have one channel name added.
+In this example, we're using a Twitch Chat and already have one channel name added. One key per line.
 
 ![](./images/exampletoken.png){: class="img_center"}
-&nbsp;
+<br />
+<br />
 
 Once you hit `Done`, you will be taken back to the services list. If you're done adding services, hit `Done` again. You may notice a bunch of toasts pop up indicating that CCI is attempting to connect to those services.
 
 You will now be asked if your streamer name differs from your Minecraft In-Game Name.
 
 ![](./images/nameprompt.png){: class="img_center"}
-&nbsp;
+<br />
+<br />
 
 Hitting yes will allow you to set your streamer name, which will affect your `$streamerName` variable. More on [Variables](url.tbd) later.
 

diff --git a/docs/gettingstarted/openingconfigeditor.md b/docs/gettingstarted/openingconfigeditor.md
diff --git a/docs/gettingstarted/settingup.md b/docs/gettingstarted/settingup.md
diff --git a/docs/gettingstarted/socketkey/streamelements.md b/docs/gettingstarted/socketkey/streamelements.md
@@ -0,0 +1,21 @@
+Finding your StreamElements JWT Token
+=====================================
+
+| Protip |
+|--------|
+| Playing Test Events work with CCI, but isn't always representative of a live event. Always use live events when making configs where possible. |
+
+
+1. Go to your StreamElements dashboard and click on your profile name in the top right.
+
+![](../images/socketkey/streamelements/dashboard.png){: class="img_center"}
+<br />
+<br />
+2. In the Channels tab, click on the Show secrets button.
+
+![](../images/socketkey/streamelements/showsecrets.png){: class="img_center"}
+<br />
+<br />
+3. And there's your JWT Token. Copy that, it's what CCI needs.
+
+![](../images/socketkey/streamelements/jwttoken.png){: class="img_center"}
diff --git a/docs/gettingstarted/socketkey/streamlabs.md b/docs/gettingstarted/socketkey/streamlabs.md
@@ -0,0 +1,30 @@
+Finding Your Streamlabs Socket.IO API key
+=========================================
+
+| Protip |
+|--------|
+| Streamlabs usually needs one of their sockets active before they begin transmitting to other third party sockets. I recommend having one of their widgets open during your stream, such as their Event List widget. |
+
+| Protip |
+|--------|
+| Replaying events through the dashboard works with CCI, but isn't always representative of a live event. Always use live events when making configs where possible. |
+
+
+1. Go to your Streamlabs dashboard and click on Settings in the left sidebar, under Account
+
+![](../images/socketkey/streamlabs/dashboard.png){: class="img_center"}
+<br />
+<br />
+2. In the Account Settings page, click on API Settings
+
+![](../images/socketkey/streamlabs/apisettings.png){: class="img_center"}
+<br />
+<br />
+3. In The API Settings page, click on API Tokens
+
+![](../images/socketkey/streamlabs/apisettings.png){: class="img_center"}
+<br />
+<br />
+4. And there's your Socket API Token. Copy that, it's what CCI needs.
+
+![](../images/socketkey/streamlabs/socketapitoken.png){: class="img_center"}