Kythia Hye-Jin is more than just a bot; she's your sweet, cute, and beautiful companion, designed to bring life and order to your Discord server!

Report a Bug · Request a Feature

Powered by the following technologies:

Kythia is packed with a massive amount of features, all organized into a clean, modular addon system. This means you can easily enable or disable features to tailor the bot to your server's specific needs.

Here's a glimpse of what Kythia has to offer:

• Advanced Moderation: A full suite of moderation commands, including ban, kick, mute, warn, clear, and more.
• Automod: Automatically delete messages containing spam, bad words, or other unwanted content.
• Logging: Keep track of everything that happens on your server with detailed logs for message deletions, member joins, and more.
• Customizable Settings: Configure the bot's prefix, welcome messages, and other settings to your liking.
• Powerful Tools: A variety of tools to help you manage your server, such as sticky messages, embed builders, and hash crackers.

• Adventure Game (adventure): Embark on an epic text-based adventure, fight monsters, and collect loot!
• Economy System (economy): Earn virtual currency, rob your friends, and gamble your way to riches.
• Music (music): Listen to your favorite tunes with a feature-rich music player.
• Pets (pet): Adopt and raise your own virtual pet.
• NSFW (nsfw): For the more... adventurous servers.
• And more! Including fun games, giveaways, and streaks.

• Ticket System (ticket): A complete ticket system to help you manage user support requests.
• Suggestions (suggestion): Allow users to submit suggestions and vote on their favorites.
• Clan System (clan): Create and manage clans for your server members.
• Leveling System (leveling): Reward your users for their activity with a customizable leveling system.
• And much more! Including invite tracking, server templates, and pterodactyl integration.

Kythia comes with a huge collection of addons, including:

• ai
• checklist
• dashboard
• minecraft
• nuke
• store
• testimony

...and the list is always growing!

There are many Discord bots out there, but Kythia stands out from the crowd. Here's why:

• 🤖 Modular by Design: Kythia is built on a powerful addon system, allowing you to enable only the features you need. This keeps the bot lightweight and efficient.
• ✨ Feature-Rich: With a massive collection of addons, Kythia offers a huge range of features, from advanced moderation to fun games and a full-fledged economy system.
• 🔧 Fully Customizable: Almost every aspect of Kythia can be configured to your liking. From custom welcome messages to fine-tuned automod settings, you're in control.
• 🚀 Actively Developed: Kythia is constantly being improved with new features, bug fixes, and performance enhancements.

Ready to bring Kythia to your server? Here's how to get her up and running.

Before running this bot, please ensure you have the following installed:

1. Node.js (Node 22 LTS recommended)
2. npm (Usually included with Node.js)
3. A Discord bot token from the Discord Developer Portal
4. Database such as MySQL, PostgreSQL, MSSQL installed
5. Optional PM2 for 24/7 hosting run npm install pm2 -g

Ensure you have the following software installed:

1. Node.js

   • Download and install Node.js.
   • Verify installation in your terminal:

     node -v
     npm -v

     If both versions are displayed, installation was successful.

2. Discord Bot Token

   • Visit the Discord Developer Portal.
   • Click New Application, name your bot, and create it.
   • Navigate to the Bot tab, click Add Bot, and copy your bot token.

1. Ensure you are in the project root directory.
2. Install the required libraries:

   npm install

3. Wait until all dependencies are installed.

1. Copy and rename example.env to .env file in the project root directory.
2. Copy and rename example.kythia.config.js to kythia.config.js
3. Configure Your Bot Open the .env and kythia.config.js files. Both files contain detailed comments to guide you in filling out all the required values.

1. Ensure all configurations are correct.

2. Choose how you want to run the bot:

   • For a quick test (in foreground):

     npm start

     (Press ctrl + c to stop the bot)

   • For 24/7 Hosting (Recommended):

     # Run this command ONLY ONCE for the very first time.
     # It will start the bot and save it to PM2's process list.
     npm run pm2:startup

     (To manage the bot later, use commands like npm run pm2:stop or npm run pm2:restart)

3. If the bot starts successfully, you will see a message such as:

   ✅ Logged in as Kythia#9135

4. Check the terminal for any errors.

5. If there are no errors, the bot is running and ready for use.

6. If errors occur, review the relevant files for troubleshooting.

1. Return to the Discord Developer Portal.
2. Select your application, then go to the OAuth2 > URL Generator tab.
3. Select the bot scope and add the necessary permissions (e.g., Manage Roles, Send Messages) but administrator recommended.
4. Copy the generated URL and open it in your browser to invite the bot to your server.

1. Open your Discord server where the bot has been invited.
2. Type /ping, /help or /about to check the bot's response.
3. Enjoy using Kythia!

Once Kythia is in your server, you can start using her commands. All commands are slash commands, so just type / to see a list of available commands.

Here are a few commands to get you started:

• /help: Shows a list of all available commands.
• /ping: Checks the bot's latency.
• /serverinfo: Displays information about the server.
• /userinfo: Displays information about a user.

For a full list of commands and their detailed usage, please see the Command Documentation.

Kythia comes with a powerful command-line interface (CLI) tool inspired by Laravel's Artisan. The CLI centralizes all project management scripts and makes it easy to perform common development tasks.

Starts the Kythia bot.

npx kythia start
npx kythia start --deploy  # Start with slash command deployment

Deploys slash commands to Discord.

npx kythia deploy

Starts the bot with PM2 and saves the process list for automatic startup.

npx kythia pm2 startup

Starts the bot with PM2.

npx kythia pm2 start

Restarts the bot process in PM2.

npx kythia pm2 restart

Stops the bot process in PM2.

npx kythia pm2 stop

Removes the bot process from PM2.

npx kythia pm2 delete

Shows PM2 logs for the bot.

npx kythia pm2 logs

Flushes the Redis database. ⚠️ USE WITH CAUTION! This will delete all data.

npx kythia db flush

Seeds the database with initial data.

npx kythia db seed

Generates documentation for all commands.

npx kythia docs generate

Runs the full build process: upversion, documentation generation, and code obfuscation.

npx kythia build build

Obfuscates the code for production deployment.

npx kythia build obfuscate

Updates the version number across the project.

npx kythia build upversion

Runs the test suite using Jest.

npx kythia test test

Formats all JavaScript and JSON files using Prettier.

npx kythia format format

Prepares Husky git hooks.

npx kythia husky prepare

Runs the check_e.js script.

npx kythia check e

Runs the check_t.js script.

npx kythia check t

Runs the refactor_t.js script.

npx kythia refactor t

Adds namespace to files.

npx kythia add namespace

Generates project structure documentation.

npx kythia gen structure

Audits command permissions across the project.

npx kythia audit permissions

Creates a new command file in the specified addon.

Arguments:

• <addon>: The name of the addon (e.g., core, economy, music)
• <name>: The name of the new command (e.g., my-command)

Example:

npx kythia make:command core test-command
npx kythia make:command economy daily-reward

This will create a new command file with a template that includes:

• Proper namespace annotation
• SlashCommandBuilder setup
• Basic execute function
• Copyright and version information

• Help Command: Use --help or -h with any command to see detailed usage information:

  npx kythia --help
  npx kythia start --help

Contributions to Kythia are managed by the internal development team. If you are a member of the team and would like to contribute, please follow the established development workflow.

• 🐛 Reporting Bugs: If you find a bug, please report it to the team through the designated channels. Be sure to include as much detail as possible, including steps to reproduce the bug.
• 💡 Suggesting Features: Have an idea for a new feature? We'd love to hear it! Please share your suggestion with the team.

This project is licensed under the CC BY-NC 4.0 License. See the LICENSE file for details.

Need help or want to connect with other Kythia users? Join our community!

• 🌐 Website: kythia.my.id
• 💬 Discord Server: dsc.gg/kythia
• 📧 Email: [email protected]