Skip to content

Latest commit

 

History

History
138 lines (99 loc) · 5.47 KB

README.md

File metadata and controls

138 lines (99 loc) · 5.47 KB
Raw

moebot

Teal Music

Teal Music is a powerful music Bot

Report Bug & Request Feature

🔥 Unique Features

  • Developed Discord.js v14
  • Advanced Music System
  • Customizable Prefix
  • Powerful Search Engine
  • 12 + Music Filters
  • Hybrid Command Handling (Slash and Normal Commands)
  • Highly Configurable
  • User-friendly and Easy to Use
  • 24/7 Music Playback
  • Playlist commands
  • Setup music channel

🎶 Support Sources

🔍 Default Sources:

  • YouTube
  • SoundCloud
  • Twitch
  • Bandcamp
  • Vimeo
  • http

🔌 Plugin Sources: (Require: LavaLink v4.0.x)

Note: You need to install the plugins to use these sources

🔧 Requirements

Before starting with the installation, you need to have the following:

🚀 Installation from source

  1. Clone the Teal Music repository:
git clone https://github.com/teal-discord/tealmusic-public.git
  1. change the directory to Teal Music
cd tealmusic
  1. Install the required packages:
npm i
  1. Set up your environment variables:

Create a .env file in the root directory of your project with the following variables:

BOT_TOKEN=
TOPGG_AUTHKEY=
DATABASE_URL=""
BOT_JOINS=channel-id
BOT_LEAVES=channel-id
BOT_ERRORS=webhook
  1. Run the bot:
npm start

📜 Contributing

Thank you for your interest in contributing to Teal Music! Here are some guidelines to follow when contributing:

  1. Fork the repository and create a new branch for your feature or bug fix.
  2. Write clean and concise code that follows the established coding style.
  3. Create detailed and thorough documentation for any new features or changes.
  4. Write and run tests for your code.
  5. Submit a pull request with your changes.

Your contribution will be reviewed by the project maintainers, and any necessary feedback or changes will be discussed with you. We appreciate your help in making Teal Music better!

🔐 License

Distributed under the GPL-3.0 license. See LICENSE for more information.

👥 Contributors

Thanks goes to these wonderful people : https://github.com/divyanshxd https://github.com/officialpiyush