Skip to main content

Installing Modules

Modules are things like Bible translations, commentaries, books, topical indexes, or sets of cross-references. When you first start the app, it will suggest starter sets depending on your language (right now, only English is supported). You can install more using the Module Manager.

Opening the Module Manager​

Go to File → Open Module Manager, click the Module Manager icon at the right of the header, or press Ctrl+Shift+P and type "module manager".

The dialog has a tab for each type of module, such as Bibles, Commentaries, Dictionaries, Books, Topical Indexes, and Cross-References, followed by Feature packs, Bundles, and Sources. On the module tabs, the All, Installed, and Updates filters choose which modules are listed.

The Module Manager open on the Bibles tab

Installing a module​

Installing from the Module Manager needs web requests to be allowed. When they are off, a banner says Network access is off, so the module store can't be loaded. Choose Turn on to allow web requests, or Install from a file…. See Web requests.

  1. Choose the tab for the type of module. The app loads the catalog from https://modules.bible.keepthyheart.com/.
  2. Search by name with the Search modules... box.
  3. Click Install. A progress indicator shows the download. You can cancel it while it runs.

Click a module's row to see its details, such as its license, size, version, and publisher.

Installed modules are available immediately, without a restart. New translations appear in the Bible pane's translation selector, and new commentaries can be opened in the Commentary pane.

Refresh reloads the catalog. The date of the last refresh is shown beside it.

Installing from a file​

To install a module file you already have, click Upload Module and select the file, or drag the file onto the Module Manager. Accepted formats are .db, .gz, .zip, and .biblepack. Installing a file for a module you already have updates it.

Bundles and feature packs​

  • Bundles installs a set of modules together. It shows the download size and the disk space each set needs.
  • Feature packs lists optional features that are not installed by default because of their download size, such as the meaning search pack used by Ideas Search. Feature packs work offline once installed.

Managing installed modules​

Choose the Installed filter to list the modules you have. Click a module's row to open its details, where you can:

  • Uninstall the module. This removes the module's content, but not your notes or highlights, unless you also select Also remove my data for this module.
  • Update the module when a newer version is available. The Updates filter lists modules with updates.
  • Re-index the module's search index. Do this if search results from that module are incomplete or out of date.

The Installed filter, listing installed modules

Where modules are stored​

Modules are files in the application's data directory. You can back them up like any other file, or reinstall them from the repository.

Your notes, highlights, and sessions are stored separately from modules, so uninstalling or updating a module does not affect them. See Backup & Restore.

Repositories​

The app is configured with the official repository by default. To add another, open the Sources tab, enter a name and URL under Add New Repository, and choose Add Repository. From the same tab you can refresh, edit, or remove a repository.

Troubleshooting​

The list of available modules is empty or won't load. Check that web requests are allowed (Privacy → Allow Web Requests), then check your internet connection and the repository URL on the Sources tab.

A module installed but doesn't appear. Restart the app. If it still doesn't appear, choose the Installed filter to confirm the installation completed.

Search doesn't find text you know is there. Open the module's details and choose Re-index.

Study mode shows no interlinear data. The translation does not include interlinear data. Install a Bible module that includes it. See Study Tools.