naozumi520 / sawayo

A discord bot that focus on osu! Commands.

Sawayo

Translations: Traditional Chinese 繁體中文

Sawayo, a discord bot for osu!
This is a dev personal repository of Sawayo bot.
Sawayo offical repository
Project progress
The bot is still in development, will need more time for the project.

Introduction

This bot is built on discord.js v12, commands like check osu!osu info or more.

Index

Setup

• Set-up & Preparation

Project-info

• Bot-commands
• Using-api
• Contributors
• Our discord
• To-do
• Donate

Set-up & Preparation

Clone the git project:

$ git clone https://github.com/Naozumi520/Sawayo.git

This project uses node and npm. Use the following command if you don't have them locally installed.

$ cd Sawayo/
$ npm install

Example gif

Before starting the bot, you will need to create a file called "config.json" under the root directory of the project.
You will also need to configure the emoji ID in emoji_config.json.

Sample config.json

{
     "token" : "8ld6ZJcDYNRFyswDaNotarealtokenls7UYkyUjHlGvMdg7X", 
     "apikey": "DkyUjHldyU6RFyNotarealtokenswDalkyUdyU6Y",
     "prefix" : "s!",
       "admin_role" : "754726868673946891",
 
     "activities": [
         { "type": "PLAYING", "text": "osu!" },
         { "type": "LISTENING", "text": "osu!memories 2" },
         { "type": "PLAYING", "text": "with circles" }
         ],
          "activities_Interval" : "6000",
          
"database": {
    "host": "localhost",
    "username": "root",
    "password": "",
    "database": "sawayo",
    "connectionLimit": 50
  }
}

Sample emoji_config.json

{
"error": "<:error:759791498279125042>",
"SSH": "<:SSH:759435267383361536>",
"SS": "<:SS:759435267181510736>",
"SH": "<:SH:759435267357540382>",
"S": "<:S_:759435267316252693>",
"A": "<:A_:759435267404070922>",
"hit50": "<:h50:759435458555412480>",
"hit100": "<:h100:759435459671359558>",
"hit300": "<:h300:759435458584510544>"
}

Once the preparation is done, the project directory should look like the following:

+ Sawayo
  + commands
    - commands1.js
    - commands2.js
    - commands3.js
    - commands4.js
  + files
    + images
     - Sawayo_banner.png
  + lib
    - database.js
  + node_modules
    - modules
  - index.js
  - package.json
  - config.json

To start the bot:

$ node index

 - start.bat     --start bot windows batch file
 - start-nodemon.bat     --start bot with nodemon batch file

Using api

• imageapi.js (^1.0.17)
• node-osu (^2.2.0)
• urban (^1.0.17)

Commands

User-profile:

 - osuset     --s!osuset <username>
 - std     --s!std <username>
 - taiko     --s!taiko <username>
 - ctb     --s!ctb <username>
 - mania     --s!mania <username>

Miscellaneous:

 - urban     --s!urban <words>
 - google     --s!google <things> <- Not work, will fix it soon

Admin-commands

 - mute     --s!mute <mentions_user> <time (could be 1s,1m,1h, 10000(ms))>
 - ban     --s!ban <mention_user> <reasons(Optional)>
 - kick     --s!kick <mention_user> <reasons(Optional)>

Contributors

veeeleven (v11)
Naozumi520
ItzTheLT

Our discord

• Naozumi#9929
• dragon.xml#1234
• TheLT#0157

Things need to do

More Commands.
Admin related stuff for Discord Server Moderations.

Feel free to contribute to this project.

Donate

v11: https://paypal.me/jammielannie