GearChecker

A Discord bot for the World of Warcraft server Warmane used by thousands of people worldwide.

This bot is a fork of Snuske with some minor improvements.

Thread on Warmane can be found here.

Description

A small Discord bot for Warmane's World of Warcraft that inspects the players' gear and lets them know certain stats and which gems/enchants they are missing.

Installation

To run this on your own server, you need a few things installed first.

• NodeJS.
• The latest version of this repository.
• Any text editor.

Then you need to create a Discord application. These are the steps:

• Go to the Discord's Developer Portal.
• Login.
• Click on New Application.
• Give it a name, maybe add an app icon and write a description.
• Grab the token from this page:

After that, you're ready to run it. For that, you have to do follow these steps:

• Rename the .env_example file to .env
• Edit the .env file and paste your token ID like this: discord_bot_id=MTIxMjE2NDQ0NTA0NDg3MTMx...
• Open the Windows console/Linux terminal from the root folder of the project.
• Run the command npm i. This will install all the packages of the project.
• Run GearChecker with this command node app.js.
• [OPTIONAL] If you want to run this as a service (in the background), you can check out this package.

Generate a link to invite the bot to your server

• Head back to the Discord's Developer Portal and navigate to the Bot page and activate the Message content intent:

• Now go to the OAuth2 page and change the authorization method of the bot to this:

• Save the changes.

• Mark the following checkboxes:

• Voilà! Spread it like Necrotic Plague with your friends!

Bot usage

Supported commands:

• !help: Displays this help text.
• !guild [player_name] [realm?]: Displays the gild of the player.
• !gs [player_name] [realm?]: Displays the GearScore of the player.
• !ench [player_name] [realm?]: Displays which enchants are missing from the player's currently equipped items.
• !gems [player_name] [realm?]: Displays which gems are missing from the player's currently equipped items.
• !armory [player_name] [realm?]: Returns a link to the player's armory.
• !summary [player_name] [realm?]: Lists all the details regarding the given player.
• !achievements or !achi [player_name] [realm?]: Lists all the details regarding the given player.

[realm?] is an optional parameter. By default = Icecrown.

Example of usage:

• !summary Metalforce Icecrown
• !guild Metalforce
• !gs Metalforce
• !summary Koch Lordaeron
• !gs Koch Lordaeron
• !achievements Metalforce
• !achi Metalforce

Feel free to join the official Discord server of the bot here and ask/suggest me anything!

Docker first run / deploy changes

After you change something, you need to stop it and build the image first with:

docker-compose down
docker-compose build

Then just run it again with:

docker-compose up -d