Code Docs

StreamUP Product Documentation

Untitled

General Notices


<aside> <img src="/icons/info-alternate_blue.svg" alt="/icons/info-alternate_blue.svg" width="40px" />

This product comes without a .StreamUP file because it is just controlled inside of Streamer.Bot. It drives the StreamUP Chapter Marker Manager OBS Plugin, so make sure you have that installed in OBS first. Remember you can get access to everything by supporting us monthly!

You still need to install the product into Streamer.Bot and use our DLL so make sure you follow the instructions below! Installing Products into Streamer.Bot Adding a Product into Streamer.Bot Setting Up a Product in Streamer.Bot* *

All these links go to the same page but for easy of access I included them all so that you can clearly see what is required to do before continuing!

</aside>

After Streamer.Bot Installation


Alright, now that you have installed everything that is required into Streamer.Bot it is time to start using the Chapter Marker Manager Companion. If you are unsure what some of the settings were and what they did you can see explanations at the bottom of this guide.

<aside> <img src="/icons/info-alternate_blue.svg" alt="/icons/info-alternate_blue.svg" width="40px" /> If there is an tiny image, you can click on the image to see a enhanced version of it.

</aside>

User Guide


<aside> <img src="/icons/info-alternate_blue.svg" alt="/icons/info-alternate_blue.svg" width="40px" /> Please note, this product has chat commands so make sure to enable them after you have installed it into Streamer.Bot Enabling Chat Commands In Streamer.Bot

</aside>

Overview

This plugin works with the StreamUP Chapter Marker Manager OBS Plugin, so it is recommended you download that first. It will allow you to do the following:

Set Chapter Marker

This will send a Chapter Marker to the OBS plugin and that will be saved in your exported chapter markers file. There are examples built in that will allow Moderators to add chapter markers with the ‘!marker’ command. You can create your own triggers by doing the following:

  1. Create a new action, set a trigger.

  2. Add a 2 new Sub-Actions. Choose ‘Core → Arguments→ Set Argument’.

    Untitled

  3. You can set the following arguments. You can use any variables in the ‘Value’ box you like too

    1. chapterName

      Untitled

    2. chapterSource

      Untitled

  4. Add a new Sub-Action. Choose ‘Core → Actions → Run Action’.

  5. Choose ‘CMMC • Set Chapter Marker’ and leave ‘Run Action Immediately’ checked.

    Untitled

  6. Now when this action is triggered it will add a chapter marker in OBS to be exported in your recordings chapter marker files and it will be sent to your Twitch VOD.

Set Chapter Annotation

This will send a annotation to the OBS plugin that will be saved in your exported chapter markers file. There are examples built in that will allow Moderators to add chapter markers with the ‘!annotation’ command. You can create your own triggers by doing the following:

  1. Create a new action, set a trigger. In this example we will use a ‘Twitch Cheer’.

  2. Add a 2 new Sub-Actions. Choose ‘Core → Arguments→ Set Argument’.

    Untitled

  3. You can set the following arguments. You can use any variables in the ‘Value’ box you like too

    1. annotationText

      Untitled

    2. annotationSource

      Untitled

  4. Add a new Sub-Action. Choose ‘Core → Actions → Run Action’.

  5. Choose ‘CMMC • Set Chapter Annotation’ and leave ‘Run Action Immediately’ checked.

    Untitled

  6. Now when this action is triggered it will add an annotation in OBS to be exported in your recordings chapter marker files.

Get Current Chapter Marker

  1. Create a new action, set a trigger.

  2. Add a new Sub-Action. Choose ‘Core → Actions → Run Action’.

    Untitled

  3. Choose ‘CMMC • Get Current Chapter Marker’ and leave ‘Run Action Immediately’ checked.

    Untitled

  4. You can then use the argument ‘%currentChapter% in your action to use the current chapter marker name

    Untitled


Settings

This is an overview of what all the settings do. You can access this menu by going to the CMMC • Settings action then right clicking the Test trigger, then press Test Trigger.

Buttons

  1. Reset Button:
  2. Save Button:
  3. Cancel Button:

General Settings

OBS Connection Number

Send Chapter Marker to Twitch VOD