War Edit

The War Edit application is what you use to create and edit Game and Race definition files.

ID Naming

Almost everything you input using War Edit needs to have a unique ID. this id should only contain lowercase letters, numbers, and underscores (_).

The tense and plural-ness of the ID should be the same of the name you put in. For example, if the rule is called Going To Ground, the ID should be going_to_ground and NOT go_to_ground or going_to_grounds. The ID should be unique for everything, not just the type you are working on. For example, there should never be a Rule and a Wargear with the same ID (even if the rule is defined in the game file, and the Wargear in the Race file). This may seem dumb, but it saves you time when creating in-text references (see below).

There is one caveat while editing Race files: changing the IDs of entries or removing them altogether while other entries are referencing them will have very bad effects. The rule of thumb is this: input the Rule, then the Wargear, and finally the Unit that references both rules and wargear. I am currently looking into fixing this, but for now remember: Rule, Unit, Wargear. Also, in-text references (see below) are not affected by this -- only the references for things like a Unit's rules or a Wargear Profile's types. If a in-text reference does not exist, or has changed, the text will not be affected (other than showing a broken link when previewing the text).

Description Format

Some entries will have a full description provided with them. This is supposed to be a complete description of the Rule, Unit, or Wargear. Inside this text, you can have special formatting. Multiple line breaks are treated as a new paragraph and multiple spaces are considered a single space. This formatting is only recgonized on fields that are allowed to contain multiple lines: these are indicated as the Full or Description fields.

To counteract this, there are formatting tags that you can use to add special formatting to the text. A tag is simply a character or sequence of characters enclosed in brackets. Some tags require a closing tag, which tells the formatter when to stop apply the formatting that the tag applies. Below is a table of tags that are available:

• *...* - make the text bold.
• *Hello*, welcome to GitHub! = Hello, welcome to GitHub!
• __...__ - make the text italic.
• My name is __Adam__ = My name is Adam

In-text References

More than likely an entry's description will contain a line like the following: "this rule confers rule X". In this case, you want to make a link to rule X so that the user may click on it and be directed to the description of rule X. This is accomplished using in-text references. These are special tags with the following rules:

• rule_id - make a reference to the rule with the ID of rule_id. This applies for any entry type. So, rule_id may be referencing a Wargear or a Unit. This is why IDs must be unique across the whole Game and Race. The reference will be replaced with a link that has the text of whatever it is referencing.
• Model is immune to the instant_death rule = Model is immune to the Instant Death rule.
• rule_id - exactly the same as above, but tells the formatter to make the text that is displayed as the link to be plural.
• vechicle count as moving if ... = Vechicles count as moving if ...
• rule_id - exactly as the first, but instead of the name of the entry appearing as the link text, The text after the | is displayed.
• This unit cannot going_to_ground = This unit cannot Go To Ground

It is perfectly fine to make in-text references to things that do not exist.

Example

This is the first line of the rule
Now, this is a new line

and a new paragraph that has the unit [[some_unit | My Unit]].
[[some_rule]] becomes [[some_rule | plural]] as plural.

**Moving**
This model may move D6" and have the [[move_through_cover]] special rule. **__Note__**: This is important.

Becomes

This is the first line of the rule
Now, this is a new line

and a new paragraph that has the unit My Unit
Some Rule becomes Some Rules as plural.

Moving
This model may move D6" and have the Move Through Cover special rule. Note: This is important.