RegionMusic

插件

· 作者 Van1boy

一个 Paper/Purpur 插件,当玩家进入 WorldGuard 区域时播放配置好的音乐(区域通常使用 WorldEdit + WorldGuard 创建和管理)。

0 本站下载 0 关注 更新于 6 个月前

需要前置:WorldGuard、WorldEdit

最新 1 · 1.21.11 · Paper / Purpur

一键开服(送7天)

RegionMusic

一个 Paper/Purpur 插件,当玩家进入 WorldGuard 区域(区域通常使用 WorldEdit + WorldGuard 创建/管理)时播放配置的音乐。

要求

  • 服务器:Paper/Purpur(plugin.yml 中的 api-version:1.21)
  • Java:21
  • WorldGuard:7.x(该插件声明了 depend: [WorldGuard])
  • 客户端资源包(如果你使用自定义音效,如 namespace:key)

安装

  1. 将插件 jar 放入 plugins/ 目录。
  2. 确保已安装 WorldGuard,并且它在 RegionMusic 之前加载。
  3. 启动服务器一次,编辑 plugins/RegionMusic/config.yml,然后重启服务器。

区域选择(重要)

如果玩家所在位置有多个 WorldGuard 区域适用,插件会按以下方式选择最佳区域:

  1. 仅考虑在 config.yml 中具有配置部分 regions.<regionId> 的区域。
  2. 具有最高 WorldGuard priority(优先级)的区域胜出。
  3. 如果优先级相等,则通过区域 id(字母顺序)稳定选择结果。

为该选定区域播放音乐。

配置

文件:plugins/RegionMusic/config.yml

最小设置(每个区域 1 首曲目):

regions:
  spawn:
    sound: "msr:spawn_theme"
    category: "MUSIC"
    volume: 1.0
    pitch: 1.0
    stopOnExit: true

多首曲目(随机播放,未耗尽前不重复)

你可以通过 sounds: 定义播放列表。曲目将以随机顺序播放,直到列表耗尽前不会重复,然后重新洗牌列表。

regions:
  spawn:
    sounds:
      - "msr:spawn_theme"
      - "msr:hscene2"
      - "msr:hscene3"
    category: "MUSIC"
    volume: 1.0
    pitch: 1.0
    stopOnExit: true

连续播放 (continuous)

Paper/Spigot 没有提供“音效结束”事件,因此要自动播放下一首曲目,你必须配置持续时间。

regions:
  spawn:
    sounds:
      - "msr:spawn_theme"
      - "msr:hscene2"
    category: "MUSIC"

    continuous: true
    durations:
      "msr:spawn_theme": 2400 # ticks(20 ticks = 1 秒)
      "msr:hscene2": 1360
    gapTicks: 0
    stopPreviousOnNext: true

支持的持续时间选项:

  • durationTicks:此区域内任何曲目的默认持续时间(ticks)。
  • durationSeconds:同上,但以秒为单位。
  • durations::映射 soundKey -> ticks(覆盖每首曲目的默认值)。

如果持续时间不准确:

  • 持续时间长于实际曲目:你会听到静音,直到下一首曲目开始。
  • 持续时间短于实际曲目:下一首曲目会提前开始;配合 stopPreviousOnNext: true,上一首曲目会被停止(可听见的切断)。

重复播放某曲目 N 次 (repeats)

你可以强制给定曲目连续重复 N 次,然后再进入下一首:

regions:
  spawn:
    sounds:
      - "msr:spawn_theme"
      - "msr:hscene2"
    continuous: true
    durations:
      "msr:spawn_theme": 2400
      "msr:hscene2": 1360
    repeats:
      "msr:hscene2": 3

值 < 1 被视为 1。

进入时停止原版音乐

为了防止区域音乐与原版背景音乐重叠,你可以在进入时停止 MUSIC 类别:

regions:
  spawn:
    stopVanillaMusicOnEnter: true

注意:

  • 原版背景音乐是客户端侧的;插件尽力尝试停止 SoundCategory.MUSIC。
  • 区域音轨会在停止 MUSIC 后的下一个 tick 启动,以避免罕见的客户端数据包顺序竞争条件。

完整的逐区域选项

  • sound: string - 单首曲目(旧版)。
  • sounds: [string] - 曲目列表(推荐)。
  • category: string - Bukkit 类别(MUSIC, RECORDS, ...),默认:MUSIC。
  • volume: number - 默认:1.0。
  • pitch: number - 默认:1.0。
  • stopOnExit: boolean - 离开所有配置的区域时停止当前正在播放的曲目,默认:true。
  • stopVanillaMusicOnEnter: boolean - 进入时停止 SoundCategory.MUSIC,默认:true。
  • continuous: boolean - 只要玩家停留在区域内就保持播放播放列表,默认:false。
  • durationTicks: int / durationSeconds: number - continuous 模式的默认持续时间。
  • durations: { "<soundKey>": <ticks> } - 逐曲目持续时间(ticks)。
  • gapTicks: int - 曲目之间的静音间隔,默认:0。
  • stopPreviousOnNext: boolean - 在开始下一首曲目之前立即停止上一首曲目,默认:true。
  • repeats: { "<soundKey>": <count> } - 让特定曲目连续重复 N 次。

资源包(自定义音效)

如果你使用类似 msr:spawn_theme 的自定义音效,客户端必须启用包含以下内容的资源包:

  • assets/msr/sounds.json(或者使用其他命名空间代替 msr)
  • assets/msr/sounds/<name>.ogg

重要提示:

  • .ogg 必须是 Ogg Vorbis 格式(不是重命名为 .ogg 的 MP3)。
  • soundKey 必须为小写(遵循 Minecraft ResourceLocation 规则)。

快速客户端测试:

/playsound msr:spawn_theme music @s ~ ~ ~ 1 1

如果你听到静音或出现“unknown soundEvent”错误,问题出在资源包/键上,而不是插件本身。

你是这个资源的作者?登录后可认领此资源。

评论 0

0.0
暂无评分
5 星
0
4 星
0
3 星
0
2 星
0
1 星
0
我的评分

登录后参与评分

还没有评论,来抢沙发吧

评论配图

相似资源