🐍 Changes in 2.9.0

tip

This is a major release with braking changes. Please update your code accordingly.

Hello, here you will find information on what has changed and what you need to change when upgrading to version 2.9.0.

---

🛠️ How to update?

npm

npm update magmastream

pnpm

pnpm update magmastream

yarn

yarn upgrade magmastream

---

🔄 Changes

ManagerOptions

• plugins → enabledPlugins
• autoPlay → playNextOnEnd
• usePriority → enablePriorityMode
• replaceYouTubeCredentials → normalizeYouTubeTitles
• autoPlaySearchPlatform → autoPlaySearchPlatforms (array of AutoPlayPlatform)

NodeOptions

• secure → useSSL
• retryAmount → maxRetryAttempts
• retryDelay → retryDelayMs
• resumeStatus → enableSessionResumeOption
• resumeTimeout → sessionTimeoutSeconds
• requestTimeout → apiRequestTimeoutMs
• priority → nodePriority

PlayerOptions

• node → nodeIdentifier

---

✨ New Features

Queue Storage Options

Choose between Memory (default), JSON, or Redis for queue persistence.

• StateStorageOptions

New Manager Events

• PlayerRestored
• RestoreComplete

New Lyrics Events (with LavaLyrics plugin enabled)

• LyricsFound
• LyricsLine
• LyricsNotFound

Discord Client Wrappers

Added official support for

• discord.js
• Detritus
• Eris
• Oceanic
• Seyfert

NodeLink v2 Support

Fully integrated.

Lyrics Subscriptions

Live lyrics streaming when LavaLyrics is available.

Automatic Inactive Player Cleanup

Enabled by default

Backup Node Support

Check NodeOptions (isBackup, default ➔ false).

FilterChange added as a possible PlayerStateEventTypes.

---

⚖️ Fixes & Improvements

AutoPlay

Expanded to include more sources and fixed issues with reloading.

Track Restoration

Tracks now play correctly even if stored with an empty player state.

Last.fm API Key

Now optional instead of required.

Previous Track Handling

Respects ManagerOptions.maxPreviousTracks.

Player & Cluster Fixes

• player.moveNode() validates session token & endpoint.
• Manager.options.clusterId is now stored on each player.
• Duplicate PlayerDestroy event on disconnect removed.

State Management

• Player states are saved & cleaned on Manager.handleShutdown().
• Restore now works correctly after shutdown & restart.

Plugin Lifecycle

Loading/unloading works as expected.

Player Updates

• PlayerMove correctly updates PlayerOptions.voiceChannelId.
• player.setTextChannelId() updates PlayerOptions.textChannelId.
• player.setVoiceChannelId() updates PlayerOptions.voiceChannelId.

---

💬 Questions?

Join our Discord — we're happy to help.