Skip to content

Latest commit

 

History

History
74 lines (55 loc) · 4.39 KB

README.md

File metadata and controls

74 lines (55 loc) · 4.39 KB
Raw

obs-text-slideshow

latest-tag Downloads CI Multiplatform Build Donate

Inspired by the built in image slideshow, except for text sources instead. Both Free Type 2 and GDI+ are supported. Useful for displaying song lyrics, captions, etc.

Note: This plugin is not under active development and has not been updated to support OBS 28.0 as I do not have time at the moment. If you wish to continue development of this plugin, feel free to fork the repo

Usage

This plugin functions exactly as the built in image slideshow plugin, except instead of transitioning between image sources it transitions between text sources instead. Simply click the add source button and add the Text Slide Show source. Text sources can be added manually using the default Slide Texts box or read from file by selecting the read from file option and specifying the file path(s). The expected format of the text file(s) is described below. Transitioning between text sources manually can be done using OBS's media controls or using the built in dock.

Text file format

Single text file format

By default, if no custom delimiter is specified, the new line character is chosen as the delimiter as follows:

text for first
text source

text for second text source

text for third text
source

single line is supported

multiline is
supported

etc.

Custom delimiters can also be specified so other characters can be used as delimiters instead of the new line character.

Multiple text file format

For the multiple text file option, the text from each text file corresponds to the text for one text source in the slideshow.

Dock

To open the dock, Select View -> Docks -> OBS Text Slide Show. The dock will display the first Text Slide Show source for the current scene as well as all of its text sources below. Clicking on the text sources on the dock will cause the source to transition to this text source. The drop down at the top of the dock can be used to have the dock display another Text Slide Show on the current scene other than the first. Only Text Slide Show sources on the current scene can be viewed on the dock. When the current scene is changed, the dock and will update accordingly to include only the Text Slide Show sources on the new scene.

Installation

Installers can be found in the Releases section.

Note: The Windows and macOS installers are currently unsigned because I don't have money to purchase a certificate to sign the Windows installer or to purchase a subscription for the Apple Developer program in order to sign and notarize the macOS pkg installer. Unfortunately as a result these installers may be flagged by certain antivirus programs and may have to be temporarily disabled in order for the installer to be allowed to run.

Building from Source

Windows

git clone https://github.com/jbwong05/obs-text-slideshow.git
cd obs-text-slideshow
./.github/scripts/Build-Windows.ps1

Linux

git clone https://github.com/jbwong05/obs-text-slideshow.git
cd obs-text-slideshow
./.github/scripts/build-linux.sh

OS X (Not supported at the moment)

git clone https://github.com/jbwong05/obs-text-slideshow.git
cd obs-text-slideshow
./.github/scripts/build-macos.sh

Possible future work

  • Text input from files (UTF-8)
  • Individual text settings for each text source
  • GUI dock for easier transitioning between sources
    • Find work around for the need for a refresh sources button; because the obs-frontend-api doesn't have a source added or edited event libobs handles the different signals for sources and not the frontend api