kyleawayan/reina

the minimal discord bot

reina

a minimal discord.js bot ✨

disclaimer

this bot has no complicated permissions and stuff like that. reina is more for chill servers with some of your friends, not big servers. also, she is really early in development so there is some bugs that still need to be fixed.

features

• minimal bot that doesn't have any complicated permissions or setup
• music bot that uses discord-player
• easily install third-party commands straight through discord
• make your own commands easily and publish on github for others to download! check out the reina-command topic for more commands!

installation

set the environment variable discord to your bot token. after that, set another environment variable, id, to your discord user id (or whoever is going to have admin permissions to your bot). you can also make a .env file in the root directory to use dotenv. once your environment variable is set, you can start reina with npm start.

if you would like to run reina without having to keep anything open, i would recommend following this guide on how to setup reina with pm2: https://discordjs.guide/improving-dev-environment/pm2.html#installation.

if you are having issues, please refer to the—work-in-progress—debugging page. please submit an issue if you need help, or even want to describe your own fixes to add to the wiki.

usage

right now there are not many commands, but her "prefix" is reina. you could also use rey or rei. it's like speaking naturally to someone, so for example, a command can be reina play niki or rei play niki.

please refer to the wiki for a list of available commands. you can also list all the commands in discord by using reina help.

make your own commands

reina uses a dynamic command handler, so it's very easy to make your own commands. you can do so by creating a module in a folder called custom (you may need to create the folder), say for example, ping.js. here's an example ping module:

// ping.js
module.exports = {

  name: "ping",
  // the command, so to call this command it will be "reina ping"

  description: "say pong when someone says ping",
  // description to show in help command

  aliases: ["bruh"],
  // optional aliases

  usage: "",
  // optional usage example to show in "reina help" command.
  // note that it shows "reina <the command>" and then whatever you put here
  // so for example for this ping command, if there was something in the usage string,
  // it would show "reina ping <whatever you put for the usage>"

  execute(message, args) {

    // "message" returns info about the user, etc.
    // "arg" returns the arguments of the command in an array.

    message.channel.send("pong");

  },
};

lastly, you can run reina in debug mode by using npm run dev. this will restart reina whenever a file is changed using nodemon.

you can find out more on developing commands and publishing them on this wiki page.

credits

• discord-player for the discord.js music bot framework!
• the art background is from niki's album, Zephyr.

reina's Issues

running npm install after update removes dependencies from custom commands

if you run npm install and reina has custom commands, npm will remove the dependencies needed for custom commands

song stutters when adding something to queue

if a song is playing and a song is added to the queue with reina play, the song will freeze for a second. experiencing this on development pc and its much worse on a t3a.micro aws server.

song doesn't play entirely through

the song will just stop in the middle of playing. when asking reina to play again she will add the song to the queue but nothing will happen. the only way to reset the music module is to run reina stop but it doesn't fix anything.