(Also known as Module Maintainer Mode (MMM).)

Warning:::  This blog post is only for those people who wish to manually install their own modules.  Why would you do that, when there’s such an excellent built-in downloader, I hear you say?  Because some people create their own modules, and wish to use those in PocketSword.

If you are going to follow these instructions, I suggest you read them all the way through before proceeding.

In order to install a module you have, you firstly must create a zip archive of the module.  The format of the zip file is to be exactly like that found on the CrossWire repository.  If you get this bit wrong, it won’t work.  Period.  And it won’t tell you why it’s not working.  This is important.  You have been warned.

Next you need to have a compatible web browser on your computer.  Unfortunately, in PocketSword 1.0 (which is the version currently available on the App Store), this needs to be a WebKit-based browser.  It has been tested (and works) in both Apple’s Safari and Google’s Chrome (and has been found to not work in Firefox, sorry about that, and has not been tested in IE, not sorry about that!).  I suggest using Safari, as it has Bonjour built-in and makes things easier if you’re installing your modules over a home Wi-Fi connection.

Now we are ready to install your module  :)

If you connect your device using Wi-Fi, this is where you want to make sure that Wi-Fi is enabled and you’re connected to your Wi-Fi network.  If not, don’t worry, you can manually install modules over a 3G connection as well  :)

So, open PocketSword on your iPhone/iPod Touch and go into the Preferences.  At the bottom of the screen (after you scroll down), you’ll see Module Maintainer Mode.  You’ll need to enable that.  Reread the note about what MMM is.  While you’re here, you probably want to disable auto-lock to prevent your device going to sleep while we’re installing the module!

Go back a screen (touch “More” in the top left corner of the screen) and select “Downloads”.  Notice that there is now a button in the top right corner, “*”.  That is the MMM button.  Tap it and read the instructions.  I’ll wait while you do that.

Read them?  Great.  :)

By the time you’ve read them, the methods to connect to your device should have updated.  If you’re connected to a Wi-Fi network, the Bonjour address should be provided as well as a local IP of your device.  If not, it’s not a problem, as the bottom like should say something like:

“Web:  http://58.104.190.170:53776”

If you have Safari and a Bonjour address showed up, simply go to the Bookmarks menu in Safari (on your computer) and find the Bonjour submenu & your device should appear there.

If there’s no Bonjour address or you’re not using Safari, you can open your web browser to point to the address that your device is supplying.

Note that this URL is unique each and every time you use MMM.  Please don’t bookmark this URL, as it will change!  This is why I suggest you try to use Bonjour -- it saves typing in a long URL  :)

The web page displayed will list the modules that are currently installed in PocketSword on your device and there are further instructions at the bottom of that page.  Read them.  :)

And now you can click on the “Choose File” button.  Choose your zip archive that you created of the module you wish to install.

When you click the “Submit” button, the module should be uploaded to your device and installed.  The web page will then be updated to show the new list of the modules that are installed.  You can tell if the installation was successful by seeing if your new module is in that list.  If the installation failed, the module won’t appear there.

Notes:

1. (1)Version 1.0 of PocketSword will only allow you to install Bibles and Commentaries.
   

2. (2)If you want, you may include multiple modules in your zip archive.  However, the folder structure in the zip file must still be the same.
   

3. (3)If you try this and it fails to install your module, please note that this method of installing modules is currently (fairly) unsupported.  I have reports of it working in both Safari and Chrome (under both Mac OS X & Linux (Fedora11)).  It does NOT work under Firefox (hopefully this will be fixed for v1.1).  I have had no reports of success or failure using IE or on a Windows PC.
   

4. (4)That being said, you can check out this forum post and ask questions there  :)