Bible Plugin

for OBS Studio

  Overview

Learn what the Generator program is, and how you can use it to import and use your own Bibles.

Important Notes:

  • The Generator program is only available in the Coffee Version.
  • The Generator program only runs on supported platforms. Please refer to this FAQ question for details.

  About the Generator

Generator program user interface
The Generator program

What is the Generator program? It is a portable executable that allows you to use your own Bibles with the Bible Plugin. It works by using a blank version of the Bible Plugin and filling it with the Bibles you have selected. It then copies the plugin to a folder of your choice.

Using the Generator has the following advantages:

  • Customizable: choose which Bible translations you want.
  • Offline access: you do not need an Internet connection to use the plugin.
  • Self-contained: the generated plugin is contained in one folder.

Here are some things you should be aware of:

  • The Generator program includes some common public domain Bibles but can also read other Bibles. If you plan to use other Bibles not already included, please keep in mind that the Generator program can only read OpenLP Bibles. For this case, OpenLP should already be installed on the same computer and should already have the Bibles that you want to use inside it.
  • Setup, while mostly the same as the Online Version, is slightly more complex for the generated plugin. This is because you will be using your own local files instead of an Internet website.

Please refer to the following FAQ questions for other relevant information:

  Using the Generator

List of available Bibles
Available Bibles (subject to change)

When you launch the program, you will be presented with all the Bible translations that the Generator has detected. Check the Bibles that you would like to include.

Bible edit screen
The Bible Edit Screen

If you click the Edit icon to the right of a Bible, you will enter the Bible editor. From here, you can customize the following:

Name
The name of the Bible translation. All selected Bibles must have unique names.
Abbreviation
The abbreviation of the Bible translation. This is usually all-caps and three to five letters long. The program will try to guess the abbreviation from the Bible name, but there may be times when you will have to manually set this.
Copyright
Bible copyright information.
Books
Select which books of the Bible you would like to include. For example, some Bibles include books from the Apocrypha, which you may not want.

When you are done, you can click Cancel to discard your changes or Save to apply them.

Output folder in the user interface
Output Folder

Remember to select which folder the plugin should be written to. Inside your chosen folder, a new folder named obs-bible-plugin will be created with all plugin files inside.

Successful plugin generation
Plugin Generation

When all the settings are to your liking, click the Generate button. A dialog should appear informing you that plugin generation was successful.

The generator will then tell you how to setup the plugin in OBS Studio. It is very similar to the instructions for the online version, but there are a few differences.

  Plugin Setup

Output Folder

To make it easier to follow this tutorial, you can enter the same output folder you set in the Generator here. This is an optional step.

Platform:

Locations

These are the locations you need to enter in OBS Studio. Click on a link to copy.

Browser file:

Dock URL:

Browser Source Setup

1. Adding a Browser Source
1. Adding a Browser Source

An OBS Studio Browser Source needs to be added in order for verses to be displayed. In the Sources panel at the bottom of OBS Studio, click the + icon.

2. Choosing the Browser Option
2. Choosing the Browser Option

In the popup menu, choose the Browser option.

3. Creating a New Browser Source
3. Creating a New Browser Source

Choose Create New and enter a name. We recommend Bible or Bible Browser to keep things simple.

4. The New Browser Source Dialog
4. The New Browser Source Dialog

Click OK. A new dialog window should appear.

5. The Local File Option
5. The Local File Option

Check the Local file option.

6. Using the Plugin Files
6. Using the Plugin Files

Click Browse and set

7. Width and Height
7. Width and Height

Set the width and height according to your preferences. You can always change this setting later.

8. Save Changes
8. Save Changes

Click OK to save all changes and close the dialog.

9. Red Rectangle
9. Red Rectangle

You should see a red rectangle on the screen with nothing inside. This is where Bible verses will appear.

10. Setting the Browser Source Location
10. Setting the Browser Source Location

If you like, you can drag the red rectangle to a location of your preference.

11. Readjusting the Width / Height
11. Readjusting the Width / Height

If the width/height is not to your liking, you can right-click the Bible browser source, click on Properties, and change them. Browser source setup is now complete.

Dock Setup

1. Adding a Custom Browser Dock
1. Adding a Custom Browser Dock

Adding the Bible dock allows us to control what is shown in the Bible Browser Source. In the OBS Studio toolbar, click View → Docks → Custom Browser Docks…

2. Setting a Dock Name
2. Setting a Dock Name

A dialog window should appear. Enter a Dock Name. We recommend Bible or Bible Dock to keep things simple.

3. Setting the Dock URL
3. Setting the Dock URL

Set the URL field to

4. Applying Changes
4. Applying Changes

Click Apply. The Bible dock should open.

5. Closing the Custom Browser Docks Dialog
5. Closing the Custom Browser Docks Dialog

Close the Custom Browser Docks… dialog.

6. Setting the Dock Location
6. Setting the Dock Location

Drag the newly opened Bible dock to a location of your preference. The left or right sides of OBS Studio are good options.

7. Resizing the Dock
7. Resizing the Dock

If the dock is too small, resize it by dragging its side to a size of your preference. Setup for the dock is now complete.

Conclusion

You are now ready to use the plugin! Choose a Bible, enter a reference, and hit Submit. Click on any resulting verse and it should show up automatically on the browser source. Click it again to hide.

If you have any further questions, please refer to our guides or send us a message on our contact page.