What’s new

On 2012/05/25, in , by Taracque

WoW Armory Sync now requires a Battle.NET API key, which can be obtained here: https://dev.battle.net/ Version 0.9: Joomla 3.3 compatible version Major code cleanup Version 0.8: Joomla 3.x compatible, Joomla 1.5 support dropped. And updated WoW Theme can be downloaded (or installed) from here: https://codeload.github.com/Taracque/RaidPlanner-wow/zip/master#.zip Groups are removed, now only uses Joomla ACL system. Frontend […]

WoW Armory Sync now requires a Battle.NET API key, which can be obtained here: https://dev.battle.net/

Version 0.9:

  • Joomla 3.3 compatible version
  • Major code cleanup

Version 0.8:

 

Plugins

On 2012/05/25, in , by Taracque

Plugins (formerly themes) is handled in a different way in version 0.8 and up. Check WoW Plugin until I made some documentation… (https://github.com/Taracque/RaidPlanner-wow/archive/master.zip). Install this via Joomla’s Extension Manager, and enable it there. From version 0.7 RaidPlanner uses Themes for game specific things, and all WoW specific thing were removed from the RaidPlanner package. A […]

Plugins (formerly themes) is handled in a different way in version 0.8 and up.

Check WoW Plugin until I made some documentation… (https://github.com/Taracque/RaidPlanner-wow/archive/master.zip). Install this via Joomla’s Extension Manager, and enable it there.

From version 0.7 RaidPlanner uses Themes for game specific things, and all WoW specific thing were removed from the RaidPlanner package.
A Plugin contains the followings:
Icons, plugins, class names, role names, race names, game specific CSS file, and optionally a code which allow synchronization of the roster with a web database.

Currently 2 Plugins are available for RaidPlanner 0.8:
RaidPlanner WoW Theme
RaidPlanner Lotro Theme (unfinished)

Old Theme files for GW2 and TSW can be found here:
RaidPlanner GuildWars 2 Theme
RaidPlanner The Secret Word Theme (unfinished)

 

Customization

On 2011/10/28, in , by Taracque

RaidPlanner is originally developed for WoW, but it’s possible to use it with other games as well. The images for classes, raids, roles are all stored inside the media/com_raidplanner directory of your Joomla installation. Modify class icons: (subject to change!!!) If you want to add new class images it’s strongly recommended to add it into […]

RaidPlanner is originally developed for WoW, but it’s possible to use it with other games as well. The images for classes, raids, roles are all stored inside the media/com_raidplanner directory of your Joomla installation.

Modify class icons:

(subject to change!!!)
If you want to add new class images it’s strongly recommended to add it into the same folder with new names, as original files will installed every time when you reinstall or update RaidPlanner. The usage of images are controlled by CSS stylesheet. If you want to use different images do the followings: Change Class CSS setting of the selected class, for example “new_class_1”. (call it anything you whish, but Class CSS must be only alphanumeric (a-z, 0-9, -, _) characters. Upload the corresponding image file to class_icons folder (in this example it’s called new_class_1.png) Put the following declaration into the end of your template’s css file (usually called template.css, or style.css, and can be found inside the template’s directory, see CSS customization for more information):

.new_class_1 {
background: transparent url(../../../media/com_raidplanner/class_icons/new_class_1.png) left center no-repeat; padding-left: 20px;
}

Make those changes for all classes you want to modify.

Modify raid icons:

Modifying raid images is much easier, just upload you images to media/com_raidplanner/raid_icons folder. Once the icon added to the directory, it can be selected for Raids.

Modify role icons:

Same as above, just upload the new icons to the media/com_raidplanner/role_icons folder. Once the icon is in it’s place, you can use it for role, using the filename. (No path needed)

CSS customization:

RaidPlanner has it’s own CSS file, but it will not work with all templates. To use your own CSS file instead of RaidPlanner’s own, set Load CSS setting to “Off”. With this setting RaidPlanner will not load raidplanner.css, so you can add you own style definitions, those will not be overridden.
Either add new declarations to your template css file, or make a copy of raidplanner.css (can be found in media/com_raidplanner/css directory) to your template’s css file, and edit it.
If you make your own copy of raidplanner.css you should add

<link href="<?php echo $this->baseurl; ?>/templates/<?php echo $this->template; ?>/css/raidplanner.css" rel="stylesheet" type="text/css" />

line into the template index.php file header section to load the definitions in your CSS file.

 

Component configuration

On 2011/10/28, in , by Taracque

RaidPlanner has some component wide configuration options. These settings can be accessed by pressing the Options button on upper right corner of RaidPlanner main screen. The following options are there: RaidPlanner Settings tab Load CSS: if you set this to “No” RaidPlanner will not load it’s own CSS file, so you can use your own […]

RaidPlanner has some component wide configuration options. These settings can be accessed by pressing the Options button on upper right corner of RaidPlanner main screen.

The following options are there:

RaidPlanner Settings tab

Load CSS: if you set this to “No” RaidPlanner will not load it’s own CSS file, so you can use your own css definitions for RaidPlanner screens. Those CSS definitions should be loaded with your template.

Guild Settings tab

Armory synchronization: if set to yes, RaidPlanner tries to synchronize guild data with battle.net armory. Set this to No if you are not playing WoW, or not playing it on an official server.

Sync time: If armory synchronization is turned to Yes, this setting will control how often (how many hours between two check) RaidPlanner should check battle.net armory.

 

Guild configuration

On 2011/10/28, in , by Taracque

RaidPlanner can handle multiple guilds on the same site. But at least one guild must be configured to make RaidPlanner working. Guilds have the following data stored: Guild name, Sync Plugin. Other data may be available depending on the used Sync Plugin. Please read Themes section, as Plugins are packed with game Themes. Currently RaidPlanner […]

RaidPlanner can handle multiple guilds on the same site. But at least one guild must be configured to make RaidPlanner working.

Guilds have the following data stored:

Guild name, Sync Plugin. Other data may be available depending on the used Sync Plugin.
Please read Themes section, as Plugins are packed with game Themes.

Currently RaidPlanner has 2 Sync plugin available:

wow_armory and lotro.

wow_armory:

this plugin synchronizes the RaidPlanner roster with World of Warcraft’s Armory via Blizzard’s battle.net service. You will need to setup

Armory region and Realm 

lotro:

this plugin synchronizes the roster with Turbine’s data.lotro.com service. You have to registered with Turbine, and you’ll need a developer name and an API key for that. More informations here: http://lorebook.lotro.com/wiki/Data.lotro.com_Usage_Guide#Obtaining_an_API_KEY

Guild name needs to be filled in every case even if don’t use any of the above plugins.

 

Community Builder

On 2011/10/25, in , by Taracque

RaidPlanner has it’s own plugin for Community Build. This plugin is automatically installed if Community Builder is installed in the system. If you install Community Builder later than RaidPlanner, just reinstall RaidPlanner, and Community Builder plugin will be installed. The goal of the CB plugin is allow users to manage their own characters, or assign […]

RaidPlanner has it’s own plugin for Community Build. This plugin is automatically installed if Community Builder is installed in the system.

If you install Community Builder later than RaidPlanner, just reinstall RaidPlanner, and Community Builder plugin will be installed.

The goal of the CB plugin is allow users to manage their own characters, or assign characters to themselves.

Once you have the CB plugin installed, publish it using Community Builder’s Plugin Manager. There are two modes of CB plugin:

Character assignment mode: 

This mode is mainly usable if you are playing WoW on an official server. In that case RaidPlanner can synchronize it’s characters database with Battle.net Armory.

Add a textarea type field to user’s profile using CB Field Manager. Name it to characters. Go to Plugin Manager, select RaidPlanner character and set “Characters field:” setting to this new field that you created. Choose no to “RaidPLanner Direct Synchronization” setting. Enable the plugin and Save.

Users have to put their own characters name into that field, separated by a newline character. Every time they visit the Calendar page of RaidPlanner, RaidPlanner will check if there are any character which is not assigned to a user, but appears in the profile. All such characters will be assigned to the user who has a matching character in their profile.

Character editor mode:

Use this mode for self management of characters (by users).

Add a RaidPlanner Characters type field into users profile, save it, and set it in RaidPlanner plugin settings (see above).  Set “RaidPLanner Direct Synchronization” to yes.

With this settings users who have “edit_characters” permission given in RaidPlanner Group settings can add, edit their own characters. Users without edit_characters permission can set existing characters as their own.

 

RaidPlanner Plugin Parameters:

RaidPlanner Plugin Enabled: enables or disables the plugin operations. Once it is set to No the plugin will not work, however it’ll still saves the data into user profiles. Turn it to Yes always.

RaidPLanner Direct Synchronization: if enabled, the plugin directly connected to RaidPlanner database. If a user removes a character from his(her) profile, that character will be deleted from the RaidPlanner database.

Characters field: which CB field is used to store list of characters.

Vacations field: which CB field is used to store vacation periods.

Calendar secret field: which CB field is used to store calendar secret.

 

Integration

On 2011/10/25, in , by Taracque

RaidPlanner component is able to cooperate with the following Joomla components:

RaidPlanner component is able to cooperate with the following Joomla components:

 

Troubleshooting

On 2011/10/24, in , by Taracque

If you have problems with RaidPlanner, first try to install the latest version, maybe the bug is already fixed, and then check the followings. I your problem still exists after you have checked the things below, post your problem in GitHub issue tracker or RaidPlanner Bug reporting forum. Joomla 1.5: Check if Mootools Upgrade plugin […]

If you have problems with RaidPlanner, first try to install the latest version, maybe the bug is already fixed, and then check the followings. I your problem still exists after you have checked the things below, post your problem in GitHub issue tracker or RaidPlanner Bug reporting forum.

Joomla 1.5:

Check if Mootools Upgrade plugin is published. Go to Plugin Manager of Joomla, filter Mootools.

 

Group configuration

On 2011/10/24, in , by Taracque

Groups defines what particular user can access from RaidPlanner. There is a special group called Guest which defines Guest user (i.e user without Joomla registration) access. Guest group have no members. In RaidPlanner every user can be a member of one group only. Users can be members of multiple groups. The strongest privilege combinations is […]

Groups defines what particular user can access from RaidPlanner.

There is a special group called Guest which defines Guest user (i.e user without Joomla registration) access. Guest group have no members.

In RaidPlanner every user can be a member of one group only.
Users can be members of multiple groups. The strongest privilege combinations is in effect.
Example: Group A has edit_raid_any, Group B has view_calendar privilege set. A user who is member of both groups will have both privileges.

The privileges which can be setup for groups are the followings:

allow_signup: Allow group members to signup for the raids. Without this permission, user will not be able to signup.

view_raids: Can see raid details. User with this permission can click on calendar events and view its details.

view_calendar: Only users with this permission can see the calendar, otherwise they will get an error: Access Restricted

edit_raids_own: User with this permission can create new raids, and can later edit raids created by themselves.

edit_raids_any: User with this permission can create raid, and edit any raids, that are already created.

delete_raid_own: User with this permission, user can delete raid, what he(she) created.

delete_raid_any: User with this permission user can delete any raid.

edit_characters: User with this permission can add, edit, delete his(her) own characters. (See User Plugin)

An example setup:

Guest group has the following privilege:
view_calendar (nothing else is checked)

Raider group has:
allow_signup, view_calendar, view_raids, edit_characters checked

Raid Leader group has:
allow_signup, view_raids, view_calendar, edit_raid_own,
delete_raid_ownedit_characters

Guild Leader group has:
allow_signup, view_raids, view_calendar, edit_raid_own,
edit_raids_any,  delete_raid_owndelete_raid_any, edit_characters

With this configuration:
Non registered users can see the calendar, but can’t see the raid details.
Raiders can signup to raids, and manage their own characters
Raid Leaders can create, modify and delete their own raids, and can do everything that Raiders.
Guild Leaders can do everything (edit, delete any raids, and everything above)

 

Configuration

On 2011/10/24, in , by Taracque

Here you can find the basic configuration options of RaidPlanner. 

Here you can find the basic configuration options of RaidPlanner. 

 

Upgrading

On 2011/10/24, in , by Taracque

Joomla 1.6 and later version have a built in updater, and RaidPlanner is compatible with it. Just go to Extension Manager, select Updates tab, press Find Updates. If you see a RaidPlanner update in the select, just click on the checkbox and press the Update button in the upper right corner. If auto update doesn’t […]

Joomla 1.6 and later version have a built in updater, and RaidPlanner is compatible with it. Just go to Extension Manager, select Updates tab, press Find Updates. If you see a RaidPlanner update in the select, just click on the checkbox and press the Update button in the upper right corner.

If auto update doesn’t work just reinstall the latest version from GitHub without uninstalling the component.
See Installation

 

Installation

On 2011/10/24, in , by Taracque

Installation of RaidPlanner is self explanatory. Download the latest version from GitHub (https://github.com/Taracque/RaidPlanner/zipball/master) and install the Zip file using Joomla Extension Manager. If you have trouble during the installation, you can try Install from URL. Use https://github.com/Taracque/RaidPlanner/archive/master.zip URL in Extension Manager’s Install from URL field. After you have installed RaidPlanner, you have to enable User – RaidPlanner […]

Installation of RaidPlanner is self explanatory. Download the latest version from GitHub (https://github.com/Taracque/RaidPlanner/zipball/master) and install the Zip file using Joomla Extension Manager.

If you have trouble during the installation, you can try Install from URL. Use https://github.com/Taracque/RaidPlanner/archive/master.zip URL in Extension Manager’s Install from URL field.

After you have installed RaidPlanner, you have to enable User – RaidPlanner plugin in Plugin Manager.

 

RaidPlanner Docs

On 2011/10/24, in , by Taracque

This will be the documentation of RaidPlanner. As writing docs is not my favorite thing to do, please help me in that. Post any idea, documentation part in Discussions tab, and I’ll incorporate it to the Docs page. Thanks for your help!

This will be the documentation of RaidPlanner. As writing docs is not my favorite thing to do, please help me in that.
Post any idea, documentation part in Discussions tab, and I’ll incorporate it to the Docs page.
Thanks for your help!