Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
MacND authored Sep 17, 2022
1 parent fbdb57f commit 5ce3e15
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,17 @@ All credit for [Streamlink](https://github.com/streamlink/streamlink) goes to th
## Getting started
Download and install the most recent release's `setup.msi`. Additionally, you'll need [VLC Media Player](https://www.videolan.org/vlc/download-windows.en_GB.html) and [Streamlink](https://github.com/streamlink/windows-builds/releases). Open MacSG, type a valid Twitch username into the streamer box, and click the "Generate". A VLC window should open with the stream playing, titled "First - VLC Media Player".

### Automated text sources
## Automated text sources
MacSG outputs the streamer names and pronouns provided into plain text files, located at `%AppData%\MacSG` (which can be opened via File > Open AppData Folder). You can use these inside OBS using the Text GDI+ source type, and checking the "Read from file" checkbox. By default, streamer names and their pronouns are written to 2 separate files, e.g. `streamer1.txt` and `streamer1-pronouns.txt`. You can write both the name and pronouns to one file by clicking File > Combine Names and Pronouns, which for `MacND;He/They` results in an output format of `MacND (He/They)`.

### Installing the macsg: protocol
## Installing the macsg: protocol
MacSG can be configured to automatically generate streams upon clicking a link or entering one in your browser.

Run MacSG as an Administrator and then select `File > Install macsg: protocol`. When prompted, restart your computer to finish the installation. Installing this will allow you to click links to automatically open MacSG. An example would be `macsg:macnd;he/they` which will open MacSG, aut-opopulate the first streamer details with MacND and He/They pronouns, and then open the stream in VLC. You can test this functionality by typing `macsg:macnd;he/they` into your browser window.

## Customising VLC behaviour
You can configure VLC to have certain behaviours exclusively with MacSG, such as hiding the VLC interface, by modifing the configuration file located at `%AppData%\MacSG\vlcrc`. Some common items you may want to change:
- Set `qt-minimal-view=1` to hide the user interface automatically
- Set `video-title-show=0` to hide the name of the media being played, this dispalys as `fd://0` for Streamlink
- Set `video-on-top=1` to have VLC always be on top of other windows
- Set `audio=0` to have streams always be muted when started

0 comments on commit 5ce3e15

Please sign in to comment.