🦊 “YAE — Your All-in-one Discord Music Companion” 🌸

📋 Prerequisites

Before awake Yae, make sure you have the following installed:

• 😸 Git – Version Control
• ⚡ Bun – super fast JavaScript/TypeScript runtime
• 🐳 Docker – required for running Lavalink audio server
• 🔑 Discord Bot Token – create a bot in Discord Developer Portal

🚀 Getting Started

💻 Installation

Clone the project

git clone https://github.com/OuOSama/YAE-BOT.git yae

Go to the project directory

cd yae

Install dependencies

bun install

Setup Lavalink and Yae

📝 Configuration

To run this project, copy .env.example into the root project directory and rename it to .env.local.

⚠️ Important: Make sure to fill in all required values inside .env.local before running the project.

Make sure your .env.local contains:

# 🔑 Discord Bot Token
TOKEN       = your_discord_bot_token

# 🎵 Lavalink Config
HOST        = localhost
PASSWORD    = youshallnotpass
PORT        = 2333
SECURE      = false

and then

bun run lavalink-setup

Awake YAE!

bun run dev

🎯 Usage

Once Yae is running, invite the bot to your Discord server and use the following commands:

Command	Description
/play <song>	🎵 Play a song
/pause	⏸️ Pause current track
/resume	▶️ Resume playback
/stop	⏹️ Stop playback and clear queue
/destroy	🗑️ Destroy music player

🛠️ Built With

• Bun - Runtime environment
• Seyfert - Discord Framework
• Lavalink - Audio delivery system
• Docker - Containerization

🤝 Contributing

Contributions are always welcome!

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

📄 MIT License

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

👨‍💻 Authors

• @OuOSama - Initial work & Development

🙏 Acknowledgments

• Thanks to the Lavalink team for the amazing audio server
• Seyfert community for the excellent documentation
• All contributors who help improve Yae

YAE Sama!