Creating and Maintaining a Module Repository
From CrossWire Bible Society
Layout of a Module repository
In order to deal with all ways the various frontends use our module repository the following needs to be provided:
An echo of the mods.d and modules area as found under any Sword module area on your system (e.g. ~/.sword) plus mods.d.tar.gz, as created by:
tar czvf mods.d.tar.gz mods.d/*
Also a directory with zipped mnodules for JSword derrived front ends. This can also serve as a repository for smaller devices without integrated module manager.
This needs to be accessible both via FTP and via HTTP (for direct download and for JSword)
Some of the smaller devices running a sword frontend do not have a network enabled module manager. Users of these devices need to download their modules as zipped files and unzip them in the right place - e.g. a SD card.
It is also helpful for people who have no access to direct internet connections or live in countries with monitored access to the internet to be able to download (and possibly distribute) zipped modules.
These come in three formats
- rawzip (required by JSword derrived front-ends)
- zip for MS Windows
- zip for Mac OSX
This is a zipped archive of a module in the file and directory layout used in the local module directory.
E.g. to create from your own module directory a zipped module of a uncompressed GenBook do this:
cd ~ftp/pub/sword zip zip/mybook.zip mods.d/mybook.conf modules/genbook/rawgenbooks/mybook
MS Windows zip
This is a zip file which will selfextract on a MS Windows computer. To create it you require:
MacOS X zip
Earlier version of MacSword relied on these instead of the module manager. This is not anymore required for a module repository.
Registering your repository with CrossWire
Most frontends can install modules from a number of repositories. Several repositories are well established with CrossWire and are maintained by various developers. If you or your organisation have set up your own repository, please announce it on the mailing list (firstname.lastname@example.org).
From libsword-1.5.12 onwards the module manager will also be able to load dynamically a list of active and accepted repositories. To enable your repository for this list please contact CrossWire