DiscAPI

DiscAPI

一个小型库,用于添加自定义音乐唱片。它提供了一个通用唱片物品、一个纹理模板(其内环和外环颜色可按唱片分别设置),以及对歌曲的完整数据包支持。

DiscAPI

一个用于添加自定义音乐唱片的小型库。它提供一个通用唱片物品、一个可分别为每张唱片设置内外圈颜色的纹理模板,以及对歌曲的完整数据包支持。


English

功能说明

  • 一个通用唱片物品(discapi:disc),可承载任意歌曲。歌曲由数据包定义,因此无需编写代码即可添加唱片。
  • 数据包支持:一张唱片就是一条 jukebox_song 条目加上物品组件。可与原版唱片机配合使用,包含红石比较器输出。
  • 可染色纹理模板:唱片贴图分为外圈和内圈,两者均按物品单独染色,因此每张唱片无需新贴图即可拥有不同外观。
  • 作者行:可选的 discapi:artist 组件会在提示文本中显示“Artist: ...”。
  • 创造模式标签页:包含通用唱片,无需命令即可测试。

使用数据包添加唱片

  1. 将歌曲定义放入数据包的 data/<your_pack>/jukebox_song/<song_id>.json:
{
  "comparator_output": 9,
  "description": { "translate": "jukebox_song.your_pack.my_song" },
  "length_in_seconds": 120.0,
  "sound_event": "your_pack:music/my_song"
}
  1. 将歌曲文本放入 assets/<your_pack>/lang/en_us.json(jukebox_song.your_pack.my_song),或改用纯 text 字段代替 translate。

  2. 发放唱片。颜色为 [外圈, 内圈] 的 ARGB 值,作者行为可选:

/give @p discapi:disc[jukebox_playable={song:"your_pack:my_song"},custom_model_data={colors:[-14725492,-5711617]},discapi:artist="Your Name"]
  1. 配方为普通数据包配方,使用相同的物品和组件。

添加音乐文件

声音本身是普通的资源包文件:

  1. assets/<your_pack>/sounds/music/my_song.ogg(Ogg Vorbis,建议使用单声道,这样唱片声音具有位置感)。
  2. assets/<your_pack>/sounds.json:
{
  "music.my_song": {
    "sounds": [
      { "name": "your_pack:music/my_song", "stream": true }
    ]
  }
}

第 1 步中的 sound_event 必须与 sounds.json 的键匹配,并加上你的命名空间前缀(此处为 your_pack:music.my_song)。

制作你自己的唱片物品(模组)

KeenRegistry registry = KeenRegistry.of("mymod");
registry.item("my_disc", DiscApi.discFactory(DiscApi.songKey("mymod", "my_song")));

然后物品模型指向 discapi:item/disc_template。

前置要求

  • 需要 KeenLib。请将其与本模组一同安装。
  • 可选:Cloth Config 用于配置界面,Mod Menu 用于在 Fabric 上提供配置按钮。

许可证

基于 CC0 1.0 Universal 发布。

链接


中文

这个模组做什么

  • 一个通用唱片物品(discapi:disc),可以承载任意歌曲。歌曲由数据包定义,因此不加代码也能新增唱片。
  • 数据包支持:一张唱片 = 一条 jukebox_song + 物品组件,原版唱片机与红石比较器输出都能正常工作。
  • 可染色纹理模板:唱片贴图拆成外圈与内圈两层,各自按物品染色,因此不需要新贴图就能让每张唱片外观不同。
  • 作者行:可选的 discapi:artist 组件会在提示里显示「作者:……」。
  • 创造模式标签页内置通用唱片,不用命令也能直接取来试。

用数据包新增一张唱片

  1. 在数据包里放歌曲定义 data/<你的包>/jukebox_song/<歌曲 id>.json:
{
  "comparator_output": 9,
  "description": { "translate": "jukebox_song.your_pack.my_song" },
  "length_in_seconds": 120.0,
  "sound_event": "your_pack:music/my_song"
}
  1. 在 assets/<你的包>/lang/zh_cn.json 里补上 jukebox_song.your_pack.my_song 的文本;也可以把 translate 换成纯 text。

  2. 发放唱片。颜色是 [外圈, 内圈] 的 ARGB,作者行可选:

/give @p discapi:disc[jukebox_playable={song:"your_pack:my_song"},custom_model_data={colors:[-14725492,-5711617]},discapi:artist="作者名"]
  1. 配方就是普通的数据包配方,物品与组件照抄上面这一行。

放入音乐文件

音乐本体是普通的资源包内容:

  1. assets/<你的包>/sounds/music/my_song.ogg(Ogg Vorbis;建议单声道,这样唱片声音有距离衰减)。
  2. assets/<你的包>/sounds.json:
{
  "music.my_song": {
    "sounds": [
      { "name": "your_pack:music/my_song", "stream": true }
    ]
  }
}

第 1 步里的 sound_event 要等于这里 sounds.json 的键再加命名空间前缀(本例为 your_pack:music.my_song)。

自定义唱片物品(模组)

KeenRegistry registry = KeenRegistry.of("mymod");
registry.item("my_disc", DiscApi.discFactory(DiscApi.songKey("mymod", "my_song")));

物品模型指向 discapi:item/disc_template。

前置与可选

  • 必须安装 KeenLib。
  • 可选:装 Cloth Config 才有配置界面;Fabric 端再装 Mod Menu 才有配置入口。

许可证

本项目基于 CC0 1.0 Universal 发布。

链接