Code Monkey home page Code Monkey logo

pippitrack's Introduction

cover

GitHub Workflow Status (branch)

PippiTrack

A Discord bot that allows you to track osu! things. It has some useful commands too.

How do I report a bug or request a feature ?

How do I use PippiTrack ?

See documentation at https://pippitrack.com/

Get started

For users

Start by linking your Discord account to an osu! username like so :

/link <username> <mode>

See all commands

For administrators

After inviting the bot to your server, you need to configure it.

/configure

configure

Track a user (top plays, weekly updates and replays) You can track up to 100 players.

/track <username>
/untrack <username>
/tracklist <?page>

List of commands

Update an osu! profile via osu!track

/update <?username>

update

Display peak rank and accuracy of a player

/score <?username>
/gifted <?username>
/peak <?username>

peak

Display your profile stats via osu!sig

/osu <?username>

osusig

Tracking

Top plays (Need polish)

top play tracking

Updates

Tracked players are queued for an automatic osu!track update. (Once a day)

mass updates

Replays (o!rdr)

Tracked players that use o!rdr will have their replays sent in the replay channel. (if set)

replays

Installation

Have Node.js (version 16.8.x or newer) installed.

npm install

Then copy the .env.example to .env and fill in the values.

To run the bot in development mode run :

npm run dev

To run the bot in production mode run :

npm run build && npm run start

Directory structure

src/commands

Commands are classes that exports a run method and several properties.

class Command {
  name = 'command-name' // !command-name
  arguments = ['username'] // Accepted arguments for the command !command-name <username>
  description = 'Description of the command' // Used for the !help command
  category = 'general'

  async run(message, args) {}
}

src/services

Services needs to export a function that triggers the service (running a cron job, etc)

src/Bot.js

The Bot.js file is used for the internal logic of the bot. We'll add listeners to the bot's events and handle the commands.

Credits

Services

Art

  • AKARA Thank you for the art ! (Badges cover of the !peak command)
  • Bouf for the name PippiTrack and the edit of Koigokoro avatar !

License

MIT

pippitrack's People

Contributors

dependabot[bot] avatar jeremymorel-dev avatar keziahmoselle avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

pippitrack's Issues

Configure track gives "Sorry there was an error"

I tried to configure Replay Tracking and set it to a text channel, but the bot returns
"Sorry there was an error"
but also
"Replay tracking" set in this channel.

image

command track still can't be used

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.