Modding Birthright: Gorgon's Alliance Adventures

[Kami]

For anyone interested, I have a command-line utility to list and extract files from RES files: https://github.com/Shiryou/brut/releases/tag/nightly

Sadly, RESUTIL converts PCX files to a non-standard bitmap format before submitting them to the RES file and doesn't re-convert them during export. Adding files to RES files is next, so I have to tackle the conversion anyway and will try to write a reversal function.

For now, only FLC and WAV files export as one would expect.

Here's how to use the program:

Usage: resutil resfile-name [[s nnnnn] [c] [n] [r] [u] [+|-|e sourcefile-name ]] | [l] | [v]
   +  add file
   e  extract file (does not remove it)
   x  extract all files (does not remove them)
   hc use CRC hash (default)
   hi use ID hash
   l  list contents of resource file
   n  do not rotate PCX resources (default)
   u  do not compress resources
   v  verify resource file

EDIT:
9/7: It can now add files, but it doesn't support compression, rotation, or PCX decompression (as mentioned above) yet.
9/9: PCX decompression is now supported. There are also builds for Windows, Mac, and Ubuntu.
9/10: PCX rotation is now supported. We're almost there! Just LZSS compression is left before we have a RESUTIL replacement. Then, I'll try undoing rotation and PCX decompression and move on to creating a GUI.
9/15: I've been able to confirm that editing a resource file works. Check out a video of replaced images in the intro sequence.

[Kami]

I've written up a lot of my findings from this past weekend on my website and am copying it here for posterity.

I've figured out how to create and import custom adventures into The Gorgon's Alliance.

Birthright allows a total of 50 adventures to be loaded. The default adventure list, containing 26 adventures, is hard-coded. These hard-coded adventures are the only ones that can be tied to a location in the game. There is then room to add 24 custom adventures. These adventures appear by default on the Adventure action screen when you start a “Full Game,” regardless of difficulty.

For a custom adventure to work, you only need four files:

• SCENES\ADVENTR.SCN: The scene file, which defines the quest objective, the WAD file to load, and some other options
• WADS\ADVENTR.WAD: The adventure, including the map, items, enemies, etc.
• TEXT\ADVENTR.TXT: The description for the adventure screen
• UI\ADVSCN\ADVENTR.PCX: The title image for the adventure screen (alternatively, you can add the file to TEXTURES.RES)

All files should be no longer than eight characters, plus the extension. This is an old DOS limitation that lives on in WINBR.

Custom adventures will appear on the Adventures screen in a Full Game (regardless of difficulty). Your adventure will get its name from the WAD filename and will not have a suggested level.

birthrt-custom-adventure.png

Scenes

“Scene” files (.SCN) are Birthright’s entry into custom adventures, including the WAD filename, quest goal “thing,” background music, and sky box. User adventures are .SCN files containing the lines:

[Type]
1

The scene file is the only part of a custom adventure that doesn’t need to have the same name as the rest of the files. The only use I can see for this is to re-use an adventure with a different quest item or sky box.

WADs

WAD (technically PWAD in this case) is a data file format originally defined for use in the Doom game engine. Birthright uses an engine called Nova that uses the same file format for storing levels. In Doom, resources like textures are loaded from internal WADs, whereas Nova loads them from TEXTURES.RES. This means that many Doom level editors can’t display Birthright’s textures properly.

slade-textures.png

If there is enough interest in creating custom adventures, we can submit patches to the popular Doom level editors to add support for Birthright’s textures.

The (in DOOM WAD terms) “Things”—enemies, decorative items, treasure, etc.—are referenced only by numbers. These numbers come from hard-coded definitions, so adding new enemies, spells, or items is impossible. The list of available Things is in THINGTYP.H.

slade-things.png

Descriptions

The .TXT files contain text for the adventure description in the Adventure and Advisors screens, including some customization for font styles, as below. Italics are an option in the code, but they don’t seem to do anything. Word wrap gave me the most trouble and seemed a bit wonky.

^F02^W304^F02Font testing F00. ^F04Font testing F04. ^F05Font testing F05. ^F09Font testing F09. ^F16Font testing F16.
^F02^W400^F02^T0T Tran^T1sluc^T2ent ^T3text^T4 T. ^T0^UUnderlined text U.^U ^BBold text B. ^B^IItalicized text I.^I
^C001Color testing C001. ^C031Color testing C031. ^C064Color testing C064. ^C120Color testing C120. ^C136Color testing C136. ^C188Color testing C188.
^F02^C001Testing word wrap at a specific width in pixels. The quick brown fox jumps over the lazy dog. Testing text length W304.
^W325Testing word wrap at a specific width in pixels. Testing text W325.
^W250Testing word wrap at a specific width in pixels W250.

birthrt-custom-text.png

Title Image

The title image is a 432 x 233 pixel PCX image either stored in TEXTURES.RES or UI\ADVSCN with a filename corresponding to the adventure name. If you intend to share your adventure with others, you should put your title image into UI\ADVSCN, so it is easy to put the entire adventure into a file archive and extract it to the right location without affecting anything else.

userpic.png

Battle Maps

While unrelated to adventures, Birthright’s maps for battles are also WAD files. You can load them into an adventure and take a stroll around. They might be useful for getting comfortable modding, as they already define some terrain you can build on top of.

Battle map .SCN filenames are hard-coded, and there are 4 maps per terrain type. For example, BATLM0.SCN is the first mountain battle map.

The four categories are:

• W = Woods
• P = Plains
• M = Mountains
• S = Swamp