@occultus/music-api 0.18.1

package/LICENSE

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright © 2025 CTN Studios
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,6 @@
+# Star Tenon Music API
+
+> [!IMPORTANT]
+> 该包仍处于开发阶段，可能会有一些问题亟待修复
+
+本包提供了方便的自定义唱片的 API，可以方便的创建新的音乐唱片。

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@occultus/music-api",
+  "version": "0.18.1",
+  "description": "Star Tenon music api",
+  "main": "src/index.ts",
+  "keywords": [
+    "Minecraft",
+    "Occultus SDK",
+    "Script API"
+  ],
+  "contributors": [
+    "FangLimao <mucigames@outlook.com>",
+    "RawDiamondMC <RawDiamondMC@outlook.com>"
+  ],
+  "license": "MIT",
+  "author": "CTN Studios",
+  "peerDependencies": {
+    "@minecraft/server": "2.3.0-beta.1.21.110-preview.20",
+    "@occultus/core": ">=0.18.2 || <0.19.0"
+  },
+  "dependencies": {
+    "@occultus/format-api": "0.18.1"
+  },
+  "devDependencies": {
+    "typedoc": "^0.28.9"
+  }
+}

package/src/api/MusicDisc.ts

@@ -0,0 +1,19 @@
+/**
+ * 音乐唱片类，用于表示游戏中的音乐唱片物品
+ *
+ * 该类封装了音乐唱片的基本信息，包括唱片物品 ID、曲目名称、唱片名称和艺术家。
+ */
+export class MusicDisc {
+  /**
+   * @param typeId 唱片的类型ID，用于区分不同的唱片
+   * @param trackName 唱片中的曲目名称
+   * @param name 唱片的名称
+   * @param artist 唱片的作者
+   */
+  constructor(
+    readonly typeId: string,
+    public trackName: string,
+    public name: string,
+    public artist: string
+  ) {}
+}

package/src/api/MusicDiscServer.ts

@@ -0,0 +1,127 @@
+import {
+  PlayerBreakBlockBeforeEvent,
+  PlayerInteractWithBlockBeforeEvent,
+  RawMessage,
+  system,
+  world,
+} from "@minecraft/server";
+import { MusicDisc } from "./MusicDisc";
+import { Color } from "@occultus/format-api";
+
+/**
+ * 管理音乐唱片的服务器端逻辑
+ */
+export class MusicDiscServer {
+  /**
+   * 初始化服务端事件监听器
+   * @private
+   */
+  private initServer() {
+    world.beforeEvents.playerInteractWithBlock.subscribe((arg) => {
+      inputListener(arg, this);
+    });
+    world.beforeEvents.playerInteractWithBlock.subscribe((arg) => {
+      removeListener(arg, this);
+    });
+    world.beforeEvents.playerBreakBlock.subscribe((arg) => {
+      breakListener(arg, this);
+    });
+  }
+  constructor() {
+    this.initServer();
+  }
+
+  /** 存储唱片类型ID与音轨名称的映射 */
+  records: Map<string, string> = new Map();
+  /** 存储唱片类型ID与艺术家名称的映射 */
+  artists: Map<string, string> = new Map();
+  /** 存储唱片类型ID与唱片显示名称的映射 */
+  names: Map<string, string> = new Map();
+
+  /**
+   * 添加一张音乐唱片到服务器
+   * @param record 要添加的音乐唱片对象
+   */
+  addDisc(record: MusicDisc) {
+    this.records.set(record.typeId, record.trackName);
+    this.artists.set(record.typeId, record.artist);
+    this.names.set(record.typeId, record.name);
+  }
+}
+
+function breakListener(
+  event: PlayerBreakBlockBeforeEvent,
+  server: MusicDiscServer
+) {
+  const block = event.block;
+  const player = event.player;
+  if (block?.typeId !== "minecraft:jukebox") return;
+  if (player?.isSneaking) return;
+  const recordComponent = block.getComponent("record_player");
+  if (!recordComponent) return;
+  const record = recordComponent.getRecord();
+  if (!record) return;
+  const sound = server.records.get(record.typeId);
+  if (sound) {
+    system.run(() => {
+      player.runCommand(`stopsound @a ${sound}`);
+    });
+  }
+}
+
+function removeListener(
+  event: PlayerInteractWithBlockBeforeEvent,
+  server: MusicDiscServer
+) {
+  const block = event.block;
+  const player = event.player;
+  if (block?.typeId !== "minecraft:jukebox") return;
+  if (player?.isSneaking) return;
+  const record = block?.getComponent("record_player")?.getRecord()?.typeId;
+  if (!record) return;
+  const sound = server.records.get(record);
+  if (sound) {
+    system.run(() => {
+      player.runCommand(`stopsound @a ${sound}`);
+    });
+  }
+}
+
+function inputListener(
+  event: PlayerInteractWithBlockBeforeEvent,
+  server: MusicDiscServer
+) {
+  const { player, itemStack, block } = event;
+  if (!itemStack) return;
+  if (block?.typeId !== "minecraft:jukebox") return;
+  if (player?.isSneaking) return;
+  const record = server.records.get(itemStack?.typeId);
+  const artist = server.artists.get(itemStack?.typeId);
+  const name = server.names.get(itemStack?.typeId);
+  if (itemStack) {
+    if (record && !block?.getComponent("record_player")?.isPlaying()) {
+      system.run(() => {
+        block.dimension.playSound(record, block.location);
+        block.dimension
+          .getPlayers({
+            location: block.location,
+            minDistance: 0,
+            maxDistance: 10,
+          })
+          .forEach((player) => {
+            player.onScreenDisplay.setActionBar([
+              Color.lightPurple,
+              {
+                translate: "record.nowPlaying",
+                with: [`${artist} - ${name}`],
+              },
+            ]);
+          });
+      });
+    } else if (record && block?.getComponent("record_player")?.isPlaying()) {
+      system.run(() => {
+        player.runCommand(`stopsound @a ${record}`);
+      });
+    }
+  }
+}

package/src/index.ts

@@ -0,0 +1,2 @@
+export * from "./api/MusicDisc";
+export * from "./api/MusicDiscServer";

package/tsconfig.json

@@ -0,0 +1,21 @@
+{
+  "include": ["src/*"],
+  "exclude": ["./out"],
+  "Modules": {
+    "resolvePackageJsonExports": true
+  },
+  "compilerOptions": {
+    "noEmit": true,
+    "noEmitOnError": true,
+    "target": "es2022",
+    "lib": ["es2020", "dom"],
+    "strict": true,
+    "moduleResolution": "node16",
+    "esModuleInterop": true,
+    "module": "node16",
+    "outDir": ".",
+    "removeComments": true,
+    "newLine": "lf",
+    "resolveJsonModule": true
+  }
+}