In this document, we will outline the following processes:
In order to use GuildPlanner.Pro, an administrator of your Discord Server with Manage Server privilege must register and set up the guild to work with it. This process will also add the GuildPlanner.Pro Discord Bot to your Discord Server and allow you and your guild members to utilize all the features that come with it, including various types of Discord commands that help with day-to-day guild life and management!
If your guild is already using GuildPlanner.Pro, all you need to do is register and import your data. As a result of this, your Game-Profile(s) will be linked to your guild’s profile on WebSite and you will get all the necessary guild roles (with accompanying Discord Server roles). With that accomplished, you will be able to use all features granted to your guild role.
If your guild isn’t already using GuildPlanner.Pro, please consider referring it to the leadership of your guild. You are welcome to share this Wiki as well, for them to get acquainted with our Feature List and more.
GuildPlanner.Pro uses Discord as our primary community platform, and as such, instead of creating our own user-management system, we solely rely on Discord’s open authentication capabilities (“Discord OAuth”). Upon logging-in for the first time (once you complete authorization process through Discord), your GuildPlanner.Pro user account will be created in the background.
During Discord Authorization (when you are logging in to our website for the first time), we request certain permission scopes from you. Those scopes, and their purposes are as follows:
Scope | Purpose |
---|---|
identify | To identify your Discord account for authentication purposes |
To get your email address from Discord in order to create your GuildPlanner.Pro account | |
guilds | To get the list of the Discord servers (a.k.a. guilds) you are part of |
guilds.join | To automatically join Discord servers on your behalf (e.g. when you join/apply to a new guild on GuildPlanner.Pro) |
applications.commands | To utilize our Discord commands |
The authorization of these scopes is essential for the successful automation of our website.
¶ What happens if I de-authorize GuildPlanner.Pro on Discord?
We do not act on it right away, but the moment our systems detect this to be the case while performing a critical operation that relies upon this authorization (such as, processing regular guild membership tasks), your user account will be immediately suspended and you will be notified via email. As stated above, Discord is very essential component to GuildPlanner.Pro and the authorization to log you in into our systems using your Discord account is critically required. To fix this, you can relogin to the website and your user account will be automatically re-activated.
Our usage of Discord as an authenticator has following benefits:
In GuildPlanner.Pro our long-term goal is to support as many popular MMORPGs as possible, the MMORPGs which support some type of game-data collection API (application programming interface). Essentially, there are two types of APIs in massive multiplayer games:
Rarely, some titles support both APIs (e.g. World of Warcraft).
After creating your GuildPlanner.Pro account, the next step is to get your game-data (such as, your character data: gear, skills, unlocked features etc and your account-wide data: achievements and similar) into our system. To achieve that, we utilize the API that is supported.
Currently GuildPlanner.Pro only supports Elder Scrolls Online, with goals to support Final Fantasy 14, Guild Wars 2 and Destiny 2 sometime in future. Upcoming Ashes of Creation is in our scopes as well (we are waiting for it to reach Beta development phase). 🤞
Since the Elder Scrolls Online is utilizing a UI API, we have developed an ingame Addon which gathers your game-data. In addition to this Addon, we also have developed a desktop Client program which automatically uploads your data to GuildPlanner.Pro (available on Windows 10+, soon to come to MacOS as well).
Once uploaded, our backend systems process these data, creating your game profile(s). If you are part of a guild who also uses GuildPlanner.Pro as their guild management tool, you’ll automatically join your guild’s resources (their WebSite pages, their Community forums and clubs etc).
Once this is done, you can share your character profiles with wider public, showcasing:
And your guild leaders will be able to manage your standing in the guild, through Guild Roles you get assigned (in-guild progressions are handled via our Tier-based and/or Hierarchical roles system). Squads (a.k.a. Raid Teams/Groups/Cores) and guild Events (such as, raids, dungeon runs etc) are also managed through WebSite.
At GuildPlanner.Pro, we aim to create systems with great User-Experience. As such, our systems tend to be very intuitive, and we constantly monitor our UI usage reports to pinpoint the bottlenecks and the sources of confusion for our users. That said, there is not that much of usage guidelines to talk about, except:
Yes, we are totally Discord-oriented. This means, if your guild is part of our ecosystem, you will have to use Discord. If you choose to deauthorize GuildPlanner.Pro on Discord, revoking authentication permissions you granted during Registration, our systems will suspend your account once they detect something malfunctioning because of this choice.
Additionally, you will have to remain in your guild’s Discord Server! Whenever you leave your guild’s server, our systems will join you back in (remember guilds.join scope mentioned above?), the moment they process your data as a member of your guild and notice you aren’t in the server. This might sound like a nuisance, but unfortunately to function without endangering data integrity of our guilds, it’s a necessary step to take. You can de-authorize GuildPlanner.Pro on Discord, and with that stop being auto-added to your guild’s Discord server (alongside with getting your account suspended of course) - but then you will have to sort it out with your guild’s leadership, because you as a member won’t be manageable via GuildPlanner.Pro.