We use GitHub to maintain our streaming assets. This service allows us to track changes, roll back things that break stuff, and work remotely when needed.
- announcementCycle.html: A webpage which OBS places on screen during the staging time before and after service, which loops through announcements on screen. Editing this page is explained later in this document.
- On Screen Text > title.txt: This text file is used to populate the "Title" text scene in OBS. Most often used for various town halls.
- On Screen Text > lowerthird.txt: This text file is used to populate the "Lower Third" text scene in OBS. Most often used to place the "Text with Questions" number on screen for town halls.
- Make sure you're editing the latest version of the file using fetch and pull. See "Using GitHub" below.
- Open
announcementCycle.html
in Visual Studio Code. - The announcements which cycle on screen start on line 6 or so of the file; each one is preceded by
announcements.push("
. Find the announcements. - Make sure the date is correct (first announcement line), then erase any announcements which are no longer needed by deleting the entire row in which it appears or, if you think you'll need it again in future weeks, precede it with two slashes (like this:
//
) to keep it from appearing on screen without actually deleting it. - Add new announcements using the same format as the exisitng ones: precede the text with
announcements.push("
and follow the text with");
. This format is very important. In addition, use the code<br>
to indicate a line break within an announcement, and•
to separate text with a bullet. - View the full announcement loop once in OBS to make sure that the newly-added announcements fit.
- Save
announcementCycle.html
. - Commit and Push your changes to GitHub. See "Using GitHub" below.
This is a brief overview. More detailed guides are all over the internet, but here are the basics. For all of these steps, you'll need to make sure GitHub Desktop is open.
Fetching syncs up your machine with the data stored on GitHub. Do this before making edits.
- In GitHub Desktop, simply press the "Fetch Origin" button.
- You may then need to pull.
After you've fetched the data from GitHub, it won't apply any changes if you have the file open unless you then pull the changes, applying them to the existing assets.
- In GitHub Desktop, simply press the "Pull Changes" button.
- That's literally all.
A "commit" is a set of changes you're uploading to GitHub.
- In GitHub Desktop, click "Commit to main." You may also type a commit message in the commit message box, which is right above the one labeled "Description," but that's not strictly necessary.
- Click the "Push to origin" button.
If you've made a mistake and saved the file, you can easily revert to the original (even if you can't Undo it) by right-clicking the filename in GitHub Desktop and choosing "Discard Changes."
If you need to go back further, you're getting into more complicated revert scenarios. Probably a more effective way to get an earlier version would be to scroll back in the History tab to the change you want to revert to, copy the pieces you need from the change preview pane, and paste them into the file on Visual Studio Code.