Wartbed:Files/Formats/Modules and Campaigns

From Dark Omen Wiki

Describes WARTBED modules and campaigns. Files are in WARTBED Script format.

Contents 1 The .module and .campaign File Formats 1.1 The .module file 1.2 The .campaign file 1.3 Dependencies

The .module and .campaign File Formats

All .module and .campaign files must specify a qualitiative name and a version, both of which are strings, and must further specify the folder that represent their local roots (the module path is always relative to the wartbed root/modules directory, and the campaign is always relative to the module root directory). Further, these files may specify an interface file detailing the graphical interface used (if none is given, the interface defaults to the module's or WARTBED's default one) and a homepage string that can be displayed if version dependencies fails.

The .module file

The .module file defines a module that can be executed in WARTBED (and provided as a parameter to the executable). Module files may only be placed in the modules directory under the wartbed root directory. It describes the name, location and any toggles to global WARTBED rules. Modules may require (depend upon) other modules for data etc.

The .campaign file

Should be moved to the Files/Formats article

Campaigns are settings (sequences of battles) in a module. Campaigns may depend on other campaigns and modules. (It has not been decided whether campaigns may depend on campaigns in other modules).

Dependencies

The dependency can be specified either by filename of the module file, including the trailing .module extension, or the qualitative name of the module.

A possible alternative for the requires format could be a block like

requires
{
    module = a module.module
    campaign = evil guys.campaign
}

If slashes are forbidden in module names, a module and campaign dependency could be written as

requires horror monsters/vampire fest
requires horror.module/vampires.campaign

This last syntax is more difficult to combine with version control, though, and would require something like this syntax:

requires horror.module version:1.5 / vampires.campaign

Alternatively to the requires module and requires campaign tags above, the dependency could be resolved by filename extension.