Semi-free Bible Plugin for OBS Studio
- Author Firstfruits Studio
- Creation date
Great news! A new and easier fix has been found that does not require you to download the Server program! Many, many thanks to Lester Torres Rivera for contacting me with this simple fix.
- Right-click your Bible browser source and click Properties.
- Copy the local file path.
- Uncheck the Local file checkbox.
- At the beginning of the URL add file:// and paste the local file path (now as URL).
What about the Server program?
The Server program will remain officially supported.
Given the increasing restrictions on local file URLs, there is unfortunately no guarantee that this new workaround of unchecking the Local file checkbox will continue to work with each OBS Studio update. The Server is pretty much guaranteed to work no matter what happens in the future. Furthermore, the new Server program also adds a lot of interesting possibilities from a development perspective that simply aren't possible otherwise (for example, remote control and integration with other applications).
For now, it is up to you to decide which approach you want to use.
Documentation Updates
We will be updating our website and guides with more details in the coming days. As always, don't hesitate to drop us a message with your ideas, questions, and/or suggestions.
After two days of hard work and investigation, we are relieved to finally announce that Bible Plugin for OBS Studio now works with OBS Studio v27.2!
However, action is required on your part if you wish to use the latest version of OBS. In your PayHip page, you will notice a new Server program available for download.
You will need to download this Server. Every time you use the Bible Plugin, you need to run this Server and use the URLs provided for your Browser Source and Custom Browser Dock. In the coming days, we will update our website and guides with more information. Keep an eye on https://bibleplugin.firstfruitsstudio.com/guides/coffee/.
Save Data:
You will need to transfer your custom browser themes and settings to the newer served version.
Reasons for the Incompatibility:
For those interested, here is a technical explanation. When OBS Studio updated, it also updated the Chromium Embedded Framework to a later version. One consequence of this upgrade was tightened restrictions on file:// URLs. This means that from now on, a local web server is required to fully access essential JavaScript APIs like the BroadcastChannel API that the Bible Plugin depends on in order to function. This is where the new Server program comes in.
Free Online Version:
The free online version remains unaffected and can still be used.
Conclusion:
We realize that this may be a big change to the way you used the Bible Plugin before. If you have any questions or are encountering any issues, please don't hesitate to drop us a message. We'll get back to you soon!
Hi, everyone!
It is with great pleasure that I can finally announce this—an official Mac release (64-bit only) has been uploaded to the Coffee Version!
As you may have known, until now Mac was only partially supported. The plugin itself worked well on Mac, but the Generator program for choosing which Bibles you wanted to use in the plugin only worked on Windows and Linux. This meant that the free version worked on Mac while the Coffee Version didn't. Not anymore! The Generator program now works just as it should on Mac, and we have some sparkling new screenshots to prove it. :D
Just like on the other platforms, you can choose from the same seven public domain Bibles (five English, one Spanish, one French) or use any Bible translation from OpenLP. The program will automatically detect OpenLP Bibles and make them available for selection, like the other platforms.
Getting and Using the Mac Version
If you have bought the Coffee Version, you will now find a new download for Mac (as of this writing, named OBS.Studio.Bible.Plugin.Generator-darwin-x64-1.4.1.zip) on your PayHip page. You should also receive an email soon. Just download the ZIP, extract it, and double-click it to run the program! Choose your Bibles, hit Generate, and follow the instructions shown to add the plugin to OBS Studio.
Background
Mac support has been perhaps the most requested feature of this plugin. It was also something I had really wanted to do. Back then, though, I didn't have access to a Mac computer. After the surprising success of this plugin, and after hearing all the requests for a Mac version, we knew we had to somehow make it. Thankfully, we were able to pull out an older Mac from storage, bought a brand new charger to replace the broken one it had, and brought the Mac back to life. And that's the story behind it. ;)
Conclusion
As always, feedback is appreciated! Thank you all for your support!
Hi, everyone!
This update does two things:
First up is keyboard shortcuts on buttons! You can toggle this feature on or off in the Settings. Once again, special thanks to user hopkir from the OBS Forums for suggesting this! (And sorry it took this long :D )
Bottom Bar
Toolbar
You can toggle this on or off by clicking the new "Show Keyboard Shortcuts on Buttons" option. It is enabled by default.
New Settings
You may be wondering what "Strip Verse Newlines" and "Strip Footnote References" do, which leads us to the next item on the update list.
The second is improved whitespace handling for verse texts. Columbian YouTuber Daniel Monsalve brought to my attention that some popular Spanish Bibles displayed weirdly on the plugin. After some digging, it turned out that this was because the Bibles embedded newlines and additional whitespace inside the verses. This means that Bible verses previously appeared something like this (there was also a leading newline there, but it's not in the photo because I forgot to take a screenshot of the earlier version):
To fix this, leading and trailing whitespace are now removed. As for the newlines, you can now change them to be more natural by enabling the "Strip Verse Newlines" option (enabled by default):
While I was at it, I also added an option to "Strip Footnote References", just because (enabled by default).
"Strip Footnote References" Disabled
"Strip Footnote References" Enabled
Special thanks to YouTuber Daniel Monsalve for bringing this to my attention, and for his patience and support while I worked on this. Be sure to check out his YouTube channel here (in Spanish): https://www.youtube.com/user/danimonl. Also, if everything goes well and no more unexpected issues pop up, stay tuned for Daniel's upcoming video in Spanish on the Coffee Version as well!
Update Guide
Important: Please backup your verse list and custom themes before updating!
Free Online Version
You will automatically be updated to the latest version.
Coffee Version
- Download the latest release from Payhip.
- Run the Generator, choose the same Bibles and output folder, and click Generate.
- Open OBS Studio. You should be on the latest version.
Side Note: About Jon and Joanna from Firstfruits Studio
For those of you who contacted Firstfruits Studio by email or social media, you may have noticed replies signed by either "Jon from Firstfruits Studio" or "Joanna from Firstfruits Studio". We have been asked about this, so here is a brief explanation.
The sole creator, developer, and maintainer of Bible Plugin for OBS Studio is me, Jon from Firstfruits Studio. In the beginning, I handled all email and social media messages as well. However, as the plugin exploded in popularity and messages kept coming, I had to dedicate more and more time to responses and less time to development. Thankfully, my sister Joanna offered to help. That is why you may see messages from either of us. Of course, it doesn't matter which of us ends up replying. We both work together to answer and help out. :D
Conclusion
Thank you all for your support! God bless!
~ Jon and Joanna from Firstfruits Studio
Hi, everyone!
This update adds a lot of things to make the plugin much more keyboard-friendly. Once again, special thanks to user hopkir from the OBS Forums for his invaluable suggestions!
New Keyboard Shortcuts Settings
Default Keyboard Shortcuts
You are free to customize or unset each shortcut as you see fit! However, please take note that keyboard shortcuts will only work if the dock has focus.
App (Global)
To Search Mode Ctrl + 1 To Bible Mode Ctrl + 2 To List Mode Ctrl + 3 To Theme Mode Ctrl + 4 To Settings Mode Ctrl + 5 Quick Show / Hide Ctrl + .
Bible
Previous Chapter Ctrl + ArrowLeft Next Chapter Ctrl + ArrowRight Previous List Item Ctrl + Alt + ArrowLeft Next List Item Ctrl + Alt + ArrowRight Add to List Ctrl + = Change Verse Range Ctrl + - Hide / Refresh Ctrl + /
List
Move Item Up Ctrl + ArrowUp Move Item Down Ctrl + ArrowDown
If you're interested, feel free to let me know what you think of the default shortcuts.
About Default Shortcuts Using Ctrl
Originally, I used Alt instead of Ctrl as the modifier key of choice for the default shortcuts. However, in OBS Studio on my Windows 10 system, this caused the system bell to keep ringing. As a result, I changed it to use Ctrl instead. Just in case anyone's interested. (For more information, see http://support.inqscribe.com/knowle...-to-turn-off-windows-default-beep-for-alt-key)
Other Changes
Focus and Select States in Bible Mode
- On switch to Search Mode, the reference field is now selected and given focus.
- List Mode now supports keyboard input: arrow keys to choose and Enter to select.
- Bible book suggestions in the reference field also accept keyboard input now: arrow keys to choose and Enter to select.
- Some notifications now avoid taking focus from other inputs (for example, the Unrecognized Reference error notification will no longer steal input focus from the reference field).
- The dock now has a subtle border indicating it has focus, useful to know at a glance whether keyboard shortcuts can be used.
- Bible Mode now has the ability to go to the previous or next list item, currently only triggered via keyboard shortcuts.
- Bible Mode has improved focus and selected states (more on this below).
In Bible Mode, a verse can be focused (shown with a blue border) and selected (shown with a gray background). A focused verse responds to keyboard inputs, while a selected verse shows which verse is currently being displayed. Usually, a verse is either focused or focused + selected. But there are some cases in which the focused and selected verses are different.
Before, in this scenario, the plugin would try to make the next focused item selected. For mouse users, this wasn't a problem; but for keyboard users, this could cause some confusing behavior. With this update, only the focused item will move if a discrepancy is detected. This lines up more closely with expected behavior, but it has the drawback that using the arrow keys will no longer move the selected verse. Clicking a new verse, hitting Enter on a new verse, or right-clicking the currently selected verse and choosing the option "Focus & Sync" will sync up both states again, though, allowing you to control both focus and selection with the arrow keys once more.
In my opinion, this behavior is good enough. My brother thinks so too, but my sister suggested bringing this up for feedback. If anyone is interested, feel free to let me know whether you think this behavior is all right.
Update Guide
Important: Please backup your verse list and custom themes before updating!
Free Online Version
You will automatically be updated to the latest version.
Coffee Version
- Download the latest release from Payhip.
- Run the Generator, choose the same Bibles and output folder, and click Generate.
- Open OBS Studio. You should be on the latest version.
Future
Thanks for all your feedback and suggestions so far. I'll be somewhat busy for a while; so major updates like the ones so far will likely not be as frequent as before. However, I do read every single comment and message; so feel free to let me know your thoughts and ideas.
Thank you all for your support! God bless!
~ Jon from Firstfruits Studio