Skip to content

docs: restructure README and document all supported Bible versions #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
LehlohonoloMofula wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: restructure README and document all supported Bible versions #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33,615 changes: 33,615 additions & 0 deletions Bibles/AMP_2001.xml
View file
Open in desktop

Large diffs are not rendered by default.

33,615 changes: 33,615 additions & 0 deletions Bibles/MSG.xml
View file
Open in desktop

Large diffs are not rendered by default.

33,616 changes: 33,616 additions & 0 deletions Bibles/NASB.xml
View file
Open in desktop

Large diffs are not rendered by default.

33,617 changes: 33,617 additions & 0 deletions Bibles/NIRV.xml
View file
Open in desktop

Large diffs are not rendered by default.

33,617 changes: 33,617 additions & 0 deletions Bibles/NLT.xml
View file
Open in desktop

Large diffs are not rendered by default.

33,615 changes: 33,615 additions & 0 deletions Bibles/The Holy Bible, New International Version®.xml
View file
Open in desktop

Large diffs are not rendered by default.

33,616 changes: 33,616 additions & 0 deletions Bibles/esv.xml
View file
Open in desktop

Large diffs are not rendered by default.

105 changes: 86 additions & 19 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,26 +1,93 @@
# Bibles and Songs for Openlp
# OpenLP Bibles and Songs

## BIBLES
| Bibles | Installation | Source |
| --- |:---:| ---:|
| American Standard Version | Import using Zefania format | [Zefania](https://sourceforge.net/projects/zefania-sharp/files/Bibles/ENG/) |
| Amplified Bible | Import using OpenSong format | [OpenSong](http://www.opensong.org/home/download) |
| King James Version | Import using OpenSong format | [OpenSong](http://www.opensong.org/home/download) |
| New American Standard Bible | Import using OpenSong format | [OpenSong](http://www.opensong.org/home/download) |
| New International Version | Import using OpenSong format | [OpenSong](http://www.opensong.org/home/download) |
| New King James Version | Import using OpenSong format | [OpenSong](http://www.opensong.org/home/download) |
| Revised Standard Version | Import using Zefania format | [Zefania](https://sourceforge.net/projects/zefania-sharp/files/Bibles/ENG/) |
| Yoruba Bible | Import using CSV format | [Github](https://github.com/gray-adeyi/pygconverter) |
This repository provides pre-packaged Bible texts and song files for easy import into **OpenLP**.

The content is organised into:

- `Bibles/` – Bible texts in Zefania XML, OpenSong, and CSV formats.
- `Songs/` – Song files prepared for import using the OpenLP 2.x song format.

---

## Getting Started

### Prerequisites

- OpenLP installed (version 2.x or later).
- This repository cloned or downloaded to your local machine.

### Importing Bibles

1. Open OpenLP.
2. Go to **Bibles → Import**.
3. Select the appropriate import format (for example, **Zefania XML**, **OpenSong**, or **CSV**).
4. Browse to the `Bibles/` folder in this repository.
5. Choose the file(s) for the translation you want to import (see the table below for file names and formats).
6. Follow the wizard prompts to complete the import.

### Importing Songs

1. Open OpenLP.
2. Go to **Songs → Import**.
3. Choose **OpenLP 2** as the import format.
4. Browse to the `Songs/` folder in this repository.
5. Select the song file(s) you want to import.
6. Complete the wizard to add the songs to your OpenLP library.

---

## Bible Packages

All Bible files are located in the `Bibles/` directory. Use the **Bibles → Import** wizard in OpenLP and select the appropriate format (Zefania XML, OpenSong, or CSV) as indicated below.

### Available Bible Versions

| Version | Files / Location | Import Format in OpenLP | Source |
| --- | --- | --- | --- |
| American Standard Version (ASV) | `Bibles/AmericanStandardVersion.xml` | Zefania XML | [Zefania](https://sourceforge.net/projects/zefania-sharp/files/Bibles/ENG/) |
| Amplified Bible (AMP) | `Bibles/AmplifiedBible.xmm`, `Bibles/AMP_2001.xml` | OpenSong / Zefania XML | [OpenSong](http://www.opensong.org/home/download), [Zefania](https://sourceforge.net/projects/zefania-sharp/files/Bibles/ENG/) |
| English Standard Version (ESV) | `Bibles/esv.xml` | Zefania XML | [Zefania](https://sourceforge.net/projects/zefania-sharp/files/Bibles/ENG/) |
| King James Version (KJV) | `Bibles/KingJamesVersion.xmm` | OpenSong | [OpenSong](http://www.opensong.org/home/download) |
| New American Standard Bible (NASB) | `Bibles/NewAmericanStandardBible.xmm`, `Bibles/NASB.xml` | OpenSong / Zefania XML | [OpenSong](http://www.opensong.org/home/download), [Zefania](https://sourceforge.net/projects/zefania-sharp/files/Bibles/ENG/) |
| New International Version (NIV) | `Bibles/NewInternationalVersion/`, `Bibles/The Holy Bible, New International Version®.xml` | OpenSong / Zefania XML | [OpenSong](http://www.opensong.org/home/download), [Zefania](https://sourceforge.net/projects/zefania-sharp/files/Bibles/ENG/) |
| New International Reader's Version (NIrV) | `Bibles/NIRV.xml` | Zefania XML | [Zefania](https://sourceforge.net/projects/zefania-sharp/files/Bibles/ENG/) |
| New King James Version (NKJV) | `Bibles/NewKingJamesVersion.xmm` | OpenSong | [OpenSong](http://www.opensong.org/home/download) |
| New Living Translation (NLT) | `Bibles/NLT.xml` | Zefania XML | [Zefania](https://sourceforge.net/projects/zefania-sharp/files/Bibles/ENG/) |
| Revised Standard Version (RSV) | `Bibles/RevisedStandardVersion.xml` | Zefania XML | [Zefania](https://sourceforge.net/projects/zefania-sharp/files/Bibles/ENG/) |
| The Message (MSG) | `Bibles/MSG.xml` | Zefania XML | [Zefania](https://sourceforge.net/projects/zefania-sharp/files/Bibles/ENG/) |
| Yoruba Bible | `Bibles/YorubaBible/` (CSV files) | CSV (custom import) | [GitHub – pygconverter](https://github.com/gray-adeyi/pygconverter) |

> **Note**
> Some translations are available in more than one format (for example, both OpenSong and Zefania XML). Choose the format that best matches your existing workflow in OpenLP.

---

## Songs

Songs can be Imported using OpenLp 2 format
All song files are located in the `Songs/` directory.

- Format: OpenLP 2.x song format.
- Usage: In OpenLP, go to **Songs → Import**, choose **OpenLP 2** as the format, then select the desired song files from the `Songs/` folder.

---

## Troubleshooting

- **Import wizard fails or aborts** – Confirm you selected the correct format (Zefania XML, OpenSong, or CSV) for the file you are importing.
- **Unsupported or corrupted file** – Re-download this repository or re-extract the archive to ensure files are not partially copied.
- **Duplicate Bible entries** – If the same translation exists in multiple formats, remove/disable the ones you do not use from within OpenLP to avoid confusion.
- **Missing characters or accents** – Ensure OpenLP is configured to use UTF‑8 and that the system fonts support the script for the selected language.

If problems persist, check the OpenLP log (via **Tools → Open Data Folder → logs**) for detailed error messages.

---

## Credits

| Source | Provides |
| --- | --- |
| [OpenSong](http://www.opensong.org/home/download) | AMP, KJV, NASB, NIV, NKJV (OpenSong format) |
| [Zefania Bible Project](https://sourceforge.net/projects/zefania-sharp/files/Bibles/ENG/) | ASV, RSV, AMP 2001, ESV, MSG, NASB, NIrV, NLT, NIV (Zefania XML) |
| [GitHub – pygconverter](https://github.com/gray-adeyi/pygconverter) | Yoruba Bible (CSV) |

### Credits
| Link | Doc |
| --- | ---:|
| [OpenSong](http://www.opensong.org/home/download) | Amp, Kjv, Nasb, Niv, Nkjv |
| [Zefania](https://sourceforge.net/projects/zefania-sharp/files/Bibles/ENG/) | Rsv, Asv |
| [Github](https://github.com/gray-adeyi/pygconverter) | Yor |