Usage Instructions

Connecting to YTMD Plugin

Please follow the steps below to set up the connection with the YTMD plugin:

1. Install the YouTube Music Desktop App.
2. Install the plugin from the release page or the official Ulanzi Studio store.
3. Add a configuration action.
4. If not connected yet, enter the correct YTMDesktop settings (such as host and port).
5. Ensure that the YTMDesktop app and Companion Server are running:
   • To start the Companion Server, click the settings gear icon in the top right corner of YTMDesktop.
   • In the "Integrations" tab on the left, enable "Companion Server".
6. Enable "Enable Companion Authorization" in the Companion Server settings.
7. In the configuration action settings, click the "Authorize" button.
8. Compare the authorization code displayed by the plugin with the one in the YTMDesktop app.
9. If they match, confirm the authorization in the YTMDesktop app.
10. Done! (Steps 6-9 only need to be performed once or when the plugin is unauthorized)

Once you have completed the steps above, you can start using the plugin!

Key Bindings

When using the plugin for the first time, drag the Configuration onto the Ulanzi Studio keyboard. Then fill in the host address, port, and password in the configuration interface, and click save. Ensure that this information is correct before dragging additional buttons onto the Ulanzi Studio keyboard.

Once set up, you can easily control the playback status of YTMD by pressing the buttons on the Ulanzi Studio.

Thank you for using this plugin!