Gameconfig 1.1.x

This is a guide for editing game files in Raidplaner 1.1.x

How to create a custom gameconfig for 1.1

White version 1.1.0 the gameconfig format changes and the file itself moved to a new location. While a conversion happens during an udpdate from 1.0.x, you can use this guide to manually convert your gameconfig, too.

The 1.1.x gameconfigs are located in "themes/games". You can add new files here, but you should not (!) edit any existing files unless you're starting fresh. If you have a really good reason to edit an existing file, see the "change safety" notes for each section.

Header

Defines general information about the game.

Change safety
Everything besides id is safe to change.

id An 1-4 characters long identifier for your game. It MUST be unique.
name A human readable name for this game.
family The theme family for this game. Only themes with this family are allowed when using this game.
classmode Either "single" or "multi". Single allows one class and two roles per character. Multi allows multiple classes with one role for each character.

Roles

Defines the available roles.

Change safety
Adding roles is safe, removing is not. Every attribute besides id is safe to change.

Example

<roles>
    <role id="tnk" loca="Tank" style="role_tank"/>
    ...
</roles>

id An exactly 3 characters long identifier for your role. It MUST be unique.
loca The localization string for the name of your role.
style One of the 5 predefined role styles.

Role styles
role_tank An icon with a shield (yellow)
role_heal An icon with a cross (light blue)
role_melee An icon with two crossed swords (red)
role_Range An icon with a bow and arrow (green)
role_Support An icon with a shielded figure (violet)

Classes

Defines the available classes.

Change safety
Adding classes is safe, removing is not. Every attribute besides id is safe to change.
Adding roles is safe, removing is not. Changing the default role is safe.

Example

<classes>
    <class id="dru" loca="Druid" style="druid">
        <role id="dmg"/>
        <role id="hlr" default="true"/>
        <role id="tnk"/>
    </class>
    ...
</classes>

id An exactly 3 characters long identifier for your class. It MUST be unique.
loca The localization string for the name of your class.
style The name of your class image (without extension) in "themes/icons/"
role: id An exactly 3 characters long identifier for a role. Must be defined in the roles section
role: default Set to "true" for the default role.

Raidview

Defines the look of the raid view.

Change safety
Safe to change

Example

<raidview>
    <slots role="tnk" order="1" columns="1"/>
    <slots role="hlr" order="2" columns="1"/>
    <slots role="dmg" order="3" columns="*"/>
</raidview>

role An exactly 3 characters long identifier for a role. Must be defined in the roles section.
order A number defining the slot order. Higher numbers are more to the right than lower numbers.
columns Number of columns available for this role. All columns must add up to 6. You can use * to use all remaining columns

Groups

Defines the available group sizes.

Change safety
Safe to change

Example

<groups>
    <group count="5">
        <role id="tnk" count="1"/>
        <role id="hlr" count="1"/>
        <role id="dmg" count="*"/>
    </group>
    ...
</groups>

count The size of this group.
role: id An exactly 3 characters long identifier for a role. Must be defined in the roles section.
role: count Number of slots for this role. All role counts must add up to match the group count. You can use * to use all remaining slots.