The Blizzard Community Platform API 7.x requires the Entity Module. The 8.x version does not need this dependency as Entity Module is part of Drupal 8.x core.
After enabling Blizzard Community Platform API, go to your configuration pages (admin/config) and enter World of Warcraft > General Settings. Alternatively, you can click on the configure link on the modules page.
In the configuration pages, you can set your regional settings, the default locale, and your private API key. Note that the base module does not make use of the default regional settings but developers that build upon this library may require this settings so it is considered as good practise to check them.
WoW Data Services
Enabling the wow base module will grant you access to the WoW Data Services, sort of daemons that periodically fetch data resources for a given region and language. You can have more information on implementation in the developer documentation.
When you install the wow component, a default service is configured based on the site language and country. While it will be accurate for the supported locales (en_US, pt_PT, pt_BR, fr_FR, ...), it will be not preconfigured for country that are not specified explicitely by Blizzard, thus the 'en_US' default service will be activated.
Sometimes, the API evolves in a way that new locales can be supported over the time, the WoW Data Service platform support the add of custom locales. Also, some locales like en_US and en_GB can be different, the former is fetched from the 'us' region, whereas the later is fetched from the 'eu' region.
Defining two different languages for Drupal (for instance en_US and en_GB) will allow you to map a service with it. A service if bound to language in a way that it cannot exist if a language is not associated with it. If you delete a language, it will remove the service. When you add a new language, you can optionally create and associate a new service with it. Changing the default language will change the default service.
The WoW Character module enables character integration with the service. It allows the fetching of new character and mapping users with them. No configuration is initially needed to enable this module and it will provides the following features:
- Adds a 'Characters' link on user pages, allowing users to own multiple characters and easily swap between them.
- Provides an in-game verification mechanism to unblock a character and verify owner identity: the form will ask to remove 4 items in the inventory to check the authority. This allows site administrators to trust their users and creates rank based permission to access private areas of your site for instance.
- Automatically fetch through cron or at entity load the character from the battle.net API, three modes of fetching are supported: At entity load, At cron time using drupal queue API, or custom if you are a module developper.
- Administrative page let you see the character list on your website, you can block/unblock them, check the owners, sees the level and class and filter only characters of your guild for instance.
- More technical information is available on the WoW Character Specifications page.
The WoW Guild module enables guild integration with the service. It allows the fetching of new guild and setting a site default. Because a guild is composed of characters in the game, but also in this API, the Character component is a required dependency.
- Adds a default guild to your website.
- Fetch guild information such as news feeds, progress and members for any guilds.
- Provides hooks for members changements: when member joined/lef the guild or was promoted/demoted in the guild.
- Automatically fetch through cron or at entity load the guild from the battle.net API, three modes of fetching are supported: At entity load, At cron time using drupal queue API, or custom if you are a module developper.
- More technical information is available on the WoW Guild Specifications page.