Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pilgrimeru/pilzic
Pilzic is a feature-rich Discord bot that allows you to play music from various sources, manage your music queue, and enjoy a seamless music experience in your Discord server.
https://github.com/pilgrimeru/pilzic
deezer discord-bot discord-music-bot music-bot soundcloud spotify youtube
Last synced: 7 days ago
JSON representation
Pilzic is a feature-rich Discord bot that allows you to play music from various sources, manage your music queue, and enjoy a seamless music experience in your Discord server.
- Host: GitHub
- URL: https://github.com/pilgrimeru/pilzic
- Owner: Pilgrimeru
- License: mit
- Created: 2023-09-04T20:30:31.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-16T17:29:45.000Z (17 days ago)
- Last Synced: 2024-09-26T11:42:42.839Z (7 days ago)
- Topics: deezer, discord-bot, discord-music-bot, music-bot, soundcloud, spotify, youtube
- Language: TypeScript
- Homepage:
- Size: 253 KB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# Pilzic 🎵
**Pilzic** is a feature-rich Discord bot that allows you to play music from various sources, manage your music queue, and enjoy a seamless music experience in your Discord server. Whether you want to listen to tracks from YouTube, Spotify, Soundcloud, Deezer, or direct link, this bot has you covered.
## Features 🚀
- 🎵 **Multi-Media Control Buttons:** Easily control your music with interactive buttons.
- 🌐 **Multi-Language Support:** The bot supports both English and French.
- 🎶 **Source Variety:** Play music from YouTube, Spotify, Soundcloud, Deezer, and direct links.
- 📎 **Attachment Playback:** Enjoy the convenience of playing audio attachments.
- ⏱️ **Automatic Disconnect:** The bot will automatically disconnect if left alone in a voice channel.
- 🗨️ **Slash Commands and Prefix Commands:** Use either slash commands or traditional prefix commands for ease of use.
- 🧹 **Auto Message Cleanup:** Automatically remove bot messages for a cleaner chat experience.
- 💪 **Strongly Typed Code:** The bot is coded in TypeScript for robust and error-free operation.
- ⚡ **Asynchronous Operations:** Utilizes asynchronous operations extensively for accelerated bot responsiveness.
- 🤖 **Powered by discord.js and play-dl:** Utilizes popular modules to provide reliable functionality.
## Prerequisites 📋
Before running the bot, make sure you have the following:
- **Node.js:** Version 16.11.0 or higher.
- **Discord API Token:** Optionally, enable "Message Content Intent" in Discord Developer Portal.
## Installation 🛠️
To get started with the bot, follow these steps:
1. Clone this repository to your local machine.
2. Navigate to the bot's directory and run the following command to install dependencies:
```bash
npm install
```
3. Rename config.env.example to config.env and fill out the values:
```env
TOKEN = "" # your discord token
MAX_PLAYLIST_SIZE = 500 # Maximum number of music fetches per playlist
PREFIX = "!" # Command prefix
AUTO_DELETE = true # Set to true to automatically delete bot responses
LOCALE = "en" # Language setting, it must exist in the local folder
STAY_TIME = 30 # Duration before disconnection when the bot is alone
AUDIO_QUALITY = 0 # 0 = minimum, 2 = maximum
DEFAULT_VOLUME = 100 # Default volume setting [0;100]
MAIN_COLOR = "#69ADC7" # Main color for the bot
```
4. Start the bot with:
```bash
npm start
```
## Command List 📜
Click to expand the command list
- `-autoplay`: Enable automatic queue filling.
- `-help (h)`: Display all available commands and their descriptions.
- `-insert`: Add a song to the beginning of the queue.
- `-invite`: Send the bot's invitation link.
- `-jumpto (jump)`: Jump to the selected position in the queue.
- `-loop (l)`: Loop the currently playing music.
- `-lyrics (ly)`: Get the lyrics of the currently playing song.
- `-move (l)`: Move the music to loop.
- `-nowplaying (np)`: Display the currently playing song.
- `-pause`: Pause the currently playing music.
- `-ping`: Show the bot's ping.
- `-play (p)`: Listen to music from YouTube and other sources.
- `-previous`: Go back in the playback queue.
- `-queue (q)`: Display the playback queue and the currently playing song.
- `-remove (rm)`: Remove a song from the queue.
- `-resume (r)`: Resume playback of the paused music.
- `-search (sh)`: Search and select videos to listen to.
- `-seek`: Jump to a specific point in the currently playing music.
- `-shuffle`: Shuffle the queue.
- `-skip (s)`: Skip the currently playing song.
- `-stop`: Stop the music playback.
- `-uptime (up)`: Check the bot's uptime.
- `-volume (v)`: Adjust the volume of the currently playing music.
## Screenshot 📸
## License 📄
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
---
**Enjoy your music experience with Pilzic! 🎶**
If you have any questions, issues, or suggestions, please feel free to open an [issue](https://github.com/Pilgrimeru/Pilzic/issues) on this repository.