tromodolo/kurisu

Discord bot written using eris.js library

Kurisu

Getting Started

Prerequisites

• Node.js
• Typescript 3.8 or above
• Mysql or Mariadb

Guide

In order to start the bot, you first need to configure the configurations found in data/config/.

Rename both config files and remove the example from the name.

bot-example.json -> bot.json

db-example.json -> db.json

Then fill out both configurations according to help below:

Bot Config

{
	"developers": [], // Array of objects containing name. Metadata for info command
	"developerIds": [], // Array of string ids. Metadata for info command
	"libraryVersion": "", // Version of eris used. Metadata for info command
	"color": "", // Required: Hex value for colour. Example: 0x7289da
	"xpMoneyEnabled": true, // Required: Whether or not xp is enabled to gain or not.
	"defaultPrefix": "", // Required: Default prefix to fall back to if not using custom
	"botToken": "", // Required: Discord API Bot token
	"devToken": "", // Only used if production is set to false in bot.ts
	"googleApiKey": "", // Required if you want to use any of google's services in the bot.
	"googleCustomSearchId": "" // Required if you want to use google command 
}

DB Config

{
	"databaseHost": "", // URL or ip for where the database is hosted. If it is on the same machine, it's likely localhost
	"databaseName": "", // Name of database to use
	"databaseUsername": "", // Username
	"databasePassword": "", // Password
	"databaseType": "" // At the moment, this needs to be set to "mysql", but in the future, maybe other types will be supported.
}

Once everything is filled out, building and running the bot is simply

npm install
tsc
node build/bot.js

If you want to set this up for production, setting it up with something like PM2 is recommended.

⛏️ Built Using

• Node.js
• Eris.js - Discord API Library

✍️ Authors

• @Tromodolo - Start of project and creator
• @CeruleanSong - Help with coding
• @Pixidesu - Made bot avatar

See also the list of contributors who participated in this project.

🎉 Acknowledgements

• @Kylelobo for creating templates for readmes which you can find Here