jgayfer / spirit

Spirit is a Destiny 2 Discord bot to assist players with everything from clan management to keeping track of in game events.

Spirit

Spirit is a discord bot designed to assist Destiny 2 players with everything from clan management to keeping track of in game events.

Spirit is no longer actively hosted/maintained, but feel free to tweak and run the code yourself!

Getting Started

Below are the steps to run the bot. Ideally you would be doing this for development/testing purposes, as I would prefer it if you didn't run an instance of the bot; I'd much prefer you just add mine to your server :)

Prerequisites

To run the bot, you'll need the following:

• Python 3.5+
• Pip
• MySQL
• Redis Server (using the default port)
• Pydest
• Spirit Server
• Bungie.net API app

Running the Bot

Note: Before the bot can be run, it's essential that both Pydest and the Spirit Server are installed and setup first.

Install the required Python modules with Pip, as well as the latest version of Discord.py

pip3 install -r requirements.txt
python3 -m pip install -U git+https://github.com/Rapptz/discord.py@rewrite#egg=discord.py[voice]

Then create a MySQL database with support for UTF8mb4 encoding

mysql -u root -p
> create database <database_name> character set UTF8mb4 collate utf8mb4_bin

Add the schema located at db/schema.sql

mysql -u root -p <database_name> < ./db/schema.sql

Finally, create a credentials.json file at the root level of this project.

{
  "token": "token",
  "dbname": "name",
  "dbhost": "host",
  "dbuser": "username",
  "dbpass": "password",
  "d2-api-key": "your-key",
  "client_id": "your-client-id"
}

That's it! The bot can now be run with

python3 spirit.py

If you play on using the register command, ensure that Spirit Server is also running.

Built With

• discord.py - An API wrapper for Discord written in Python

spirit's Issues

Add a web UI for creating events

Add ability to indicate how long an event will take

Add upper limit on maximum number of attendees for an event

Currently the user can input a much larger value than the database can handle which results in an exception. We should limit this to a reasonable number.

Some commands don't clear chat when spam cleanup is enabled

Affected Commands

• About
• Countdown

Update documentation on how to setup development environment and how to contribute

Add ability to register with Battle.net account

Add the ability to register with Battle.net - once this is done, everything else should just work ;)

[Bug] If roster is too big for the max message size (2048), it won't display

To fix this, we should split the roster up into multiple messages as necessary.

Track (and persist) individual command usage

Some users receive duplicate broadcast messages

If a user owns more than one server that Spirit is a part of, they will receive multiple broadcast messages. A check needs to be added to ensure that the message is only sent out to unique users.

Change KDA/KAD to be the same as what is displayed in game

Add a reminder for players who have accepted an event

Choose platform with a reaction

Instead of having to enter in the platform by hand, it would be better if reactions could be used. This would make the experience of registering much easier for the user.

Add subclass to loadout

Add alias for 'roster show'

User has requested that 'roster show' be aliased to 'roster view' to improve ease of use.

Duplicate event title error message should be displayed right away

Currently the user must complete the entire event creation process before the duplicate event message is displayed. This is annoying, and should happen sooner.

Spam cleanup isn't triggered until after pagination finishes - Item command

We'll probably need to spin up a separate event loop and have it call the cleanup function before we being paginating to fix this.

Allow events to be created with the event time set to "now"

This would just be a small QoL improvement for creating events that are starting right away.

[Typo] Welcome message gives incorrect instructions for some commands

Allow loadout and stats to be displayed for other accounts

Currently the loadout and stats commands only grab information about the user invoking them. It would be nice to be able to check the stats or loadout of other players.

Event organizer should automatically accept event after creation

There may be cases where this isn't desirable, but 99% of the time this is what happens. In the rare case that this isn't the case, the event creator can simply decline the event.

Add clan (members) leaderboard command

Add link to support server in help message

Add a limit as to how often commands can be run

Trials stats

This will be added in as !stats trials. The API has this information available, with the exception of number of flawless runs. This value is important; some investigation will be needed as to where we can find it.

Auto delete events in the past

Events in the past should be auto removed to clean up the events channel.

Display number of Titans, Hunters, and Warlocks for an event

Add ability to make poll

Add command to search for and display Destiny 2 weapons/armor

Allow loadout & stats commands to be used without registering

ie. !loadout Asal xbox

Broadcast command sends out duplicate messages if a user owns multiple servers that Spirit is a part of

To fix this, we'll need to filter the list of users to only unique users.

Command in settings to show current prefix

Add aim assist to the Item command

Paginate character loadout

It would be near if a used could page through all of their characters with the loadout command.

For info on how to do this, check out cogs/utils/paginator.py and how it's used in cogs/item.py

Note: This on hold until this Discord bug is fixed, as the bold formatting in the Loadout message will be affected.

Bungie API errors should be handled gracefully

To fix this, Pydest API calls should be surrounded by a try/except block.

Message for duplicate event title should be displayed as soon as a title is entered

Post Bungie news and updates to a channel

This is a highly requested feature. There is still some question as to where the info will come from though (tweets, RSS, etc.)

Raid stats

We will add this onto the existing stats command as !stats raid

Send private msg to event creator when someone accepts their event

Add Standby option to events

OAuth 2.0 registration

Moving to OAuth registration will allow for authenticated API calls. This will mean accessing players items and other information. It will also allow for easy access to all platforms a user plays on.

Raid stats command

Add a new !stats raid command that shows aggregate information about an account's raid stats.

Add help text to item command

Including emojis in event title or description causes event creation to fail

Paginate character loadouts

Currently, the loadout command only shows the last player character. To improve user experience, we can use paginator.py to allow for all characters to be displayed, similar to the item command.

Add clan command

The first iteration of the clan command should show information such as:

• Clan name and description
• Level and perks
• Number of members
• Engrams earned this week
• Weekly and overall XP progress

Item command doesn't display error message if no search terms are given

If no search terms are given, we should say something along the lines of: "Oops! You didn't specify a search term."

Add reaction to indicate event standby

Right now standby is only triggered if the event is full and a user accepts it. This should be changed so that a user can indicate that they would like to be on standby when the event still has room.

Edit events

Any plan for editing events?

Add !donate command

Deleting command "spam" messages is slow

This is due to the limitation of the API where messages can only be removed individually at a rate of 5 per second. It's possible that this issue could be overcome if purge_from() is used instead.