This module gives you control of SLMN.GG actions and services. You will need to supply an authentication token and have a SLMN.GG profile with production access.
-
Install Companion v3. You should make sure that any modules you require for production have also been updated to the new v3 format.
-
Create a folder somewhere in which you will install external modules, including this one
-
Run Companion and press the developer settings cogwheel in the top right, which will show the Developer modules path box. Choose your new folder here.
You'll now need to download and install this module into a subfolder. You can download the full-setup.bat file into your developer modules folder and run it. Otherwise, you can manually install everything you'll need.
This is just an explanation of what the full setup batch file does. If you know what you're doing, just pull the commands you need from here.
- Open a command prompt window in your developer modules folder.
- Install Git to make it easier to download updates:
winget install Git.Git - Download the module code:
git clone https://github.com/slmnio/companion-module-slmngg - Enter the new downloaded folder
cd companion-module-slmngg - Install Node (v18 or higher). This installer uses the v18 LTS version.
winget install OpenJS.NodeJS.LTS - Install dependencies
npm install
You should now see SLMN.GG in your Companion connections list. If you don't quit Companion and re-open it.
The module will be prefilled with the current data server address, but you can change it or use a local address instead.
You'll need to get a token from SLMN.GG. We recommend using the development version (dev.slmn.gg) when working on production since it will have the latest changes. Log in to the dashboard and choose Token from your user drop-down. It will give you a warning about the dangers of sharing your token, but you should be fine as long as you are using it locally.
Your token will be checked when you press save on the settings menu, and will warn you if your token is invalid.
You should now have full access to SLMN.GG through Companion! (or at least the amount of access you're supposed to have, anyway). You can explore the different actions, feedbacks and variables that are pulled from the server into Companion.
There are a few presets you can look through to help you get started.
The features we add get extensively tested in our productions, so you should find things that will be useful for you. For example, teams can always be referred to as either 1 or 2 (as in the broadcast schedule) or as left or right (as showing on the in-game overlay). You can use this in conjunction with the Swap Teams action to make some reactive displays.
We will keep pushing updates to this repository as new features get added. You can run the update.bat script in your module folder to get new updates and install any new dependencies.