thiemok / discord-playtime

Discord Bot that collects playtime statistics

discord-playtime

A discord bot intended to track playtime. Written for nodejs and based on discord.js.

Overview

This bot allows you and your guild to track which games are most popular and who plays the most. It allows you to view a overview of your guilds statistics as well as fetch stats per game or player.

Available commands are:

• Overview: Prints a summary of your guilds statistics
• UserStats : Prints detailed stats on the player with the given display name
• GameStats : Prints detailed stats on the given game
• Help

All commands are prefixed by your configured COMMAND_PREFIX

Setup

• clone the repo
• run yarn install
• copy config.json.default to config.json and fill in your options
• start the bot with yarn start and use the generated link to add the bot to your server

Running on Docker

• Use the following environment variables to configure the bot: DISCORD_TOKEN, MONGO_URL, COMMAND_PREFIX, mashapeKey, HEALTHCHECK, HEALTHCHECK_PORT

discord-playtime's Issues

Update dependencies

Fix flow libdefs for discrod.js and express

Libdefs for discord.js and express are incomplete, corresponding errors are for now supressed using // $FlowIssue but should be fixed in the future by either updating flow-typed or providing a fixed version go flow-typed

Docker healthcheck endpoint

Add a docker healthcheck endpoint

Random discord api disconnects without reconnect

The discord api will randomly disconnect after some time and fail to reconnect after this. This needs to be handeled.

Add tests for database.js

Empty db responses cause crash

Add placeholder images to embeds

Embed size varies between having an image set or not. A placeholder should be set if a command might set an image, but could fail to do so. For example when a user has no avatar set, or a games cover was not found.

Don't record very short sessions

Discard sessions that are less than one ore two minutes long

Add timeframes to commands

A user should be able to query statistics limited to the last [week, month, year]

Handle Stream titles

Stream titles will replace game names when a player is streaming, this needs to be considered

Add jest

Update Dockerfile to use babel build

Babel-register should not be used in production, so docker should use a babel build instead

Update readme

Extend readme and add examples for functionality

Rewrite to ES6

Allow mentions on !gtUserStats

//title

Refractor mongodb connection code

Mongodb connection code needs to be refractored. Mainly some form of connection pooling needs to be implemented

Graphing

A user should be able to generate and view a graph for his data

rich embed field size exceeded

Sometimes embed fields exceed the maximum field size of 1024 characters. the embed generator needs to handle this.

Add flow typings

Also track afk users while in game

Discord does not track gamepad inputs as activity for its away mechanism. This results in players using gamepads switching to away while still playing. Maybe those should also be tracked, on the other hand this would include legit away players with running games in the tracking

Use node logging

logging code should be refactored to use node logging facilities

Remove config.json configuration and switch to dotenv

This provides a unified configuration method for all platforms

Update dockerfile to use yarn

Command exportJSON uses deprecated functions

The command exportJSON uses the deprecated functions

EvaluatedPermissions#hasPermission
TextChannel#sendFile

This needs to be updated

Refactor message content generation

Message content generation is a major mess and needs a rewrite

Documentation Clarification

Can you clarify some details relating to how to properly setup the mongodb for this as well the processes relating to mashape API for IGDB?

If you can summarize, I'd be more than willing to submit a pull request with those steps more fleshed out in your readme.

Thanks!

Is this even still maintained? - Quite a lot of issues/requests

Issues such as:

(node:8980) UnhandledPromiseRejectionWarning: RangeError: RichEmbed field values may not be empty.
at RichEmbed.addField (/home/skyrider/discord/playtime/node_modules/discord.js/src/structures/RichEmbed.js:158:34)
at addFieldsToEmbed (/home/skyrider/discord/playtime/app/util/embedHelpers.js:122:16)
at /home/skyrider/discord/playtime/app/util/embedHelpers.js:149:12
at new Promise ()
at new F (/home/skyrider/discord/playtime/node_modules/core-js/library/modules/_export.js:36:28)
at generateEmbeds (/home/skyrider/discord/playtime/app/util/embedHelpers.js:135:17)
at /home/skyrider/discord/playtime/app/commands/gameStats.js:72:7
at
at process._tickCallback (internal/process/next_tick.js:188:7)
(node:8980) UnhandledPromiseRejectionWarning: Unhandled promise rejection. This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). (rejection id: 70)

Commands are required to be capitalized. (Eg, !overview doesn't work while !Overview does).

You can't use userstats on a userID, a clear copy/paste of his name is required. EG:

!UserStats @ Skyrider

Shows up:

: I could not find <@!133631162894516225> please use an existing username

Also an ignore feature would be nice. Spotify for example isn't a game.

Kind Regards,
Skyrider