Giter Club home page Giter Club logo

akane's Introduction

Akane Discord Bot


Akane Discord Bot
A multipurpose Discord bot, developed with โค by XSaitoKungX

Discord Server GitHub Documentation Dashboard

Welcome ๐Ÿ‘‹

Welcome to the Akane Discord Bot! The Akane Discord Bot is a versatile and customizable bot designed to enhance your Discord servers. With a wide range of features and commands, this bot provides a fun and useful experience for your community.

Description ๐Ÿ“š

The Akane Discord Bot is a powerful and user-friendly bot developed to add functionality to your server and improve your community's Discord experience. With a wide range of features, including slash commands and simple music commands, Akane is the perfect addition to any Discord server.

Features

  • ๐Ÿค– Versatility: The bot offers a wide range of features, from entertainment to moderation, to provide diverse capabilities to your server.

  • ๐Ÿ“ˆ Dashboard: Conveniently manage the bot through a user-friendly dashboard. Customize settings, monitor activities, and maintain control.

  • ๐Ÿ“Š Polls: Utilize the poll feature to create custom polls and gather opinions from your server members. Ideal for collaborative decision-making.

  • ๐Ÿ–ผ๏ธ Image Captioning: Personalize your images by adding text captions. Add a personal touch to your graphics.

  • ๐ŸŽต Music Bot: Enjoy the ability to play music in voice channels and control playback as you wish. Become the DJ on your server.

  • ๐Ÿ›ก๏ธ Moderation: Maintain control of your server and create a pleasant atmosphere with integrated moderation commands. Protection and order come first.

  • ๐Ÿ’ฐ Economy System: Give your server an economy with its own currency system. Reward activities and create an interactive community experience.

  • ๐Ÿ’Œ Invites System: Keep track of members who invite new members to your server. A useful tool to encourage participation.

  • ๐ŸŽซ Ticket System: Provide your members with an easy way to get support or assistance by implementing a ticket system. Efficient and organized.

  • โš™๏ธ Customizability: Customize the bot to your specific needs by adding additional custom commands. Make the bot your own.

  • And much more... The possibilities are endless, allowing you to further expand the bot and make your server truly unique.

Features ๐Ÿš€

  • Prefix
  • Slash Commands

To-Do ๐Ÿ“

  • Automoderation
  • Custom Commands
  • Advanced Music Commands
  • Leveling System
  • Poll System
  • Music
  • Ticket System
  • Suggestions
  • Reaction Roles
  • Family Features
  • Contests
  • Dashboard
  • Don't want to host the bot yourself?

Before you can use Akane, make sure you meet the following requirements:

  • Install Visual Studio Code
  • Node.js v16 or higher
  • Discord.js Library: The bot's functionality is based on the Discord.js library. Install it through Node.js with the command: npm install discord.js@latest.
  • You need a Discord bot token. Create your own bot on the Discord Developer website and copy the token.
  • MongoDB (Required)

Locales ๐ŸŒŽ

Currently available locale schemes are:

  • German (de-DE)
  • English (en-US)

Installation Guide ๐Ÿ

Follow these steps to install Akane on your server:

  1. Fork the Repository
  2. Clone your fork: git clone https://github.com/your-username/Akane.git
  3. Create a feature branch: git checkout -b my-new-feature
  4. Stage your changes: git add .
  5. Commit your changes: Use cz or npm run commit, but not git commit
  6. Push your branch: git push origin my-new-feature
  7. Create a pull request

Statistics ๐Ÿ“Š

Package Private

๐Ÿค– Bot Configuration

๐Ÿ” config.yml:
- Fill in the `token` and `guild` fields with your Discord Developer Portal information.
- Customize general settings such as bot name (`name`), prefix (`prefix`), and currency symbol (`currency_symbol`).
- Configure database settings if you're using one.
- Customize addons, server settings, and more according to your requirements.

๐Ÿ“ commands.yml:
- In this file, you can configure bot commands, including required roles, descriptions, and aliases. Adjust command configurations to suit your needs.

๐ŸŒˆ embeds.yml:
- Here, you can set the colors for embeds using color names (e.g., "Red," "Green") or HEX values (e.g., "#f1f1f1," "#dddddd"). Use `\n` to add new lines within embeds when necessary.

๐Ÿ“œ language.yml:
- This file allows you to customize bot messages and text. Modify the text to ensure it aligns with your server and requirements.

๐Ÿš€ Getting Started
--------------------------------
- Once you've configured these files, save them in your bot project directory.
- Ensure all required dependencies and libraries are installed.
- Start your bot by running the appropriate launch script.
- Verify that your bot is set up correctly on your Discord server with the necessary permissions.

๐Ÿ“– Note
--------------------------------
This is a general guide for configuring a Discord bot. The specific steps may vary depending on the bot development platform or framework you're using. Consult the documentation of your specific bot and framework to ensure everything functions correctly.

Contact

Contributors ๐Ÿค

User Profile ๐Ÿง‘โ€๐Ÿ’ผ

๐Ÿ”ฅโ”†Github Stats

profile languages

License ๐Ÿ“

This project is licensed under the MIT License.

The MIT License is an open-source license that allows you to use, modify, and distribute the project in your own projects as long as you comply with the license terms. For more information, refer to the license file.

MIT License

Copyright (c) [2023] [XSaitoKungX]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

ยฉ 2023 XSaitoKungX | Developed with โค๏ธ and code

akane's People

Contributors

xsaitokungx avatar

Watchers

 avatar

Forkers

dimanext-1996

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.