Quick Start
Introduction
OpenDKP is a Dragon Kill Point (DKP) and Attendance tracking system designed to be highly performant and reliable by leveraging Amazon Web Services.
All links provided in this documentation will point to the Demo Client. You can replace the "demo" part with your guild's subdomain to reach the appropriate url for your guild
Common Definitions- Client: A client is essentially a guild, uniquely identified with a Client ID and has it's own set of characters, raids, adjustments, etc...
- Subdomain: A subdomain is the URL you go to in order to
reach your client.
- I.E. https://demo.opendkp.com - the bold characters are the subdomain
- I.E. https://ogc.opendkp.com - 'ogc' is the subdomain
- ...etc
Registration
Cognito
AWS Cognito manages user accounts on behalf of OpenDKP. When you register an account, you get access to additional features. You are NOT required to register an account to use OpenDKP to view your DKP or Attendance.
Demo Client Registration Link: https://demo.opendkp.com/#/register
- Username is required to be unique across all OpenDKP clients
- Nickname does NOT have to be unique and typically aligns to your Main Character
- Email must be valid as you'll recieve a verification email
- Password must be at least 8 characters, contain upper and lower case characters along with 1 special character
- If you need a new verification code, click "Send new Verification Code"
- If you leave this page before verifying your email address, you can always return here and click the "Verify Email" link at the bottom
Profile Page
The profile page serves as a landing page for your account details, including your characters and request status/history
Demo Client Profile Page: https://demo.opendkp.com/#/profile
(Must be logged in to view)
Requests
Request Types
- Character Assignment - A user can request to associate a given character with their Cognito account. You can have one ore more characters assigned to your account.
- Raid Tick - A user can request to be added to a Raid Tick to recieve credit for a raid. You can find out more about this feature under the utilities section
Request Statuses
There are 3 statuses a request can be in:
- Pending - Request is pending approval from an administrator
- Approved - Request has been approved by an administrator
- Denied - Request has been denied by an administrator
Characters
Characters represent entities that earn DKP by attending raids, purchasing items or having adjustments applied to them. It is possible that a single person has multiple characters and each are treated independently. Most games or guilds use the attributes tied to a character to determine a status such as "ALT" or "BOX" versus "MEMBER" etc. See the attributes section for more details
Attributes
A character contains multiple attributes, many which are configurable for multiple game types:
- Name: Represents the name of the character in game, unique to the client
- Active: Active or Inactive, Active will show up on the Summary Page while Inactive is hides the character in the system
- Rank: Configurable, enter any rank within a game or guild you prefer
- Level: Level of the character in game
- Class: Configurable, enter any class within a game
- Race: Configurable, enter any race within a game
- Gender: Male or Female
DKP Summary
A quick summary view is available for the character's DKP information if it is available. The summary will only be provided if the character is considered Active and has attended raids recently.
Adjustments
Adjustments are an adhoc way to apply DKP bonuses or penalties to Characters. An adjustment can be positive or negative in terms of value. Adjustments have no expiration date at this time, so adjustments will always be applied and only impacted potentially by DKP Decay (if enabled)
Example: Leeroy Jenkins was given a -500 Adjustment for rushing without the group.
Attributes
- Character: the character to assign the adjustment to
- Name: Name of the adjustment, does not have to be unique
- Description: a short description, could be the event or reason leding up to the adjustment
- Value: A positive or negative number to apply to the DKP of Character
- Date: The date the adjustment is applied
Raids
A raid is the primary form of earning DKP and Attendance in OpenDKP
Attributes
- Raid Name: The name of the raid, it does NOT have to be unique
- Date: The date of the raid
- DKP Pool: DKP Pool is currently not used for anything in the system, but maybe in the future
- Raid Ticks: A collection of Raid Tick which holds a collection of Characters (attendees) and DKP Value
- Items: A collection of items that were awarded/earned/bid on during the raid
Raid Tick
A Raid Tick can represent anything you want. It can signify a time period that has elapsed (30 minutes, 1 hour, etc) or the death of a boss. Each Raid Tick will count as 1 / N attended raids for attendance purposes. A raid tick also contains a DKP value that will be assigned to every Attendee. Each Raid Tick has a collection of Attendees (characters). You decide how many Raid Ticks are assigned to a raid and at what frequency.
Raid Ticks allow you to keep track of which Characters attended the event (time period, boss kill, etc) so it is expected that Characters may or may not be present on all raid ticks. If a character misses a raid tick, their attendance and total DKP will be impacted as such.
The below diagram represents an example raid which contains 5 raid ticks, awarding 50 DKP total if someone had attended all raid ticks
Attendees
Each Raid Tick contains a collection of Attendees which are Characters who were present at the time of the Raid Tick
Items
A list of Items that are earned during the raid. This could be items looted, bid off, or simply items you want to charge DKP for.
Items
Attributes
- Character: The name of the Character the Item was assigned to
- Item: The Item assigned
- DKP: The amount of DKP charged for the item, this amount will be subtracted from the Characters total DKP
- Date: The date the item was awarded
- Raid: The raid the item was awarded on
