Skip to content

Commit

Permalink
Add Meld Studio guides
Browse files Browse the repository at this point in the history
  • Loading branch information
nate1280 authored Sep 13, 2024
1 parent 0608476 commit 7ebee21
Show file tree
Hide file tree
Showing 8 changed files with 144 additions and 1 deletion.
44 changes: 43 additions & 1 deletion streamerbot/1.get-started/2.setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,9 @@ Set up your broadcasting software to work with Streamer.bot
::card{icon="i-mdi-desktop-mac" title="Streamlabs Desktop" to=#streamlabs-desktop}
Control Streamlabs Desktop with Streamer.bot
::
::card{icon="i-mdi-desktop-mac" title="Meld Studio" to=#meld-studio}
Control Meld Studio with Streamer.bot
::
::

::tip{color=primary}
Expand Down Expand Up @@ -242,4 +245,43 @@ Set up Streamer.bot to remotely control your Streamlabs Desktop instance

::callout{icon=i-mdi-bookmark color=green to=/guide/broadcasters/streamlabs-desktop}
Explore the full [Streamlabs Desktop Configuration Guide](/guide/broadcasters/streamlabs-desktop) to learn more about all available options.
::
::

---
### Meld Studio
Set up Streamer.bot to remotely control your Meld Studio instance

1. Enable Remote Connections

::callout{icon=i-mdi-navigation}
In Meld Studio, navigate to **File > Preferences > Advanced** in Meld Studio<br/>
::

![Meld Studio Advanced Settings](assets/meld-studio-advanced-settings.png){width=600}

- Ensure the `Allow remote connections` is **enabled** (checked)

2. Setup your Meld Studio connection in Streamer.bot

::callout{icon=i-mdi-navigation}
Navigate to **Stream Apps > Meld Studio**
::

![Meld Studio Configuration](assets/meld-studio.png)

To add a new connection, <kbd>Right-Click</kbd> anywhere in the panel area and select `Add`
![Meld Studio Add Connection](assets/meld-studio-add-connection.png)

- Enter a name for this Meld Studio connection
- If Meld Studio is running on the same machine, keep `127.0.0.1` for the `Host` field
- For multi-pc setups you can configure this with another LAN IP address
- Click `OK` when you have finished configuration
- <kbd>Right-Click</kbd> the new instance and select `Connect` to force an immediate connection attempt

::callout{color=amber icon=i-mdi-alert}
If you are having trouble connecting, double-check the **Host** to ensure it matches your OBS Studio instance.
::

::callout{icon=i-mdi-bookmark color=green to=/guide/broadcasters/obs-studio}
Explore the full [Meld Studio Configuration Guide](/guide/broadcasters/meld-studio) to learn more about all available options.
::
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added streamerbot/1.get-started/assets/meld-studio.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
101 changes: 101 additions & 0 deletions streamerbot/2.guide/21.broadcasters/meld-studio.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
---
title: Meld studio Studio
description: Configure Streamer.bot to interact with your Meld Studio instances
logo: /img/icons/meld-studio.png
---

::callout{icon=i-mdi-warning color=amber to=/get-started/setup#meld-studio}
You must enable **Allow remote connections** under Advanced. Check out the [Get Started Guide](/get-started/setup#meld-studio) for details.
::

::callout{icon=i-mdi-navigation}
Navigate to **Stream Apps > Meld Studio** in Streamer.bot
::

![Meld Studio Configuration](assets/meld-studio.png)

## Configuration
To add a new connection, <kbd>Right-Click</kbd> anyhere in the panel area and select `Add`:

![Meld Studio Add Connection](assets/meld-studio-add-connection.png)

Configuration options are outlined below:

::field-group
::field{name=Name type=Text required}
Enter any name or label to describe this Meld Studio instance, e.g. `Local Meld Studio`
::

::field{name=Host type=Text required default="127.0.0.1"}
Enter the host address of your PC

If Meld Studio is running on the same machine as Streamer.bot, keep `127.0.0.1`

For multi-pc setups you can configure this with another LAN IP address, e.g. `192.168.1.10`
::

::field{name="Auto Connect on Startup" type=Toggle}
Automatically connect to this Meld Studio instance when Streamer.bot starts up
::

::field{name="Reconnect on Disconnect" type=Toggle}
Automatically reconnect to this Meld Studio instance when the connection is disrupted
::

::field{name="Retry Interval" type=Number default=30}
Change the interval of reconnection attempts when `Reconnect on Disconnect` is enabled
::
::

## Context Menu
<kbd>Right-Click</kbd> on a configured connection to reveal the context menu:

#### `Add`
Add a new Meld Studio connection

#### `Edit`
Edit the selected Meld Studio connection

#### `Delete`
Delete the selected Meld Studio connection

#### `Auto Connect`
Quickly toggle the `Auto Connect on Startup` configuration option for the selected connection

#### `Reconnect`
Quickly toggle the `Reconnect on Disconnect` configuration option for the selected connection

#### `Default`
Set this connection as the default when importing actions

::tip{color=amber}
If no default is set, imported actions will default to the first connection in the list
::

#### `Force`
Temporarily override **all** Meld Studio connections to use the selected connection.

::callout{icon=i-mdi-alert color=amber}
This setting does **not** persist when you restart Streamer.bot
::

#### `Update All Actions To...`
Reconfigure all actions utilizing an Meld Studio connection to use the selected connection

#### `Connect`
Manually attempt to connect to the selected connection

## Status Panel
Selecting a connected Meld instance in the left panel will reveal additional realtime information about that instance on the right panel.

#### `Current Scene`
Shows the name of the currently broadcasting scene on the selected connection

#### `Stream Status`
Shows the status of the current streaming and recording activity

#### `Scenes/Layers`
Lists all layers present on the currently selected scene

## Usage
:api-reference-cards{path=meld-studio}

0 comments on commit 7ebee21

Please sign in to comment.