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 .lbe 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. Click on Install Extension in your LioranBoard Receiver
  2. Select the .lbe extension file you downloaded
  3. Select your default Transmitter you are using. That’s the tsl_transmitter.html file residing in your lioranboard folder. Make 100% sure it is the correct file.
  4. Your Transmitter will automatically refresh, adding a new tab for the extension you just installed. 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, add (Send to Extension)[] command and select the extension you just installed.

Extension is installed properly if:

  • You can see all its fields in your Send to extension command. If you can only see the extension name, the extension was not installed properly or your Transmitter is not running. The amount of input fields depends on the extension, but it should in most cases contain at least one.
    Correctly vs. incorrectly installed extension
    Correctly vs. incorrectly installed extension
  • Your Transmitter displays that it’s correctly installed. You should see a new tab and a checkbox at the bottom with the extension name added.

Uninstall an extension #

  1. Click on the Uninstall Extens. button in your LioranBoard Receiver.
  2. Select the correct Transmitter where your extension is installed and press Yes when prompted whether you want to replace it.
  3. You will get a dropdown menu in your Receiver. Click on the extension you wish to uninstall and press Yes.
  4. The extension is now completely removed from your Transmitter.

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 LioranBoard/extension/how to make extensions.txt file.
We encourage you to go over a few premade 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.


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 #

LioranBoard natively supports only OBS Studio, as it uses OBS Websocket to communicate.
It might be possible to make this available in LioranBoard 2, which is currently in progress.


Edit

Voice Recognition and TTS #

Default Text to Speech
There’s a default TTS extension when you install LioranBoard Notification System. Transmitter must run in a browser outside of OBS for the TTS to properly work.

Polly Text to Speech
I have created a more advanced extension Polly TTS which works with Transmitter running in OBS as a dock.
You can download Polly TTS from Itch.io below, which is a popular platform for developers to host their indie games and tools.


Voice Recognition
Not implemented as of now, however we’re looking into adding it to LioranBoard 2, which is currently in progress!


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!