Wartbed:Files/Structure

From Dark Omen Wiki

(Difference between revisions)
Jump to: navigation, search
(Modules and campaigns)
Line 13: Line 13:
<tt>
<tt>
'''WARTBED main folder'''
'''WARTBED main folder'''
-
:'''Bin''' <span style="color:green">- Executables and libraries</span>
+
:'''bin''' <span style="color:green">- Executables and libraries</span>
-
:'''Resources''' <span style="color:green">- All common resources</span>
+
:('''bin_d''' <span style="color:green">- Executables and libraries for debug build</span>)
-
:'''Modules''' <span style="color:green">- All game module description files and data folders</span>
+
:'''cfg''' <span style="color:green">- Currently only contains ''application.config''</span>
 +
:'''resources''' <span style="color:green">- All common resources and assets</span>
 +
:'''modules''' <span style="color:green">- All game module description files and data folders</span>
::''Example file.module'' <span style="color:green">- see module format below</span>
::''Example file.module'' <span style="color:green">- see module format below</span>
::'''Example module folder'''         
::'''Example module folder'''         

Revision as of 19:56, 12 April 2009

Contents

Note: This article is ahead of itself. It does not represent how WARTBED currently looks or a decision as to how it will look. It is written as a guideline and as a place to jot down ideas.

Also see WARTBED file formats article.


WARTBED main folder

bin - Executables and libraries
(bin_d - Executables and libraries for debug build)
cfg - Currently only contains application.config
resources - All common resources and assets
modules - All game module description files and data folders
Example file.module - see module format below
Example module folder
Good faction.campaign - see campaign format below
Evil faction.campaign

Modules and campaigns

Modules are large-scale settings. Though intended to represent game remakes (f.i. Bright Portents and the Saga modules are modules implementing Dark Omen and the Myth games in WARTBED) they can of course be totally new games. Modules in turn contains campaigns which are sequences of connected battles within the setting of a module. Modules and campaigns also allow basic customisation of the WARTBED framework, for instance of user interface appearance etc.

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). It describes the name, location and any toggles to global WARTBED rules. Modules may require (depend upon) other modules for data etc.

game name.module
(text file)
name = Really Cool Tactical Fantasy Epic
folder = RCTFE/
requires = another module
requires = yet another module
interface=filename.xml

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).

campaign name.campaign
(text file)
name = Good guys rules!
requires campaign = another campaign
requires module = still another module
interface=filename.xml

More stuff will go here...


Dependencies

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

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

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

Personal tools
communication