Skip to content

CharmingDays/Kurusaki

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

83 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Kurusaki

A multipurpose discord bot.

You will need python version 3.11 for wavelink v3+ to be properly installed.

Installing/Setting up Lavalink server.

You will need lavalink version 4+ for this to work.

Open application.yaml file inside the lavalink/ folder and adjust customize the settings to your needs.

Next just run the server by using the command java -jar Lavalink.jar You can also specify max and min memory usage via -Xmx (max memory usage) or -Xms (min memory start up usage)

Running the Discord bot

To run the discord bot, simply start the kurusaki.py file
python3 kurusaki.py

Cogs

Currently these are the "working" cogs for the bot

[
    'Cogs.member',
    'Cogs.help',
    'Cogs.music',
    'Cogs.utility',
    'Cogs.events',
    'Cogs.text_channel',
    'Cogs.minecraft'
]

WARNING:

Most commands will not work unless you setup a mongodb database which is free as this readme update.

Mongodb setup:

You can watch this video or following the instructions below.

Mongodb setup Video

  1. Create a free account at mongodb

  2. Create a cluster

    Give it a name, select the free one and add a tag and create the cluster.

    Make sure to create a Database named Discord-Bot-Database a collection named General and the documents required with _id matching the ones in the code.

  3. Connect to your new cluster and past the link into your bot's .env file by assigning it the key MONGO EX: MONGO=YOUR_MONGO_DB_CONNECTION_URL_WITH_PASSWORD

    NOTE: Make sure to replace <password> with your created password


Enter s.help to view the commands that he bot.

Visit kurusaki website for better documentation on how to use the bot

NOTE: This bot uses mongodb as it's database, so you will need to create one or modify the code to use other databases or remove the cloud database functions completely.

Releases

No releases published

Languages