flowabot

flowabot is a modular discord bot with a focus on osu! features. Instead of me explaining this with words, I'll just leave a demonstration video:

Jump to Installation.

Main Features

Fancy scorecards with unique information like a difficulty graph or unstable rate

Get an overview of your osu! stats

Render a video or picture of any osu! beatmap

Get a graph with the hardest parts of a beatmap

Get a graph of the bpm changes throughout a beatmap

You can find more features in the commands list.

Installation

Prerequisites

• Using Linux or macOS is recommended (No support for Windows, here's two unofficial guides to run it on Windows if you wanna try anyway: https://github.com/LeaPhant/flowabot/issues/9, https://pastebin.com/g6yuxCCf)
• Git (https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
• Node.js 14 or higher (https://nodejs.org/)
• node-gyp (https://github.com/nodejs/node-gyp#installation)
• Be sure to have gcc/g++ installed, e.g. sudo apt install build-essential on Ubuntu
• Discord bot token and client ID (https://discord.com/developers/applications/)
• osu!api key (https://osu.ppy.sh/p/api/)
• node-canvas dependencies (https://github.com/Automattic/node-canvas#compiling)

Setup

Clone the repo and enter the bot directory

git clone https://github.com/LeaPhant/flowabot.git
cd flowabot

Install all modules

npm i

Now you'll be able to use the configuration wizard.

npm run config

Follow the on-screen instructions, just press enter without typing anything for features you don't need.

You should be able to run the bot now.

npm start

If you provided a Discord client ID during the configuration you will receive an invite link to add the bot to your server.

Make the grade emojis work (S rank, A rank, etc.)

npm run emojis

This script will automatically upload the grade emojis to a server you'll have to pick. If there are no free emoji slots create a new server just for the bot to use its emojis from.

To keep the bot running in the background install pm2 and run

pm2 start npm --name flowabot -- start

To start the bot on system boot use

pm2 save
pm2 startup

(This is only tested on Linux)

Patrons

Thanks to anyone supporting me on Patreon, especialy the following peeps who decided to leave $5 or more per month 😳

WitchOfFrost