Project Structure

The following sub-directories of the Build Environment are included in the Mercurial repository.

• asm - Assembler source code
  • color - programs for generating / displaying color palettes
  • common - common code
  • launcher - programs used to launch the upgrade (e.g. ULTIMA3.COM)
  • u3drv - U3 Upgrade graphic & music drivers
  • u5drv - U5 Upgrade music drivers
• tools - C source code
  • binpatch - a binary diff/patcher utility
  • cfg - upgrade configuration programs
  • common - common code
  • patch - code/data patching programs for U2 & U5
  • reset - player character reset programs for U2 & U3
  • tlk - tools for viewing U2's TLK files
• patches - binary patches for the upgrades (used with binpatch)
• ext - external libraries / dependencies
• data - new/modified game data files
  • u2gal - U2 Galaxy Maps (from Micro Dragon's patch)
  • u2gfx - U2 graphic data
  • u2tlk - U2 lower-case TLK files
  • u3gfx - U3 graphic data
  • u3midi - U3 midi data
  • u5midi - U5 midi data
• doc - technical & release documentation

The following additional sub-directories of the Build Environment are used by the project, but are not included in the Mercurial repository.

• game - The Ultima games for reference/testing
  • u2orig - unmodified U2 game files (for reference)
  • u3orig - unmodified U3 game files (for reference)
  • u5orig - unmodified U5 game files (for reference)
  • u2up - modified U2 game files (for testing)
  • u3up - modified U3 game files (for testing)
  • u5up - modified U5 game files (for testing)
• build - Compilation/packaging work area (created during make)
  • bin - assembled/compiled binaries
    • i386-dos - DOS binaries
    • \<local> - local binaries (will be named according to "gcc -dumpmachine")
  • lib - compiled object files
    • i386-dos - DOS object files
    • \<local> - local object files (will be named according to "gcc -dumpmachine")
  • dmkit - extracted DIGPAK/MIDPAK developers kit
  • u2pkg - files included in U2 upgrade package
  • u3pkg - files included in U3 upgrade package
  • u5pkg - files included in U5 upgrade package