Wobbleworks • Group Calendar Instructions Home Luminos Downloads Interests Privacy Contact

Group Calendar Instructions

Special note to guild leaders

If you are an officer of your guild with the ability to update the Guild Information data in your guild then you can also act as guild administrator for Group Calendar. As administrator you can specify the configuration for all of your guild members at once, making setup automatic for them. For instructions see the Guild administrator setup section.

Special note to guild members

If the officers of your guild have configured Group Calendar for the whole guild, then you won't need to do anything except install the addon in order for it to work. If it doesn't seem to work, check the Setup tab and make sure it's set to Automatic (it should be set that way by default, but stuff happens).  If that still doesn't work then your guild has probably not been configured for automatic setup.

Contents

Installing

Group Calendar is installed like any other addon. If World of Warcraft is running you should exit from the game before installing. The .zip file contains a single folder named GroupCalendar.  Copy this folder to World of Warcraft's Addons folder located inside the Interface folder and start WoW.

Windows users: The Addons folder can normally be found at C:\Program Files\World of Warcraft\Interface\Addons

MacOS users:The Addons folder can normally be found inside the Interface folder which is located inside the World of Warcraft application folder

IMPORTANT: Depending on your unzipping application, you may end up with the addon folder inside another folder. Look inside the GroupCalendar folder and verify that there's a file named GroupCalendar.toc. If you don't see this file and see another folder instead, open that folder and look for the file. The folder containing the .toc file is the one which should be copied to your World of Warcraft addons folder.

The addon is now installed and you can now launch World of Warcraft.

Accessing the calendar

There are two ways to open the calendar: either use the '/cal show' command or click the calendar icon in the upper-right corner of your minimap. A working clock replaces the sun and moon icons normally found on the minimap and clicking on that clock will open Group Calendar.

Quick setup

If you are in a guild and a guild administrator has set up your guild for automatic configuration then you will only need to make sure that you are set to use automatic configuration. If you are not in a guild or your guild does not use automatic configuration, skip to the section on Manual configuration to set up the addon.

To verify that the addon is set for automatic configuration, open the calendar and click on the Setup tab at the bottom of the window.  The Configuration menu should be set to Automatic. 

Channel Setup UI

If automatic configuration is working correctly, you will see the settings detected and the status message will show "Synchronizing with network" (which will change to "Connected" after the five minute synchronization period has ended)

The calendar display

The calendar will always open to the current month with an animated marquee around the current date. To see the schedule for today or any other date simply click on on that day in the calendar and that day's schedule will open alongside the calendar.

To choose a date in another month, use the arrow buttons located on either side of the month name to switch to the previous or next month.

To quickly return to the current date, use the downward pointing arrow in the top right corner.

Group Calendar normally displays events using server date and time.  If you want to display and edit events using your local date and time, uncheck the Use server dates and times checkbox.

There are some additional display options which are not available from the graphical UI.  These options change the calendar display or the time formats:

			/cal 12h        Show times using the AM/PM format
			/cal 24h        Show times using 24-hour format
			
			/cal sun        Start the week on a Sunday
			/cal mon        Start the week on a Monday
		
Day Summary UI

Viewing and attending an event

To view details for an event select the date and then select the event from the list of events for that day.

Event Viewer UI

From the event viewer you can sign yourself up for the event so that the event organizer knows you want to attend.

To sign yourself up choose which of your characters you want to attend on and then check the Yes box.

If you can't attend the event and want to let the organizer know, check the No box.

You can optionally add a comment to explain special circumstances for your attendance. For example you may say that you're attending but that you'll be late, or you may want to give a reason why you won't be attending.

The Status at the bottom of the window shows what's happening with your attendance request.  Possible messages are:

Adding an event

To add an event click on the day that you want the event to take place, then click the New Event button in the schedule window.

Event Editor UI

Use the Event menu to set the icon for the event.  This will also be used as the title if you don't provide a title of your own.

Title sets an optional title for the event

Time sets the start time for the event. Birthday events will not show a Time field.

Duration sets how long the event is expected to last. Birthday events will not show a Duration field.

Levels sets an optional level range for the event. Players who are not within the specified level range will see the event as dimmed in their calendar and will not be allowed to provide attendance feedback for the event. The level range field is not display for Birthday or Meeting events.

Description sets an optional description for the event. This could be used to clarify which part of a dungeon the event will cover or what a meeting's agenda will be.

To automatically sign yourself up for the event, check the "will attend" box at the bottom of the window.

If you're in a multi-guild alliance and want this event to be for your own guild members only then check the "<Guild name> members only" box.

Once you've set up your event, click the Done button to save it to the calendar. If you change your mind and don't want the event, click the Delete button.

Editing an event

To edit an event select the date in the calendar and then click the event in the day schedule. You can then make any changes to the event and click the Done button to save the changes to the calendar.

Deleting an event

To delete an event select the date of the event in the calendar and then click the event in the schedule window. In the event editor click the Delete button and then confirm the deletion in the dialog which appears.

Event attendance

Attendance UI

Group Calendar has the ability to track attendance responses to dungeon and meeting events (there is not attendance feedback for birthday events). Additionally, attendance requests can be processed automatically using specified class limits, the requests can be manually processed, or the event can be closed off to attendance (useful to pre-announcing an event without allowing people to sign up too far in advance).

To manually confirmation confirm attendance requests set the menu to Manual Confirmations. Users who request to attend your event will always be placed into the standby list in this mode. You can then use the menu next to their name to change their status to Accepted or Declined if desired.

To have members automatically confirmed in the order in which they signed up set the menu to Automatic Confirmations. You can then specify limits for the various classes for your event using the Settings button. Those limits instruct Group Calendar how many people you want for your event as well as what class composition you want.

The Add button at the bottom of the attendance view can be used to manually add players to the event.  See the next section on manually adding players for more information about this feature.

Confirmation Limits UI

When using limits, players will be confirmed for the event using these rules:

If there's a minimum set for their class and that minimum hasn't been met, the player is confirmed

If there's a maximum set for their class and that maximum has already been reached, the player is placed on standby

If there's a maximum number of players set for the event and it hasn't been reached then the player is confirmed

Otherwise, the player is placed on the standby list

This may seem confusing but hopefully you will find that players are accepted for your group in the way you would expect. It's fairly easy to understand how minimums work since that class will simply be filled in until the minimum is reached. How spaces are given out between the minimum and maximum values may seem a little confusing however. At the bottom of the limits window is the total of all the minimums you've entered for all classes combined as well as a setting for the maximum size for the event.  The players between these minimum and maximum values are considered "extras" and those extra slots will be made available on a first-come-first-served basis to all players, as long as the maximum for a player's class hasn't been reached. For example, if the total of all the class minimums is 32 players and the maximum size of the raid 40 players, then there are 8 spaces available for extra players. These slots will be given out to the first players who request them, unless the maximum for that players class has already been reached.

Using a minimum value for a class ensures that space will be reserved in your event for that many players of the class.  Leaving minimum blank is the same as setting the minimum to zero.

Using a maximum value for a class ensures that you won't fill all of your extra spaces with only that class.  Leaving maximum blank means that there is no maximum for the class and that it's ok for all of the extra spaces to be filled by that class.

If you don't want any players at all of a certain class, set the maximum for that class to zero.

Adding players manually

To add a player manually to an event first select the event and then go to the Attendance tab.

You can then add players in one of two ways. The basic way is to click the Add button at the bottom of the attendance view and fill in the various fields of the Add Player dialog. If the player is in your guild then you only need to provide their name and the other fields will be filled in automatically.

Alternatively you can add players via whispers. This is especially useful if your guild customarily does signups for events by having player whisper for invites at the start of the event rather than signing up in advance. At the top of the attendance list for the event there will be a category named Recent Whispers (this category won't be present if you aren't the creator of the event or if nobody has whispered you since you logged on). Use the menu next to the first whisper and choose Add Player to bring up the Add Player dialog.

Add Whisper UI

Here you can see the last whisper from that player and decide what to do with them. If you want to add them to your event, fill in any missing fields and choose whether they should be set to Accepted or to Standby. Optionally, you can provide a response whisper, usually a confirmation that they've been added. This response whisper will be remembered and used for subsequent players as you add them. Click the Save button to add the player to the event and that whisper will be removed and the next whisper will automatically be displayed.

If the whisper isn't related to the event you can click the Delete button and it will be discarded and the next whisper will be displayed

If you don't want to process any more whispers, click the Done button to save and exit from the dialog or the Cancel button to exit without doing anything with the current whisper.

Party/Raid management

Group Calendar can assist you with putting your party or raid together for your event. It can automatically choose players for your party, invite those players to your group, and help fill extra spaces when people have to leave.

To access the party/raid management features, open your event and go to the Attendance tab. There you will see two tabs on the attendance list, All and Group. Select the Group tab.

Party Management UI

This view shows all of the attendees who are either accepted or on standby for the event as well as any players currently grouped with you, including your own character. All players will show a status in parenthesis next to their name. Possible values are:

To start forming your group you must first select the players you want to have join. You can manually select players by using the checkbox next to their name. Note that if they're already in your party or raid there won't be a checkbox and you can't select them.

To automatically select players click the Select Players button. This will give you a class limits dialog very similar to the one used for automatic confirmations. Read the section above about how automatic confirmations work for an explanation of how the limits in this dialog work as well.

Auto-select UI

The automatic selection dialog has one additional setting for Priority. Use this to determine if players should selected based only on their signup date or if top priority should be given to higher guild ranks with signup date used to determine who is selected within each rank.  Note that guild rank priorities will not work properly if you have players who are not in the same guild as your character.

To invite the selected players click the Invite Selected button. This will automatically whisper everyone who is selected telling them what they're being invited to as well as sending them the actual group invite. If they are already in a group and therefore can't be invited then they will receive a second whisper telling them this. You will need to re-invite them once they inform you that they've left their group.

If your group is going to be a raid then only the first four invites will be sent initially. Once any of these players has accepted then the party will automatically be converted to a raid and the remaining invites will be sent.

Ignoring other player's events

If you don't want to see events posted by a particular player you can ignore them by adding their name to the Ignore list in the Setup tab. To add them, enter their name into the Name field and click the Add button.

If you later change your mind you can remove them from the Ignore list by selecting their name and clicking the Remove button.

Channel Setup UI

Guild administrator setup

If you are an officer of your guild with the ability to update the Guild Information data in your guild then you can also act as an administrator for Group Calendar for your guild. This will allow you to specify the channel and password for members of your guild, making setup automatic for them. This will also allow you to easily change the data channel name and password for the entire guild at once rather than having to pass the new information on to each member individually.

On the Setup tab, set the Configuration to Administrator (note that this option will not appear if you do not have the ability to edit your guild's Guild Information data).  Administrator mode behaves exactly like Manual Configuration except that any settings you change will be stored as a coded message in your Guild Information.  The copies of Group Calendar running on your member's machines will then read that coded message and use it to auto-configure themselves.

Which channel mode to use depends on your needs.  If your guild's calendar is private and won't be shared with other guilds then you should choose the "Use guild data channel" option.  Benefits of using the guild data channel are:

If your guild is part of a multi-guild alliance then you should use the "Use shared data channel" option instead and set a channel name and password.  This will create an ordinary chat channel which will be used to pass the data around. Since it's just a chat channel, players outside your guild will be able to join it as well.  The administrators for the other guilds in your alliance should do the same setup as you for each of their guilds.  You and the other administrators should then coordinate future channel and password changes so all of your members switch to new configurations at the same time.

In this mode there is no control over who can post events. Group Calendar can't find out anything useful about the members of other guilds - what guild they're in, what their rank in that guild is, what rank is required to post events in that guild, etc.  That makes it impossible to control who can post events -- anyone who gets into your channel will be able to add events to the calendar.  You can still manually blacklist people using the ignore feature on the Setup tab, but that only affects your view of the calendar, everyone else will have to add that player to their own ignore lists as well.

IMPORTANT: When you need to change the data channel password you should also change the name of the data channel. This is because there is no real concept of channel ownership in World of Warcraft (ownership is arbitrarily passed to someone else in the channel when the current owner logs off). This makes it very difficult to change only the password, so whenever changing the channel configuration always change both the name and password for the channel.

Manual setup

If you are not in a guild or are in a guild which doesn't use the automatic setup feature then you will need to manually configure the channel.

Which channel mode to use depends on your needs.  If your guild's calendar is private and won't be shared with other guilds then you should choose the "Use guild data channel" option.  Benefits of using the guild data channel are:

If your guild is part of a multi-guild alliance then you should use the "Use shared data channel" option instead and set a channel name and password.  This will create an ordinary chat channel which will be used to pass the data around. Since it's just a chat channel, players outside your guild will be able to join it as well. 

In this mode there is no control over who can post events. Group Calendar can't find out anything useful about the members of other guilds - what guild they're in, what their rank in that guild is, what rank is required to post events in that guild, etc. That makes it impossible to control who can post events -- anyone who gets into your channel will be able to add events to the calendar. You can still manually blacklist people using the ignore feature on the Setup tab, but that only affects your view of the calendar, everyone else will have to add that player to their own ignore lists as well.

/cal commands

	/cal help       Displays a list of available commands

	/cal 12h        Show times using the AM/PM format
	/cal 24h        Show times using 24-hour format

	/cal sun        Start the week on a Sunday
	/cal mon        Start the week on a Monday

	/cal versions   Displays the last known GroupCalendar
	                   version each known player is running
	/cal reset      Deletes all of the event data for all
	                   of your characters on your current realm
	/cal reset all  Deletes all of the event data for all of
	                   your characters on all realms

	/cal kill name  Sends out a command to the guild to delete
	                   all events created by the specified player.
	                   This command may only be issued by a guild
	                   officer.
	/cal clock off    Turns off the minimap clock display
	/cal clock auto   Turns on the minimap clock display and uses
	                     the same time zone setting as the calendar
	/cal clock local  Turns on the minimap clock display to show local time
	/cal clock server Turns on the minimap clock display to show server time

	/cal reminder off Turns off tradeskill reminders
	/cal reminder on  Turns on tradeskill reminders
	
	/cal maxage days  Sets the maximum number of days to keep old events