Manual

Click on the tab below for the version you wish to read the manual for

RaidTracker Manual

Introduction

RaidTracker (RT) was designed to be a simple web application, usable by all. This is the manual for RaidTracker, updated as of 2.00.

Please note that while this manual may be useful for anyone, certain privileges may not be available unless you are considered a super-administrator (aka superadmin). Superadmins are defined as holding the top RT rank. If this is the case, and you are not a superadmin, you need to contact your superadmin for assistance, not me.

Key areas of RaidTracker

Accounts/logged in

RaidTracker customizes to your personal settings, that is, holding an account and logging in. Certain features do not require logging in, but in general, administrators or superadmins will set properties limited to levels (these are called Permissions). Some features such as the status icons in calendar view, are automatic when logged in only. This manual assumes you are logged in, unless stated otherwise.

Views

Before you begin to use RaidTracker, you need to get used to the pages, called 'views'. Most views are linked to each other. Some views act like a dialog box in a regular application. Since these are pages in their own right, they are also considered 'views'. Here is a list of most of the views you'll encounter in RT:

Main-The first page you'll see when you go to your RT address page. Main page can either be your Calendar view, or your History view, depending on your logged-in status, and your settings. Main view will always be used unless there is a feature specific to Calendar or History view.
Calendar-The default view for non-logged in users and new accounts. Calendar view shows raids in a series of weeks, with details when you hover over a raid. Calendar view can be customized in many ways.
History-An alternative to Calendar view, in that it lists a certain number of raids, starting from the newest (possibly future raids) to the oldest. This view can show the signup numbers without clicking on each raid. History was removed temporarily for the 2.00 release.
List-Second most used view. It shows the details for a particular raid, as well as lists of various signup options, from those on the Raid List to Subscribed and Withdrawn members. Officers use this screen a lot to make and determine raid signups.
Guild-This view shows your guild members. Highly customizable, you may see names, ranks, and even signup counts over a certain period.
Settings-This view can apply to yourself or to other players. In both views, you may see all the characters controlled by a player. If these are characters you control, or are an officer, you can add, delete, modify them, as well as make general personal preferences to your account.
Admin-Generally left to officers or administrators, can customize features specific to RT itself, or view actions done in RT.

Getting started

Installation and first time

RaidTracker makes it easy to use out of the box, as long as you meet the system requirements. The system requirements are a web host/server with PHP 5.02+ and MySQL 5.0+. For the most part, you want to download the application zip file, any themes and packs, and extract all together in the same location. Suggestion to create a /raidtracker folder to install RT is a good idea (though the directory name can be different.) Once uploaded, simply point your web browser where you installed RaidTracker, and follow the steps given with the installation. Now you are ready to open RaidTracker to your guild.

Upgrading to a newer version of RaidTracker

In most cases, you'll want to download the patch, and install it in the same place where RaidTracker is. Some files may be overridden, that's ok. Most of the time, you will need to point your web browser to your RT location, as you may have to undergo some install upgrades. Remember to log in as superadmin when requested, or the install will not work. Then, enjoy RT when it's done installing.

Upgrading from 1.91.x

If you are upgrading from 1.91 or 1.91.1 to 2.00, you can, though you will need to take a few extra steps prior to upgrading:

Back up your RT /user directory.
Erase all files and directories in your RT install directory (but do not get rid of your RT home directory).
Install RT2 to the place where you originally installed RT.
Restore your /user folder
Run the install process (go to your RT location in your web browser.)

This will ensure that old files won't corrupt your new RT.

Upgrading from 1.90.x and older versions

If you are upgrading from 1.90 and 1.90.1, follow the process as 1.91.x upgrading above. Anything older than 1.90 (e.g. 1.80) will not work. You will need to install a new version, and start from scratch.

Creating an account

If you are a superadmin, you will create your account during installation. For all other users, just click on the "Login/Create account" link. At this point, you will need to enter your e-mail address and click on 'Create'. For security's sake, your e-mail will not be shown. You will then proceed to the Create view, where you'll need to confirm your e-mail (to avoid typos), and create your character. This character should be your main character, as it may be hard to change mains later, depending on settings. The role is your primary function in a raid group, though you may change this at any time. Once done here, you will get a confirmation message as well as being asked to log in again to use RT (following below.)

Logging in and out

Logging in is easy, and should be used whenever possible. Just click on the 'Login/Create Account' link, enter your e-mail address used, and click Login. You should then see your main character name in the menu.

While you shouldn't need to log out, you can if you're at a public access terminal or for other reasons. Just click on the 'Logout' link next to your name, and your session will be done.

Raids

Creating raids

Creating a raid is easy, if you have the permissions. From the main view, you can click on the "Add a raid" button at the bottom. If you are using calendar view, you can create a raid for a particular day by clicking on the '+' button next to the date. Either way, this brings you to the Raid view. On this page you have the following:
* Raid location. This is the instance location. If you are not sure, or not attending a standard raid (i.e. PVP raids, or worldboss raids), you can select 'Other', which displays the '?' icon.
* Raid. The title. Required, and is displayed in all views.
* Date. Already pre-filled if you clicked the '+' button. This is the day this raid starts.
* Start/End time. This is the time the raid is expected to start and end, according to realm time. RT is smart enough to know if a raid ends after 23:59 to adjust it to the correct day. So, if your raid ends at 12:30am, then just enter '00:30'.
* Close deletions. This is the time when a player cannot click the "withdraw" button.
* Close additions. This is the time when a player cannot subscribe to the raid any longer.
* Invite time. This is the time when the guild will start inviting players to the raid.
* Raiders. Shows a number of raiders in History and List views.
* Tank/Healer/Melee DPS/Range DPS. The role breakdown in the raid. These numbers are required, though you can hide the numbers for a role by entering in 0. These numbers show up only when there are charactes in the raid list or the whiteboard.
* Notes / Officer notes. Extra notes or communication among guild members and/or officers if desired.

Alter or Delete a raid

To alter or delete a raid, you need to click on the raid icon to go to its List view. Then, you can click on "Modify raid info". You will see a screen similar to create raid. You can modify it, and click submit, or you can delete the entire raid just by clicking delete. Changes take effect immediately.

Signing up for raids

If you are signing up for a raid for yourself, this is easy. In the List view, just click on the correct button (Raid list, Subscribe, or Reserve.) If you wish to leave a comment, just enter your comment in the comment box before clicking on the button. This assumes that the raid is not closed for signups.

A faster alternative is to hover over the raid icon in Calendar view and click on the 'Sign up' button that appears. This is the same thing as signing up as Available (Subscribe) without any comment.

If another person needs to sign up, and you have the right permissions, you can add him/her to the raid. Below the table is a setting to "Add a new player". You can select the player in the drop-down box. Then, in the "Move to" box, choose his signup method. (More on sign up methods later). Before you select "Submit", make sure no other players are checked in the lists table, or else you will move them as well. You can also add a comment by checking the comment box, and writing the comment next to the checkbox. Then, click "submit".

Changing or cancelling a signup

This assumes that the raid is not closed to withdrawls, or that you can override it. If you are changing yourself, you can change your status on the list view by clicking a button. You may see different buttons than you saw when you subscribed. You can just choose to change/leave a comment by entering your comment, and click on the Comment Only button. You can't delete your own signup, but you can withdraw from a raid. This lets the officers know that something happened and will not schedule you in the raid. Or you can change between Available and Reserve (more on this with sign up statuses). Again, for any change, you can choose to leave a comment in the comment box just before clicking the button.

If you are changing status for another player or players, you may do so by checking the checkboxes next to the player. Then, below the table, choose a status next to the "Move to" setting. This will be applied to all selected players (as well as a new player, if you selected one in the "Add new player" box.) You can also make a comment by checking the comment box, and entering in the comment if necessary. Then, you can click Submit, to make the changes necessary.

Statuses and Raid planning

This may be easiest if you are an officer with the rights. Before you plan for a raid, it is important to understand what each status means in RT.
* Raid List: Players on the Raid List are guaranteed to raid, and expected to show up.
* Available: Default signup. This usually means a player is available to raid, no strings attached on times, etc.
* Reserve: This usually means a player has some conditions (i.e. may be late, can't stay late, etc.) Request to swap alts is not covered by this status.
* Withdraw: A player initially signed up, but then had something come up causing him/her to renege his subscription.
* Remove: An officer removed a player's subscription from this raid. Usually this is due to discipline, but can include other factors. The comment will be shown to the player, and that player cannot subscribe or alter anything without officer intervention.
* Whiteboard: A 'secret' list where officers are free to plan for a raid before publicizing the raid list. Players without the rights to see the whiteboard are viewed as available, except if a player was initially shown as reserve.
* Delete: Not really a status, it literally deletes the record of a signup. This is recommended to administrators only and only for bugged signups. If you wish to deny a signup, remove is recommended, as deleting a record will not stop a player from resigning up. Besides, remove will keep a record under the remove column, while delete will not track anything.

To prepare for raids, one selects the players desired from the table and/or a new player from the Add a player setting. Then, next to "Move to", the correct status is chosen. When planning raids, Raid List will move players directly to the raid list, or Whiteboard will move players to a whiteboard list while officers can discuss changes if needed before publishing the raid list. Comments may be entered, though each player will get the same comment. Then click Submit to finalize your choice.

When using the whiteboard, you and the other officers may use the officer's notes feature to make comments without revealing it to the rest of the guild. (This goes for any player, not just those on the whiteboard.) When you use the whiteboard, you get two extra buttons that affects all on the whiteboard list. The publish button moves all on the whiteboard to the Raid List (not affecting those already on the Raid List.) The Clear button will move all of the players back to Available (or Reserve, if they were shown as reserve prior to being on the whiteboard.) Individual players may be moved off the raid list using the conventional method above.

Alternate characters and roles

When a player signs up (or is added to a raid), RT uses the main character and his/her role as defined by the settings at that time. There may be a time when an alt may be better suited, or a respec is necessary to run a raid. This is accomplished in RaidTracker. Alts may be used as long as they are listed on the player's settings, and only one character may be specified at any one time per player ('account'). A permission, which when set, allows players to switch characters while signup is available: In List view, choose the character in the drop box right of the subscription buttons, and choose your subscription method (or hit 'Comment Only' if you are already subscribed and just want to change alts. This works if a player has more than one character on the account, and the permission 'sign_alt' is enabled to the player's level. Using this method also uses the raid role set in your settings, and cannot be changed once character swap is complete except to officers.

If the permission "sign_alt" is not set, only an officer can change alts. To change an alt, the officer must select the player (or players) to change, then click on the "Change raid role or use an alt" option. This may be combined with other features, such as moving. After hitting "Submit", the next page shows the characters to change at the top. For each player, you may choose to change to his/her alt, change his/her raid role, or both. Leaving the character at "(no change)" and role to "(default)" will do nothing for the player in question. Only changing the character will assume that character's role as defined in the settings (e.g. a player has a warrior in his settings with the role of a tank.), so it is unnecessary to change the role unless you wish to change both. You can also keep the same character, but change the role temporarily (i.e. change a priest from range DPS to a healer). These changes only affect the current raid, and does not change any roles from other raids, nor defaults in a player's settings. Once all players are set, click on Submit to make the changes immediate.

Note: There is no way to hide character or role changes if a player is on the Whiteboard. All changes are shown immediately. It is recommended to use officer notes before you are ready to reveal the change.

Advanced RT features

RaidTracker earns its name by tracking players' signups easy, as well as being easy-to-manage. It also has several other features that track ranks and who is authorized to make changes.

Tracking participation

RaidTracker can track player participation easily. Guilds are free to use this information however they wish. There are two methods of checking signups:
1. Counts of participation. In Guild view, you may view the period of participation over a certain period. These track the number of signup for each status. Remember that unless you choose "Life", you will not see future raid numbers in the count. Whiteboard status will count as Available in most cases. A 30-day only count is found in each player's Settings view.
2. Last 30 raid history. This view is available under each player's settings. This history covers the last 30 raids the player has signed up for, including the character used, the signup status and any comments. Unlike the count of participation, this view may include future raids a player has signed up for. This history is good for settling disputes with raid signups, or to track days/style of player signups.

Controlling access

RaidTracker is quite powerful in the wrong hands, so there are methods of controlling what players can do to RaidTracker. RaidTracker uses a ranking system, and each system can contain up to 10 ranks. More on the rank systems follows.

Guild rank

This is a purely visual rank, used to resemble your current guild ranking system in game. This displays in the Guild List view, and as a popup in various places in the List view and Log. This popup serves as a reminder in case your guild uses a guild rank to determine signup rules.

RaidTracker rank

RaidTracker Rank (also known as RT rank) determines what can be done in RT. RT ranks use a hierachical system, where ranks above inherit properties of the lower rank. This list may be viewed on Guild List view.

Changing ranks

Unless you are a superadmin, you will not be able to assign ranks higher than you to anyone. This goes for both guild and RT ranks.

To alter the names of the ranks, this may be done through the Administration menu. Then click on Ranks, and there you may be able to add, modify or delete the names of ranks.

Assigning new ranks to players

In the Guild list view, all you need to do is to select the player(s) you wish to change, select the new rank in the options below the table to assign players, whether it be Guild rank, RT rank or both, then click "Submit". Changes take place immediately.

Changing allowed actions

RaidTracker allows different actions allowed based on your RT rank. With one exception, these permissions follow a hierachical order, in that any ranks above this position inherit these permissions (i.e. an admin will inherit properties from any rank below him.) Everyone means that this applies to all, including those not logged in/without an account, while None means it is not accessible to anyone, including the admin.

To change the permissions, click on Permissions from the Admin menu. You will then see a list of actions allowable to be changed, and a brief description next to it. Some permissions require other permissions to be set (e.g. Publish Whiteboard requires someone to actually view the whiteboard.) The Self Override checkbox allows players even with a lower rank to have rights to this feature, but only with regards to their account. (e.g. Not setting the self-override box on change e-mail will disable a player from changing their own e-mail address--not a very good solution.) Certain properties will not use the self override box at all. When done, click on "Submit changes". Changes take place immediately.

Other features

Breaking news

RaidTracker allows publishing of so-called "Breaking News" on the main view. In the Admin menu, there is a place to change the news box. HTML is allowed here (unlike in the comments, where it is stripped out.) Only one news box is allowed at any time, though it may contain whatever is needed. To clear it, press "Erase". Your name will appear in the news box once you add or change news.

Log

RaidTracker keeps a log of all actions done. From the Admin menu, click on Log. This log is read-only, and the viewer typically shows 100 entries at a time starting from the most recent. The categories have links that will take you to the appropriate page (i.e. a signup link will take you to the List view of the raid where that signup took place.)

As the log generates a lot of traffic in a hurry, you may find it convenient to empty the log. Just click on the "Clear Log" button, and it will disappear--but you'll find that it will log clearing a log.