korsinemi / tsuyo

🤖 A light-weight and easy-to-use modular Discord bot built with DiscordJS.

A light-weight, multi-purpose Discord bot built with Discord.js.

Features

• Currency/points system
• XP levelling
• Per-guild settings
• Fun games and commands
• Moderation and logging
• Helpful community and quality support

Installation:

A couple of dependencies you will need: NodeJS - A JavaScript runtime, it also has NPM built-in.

Once NodeJS is installed, install the npm dependencies in the windows command prompt.

• cd [folder where the package.json is]
• npm install

Now that the hard part is over, installation is a simple as a couple of clicks (and patience depending on your internet speed). Simply fork or download the repository and then execute this in the windows command prompt.

• cd [folder where bot.js is]
• node bot

Setting up the bot:

By default, the only thing you will need to edit in .env is the bot's token. If you're not sure on how to get a bot token, you can follow this tutorial made by our friends over at Reactiflux.

TOKEN=SEE-ABOVE-IF-NOT-SURE

Optionally, you can edit the other stuff too if you want to add DBL voting and server count and dashboard.

Setting up the dashboard with MongoDB

Setting up the dashboard is disabled by default, only follow these steps if you plan on hosting the dashboard.

1. Create a free account with MongoDB.
2. Create a new cluster using either premium or free plans.
3. After the cluster has been created, click connect.

4. Set up credentials and then click on Choose a connection method. Remember your <dbUser> and <dbUserPassword> values, we will be using them later.

5. Select Connect with the MongoDB shell.

6. Grab your <dbName> and <identifier> values from here, we will be using them shortly.

7. After MongoDB has been set up, navigate to your .env file located where the bot folder is and add the following line into it. Replace <dbUser>, <dbUserPassword>, <dbName> and <identifier> with the values you have set up with MongoDB. MONGODB_HOST=mongodb+srv://<dbUser>:<dbUserPassword>@<dbName>.<identifier>.mongodb.net/database?retryWrites=true&w=majority
8. Run the bot and the dashboard should be running.

Contributing guidelines:

You can find information on editing files, pull requests, merge requests and issues here.

Don't want to host the bot yourself?

We have a public instance of the bot which you can add to your Discord here.

Having problems?

Why not join the official Tsuyo Bot Support Discord? With lots of things to do and loads of members to chat with, it's one of the most friendly places on the internet... sorta.