The Strongest Kazoo

A discord music bot with youtube support written in python
Explore the docs »

Get Started · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Strongest Kazoo is a discord bot with support for youtube videos, written in python 3.11 using discord.py 2.3.2

(back to top)

Built With

• 
• 

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

• poetry
• python

Installation

1. Clone the repo

   git clone https://github.com/HyScript7/StrongestKazoo.git

2. Install environment

   poetry install

3. Copy example.env as .env and set your token value
4. Run the app module

   poetry run python3 -m app

(back to top)

Usage

To use the bot, add your discord bot application to your server. Then re-run the bot to force commands to sync.

Afterwards, type / to view a list of avabiable commands.

(back to top)

Roadmap

• Youtube Support
  • Playlist Support
  • Metadata Cache
  • Fragmenting
    • Seemless fragmenting
    • Fragment Cache
• Spotify Support
  • ...
• Soundcloud Support
  • ...
• Playlists (Store and load your queue)
• Web UI

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.md for more information.

(back to top)

Contact

Your Name - @hyscript7 - [email protected]

Project Link: https://github.com/HyScript7/StrongestKazoo

(back to top)

Acknowledgments

• yt_dlp

(back to top)