flying-squid/src/lib/plugins/sound.js

A minecraft server written in node.js

const { skipMcPrefix } = require('../utils')

const Vec3 = require('vec3').Vec3

module.exports.server = function (serv, { version }) {
  const { registry } = serv
  serv.playSound = (sound, world, position, { whitelist, blacklist = [], radius = 32, volume = 1.0, pitch = 1.0, soundCategory = 0 } = {}) => {
    const players = (typeof whitelist !== 'undefined'
      ? (typeof whitelist instanceof Array ? whitelist : [whitelist])
      : serv.getNearby({
        world,
        position,
        radius
      }))
    players.filter(player => blacklist.indexOf(player) === -1)
      .forEach(player => {
        const iniPos = position ? position.scaled(1 / 32) : player.position.scaled(1 / 32)
        const pos = iniPos.scaled(8).floored()
        if (serv.supportFeature('removedNamedSoundEffectPacket')) { // 1.19.3 removes named_sound_effect
          // Use new Holder structure for sound
          player._client.write('sound_effect', {
            sound: {
              data: {
                soundName: sound
              }
            },
            soundCategory,
            x: pos.x,
            y: pos.y,
            z: pos.z,
            volume,
            pitch: Math.round(pitch * 63),
            seed: 0
          })
        } else {
        // only packet still in fixed position in all versions
          player._client.write('named_sound_effect', {
            soundName: sound,
            soundCategory,
            x: pos.x,
            y: pos.y,
            z: pos.z,
            volume,
            pitch: Math.round(pitch * 63),
            seed: 0
          })
        }
      })
  }

  serv.playSoundId = (soundId, world, position, { whitelist, blacklist = [], radius = 32, volume = 1.0, pitch = 1.0, soundCategory = 0 } = {}) => {
    const players = (typeof whitelist !== 'undefined'
      ? (typeof whitelist instanceof Array ? whitelist : [whitelist])
      : serv.getNearby({
        world,
        position,
        radius
      }))
    players.filter(player => blacklist.indexOf(player) === -1)
      .forEach(player => {
        const iniPos = position ? position.scaled(1 / 32) : player.position.scaled(1 / 32)
        const pos = iniPos.scaled(8).floored()
        // Use new Holder structure for sound ID
        player._client.write('sound_effect', {
          sound: {
            soundId
          },
          soundCategory,
          x: pos.x,
          y: pos.y,
          z: pos.z,
          volume,
          pitch: Math.round(pitch * 63),
          seed: 0
        })
      })
  }

  serv.playNoteBlock = (pitch, world, position, { instrument = 'harp', particle = true } = {}) => {
    if (particle) {
      serv.emitParticle(23, world, position.clone().add(new Vec3(0.5, 1.5, 0.5)), {
        count: 1,
        size: new Vec3(0, 0, 0)
      })
    }
    serv.playSound('note.' + instrument, world, position, { pitch: serv.getNote(pitch) })
  }

  serv.getNote = note => 0.5 * Math.pow(Math.pow(2, 1 / 12), note)

  serv.commands.add({
    base: 'playsoundforall',
    info: 'to play sound for everyone',
    usage: '/playsoundforall <sound_name> [volume] [pitch] [useID]',
    onlyPlayer: true,
    op: true,
    parse (str) {
      const results = str.match(/([^ ]+)(?: ([^ ]+))?(?: ([^ ]+))?(?: (true|false))?/)
      if (!results) return false
      return {
        sound_name: skipMcPrefix(results[1]),
        volume: results[2] ? parseFloat(results[2]) : 1.0,
        pitch: results[3] ? parseFloat(results[3]) : 1.0,
        useId: results[4] ? results[4] === 'true' : false
      }
    },
    action (action, ctx) {
      if (action.useId) {
        const id = registry?.soundsByName[action.sound_name]?.id
        if (id) {
          ctx.player.chat('Playing "' + action.sound_name + '" (volume: ' + action.volume + ', pitch: ' + action.pitch + ') using ID')
          serv.playSoundId(id, ctx.player.world, ctx.player.position, { volume: action.volume, pitch: action.pitch })
        } else {
          ctx.player.chat('"' + action.sound_name + '" could not be played by ID')
        }
      } else {
        ctx.player.chat('Playing "' + action.sound_name + '" (volume: ' + action.volume + ', pitch: ' + action.pitch + ')')
        serv.playSound(action.sound_name, ctx.player.world, ctx.player.position, { volume: action.volume, pitch: action.pitch })
      }
    }
  })

  serv.commands.add({
    base: 'playsound',
    info: 'to play sound for yourself',
    usage: '/playsound <sound_name> [volume] [pitch] [useID]',
    onlyPlayer: true,
    op: true,
    parse (str) {
      const results = str.match(/([^ ]+)(?: ([^ ]+))?(?: ([^ ]+))?(?: (true|false))?/)
      if (!results) return false
      return {
        sound_name: skipMcPrefix(results[1]),
        volume: results[2] ? parseFloat(results[2]) : 1.0,
        pitch: results[3] ? parseFloat(results[3]) : 1.0,
        useId: results[4] ? results[4] === 'true' : false
      }
    },
    action (action, ctx) {
      if (action.useId) {
        const id = registry?.soundsByName[action.sound_name]?.id
        if (id) {
          ctx.player.chat('Playing "' + action.sound_name + '" (volume: ' + action.volume + ', pitch: ' + action.pitch + ') using ID')
          ctx.player.playSoundId(id, { volume: action.volume, pitch: action.pitch })
        } else {
          ctx.player.chat('"' + action.sound_name + '" could not be played by ID')
        }
      } else {
        ctx.player.chat('Playing "' + action.sound_name + '" (volume: ' + action.volume + ', pitch: ' + action.pitch + ')')
        ctx.player.playSound(action.sound_name, { volume: action.volume, pitch: action.pitch })
      }
    }
  })
}

module.exports.player = function (player, serv) {
  player.playSound = (sound, opt = {}) => {
    opt.whitelist = player
    serv.playSound(sound, player.world, null, opt)
  }

  player.playSoundId = (sound, opt = {}) => {
    opt.whitelist = player
    serv.playSoundId(sound, player.world, null, opt)
  }

  player.on('placeBlock_cancel', async ({ reference }, cancel) => {
    if (player.crouching) return
    const id = await player.world.getBlockType(reference)
    if (id !== 25) return
    cancel(false)
    if (!player.world.blockEntityData[reference.toString()]) player.world.blockEntityData[reference.toString()] = {}
    const data = player.world.blockEntityData[reference.toString()]
    if (typeof data.note === 'undefined') data.note = -1
    data.note++
    data.note %= 25
    serv.playNoteBlock(data.note, player.world, reference)
  })

  player.on('dig_cancel', async ({ position }, cancel) => {
    const id = await player.world.getBlockType(position)
    if (id !== 25) return
    cancel(false)
    if (!player.world.blockEntityData[position.toString()]) player.world.blockEntityData[position.toString()] = {}
    const data = player.world.blockEntityData[position.toString()]
    if (typeof data.note === 'undefined') data.note = 0
    serv.playNoteBlock(data.note, player.world, position)
  })
}

module.exports.entity = function (entity, serv) {
  entity.playSoundAtSelf = (sound, opt = {}) => {
    serv.playSound(sound, entity.world, entity.position, opt)
  }
}