FerraLink Example — Discord Music Bot Template (Lavalink, Spotify, YouTube)

A ready-to-use Discord music bot template built with FerraLink, discord.js v14, and Lavalink. Stream music from Spotify, YouTube, and SoundCloud in your Discord server with high-quality audio and simple setup.

---

Table of Contents

• About This Project
• Features
• Requirements
• Installation
• Configuration
• Commands
• Tech Stack
• Documentation & Support
• Author & Contact
• License

---

About This Project

FerraLink Example is an open-source Discord music bot starter template. It uses the FerraLink Lavalink client wrapper to connect your bot to a Lavalink node and play music from multiple sources. Ideal for developers who want to run a Discord music bot with Spotify, YouTube, and SoundCloud support without building the audio stack from scratch.

Use cases: Discord server music, radio bots, playlist management, voice channel entertainment.

---

Features

• Multi-source playback — Spotify, SoundCloud, and YouTube
• High-quality audio — Powered by Lavalink
• Modern stack — discord.js v14, Node.js 16+
• Simple setup — Single config file, clear structure
• Rich controls — Play, pause, skip, shuffle, volume, queue
• Auto events — Now playing embeds, queue end handling

---

Requirements

• Node.js 16.x or higher
• A Discord Bot (Developer Portal)
• A Lavalink server (self-hosted or public node)
• Spotify API credentials (optional, for Spotify support)

---

Installation

1. Clone the repository

   git clone https://github.com/KuchikiRenji/Ferralink-Example.git
   cd Ferralink-Example

2. Install dependencies

   npm install

3. Configure the bot — Edit config.js (see Configuration).

4. Run the bot

   npm start

---

Configuration

Edit config.js with your bot token, prefix, Lavalink node, and optional Spotify credentials.

module.exports = {
    prefix: "Your bot prefix",
    token: "Your bot token",
    nodes: [{
      name: "lavalink",
      url: "localhost:2333",
      auth: "youshallpass",
      secure: false
    }],
    shoukakuOptions: {
      moveOnDisconnect: false,
      resumable: false,
      resumableTimeout: 60,
      reconnectTries: 10,
      restTimeout: 60000
    },
    spotify: {
        clientID: "Your spotify clientID",
        clientSecret: "Your spotify clientSecret"
    }
};

Option	Description
prefix	Command prefix (e.g. !, ?)
token	Discord bot token
nodes	Lavalink node(s) (url, auth, secure)
shoukakuOptions	Shoukaku/Lavalink client options
spotify	Spotify app client ID and secret

---

Commands

Command	Description
play	Play a track or playlist from URL or search
pause	Pause playback
resume	Resume playback
skip	Skip current track
stop	Stop playback and clear queue
volume	Set or show volume
shuffle	Shuffle the queue
nowplay	Show currently playing track
disconnect	Disconnect bot from voice channel
help	Show command list

(Exact command names depend on your prefix in config.js.)

---

Tech Stack

• Runtime: Node.js 16.x
• Discord API: discord.js v14
• Music / Lavalink: FerraLink, Shoukaku connectors
• Sources: Spotify, YouTube, SoundCloud (via FerraLink/Lavalink)

---

Documentation & Support

• FerraLink documentation: GitBook
• FerraLink support server: Discord

---

Author & Contact

KuchikiRenji

• GitHub: KuchikiRenji
• Email: KuchikiRenji@outlook.com
• Discord: kuchiki_renji

For questions, suggestions, or contributions related to this example project, reach out via GitHub issues or the contact above.

---

License

This project is open source and available under the MIT License.

---

Discord music bot • Lavalink • FerraLink • Spotify • YouTube • SoundCloud • discord.js • Node.js