General

Edit

How do I do X? #

Making your own buttons in SAMMI is a little bit like programming. It takes some time to learn how everything works.
You can start with something as small as making a button to change your OBS scene and slowly work towards more complex buttons. This documentation should help you achieve that!

We welcome new members on our Discord server to ask questions if they encounter a problem with their buttons or commands, but discourage asking for a whole custom button to be created just for their needs. In that case you’re free to request a commission instead.


Edit

Extensions #

Extensions are meant to add new functionality to SAMMI. They’re made by the SAMMI community.

We recommend installing only officially released extensions that have been verified to be safe to use.

Install an extension: #

  1. Download the .sef extension file
    • If you’re downloading the extension from Github, please refer to the screenshot below.
    Correct way to download an extension file from Github
    Correct way to download an extension file from Github
  1. (optional) If you want to select a different Bridge than the one you’re currently using, click on Bridge - Select a Bridge and select a new Bridge file to install your extension to.
  2. Click on Bridge - Install an Extension in your SAMMI
  3. Select the .lb2 extension file you downloaded
  4. If the extension requries Bridge to be running, your Bridge will automatically refresh and a new extension tab will be added. You should also see it added in at the bottom list of all the extensions.
  5. Most extensions include a premade deck with buttons. If you do not see one, create a new button, press + - Extension Commands - Your Bridge and select the extension name. If you do NOT see this menu, it means the extension either does not require Bridge or you did not properly install it.

Uninstall an extension (if extension requires Bridge) #

  1. Click on Bridge - Uninstall an Extension in SAMMI.
  2. You will see a dropdown menu of all extensions. Click on the extension you wish to uninstall and press Yes.
  3. The extension is now completely removed from your Bridge.
  4. You must delete your uninstalled extension’s deck manually.

Protected Extensions #

Extension developers can choose to protect their extension decks and their buttons. If the particular button is protected, you cannot copy the button, its commands or see what’s inside nested commands (if they’re closed). You may still add new commands, modify or delete them.

Create an extension #

SAMMI communicates with all its extensions via bridge.html and its own websocket.
Information about how to make your own extension can be found in SAMMI/bridge/how to make extensions.txt file.
Knowledge of JavaScript programming and SAMMI variable handling is a requirement to program extensions. We encourage you to go over some existing extensions to understand the process.
Once you have an extension working, you can submit it in #development channel in the official SAMMI Discord server. You will need one of the mods to approve it before it can be officially released. Use our Extension Submission Form if you want your extension to be posted on the official SAMMI website.


Edit

Dual PC Setup #

SAMMI can connect to your OBS from another PC, as long as they are both sharing the same network.

PC running OBS

  1. Run your OBS as normal.
  2. Open your command line (Windows + R, cmd.exe) and type ipconfig. Note down your IPv4 address. It probably starts with 192.168., but could start with 10. instead.

PC running SAMMI

  1. Open SAMMI Core, and open OBS Connections.
  2. Enter your other PC’s IPv4 address in the IP box.
  3. Make sure your Port and Password match, as shown in the instructions to set up an OBS connection.
  4. Click Connect.

As long as nothing is blocking the connection to your streaming PC (like your anti-virus or firewall), SAMMI should now be linked to your other PC’s OBS.

Modified "OBS Connections" to use OBS PC′s IPv4 Address
Modified "OBS Connections" to use OBS PC′s IPv4 Address


Edit

Remote Connection #

It’s possible to remotely connect and control SAMMI via SAMMI Deck from anywhere in the world.
There are multiple ways to accomplish this. This documentation covers the easiest and most accessible one.

  1. Download Ngrok and sign up for an account.
  2. Log in to your account and retrieve your authtoken.
  3. Go to the downloaded file, unzip it and run ngrok.exe. You should see a command line open.
  4. Type ngrok authtoken YOURAUTHTOKEN and press enter. You should see a message Authtoken saved to configuration file: C:\Users\.... This step is necessary to prevent your session from timing out.
  5. To start the tunnel, type ngrok tcp 9423 and hit enter.
    The default region is US. You can change it by adding -region=REGION flag. Available regions: us, eu, ap, au, sa, jp, in. Example: ngrok tcp -region=eu 9423.
  6. You should see your session started. Go to your SAMMI Deck and paste the new IP and port from the Forwarding line (make sure to omit the tcp:// part). As long as your tunnel is active, you can connect to your Receiver from anywhere in the world now! :)
    Creating a new tunnel via ngrok
    Creating a new tunnel via ngrok

All currently active tunnels can be seen on your dashboard.
If you wish to close the tunnel, you can press CTRL+C or type taskkill /f /im ngrok.exe in the command line and press enter.


Edit

Elgato Stream Deck #

SAMMI can natively communicate with Elgato Stream Deck via key presses.
If you’re looking for even better functionality, there is an extension SAMMI Bridge for Elgato Stream Deck from StreamUp that you might wanna check out!


Edit

OBS Streamlabs #

There are no plans to support OBS Streamlabs in the future.


Edit

Connecting to other apps #

SAMMI can connect to any app or service that has public API or websocket access.
It is done via custom made extensions. All available and approved extensions are listed in the #Releases channel in our Discord server.
If none of them suits your needs, feel free ask in the #Suggestions channel or request a commission!


Edit

Localisation #

SAMMI now has the abliity to be translated into your local language. Currently, this is still a work in progress with localisation available for the following languages:

  • Spanish
  • German
  • French

If you’d like to contribute to the localisation efforts, please let us know!


Edit

Developer Mode #

For advanced users who would like the ability to encrypt and lock your buttons and decks, developer mode can be unlocked by pressing the Reset button 10 times.