Skip to content

Latest commit

 

History

History
42 lines (28 loc) · 2.88 KB

README.md

File metadata and controls

42 lines (28 loc) · 2.88 KB

YASU: Yet Another Stream Utility

Overview

A program to help assist in streaming. Provides a simple interface for dynamic editing of stream-related content. Currently focuses on score keeping in the context of a game.

This is written in Rust, using EGUI.

Screenshot

GUI example

Configuration

Most primarily, one will want to use a streaming / recording tool, such as Open Broadcaster Software (OBS). While as much as possible is made to be generic, the app was objectively developed with OBS in mind, and thus any instruction should be taken in this context.

All interaction done within YASU will result in file updates to the files in the output directory. You should point your OBS to these files.

  • Text:

    • Make Text (GDI+) objects in an OBS scene, check Read from file, and direct them to something like path/to/YASU/output/player_1.txt. Do this for all relevant output files (you may need to use the app to make sure a file is created) and OBS should be auto-updating as needed.

  • Image:

    • Fill the images directory with images that you want to select between, such as character icons.
    • Make an Image object in an OBS scene, and direct it to something like path/to/YASU/output/image_1.png. Do this for all relevant output files (you may need to use the app to make sure a file is created) and OBS should be auto-updating as needed.

  • Replay:

    • Enable the replay buffer in OBS.
    • Set the hotkey for Save Replay to Ctrl + Shift + R in order to match with this app.
    • Make a Media Source object in an OBS scene, and direct it to something like path/to/YASU/output/replay.mp4: you will need to use the app to make sure a file is created. Check Close file when inactive on that media source.
    • Modify the settings.toml file under [replay] as needed for your local setup:
      • obs-path (default C:/Users/User/Videos/)
      • video-ext (default .mp4)
      • save-delay (default 4 (seconds))
    • Press CTRL+SHIFT+R while in YASU, with the OBS replay buffer running, and not on the same scene as your replay Media Source.

  • Graphics:

    • Update animation_background.png, graphic_background.png and players/default.png to be what you want as your generation bases. Add known players into the players directory as PNG images: these will be string matches based on YASU player name input, so "bean" would look at players/bean.png and "John Adams" would look at players/john adams.png.
    • To use the included slide-on animation: make a Browser object in an OBS scene, and direct it to something like path/to/YASU/1v1_graphic_anim.html. Check Shutdown source when not visible and Refresh browser when scene becomes active on that browser element.

Contact

Email [email protected] for any questions / inquiries.