titan-ultima 0.6.5

TITAN – Tool for Interpreting and Transforming Archival Nodes. CLI and library for Ultima file formats (U8: Pagan, U7: Black Gate & Serpent Isle).

titan-ultima

TITAN - Tool for Interpreting and Transforming Archival Nodes.

TITAN is a Python CLI and library for working with proprietary data formats from Ultima 8: Pagan and Ultima 7: The Black Gate / Serpent Isle. It reads, extracts, converts, inspects, and reconstructs archives, shapes, palettes, music, speech, maps, saves, and Exult runtime data.

Run titan --help, titan u8 --help, titan u7 --help, or see the full CLI reference.

---

Installation

pip install titan-ultima

Requirements:

• Python 3.9+
• NumPy >= 1.24
• Pillow >= 10.0
• Typer >= 0.15
• questionary >= 2.0
• tomli >= 2.0 on Python < 3.11, for titan.toml support

---

Quick Start

Run setup once. It detects common Ultima 8 and Ultima 7 install locations, detects Exult runtime folders and the Exult install directory (for exult_bg.flx / exult_si.flx), writes titan.toml, and can extract the U8 shape/glob data used by map rendering.

titan setup

After setup, many commands can use configured paths:

# U8 map render
titan u8 map-render -m 5

# U8 dialogue web viewer
titan dialogue prepare
titan dialogue validate
titan dialogue launch

# U7 configured commands
titan u7 map-render --game bg --sc 85 -o britain_bg.png
titan u7 typeflag-dump --game si -f csv -o tfa_si.csv
titan u7 gamedat-info --game si -f detail -o gamedat_info.txt

The detailed dialogue web documentation lives in src/titan/dialogue/websrc/READMEd.md.

---

Capabilities

The table below is the compact command map. The CLI reference is the canonical place for command options, longer examples, and format notes.

Area	Ultima 8	Ultima 7 / Exult	Quick example	Reference
Archives	Flex .FLX list/extract/create/update	Flex/VGA-style archive support where relevant	titan flex-list U8SHAPES.FLX	Flex commands
Shapes	Export/import U8 .shp frames	Export U7 shapes from SHAPES.VGA, FACES.VGA, etc.	titan u7 shape-export SHAPES.VGA --shape 150 -p PALETTES.FLX -o shape_150/	U8 commands, U7 shape commands
Palettes	Export U8 VGA palette	Export 12 U7 palettes from PALETTES.FLX	titan u7 palette-export PALETTES.FLX -o palettes/	U7 palette commands
Music	XMIDI to MIDI from MUSIC.FLX	MIDI export from ADLIBMUS.DAT, MT32MUS.DAT, ENDSCORE.XMI; optional GM rewrite	titan u7 music-export MT32MUS.DAT --target gm -o music_gm/	U8 music commands, U7 music commands
Sound and speech	Sonarc sound effects and speech FLX archives	Creative Voice .voc decode and U7SPEECH.SPC export	titan u7 speech-export U7SPEECH.SPC -o speech_wav/	Sound commands, U7 voice commands
Dialogue web	Prepare, validate, and launch the U8 dialogue web machine	Not applicable	titan dialogue launch	Dialogue CLI, Dialogue README
Maps	Render U8 isometric/top-down maps from FIXED.DAT, GLOBs, shapes, saves	Render U7 maps from U7MAP, U7CHUNKS, U7IFIX*, SHAPES.VGA, optional u7ireg*	titan u7 map-render STATIC/ --full -o u7_world.png	U8 map commands, U7 map commands
Type data	Decode U8 TYPEFLAG.DAT	Decode U7 TFA.DAT, SHPDIMS.DAT, WGTVOL.DAT	titan u7 typeflag-dump STATIC/ -f csv -o tfa_data.csv	U8 data commands, U7 type flag commands
Saves and runtime data	List/extract U8 save archives	Read Exult .sav; inspect loose gamedat/; dump NPCs, schedules, flags	titan u7 save-info exult00bg.sav	U8 save commands, U7 save commands
Fonts	U8 font archives can be extracted as Flex data	U7 font-create wizard for Exult-compatible font shapes	titan u7 font-create	U7 font-create
World query	Not applicable	Interactive wizard to filter IFIX/IREG object placements by shape class, number, TFA flags, and area	titan u7 world-query --game bg	U7 world-query
Container data	Not applicable	Browse IREG container contents with full nesting; filter by container name, item name, or tile area; optional per-frame item names via Exult FLX	titan u7 container-browse --game bg --container-name chest	U7 container-browse
Egg data	Not applicable	Query IREG egg trigger objects — type, usecode function, probability, location	titan u7 egg-query --game bg --type usecode	U7 egg-query
Text and misc data	Gump layout, XOR credits, quotes, transform palettes	Global flags and selected runtime metadata	titan u8 credits-decrypt ECREDITS.DAT	U8 data commands

---

Common Workflows

U8 Dialogue Web

titan dialogue prepare
titan dialogue validate
titan dialogue launch

For setup, local development, export behavior, and known dialogue-machine limits, see the dedicated dialogue web README.

U7 Exult Runtime Inspection

# Inspect configured Serpent Isle GAMEDAT, including mod fallback sources.
titan u7 gamedat-info --game si -f detail

# Inspect a mod's packaged patch/initgame.dat archive directly.
titan u7 gamedat-info mods/<mod-name>/patch/initgame.dat --static STATIC/

# Inspect a specific Exult save archive.
titan u7 save-info exult00si.sav
titan u7 save-npcs exult00si.sav --static STATIC/ -f detail
titan u7 save-schedules exult00si.sav -f detail

U7 Map Rendering

# Superchunk render.
titan u7 map-render STATIC/ --sc 0x55 -o superChunk_85.png

# Full world render.
titan u7 map-render STATIC/ --full -o u7_world.png

# Minimap sample with grid.
titan u7 map-sample STATIC/ --scale 4 --grid -o minimap.png

U7 World Query

# Interactive wizard — walks through shape class, flag, and area filters.
titan u7 world-query --game bg

# With explicit paths (no titan.toml required).
titan u7 world-query STATIC/ --gamedat gamedat/

# Pre-set STATIC from config, add a runtime GAMEDAT for IREG objects.
titan u7 world-query --game si --gamedat /path/to/serpentisle/gamedat

The wizard prompts for shape-class checkboxes, optional shape numbers, TFA flag checkboxes, area (all or specific superchunks), and output format (summary / full text / CSV). Output can be printed or saved to a file.

U7 Container Browse

# Interactive wizard — configured BG paths.
titan u7 container-browse --game bg

# Show all chests with their full contents tree.
titan u7 container-browse STATIC/ --gamedat gamedat/ --container-name chest

# Find containers holding a sword.
titan u7 container-browse STATIC/ --gamedat gamedat/ --contains-name sword

# Export to CSV with per-frame item names (requires Exult installation).
titan u7 container-browse STATIC/ --gamedat gamedat/ -f csv -o containers.csv \
  --exult-flx "C:/Program Files/Exult/data/exult_bg.flx"

# Configured paths with per-frame names from titan.toml [exult.paths].
titan u7 container-browse --game bg --container-name desk

U7 Egg Query

# Interactive wizard — configured BG paths.
titan u7 egg-query --game bg

# All usecode eggs.
titan u7 egg-query STATIC/ --gamedat gamedat/ --type usecode

# Find every placement of a specific usecode function.
titan u7 egg-query STATIC/ --gamedat gamedat/ --fn 0x06BC

# Export usecode eggs to CSV.
titan u7 egg-query STATIC/ --gamedat gamedat/ --type usecode -f csv -o usecode_eggs.csv

U8 Map Rendering

titan u8 map-render -m 5
titan u8 map-render -m 0 --no-roof
titan u8 map-render-all --maps 0 5 39 --views iso_classic iso_high

---

Configuration

titan.toml stores default paths so commands can run without long path arguments. Command-line options always override config values.

Config search order:

1. ./titan.toml
2. ~/.config/titan/config.toml
3. %APPDATA%\titan\config.toml

Use titan --config /other/path.toml <command> to override.

Minimal multi-game shape:

[u8.game]
base     = "C:/Path/To/Ultima8"
language = "ENGLISH"

[u8.paths]
fixed    = "FIXED.DAT"
palette  = "U8PAL.PAL"
typeflag = "TYPEFLAG.DAT"
shapes   = "shapes/"
globs    = "globs/"
nonfixed = "U8SAVE.000"

[u7bg.game]
base    = "C:/Path/To/Ultima7/ULTIMA7"
variant = "blackgate"

[u7bg.paths]
static  = "STATIC/"
shapes  = "STATIC/SHAPES.VGA"
palette = "STATIC/PALETTES.FLX"
gamedat = "gamedat/"

[u7si.game]
base    = "C:/Path/To/Ultima7/SERPENT"
variant = "serpentisle"

[u7si.paths]
static  = "STATIC/"
shapes  = "STATIC/SHAPES.VGA"
palette = "STATIC/PALETTES.FLX"
gamedat = "gamedat/"

[u7si.mods."<mod-name>".paths]
root    = "C:/Users/<you>/AppData/Local/Exult/serpentisle/mods/<mod-name>"
saves   = "C:/Users/<you>/AppData/Local/Exult/serpentisle/mods/<mod-name>/saves"
gamedat = "C:/Users/<you>/AppData/Local/Exult/serpentisle/mods/<mod-name>/gamedat"
archive = "C:/Path/To/Ultima7/SERPENT/mods/<mod-name>/patch/initgame.dat"

[exult.paths]
bg_flx  = "C:/Program Files/Exult/data/exult_bg.flx"
si_flx  = "C:/Program Files/Exult/data/exult_si.flx"

Notes:

• titan setup writes this file for you.
• U8 relative paths expand from the configured U8 install and language folder, except shapes and globs, which are local working directories.
• U7 gamedat should usually point at Exult's initialized runtime copy when available.
• U7 mod saves is discovered by scanning the mod profile root recursively for .sav files and choosing the folder with the most saves.
• A fully annotated template is available in titan.toml.example.
• Full config details are in cli_reference.md#configuration-titantoml.

Inspect the active config:

titan config
titan config --edit

---

Library Use

TITAN can also be imported as a Python library. U8 modules live under titan.u8; U7 modules live under titan.u7. Backward-compatible imports such as from titan.shape import U8Shape are still supported.

from titan.u7.flex import U7FlexArchive
from titan.u7.palette import U7Palette
from titan.u7.shape import U7Shape

archive = U7FlexArchive.from_file("SHAPES.VGA")
shape = U7Shape.from_data(archive.get_record(150))
palette = U7Palette.from_file("PALETTES.FLX")
shape.to_pngs(palette)[0].save("shape_150_frame0.png")

---

Supported File Families

Family	Ultima 8	Ultima 7 / Exult
Archives	*.FLX, speech FLX archives	Flex/VGA archives, Exult ZIP/FLEX saves
Shapes	U8SHAPES.FLX, U8FONTS.FLX, U8GUMPS.FLX	SHAPES.VGA, FACES.VGA, GUMPS.VGA, SPRITES.VGA, POINTERS.SHP, generated font shapes
Palettes	U8PAL.PAL, XFORMPAL.DAT	PALETTES.FLX
Audio	SOUND.FLX, MUSIC.FLX, E*.FLX / G*.FLX	ADLIBMUS.DAT, MT32MUS.DAT, ENDSCORE.XMI, INTROSND.DAT, U7SPEECH.SPC
Maps	FIXED.DAT, GLOB.FLX, NONFIXED.DAT, U8SAVE.000	U7MAP, U7CHUNKS, U7IFIX*, SHAPES.VGA, gamedat/u7ireg*
Type and object data	TYPEFLAG.DAT, GUMPAGE.DAT	TFA.DAT, SHPDIMS.DAT, WGTVOL.DAT, npc.dat, schedule.dat, flaginit
Text	ECREDITS.DAT, QUOTES.DAT	Selected Exult save/runtime metadata

---

Game Files

TITAN requires the original game files. You must own a legitimate copy of the games. titan setup checks common GOG, EA/Origin, manual, Pentagram, ScummVM, and Exult paths.

Common Windows paths include:

• Ultima 8 GOG Galaxy: C:\Program Files (x86)\GOG Galaxy\Games\Ultima 8
• Ultima 8 GOG offline: C:\GOG Games\Ultima 8
• Ultima 7 Black Gate: C:\GOG Games\Ultima VII\ULTIMA7
• Ultima 7 Serpent Isle: C:\GOG Games\Ultima VII\SERPENT

---

Documentation

• CLI reference
• Dialogue web README
• Annotated config template
• Font credits
• Third-party notices

---

Credits

TITAN uses the following excellent open-source tools:

• LeRF by Jiacheng Li, Chang Chen, et al. Adaptive downscaling and geometric transforms are powered by LeRF's official LUTs and NumPy implementation.

The font-create wizard ships six TrueType fonts for Ultima script systems. See FONTS_CREDITS.md for full attribution and licensing details.

---

License

MIT

TITAN also distributes a modified fold component derived from the Pentagram project as part of dialogue tooling. That component is licensed under GNU GPL v2 or later and is not covered by TITAN's MIT license.

See THIRD_PARTY_NOTICES.md and src/titan/third_party/fold/ for attribution, license scope, source mapping, build entry points, and bundled GPL license text.

Ultima (Copyright 1981-1999, Electronic Arts)

This fan-made tool requires a legitimate copy of the original games: Ultima 8 and Ultima 7. This project is not affiliated with Electronic Arts. All rights to Ultima remain with Electronic Arts.