This is a bot for Discord that integrates with the Guild Wars 2 API.
As of version 2 the bot is now using a sqlite database to store information rather than the redis cache. This should make the bot easier to install and run, especially on windows systems.
To migrate user keys from redis a utility has been provided.
$ sudo npm install -g redis-dump
$ redis-dump -f "gw2_discord:*" --json > redis_dump.json
$ node ./import_redis.js redis_dump.json
Copy the file config/default.toml to config/local.toml and make your changes there. Any options you want to leave at the default value you can remove from the local.toml file.
You need to create an application on the discord developers site at https://discordapp.com/developers/applications/. Make sure that in the "Privileged Gateway Intents" section that PRESENCE INTENT and SERVER MEMBERS INTENT are enabled. Create a bot user for it. The client ID and the bot user token should be entered into your configuration file. When you start the bot it will display a link which you can use to add it to any servers that you own.
Once you have everything configured run ...
$ npm install --production
$ npm run start
Unless specified otherwise, each feature can be excluded by removing it from features.enabled in the config file.
This feature can not be disabled. This allows users to identify themselves to the bot by providing an API key from Anet. To initiate the process send a direct message to the bot with the word "link". If the option for world role is set, any users on the specified world will be added to that role. If the option for guild role is set any users in that guild will be added to that role.
The ranks feature will create discord roles for each rank your guild has in-game and will keep your members in the appropriate rank.
The world_role feature will assign each user to a role for the world their Guild Wars 2 account is on.
This will apply your guild message of the day to the description of a channel in discord. Changes are checked for every hour, or you can force a manual update by sending "refresh motd" to the bot in a direct message (note that it may take up to 5 minutes for changes to appear on the API).
This will reply with the score for the current WvW matchup. If the user has given an API key, the users world will be used. If they have not it will fall back to the world specified in the config file. There are three options for how the score is displayed:
!score- The overall score of each world and their PPT.!relscore- Only the overall score of the top server is given, the second and third place scores are given as the difference to the world above.!kd- The kill/death ratio for each world
This will reply with some personal progression related information for the user:
!fractal level- Responds with the users fractal level!wvw rank- Responds with the users WvW rank.
!build [character name] [pve|wvw|pvp]- Responds with your specialization and trait information for a specified character. Specify the type of build at the end, if you leave this off it will default to PvE.!equip [character name]- Responds with a listing of currently equiped pve/wvw gear.!private [character name] [private|guild|public]- Allow or disallow others to query your build by including a mention after the character name. Defaults to private for all characters.
For example:
!build Rytlock Brimstone pvp
!equip Rytlock Brimstone
When this feature is enabled, the game will monitor users game status in discord. When they enter and leave Guild Wars 2 it creates a snapshot of their account. Entering the !last session command will display a summary of what they did during that session.
The bot includes a graphql server which can be used to query it and can allow you to do things like set keys through a web interface. This is enabled by default but will only listen on localhost. If you want to make use of this you will need to put it behind a reverse proxy such as nginx.
To customize the text the bot sends, create the file phrases/local.json. Any keys in here will over-ride those given in the other files.
If you would like to translate the bot to another language, use the format [feature].[language].json. If you are translating to a language recognized by the Guild Wars 2 API (es, de, fr, ko, or zh) then the responses from the API will also come back in that language. The bots language can be specified in the config file.