[xiphos-users] creating a bible module

[Karl Kleinpaste]

On 11/7/25 9:39 AM, gfp wrote:
> Is it possible, and how to do that, to create a module etc

The short answer is Yes, absolutely. The PDF will probably not be 
useful, but the text is fine.

It's not a trivial process, but it's very doable, especially for simple 
text format source material. You just have to put in some effort.

See first the Crosswire developers' wiki 
<https://wiki.crosswire.org/Main_Page>, where the relevant information 
will be found. At bottom right, see Module Development.

You need to do a couple things:

- Edit the text into a format usable by Sword's conversion tools. 
Notably for you, this is probably the simple "import format." This is a 
format where verse identifications are separated from verse text:

$$$Genesis 1:1
In the beginning, God created the heavens and the earth.
$$$Genesis 1:2
...

and so on.

- Then "imp2vs" will convert that "import" content to the internal 
versified (indexed) format used by all Sword apps. That produces 4 
files: ot, ot.vss, nt, nt.vss. The *.vss are index files referencing the 
textual content in the non-.vss files, respectively Old and New Testament.

- You need to edit a configuration file. Look in ~/.sword/mods.d for 
examples and see the Module Configuration Files reference at the wiki. 
Don't overdo it, especially for a module built from simple text.

Put your .conf into ~/.sword/mods.d/.
Put the ot/nt files into the directory beneath ~/.sword/modules that you 
specified in the .conf as DataPath.

After that, Xiphos will know about the module.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://crosswire.org/pipermail/xiphos-users/attachments/20251107/6e86c770/attachment.htm>