Ferralink-Example

KO | EN

gitlite — search

#python #ai #typescript #deep-learning #linux #docker #macos #java #nodejs #awesome #kubernetes #security #mcp #openai

Ferralink-Example

(★ 1)

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.

Ferralink-Example Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

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

**A ready-to-use Discord music bot template** built with [FerraLink](https://www.npmjs.com/package/ferra-link), [discord.js](https://discord.js.org/) 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](#about-this-project)
- [Features](#features)
- [Requirements](#requirements)
- [Installation](#installation)
- [Configuration](#configuration)
- [Commands](#commands)
- [Tech Stack](#tech-stack)
- [Documentation & Support](#documentation--support)
- [Author & Contact](#author--contact)
- [License](#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](https://discord.com/developers/applications))
- A **Lavalink** server (self-hosted or public node)
- **Spotify API** credentials (optional, for Spotify support)

---

## Installation

1. **Clone the repository**
   ```bash
   git clone https://github.com/KuchikiRenji/Ferralink-Example.git
   cd Ferralink-Example
   ```

2. **Install dependencies**
   ```bash
   npm install
   ```

3. **Configure the bot** — Edit `config.js` (see [Configuration](#configuration)).

4. **Run the bot**
   ```bash
   npm start
   ```

---

## Configuration

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

```js
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](https://ferralink.gitbook.io/untitled/)
- **FerraLink support server:** [Discord](https://discord.gg/8n3yNqtPAE)

---

## Author & Contact

**KuchikiRenji**

- **GitHub:** [KuchikiRenji](https://github.com/KuchikiRenji)
- **Email:** [KuchikiRenji@outlook.com](mailto: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*

Ferralink-Example

Ferralink-Example Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Ferralink-Example

Ferralink-Example Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README