Total AnnihilationとTA: Kingdomsのファイル形式リファレンス

Cavedog EntertainmentがTotal Annihilation（1997年）とTotal Annihilation: Kingdoms（1999年）に同梱した独自のファイル形式について、実際にリバースエンジニアリングを行ってきた立場から書いた手引きです。どのページでも、ディスク上のバイト配置と一緒に、kbotの1行コマンドを載せているので、説明を読みながら本物のファイルを実際にいじってみることができます。

go install github.com/coreprime/kbot/cmd/kbot@latest
kbot ctx add ~/games/totala --alias ta --game totala

形式の一覧#

コンテナとラッパーの形式#

グラフィックとメディア#

マップと地形#

ユニット、スクリプト、設定#

TA: KingdomsのGUI#

チュートリアルとリファレンス#

凡例：✅ kbotが本格的に対応 · 🟡 ドキュメントはあるが、現在のkbotでは解析しない

形式どうしの関係#

                                ┌───────────────────────────────┐
                                │   HPI / UFO / CCX / GP3       │
                                │   (encrypted, compressed VFS) │
                                └──────────────┬────────────────┘
                                               │ contains
            ┌──────────────────────┬───────────┼───────────────┬──────────────────┐
            ▼                      ▼           ▼               ▼                  ▼
        ┌───────┐             ┌───────┐   ┌───────┐       ┌────────┐        ┌─────────┐
        │  FBI  │ unit stats  │  COB  │   │  3DO  │ mesh  │  GAF   │ sprites│   TNT   │ map
        └───┬───┘             └───┬───┘   └───┬───┘       └────┬───┘        └────┬────┘
            │ references          │ runs on   │ textured by    │ used by         │ built from
            ▼                     ▼           ▼                ▼                 ▼
        ┌───────┐             ┌───────┐   ┌───────┐       ┌────────┐        ┌─────────┐
        │  TDF  │ weapons     │ piece │   │  PCX  │ skins │  PAL   │ colour │   SCT   │ tiles
        │ /OTA  │ /features   │ tree  │   │  unitpic│      │ /ALP/LHT/SHD   │ + heights
        └───────┘             └───────┘   └───────┘       └────────┘        └─────────┘

リバースエンジニアリングの作業は、ほとんどの場合HPIをマウントするところから始まります。展開済みのインストールでさえ、HPIを取り出したものにすぎません。そこから、ユニット（FBI）がメッシュ（3DO）、スクリプト（COB）、ユニットの肖像画（PCX）、アニメーションのガジェット（GAF）を指しています。マップ（TNT）は、セクション（SCT）と地形物の配置から組み立てられ、地形物の配置はTDFの地形物定義に解決されます。

kbot mount ~/games/totala --server   # opens at http://localhost:8090

エンディアン、文字セット、座標の規則#

ページで明示的に別の扱いをしていない限り、このドキュメントのすべての形式に次の規則が当てはまります。

このドキュメントの使い方#

形式ごとのページは、どれも同じ構成になっています。

1. それが何か：用途と、TAのインストールのどこに出てくるか。
2. ディスク上の配置：ヘッダーの構造体、続いてペイロードの各部分を、バイトオフセットを示しながら説明します。
3. 読み込みの順序：ファイルを正しく解析するためのシークと読み込みの手順。
4. 実例：Cavedogの本物のファイルを1バイトずつ分解します。
5. 自分で確かめる：自分のインストールに対して実行し、データをその場で見られるkbotのコマンド。
6. 注意点：ドキュメントにない境界条件、バージョンによる違い、Cavedogのツールが残した作業用のバイトなど。

次のような囲みがあれば、

kbot pal swatch palettes/palette.pal --target out.png --cell 24

…そのコマンドは、コンテキストを設定しておけば書かれたとおりに実行できるという意味です。

クレジットと資料#

このドキュメントは、コミュニティが数十年にわたって積み重ねてきたリバースエンジニアリングの成果をまとめたものです。個々の発見は各ページの本文中で出典を示していますが、土台になっているのは次の人々の仕事です。

• Joe D.：HPI形式の最初の解析（1997年）。
• Saruman & Bobban / dFR Engineering：最初のTNTの解説（1997年）。
• Scott "me22" McMurray：TNT形式の補足（2003年）。KinboatのAnnihilatorのソースを参考にしたもの。
• Kinboat：SCT形式、GAFのツール、Annihilatorマップエディター。
• Dan Melchione & Dark Rain：3DO形式（1998年、2002年改訂）。
• C_A_P、Switeck、KhalvKalash：COB/BOSのオペコードのリバースエンジニアリングと、Scriptor系のツール。
• Dark Rain：TA:KのGUI形式と、TA:Kの形式の難点についてのメモ。
• Cavedog Entertainment：25年以上たった今も生かし続ける価値のあるゲームを作ってくれたことに。

このドキュメントがそれらの原典と食い違う場合は、kbotのソースコードが正しい情報源です。ここにある形式は、Cavedogの本物のファイル数千個を相手にラウンドトリップのテストを済ませています。食い違いを見つけたら、https://github.com/coreprime/kbotでissueかPRを作成してください。