Skip to content

Latest commit

 

History

History
92 lines (64 loc) · 3.91 KB

README.md

File metadata and controls

92 lines (64 loc) · 3.91 KB
Raw

Easy-Sounds Bot

Easy-Sounds Bot is a powerful Discord bot that allows users to set join sounds, delete sounds, rename sounds, and download and trim sounds from YouTube all from a text channel for a custom soundboard experience.

Features

  • Easy-to-Use Soundboard: Sounds are displayed as buttons in the designated channel, making it very easy to play sounds with a single click.
  • Set Join Sound: Users can set a custom sound to play when they join a voice channel.
  • Delete Sound: Administrators can delete sound files from the soundboard.
  • Rename Sound: Administrators can rename sound files.
  • Download and Trim from YouTube: Users can download and trim sounds from YouTube.
  • Upload Sounds Directly: Users can upload sound files directly to the designated text channel to add them to the soundboard.

Installation

  1. Clone the repository:

    git clone https://github.com/1JanPeters/easy-sounds.git
cd easy-sounds

  2. Create and activate a virtual environment:

    python3 -m venv venv
source venv/bin/activate

  3. Install the dependencies:

    pip install -r requirements.txt

  4. Copy the configuration template:

    • Copy config_template.json and save it as config.json.
    • Edit config.json and replace placeholders with your Discord bot token, guild ID, soundboard channel ID, and the full path to your sounds folder (e.g., /home/user/sounds, C:\Users\user\sounds).

Creating and Setting Up the Discord Bot

  1. Go to the Discord Developer Portal.

  2. Click on "New Application" and give it a name.

  3. Navigate to the "Bot" section on the left sidebar and click on "Add Bot". Confirm by clicking "Yes, do it!".

  4. Under the "TOKEN" section, click "Copy" to copy your bot token. This will be used in your config.json file.

  5. Enable the "MESSAGE CONTENT INTENT" in the "Privileged Gateway Intents" section.

  6. Retrieve your APPLICATION_ID:

    • On the "General Information" page of your application, copy the "Application ID".

  7. Generate your bot's invite link:

    • Use the following URL format, replacing APPLICATION_ID with your application's ID: 
      https://discord.com/oauth2/authorize?client_id=APPLICATION_ID&scope=bot&permissions=2150632448
    • Paste the generated URL into your browser, and invite the bot to your server.

  8. Retrieve your GUILD_ID:

    • Right-click on your server icon in Discord.
    • Click on "Copy ID".

  9. Create a text channel in your server for the soundboard and retrieve the SOUNDBOARD_CHANNEL_ID:

    • Right-click on the channel name.
    • Click on "Copy ID".

  10. Update your config.json file with the TOKEN, GUILD_ID, and SOUNDBOARD_CHANNEL_ID.

Usage

  1. Run the bot:

    python bot.py

  2. Use the following commands in Discord:

    • /setjoinsound sound_name: Set a sound to play when you join a voice channel.
    • /deletesound sound_name: Delete a sound file from the soundboard (admin only).
    • /rename "old" "new": Rename a sound file (admin only).
    • /ytdlsound -n name -l link -s start HH:MM:SS.sss -e end HH:MM:SS.sss: Download and trim a sound from YouTube. The -s (start) and -e (end) parameters are optional. If not provided, the entire audio will be used as the sound.

  3. Upload sound files directly to the soundboard:

    • Drag and drop your audio files (e.g., .mp3, .wav) into the designated text channel to add them to the soundboard.

Disclaimer

This bot allows users to download and trim audio from YouTube. Users are responsible for ensuring they have the right to download and use the content in accordance with YouTube's Terms of Service. The developers of this bot are not responsible for any misuse of the tool.

License

This project is licensed under the MIT License - see the LICENSE file for details.