General

Edit

How do I do X? #

Making your own buttons in LioranBoard 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 LioranBoard. They’re made by the LioranBoard community.

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

Install an extension: #

  1. Download the .lb2 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 Transmitter than the one you’re currently using, click on Transmitter - Select a Transmitter and select a new Transmitter file to install your extension to.
  2. Click on Transmitter - Install an Extension in your LioranBoard
  3. Select the .lb2 extension file you downloaded
  4. If the extension requries Transmitter to be running, your Transmitter 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 Transmitter and select the extension name. If you do NOT see this menu, it means the extension either does not require Transmitter or you did not properly install it.

Uninstall an extension (if extension requires Transmitter) #

  1. Click on Transmitter - Uninstall an Extension in LioranBoard.
  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 Transmitter.
  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 #

Lioranboard communicates with all its extensions via transmitter.html and its own websocket.
Information about how to make your own extension can be found in LioranBoard2/transmitter/how to make extensions.txt file.
Knowledge of JavaScript programming and LioranBoard 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 LioranBoard 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 LioranBoard website.


Edit

Dual PC Setup #

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

Streaming PC

  1. Run your OBS as normal.
  2. Open your command line and type ipconfig. Note down your IPv4 address. It should start with 192.168.

Gaming PC

  1. Go to your LioranBoard/Receiver folder and open connect.ini. Under [connection] section, add a new entry: websocket_ip="YOUR STREAMING PC IPv4".
  2. Save the file, open Lioranboard and try connecting to the OBS websocket on your streaming PC.
    It should work as long as nothing (antivirus, firewall) is blocking connection to your streaming PC.

    Modified connect.ini
    Modified connect.ini


Edit

Remote Connection #

It’s possible to remotely connect and control your LioranBoard via Stream 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 Stream 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 #

LioranBoard can natively communicate with Elgato Stream Deck via key presses.
If you’re looking for even better functionality, there is an extension LioranBoard 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 #

Lioranboard 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

Translations #

LioranBoard will most likely not be translated to other languages in the near future.
If you’d like to contribute to translating this documentation to other languages, please let us know!