Developer Notes

Release checklist

1. Update Source_Files/Misc/alephversion.h
2. Fill out version placeholders in Lua documentation
   • cd docs
   • sed -e 's/version="SVN"/version="20150619"/g' -i '' Lua.xml Lua_HUD.xml
   • xsltproc Lua.xsl Lua.xml > Lua.html
   • xsltproc Lua.xsl Lua_HUD.xml > Lua_HUD.html
3. Make final builds and archives for distribution, as documented above
4. Test and commit version changes above
5. Tag release in Git
6. Upload files to GitHub release page
   • 4 Mac disk images (1 standalone Aleph One, 3 bundled app + data)
   • 7 Windows zip files (1 standalone Aleph One, 3 bundled exe + data, 3 exe only)
   • 3 data-only zip files
   • 1 source tarball
   • 1 release notes document (README.md)
7. Update _data/version.yaml in aleph-one-marathon.github.io repository
8. Sync and rebuild alephone.lhowon.org from updated site repository
9. Announce on Pfhorums, Story forum

Compatibility notes

Film playback compatibility is handled in Source_Files/CSeries/FilmProfile.[cpp,h]. When making a gameplay-related change after a release, set up a new profile and add handling for the newly-obsoleted profile.

Multiplayer compatibility is handled in Source_Files/Network/network_capabilities.[cpp,h]. When making gameplay-related or net protocol-related changes, bump kGameworldVersion and/or kGameworldM1Version as necessary.

Scenario compatibility is handled in MML, in the <scenario id="..."> attribute. The ID should be changed whenever MML or data updates affect gameplay.

Version checks are made to updates.lhowon.org, which is a mirror of alephone.lhowon.org. When updating the web site, be sure to keep the current version-check URLs functional.

Metaserver and other online functions communicate with metaserver.lhowon.org and stats.lhowon.org. Coordinate any new online features with the admins of these sites.