Kiyo Discord Bot

A versatile Discord bot packed with moderation, entertainment, and utility commands to enhance your server experience. Originally designed and tailored for the TKOD Discord server, Kiyo offers a wide range of features to manage and engage your community.

✨ Features

• Moderation: Commands to help moderators manage the server effectively (e.g., ban, kick, mute, warn). (Add specific moderation features here)
• Entertainment: Fun and engaging commands to keep users entertained (e.g., games, image commands, meme generation). (Add specific entertainment features here)
• Utility: Useful tools and commands to provide information and enhance server functionality (e.g., weather, calculator, search, YouTube info). (Add specific utility features here)
• YouTube Subscriber Roles: Automatically assign roles to users based on their YouTube subscriber counts, encouraging community engagement.
• And more! Explore the commands to discover all the features Kiyo has to offer.

🛠️ Requirements

• Node.js: version 18.0.0 or higher (Download Node.js)
• npm: (usually comes with Node.js) or any other Node.js package manager like yarn or pnpm

🚀 Installation

Get Kiyo up and running in a few simple steps:

1. Clone the repository:

   git clone https://github.com/KIO2gamer/project-kiyo.git
   cd project-kiyo

2. Install dependencies:

   npm install

3. Configuration:

   • Create a .env file in the root directory of the project.
   • Add the necessary environment variables as listed below. Ensure you replace the placeholder values with your actual credentials and IDs.

   DISCORD_TOKEN=your_discord_token
   IGDB_CLIENT_SECRET=your_igdb_client_secret
   DISCORD_CLIENT_SECRET=your_discord_client_secret
   MONGODB_URI=your_mongodb_uri
   DISCORD_REDIRECT_URI=your_discord_redirect_uri
   GOOGLE_SEARCH_ENGINE_ID=your_google_search_engine_id
   IGDB_CLIENT_ID=your_igdb_client_id
   DISCORD_CLIENT_ID=your_discord_client_id
   DISCORD_GUILD_IDS=your_discord_guild_ids
   GOOGLE_API_KEY=your_google_api_key
   YOUTUBE_API_KEY=your_youtube_api_key
   PEXELS_API_KEY=your_pexels_api_key
   WEATHER_API_KEY=your_weather_api_key
   TENOR_API_KEY=your_tenor_api_key
   GIPHY_API_KEY=your_giphy_api_key
   MUSIXMATCH_API_KEY=your_musixmatch_api_key
   GEMINI_API_KEY=your_gemini_api_key
   

   Important: Keep your .env file secure and do not commit it to your Git repository if it contains sensitive information. It's already in .gitignore, but double-check!

4. Start the bot:

   npm start

   The bot should now be online and ready to use in your Discord server.

☁️ Deployment

Get your own instance of Kiyo deployed!

1. Initialize Git (if not already done):

   git init
   git add .
   git commit -m "Initial commit"

2. Connect to your remote repository:

   git remote add origin https://github.com/KIO2gamer/project-kiyo.git
   git branch -M main
   git push -u origin main

3. Deploy to Netlify (Recommended):

   • The easiest way to deploy Kiyo is using Netlify.

   • Netlify Badge: The badge at the top of this README shows the deployment status on Netlify.

   • Steps:

     1. Sign up or log in to Netlify.
     2. Click "Add new site" -> "Import an existing project".
     3. Connect your GitHub repository where you pushed the code.
     4. Build settings (Important):
        • Build command: npm run build (If you have a build process, otherwise leave it blank or adjust accordingly)
        • Publish directory: dist (Or your build output directory if applicable)
        • Functions directory: netlify/functions (If you are using Netlify Functions)
     5. Environment variables: In Netlify's site settings, add all the environment variables you configured in your .env file.
     6. Click "Deploy site".

   • Netlify will automatically build and deploy your bot. Any future pushes to your main branch will trigger automatic redeployments.

   • Alternative Deployment Platforms: You can also deploy Kiyo to other platforms like:

     • Heroku
     • AWS EC2
     • Google Cloud Compute Engine
     • DigitalOcean
     • (Add links and basic instructions for other platforms if you want to support them)

🤝 Contributing

Contributions are welcome and greatly appreciated!

• Bug Reports: If you find a bug, please open an issue on GitHub to report it.

• Feature Requests: Have a great idea for a new feature? Open an issue to discuss it.

• Pull Requests: If you want to contribute code:

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix (git checkout -b feature/your-feature-name).
  3. Make your changes and commit them (git commit -m 'Add some feature').
  4. Push to your branch (git push origin feature/your-feature-name).
  5. Submit a pull request.

  For major changes, please open an issue first to discuss what you would like to change and ensure it aligns with the project goals.

📜 License

This project is licensed under the MIT License. See the LICENSE.md file for details.

---

Made with ❤️ by KIO2gamer and contributors