Gameconfig 1.0.x

This is a guide for editing the gameconfig.php in Raidplaner 1.0.x

Configuring the raidplaner for other games

The raidplaner comes with common settings for World of Warcraft. To use the raidplaner for other games you might want to change the available roles and classes.
To do this you will have to edit the "lib/private/gameconfig.php". The file contains several comments explaining which settings will have what effect. You will need basic knowledge of PHP when editing this file.

When configuring the raidplaner for a new game you should always work with an empty database, i.e. there should be no characters defined for any user. If this is not the case, you should backup your database and clear the tables "<prefix>Character and "<prefix>Attendance".
If you do not work with an empty database, you will end up with incorrect profile pages and other weird stuff.

Defining new roles

Roles are defined in the $s_Roles array. There can be up to 5 roles and there has to be at least 1 role. The roles have to be defined as a key/value pair like this:

$s_Roles = Array(
    "identifier" => "roleLoca"
);

The key ("identifier") will be used in the database as well as for identifying the correct image for the role (see above). The localization name has to be added to all localization files (or at least the one you are using). Localization files can be found in "lib/private/locale".

if ( defined("LOCALE_MAIN") )
{
    $g_Locale[ "roleLoca" ] = "Meine neue Rolle";
    // ...

After defining your new roles you have to set up the raid slot images. These images are shown in the raid detail view and should make it easy to see which slot is available for which role. The slotimages are assigned to the corresponding role at the same index as used in $s_Roles. So the first entry in $s_RoleImages will be the slot image for the first role defined in $s_Roles.

Finally you might want to define role sets to by used by class definitions. For example: A deathknight can be played as a damage dealer as wall as a tank. So you might want to define a role set for this combination.

class Roles
{
    public static $all = Array("dmg","heal","tank","identifier");
    // ...

Defining new classes

Defining new classes is very similar to defining new roles. You have to edit or extend the $s_Classes array, which is again associative. As with the roles array, the key will be the class identifier used in the database and when finding the corresponding class image.
The value of each class entry has to be set to an array containing the localization key and a role set (array of role identifiers). If you defined role sets you can just use the fitting role set here.
Note the the class "empty" is mandatory.

$s_Classes = Array(
    "empty" => Array( "", Roles::$damage ),
    "newClass" => Array( "classLoca", Roles::$all ),
    // ...

Defining new group sizes

The raidplaner supports custom group sizes. If your game does not support the common World of Warcraft group sizes (5,10,25) or you want to disallow/add a size you need to change this array.
The $s_GroupSizes array needs to define the size of the group as key and the default slot size for each role as value. So if you have 5 roles and want to define a new group with 20 players, it will look like this:

$s_GroupSizes = Array(
    20  => Array(4,4,4,4,4),
    // ...