Skip to content

Commit

Permalink
Bumped version and updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
jbwong05 committed Jul 29, 2021
1 parent 9c41ca0 commit 8798d28
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 1 deletion.
2 changes: 1 addition & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ cmake_minimum_required(VERSION 3.10)

# Change obs-plugintemplate to your plugin's name in a machine-readable format
# (e.g.: obs-myawesomeplugin) and set
project(obs-text-slideshow VERSION 1.3.0)
project(obs-text-slideshow VERSION 1.4.0)

# Replace `Your Name Here` with the name (yours or your organization's) you want
# to see as the author of the plugin (in the plugin's metadata itself and in the installers)
Expand Down
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,29 @@

Inspired by the built in [image slideshow](https://github.com/obsproject/obs-studio/blob/master/plugins/image-source/obs-slideshow.c), except for text sources instead. Both Free Type 2 and GDI+ are supported. Useful for displaying song lyrics, captions, etc.

## Text file format
### Single text file format
New lines are expected in order to separate the text for the different text sources in the slideshow.
```
text for first
text source
text for second text source
text for third text
source
single line is supported
multiline is
supported
etc.
```

### 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.

## Installation
Installers can be found in the [Releases](https://github.com/jbwong05/obs-text-slideshow/releases) section.

Expand Down

0 comments on commit 8798d28

Please sign in to comment.