Wartbed:Files/Formats/Modules and Campaigns
From Dark Omen Wiki
| Line 9: | Line 9: | ||
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 .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. | ||
<div style="margin-left:2em;border:1px solid gray; background:rgb(215,225,215);"> | <div style="margin-left:2em;border:1px solid gray; background:rgb(215,225,215);"> | ||
| - | <div style="float:right;text-align:right;padding:0.5em;background:grey;color:rgb(225,225,225);width:25%;">game name'''.module'''<br>( | + | <div style="float:right;text-align:right;padding:0.5em;background:grey;color:rgb(225,225,225);width:25%;">game name'''.module'''<br>(WARTBED Script)</div> |
<div style="padding:1em; color:rgb(0,32,0);"><tt>name = Really Cool Tactical Fantasy Epic<br>folder = RCTFE/<br>version = 1.0.0<br>requires = another module<br>requires = yet another module<br>interface = filename.xml //optional<br>homepage = www.mywartbedmodules.com //optional<br> | <div style="padding:1em; color:rgb(0,32,0);"><tt>name = Really Cool Tactical Fantasy Epic<br>folder = RCTFE/<br>version = 1.0.0<br>requires = another module<br>requires = yet another module<br>interface = filename.xml //optional<br>homepage = www.mywartbedmodules.com //optional<br> | ||
<span style="outline:1px solid black">''Rules section goes here...''</span> | <span style="outline:1px solid black">''Rules section goes here...''</span> | ||
| Line 20: | Line 20: | ||
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''). | 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''). | ||
<div style="margin-left:2em;border:1px solid gray; background:rgb(215,225,215);"> | <div style="margin-left:2em;border:1px solid gray; background:rgb(215,225,215);"> | ||
| - | <div style="float:right;text-align:right;padding:0.5em;background:grey;color:rgb(225,225,225);width:25%;">campaign name'''.campaign'''<br>( | + | <div style="float:right;text-align:right;padding:0.5em;background:grey;color:rgb(225,225,225);width:25%;">campaign name'''.campaign'''<br>(WARTBED Script)</div> |
<div style="padding:1em; color:rgb(0,32,0);"><tt>name = Good guys rules!<br>version = 1.0.0<br>folder = good guys/<br>requires campaign = another campaign<br>requires module = still another module<br>interface = filename.xml //optional<br>homepage = www.mywartbedmodules.com //optional<br> | <div style="padding:1em; color:rgb(0,32,0);"><tt>name = Good guys rules!<br>version = 1.0.0<br>folder = good guys/<br>requires campaign = another campaign<br>requires module = still another module<br>interface = filename.xml //optional<br>homepage = www.mywartbedmodules.com //optional<br> | ||
<span style="outline:1px solid black">''More stuff will go here...''</span> | <span style="outline:1px solid black">''More stuff will go here...''</span> | ||
Revision as of 19:12, 14 November 2009
| This article is a stub. You can help quell The Dread King by expanding it. |
Describes WARTBED modules and campaigns. Files are in WARTBED Script format.
Contents |
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
- Should be moved to the Files/Formats article
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.
(WARTBED Script)
folder = RCTFE/
version = 1.0.0
requires = another module
requires = yet another module
interface = filename.xml //optional
homepage = www.mywartbedmodules.com //optional
Rules section goes here...
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).
(WARTBED Script)
version = 1.0.0
folder = good guys/
requires campaign = another campaign
requires module = still another module
interface = filename.xml //optional
homepage = www.mywartbedmodules.com //optional
More stuff will go here...
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.
