Music Trigger

Overview

This mod allows you to play a custom music track when an FTB Quest is completed. Usage is as follows:

// kubejs/server_scripts/example.js

/**
 * Play music upon quest completion
 * 
 * @param {string} questLinkObjectId - The quest ID (can be copied from the quest UI)
 * @param {string} fileName          - Name of the audio file .mp3, .wav, or .flac (must be in config/music_trigger/audio/)
 * @param {number} volume            - Playback volume, range: [0.0, 1.0]
 * @param {string} scope             - Playback scope ("self", "nearby", or "all")
 * @param {boolean} stopVanillaMusic - Whether to suppress vanilla Minecraft background music while playing (may cause unexpected behavior)
 */

MusicTriggerEvents.registerMusicTriggers(event => {
    // Basic usage: play music for all players when the quest is completed
    event.register("#67C8AAFC31D6F28B", "victory.mp3", 1.0);

    // Advanced usage: only the completing player hears it, and vanilla music is stopped
    event.register("#67C8AAFC31D6F28B", "secret_theme.mp3", 0.8, "self", true);

    // Or play only for nearby players
    event.register("#67C8AAFC31D6F28B", "boss_music.flac", 1.0, "nearby");
});