Skip to content

tryforge/ForgeLinked

Repository files navigation

ForgeLinked v2 🌋

Music made stronger with Lavalink for ForgeScript.


✨ Features

  • Simple and easy-to-use ForgeScript functions
  • Support for multiple event listeners
  • Support for different audio providers
  • Playlist & queue management
  • Lavalink v4 ready

📦 Installation

Install via npm, yarn, pnpm etc:

npm install @tryforge/forge.linked

🚀 Setup

First, import ForgeClient and ForgeLinked in your main file:

const { ForgeClient } = require('@tryforge/forgescript')
const { ForgeLinked } = require('@tryforge/forge.linked')
import * as dotenv from 'dotenv'
dotenv.config()

const lavalink = new ForgeLinked({
  nodes: [
    {
      id: "Public Lavalink Server",
      host: "lavalink.zack911.xyz",   // or your VPS IP/domain
      port: 443,
      authorization: "ZackIsSoCool", // ✅ must be 'authorization'
      secure: true
    }    
  ],
  playerOptions: {
    defaultSearchPlatform: "youtube"
  },
  events: ['linkedPlayerCreate', 'linkedPlayerDestroy']
})

const client = new ForgeClient({
  intents: [
    'Guilds',
    'GuildMessages',
    'MessageContent',
    'GuildVoiceStates'
  ],
  events: ['messageCreate'],
  extensions: [lavalink],
  prefixes: ['.']
})

client.commands.add({
  name: 'e',
  type: 'messageCreate',
  code: '$onlyForUsers[Not for you!;$botOwnerID] $eval[$message]'
})

client.login(process.env.BOT_TOKEN)

⚙️ Lavalink Configuration

Provide Lavalink server details inside nodes:

const lavalink = new ForgeLinked({
  nodes: [
    {
      id: "Main Node",
      host: "lavalink.example.com",
      port: 2333,
      authorization: "youshallnotpass",
      secure: false
    }
  ]
})

🔑 You can find public Lavalink nodes online or host your own.


💡 Tips

Default Search Engine

Set a default search engine in playerOptions:

const lavalink = new ForgeLinked({
  playerOptions: {
    defaultSearchPlatform: 'youtube'
  }
})

Available:

  • youtube
  • youtube music
  • soundcloud
  • spotify (if enabled)

📄 License

ForgeLinked v2 is licensed under the GPL-3 License. See LICENSE for more info.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published