Difference between revisions of "Uploading a module"

Revision as of 03:23, 16 September 2013

Once your module is complete, you'll want to upload it to http://te4.org/games so that others can play it. To do so:

1. Request upload permission from http://te4.org/contact, if you haven't already done so.
2. Go to http://te4.org and click the "Create a module" link. Fill out the form there; most of the information here can come straight out of your init.lua.
3. Zip your module up into a .team file. A .team file is simply a zip file, renamed to have a .team extension. The .team file's layout is slightly different than the normal module directory structure; the data subdirectory remains unchanged, while everything else is placed in a mod subdirectory. (You'll probably also want to exclude any development documentation, .gitignore files, scripts, etc.)
4. Get the MD5 checksum for your module. To do so, start ToME, load your newly zipped module, then exit. Check te4_log.txt for a line similar to the following:

   [MODULE LOADER] module MD5 1234567890abcdef1234567890abcdef

   In this example, "1234567890abcdef1234567890abcdef" is the checksum.
5. Go to http://te4.org and click the "Upload a module" link. Under "File:", select your .team file and click Upload. Fill out the rest of the page and click Save.
6. Go to http://te4.org/games and bask in the pleasure of seeing it listed alongside the other T-Engine4 games. Dream about it becoming the next smash hit.

A script to automate creating the .team file and calculating the MD5 checksum is available at https://github.com/joshkel/qdz/blob/master/dev/release.py. Although it was written for another T-Engine module, it should work with any module. Just run it from the command line with the path to your module directory as a command-line parameter. (You'll need to have Python 2.7 or 3 installed.)