SYNCHRO

This is the official repository for Synchro Discord Bot. Let the public of a voice channel be the dj of it, by playing music through Synchro. Explore the docs » View Demo · 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

About The Project

Synchro is an open-source project that started as a community bot designed to replace Rythm, following its ban request from Youtube. Synchro is aiming to be deployed by the people for the people ! Any pull request or issue is welcomed !

(back to top)

Built With

This project has been built with the following prerequisites

• C# .NET Core 3.1
• Discord.net
• YoutubeExplode
• python3
• yt-dlp

(back to top)

Getting Started

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

Prerequisites

Please install the following required tools and frameworks:

• Ubuntu

    sudo apt-get install python3 python3-pip libsodium-dev opus-tools &&
    python3 -m pip install -U yt-dlp &&
    ...
    

Installation

1. Create an application on Discord developer portal ! https://discord.com/developers/applications
2. Clone the repo

   git clone https://github.com/LilianSchall/Synchro.git

3. In the repo, compile the project.

   dotnet publish -c Release

4. Add the token to your environnment as following:

   export DISCORDTOKEN="your_token"

5. Run the bot !

dotnet run

(back to top)

Usage

When your Synchro is finally ready, type ;help in your channel to see the current command available !

(back to top)

Roadmap

• [✅] Work on docker containerization
• [✅] Add whitelist channel command
• [] Work on CI
• [✅] Add remove from queue command
• [✅] Work on queue bug

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

(back to top)

Contributing

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/SynchroFeature)
3. Commit your Changes (git commit -m 'Adding features to Synchro !')
4. Push to the Branch (git push origin feature/SynchroFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the GPL 3.0 License. See LICENSE.txt for more information.

(back to top)

Contact

Lilian Schall - @LilianSchall

Project Link: https://github.com/LilianSchall/Synchro

(back to top)