Skip to content

Going live

Jump to bottom
CJMAXiK edited this page Aug 17, 2024 · 7 revisions

Note

Due to high memory consumption, it is recommended to use exported version of this project for livestreams. You can use release version (by following this page) or build it by yourself (at the end of the page). The rest of the page is applicable to both configurations.

This page describes the default streaming configuration (as it works right now).

Requirements:

  • OBS x64 v30 or higher, with the Scene Collection Manager, Countdown Timer, and Spout2 plugins installed.
  • mpv (music player, for streaming music from YouTube)
  • Plane9 (music visualizer, in windowed mode)
  • Toaster (Live2D host, with console output)

Release folder contents:

  • config - configuration folder
    • prod.cfg.example - example configuration
  • songs - songs folder
  • libgd_cubism.windows.release.x86_64.dll - GDCubism library
  • run.ps1.example - PowerShell script, used to automate the launch process
  • toaster.console.exe - launches Toaster with the console output
  • toaster.exe - Executable for Toaster

First steps

  1. Download the archive here and unpack it.
  2. In the config folder, duplicate prod.cfg.example file, rename it to prod.cfg, then fill it out with the connection details for both OBS and backend (make sure they are available).
  3. (optional, for Windows) In the root folder, duplicate run.ps1.example, rename it to run.ps1, then edit to reflect your streaming setup.
  4. Import the Melba scene from the #stream-assets channel.
  5. (optional) Download the songs folder from the #stream-assets channel and put its contents into songs folder of the Toaster.

Before going live

  1. Open all the required apps, either manually or via run.ps1.
  2. Check if all the sources are picked up and running.
  3. In OBS, in Countdown Timer dock, set the Source to "Countdown", then set the desired period in "period" tab. Hit "Set and reset timer".

Going live

  1. In Toaster, make sure that "OBS" and "Backend" buttons are green (connected).
  2. In Toaster, set "Model Position" dropdown to "intro".
  3. (optional) In Toaster, make sure you have songs.
  4. In OBS, hit "Start Streaming"
  5. In OBS, hit "Start timer" in the Countdown Timer dock.

Toaster is in control of the intro sequence:

  • Follows the countdown
  • When timer hits 5 seconds, lowers the volume of the MUSIC channel to 50%
  • When timer hits 0 seconds, switches to Main scene
  • When the animation is over, unpauses Melba

Build by yourself

  1. Open the project in Godot
  2. Navigate to Project -> Export... in the main menu
  3. In the Export window, hit Export All..., then Release.
Clone this wiki locally