Maks-gaming / mineflayer-plasmovoice

A lightweight plugin for Mineflayer that allows use VoiceChat for PlasmoVoice plugin
MIT License
19 stars 2 forks source link

mineflayer-plasmovoice

A lightweight plugin for Mineflayer that allows use VoiceChat for PlasmoVoice plugin

Features

Getting Started

Installation

1) This plugin is built using Node and can be installed using: npm install mineflayer-plasmovoice --save

Simple Sound Player

A bot that sneaks will play a certain sound (/path/to/music.mp3) and get up.

const mineflayer = require("mineflayer")
const plasmo = require("mineflayer-plasmovoice")

const bot = mineflayer.createBot({
    "host": "localhost"
})

bot.loadPlugin(plasmo.plugin)

bot.on("plasmovoice_connected", () => {
    bot.setControlState("sneak", true)

    // Path to file with any audio format
    bot.plasmovoice.sendAudio("/path/to/music.mp3")
})

bot.on("plasmovoice_audio_end", () => {
    bot.setControlState("sneak", false)
})

Debugging

const plasmo = require("mineflayer-plasmovoice")

/** By default - 4, and these are warnings, errors and fatal errors */
plasmo.setLoggingLevel(0)

Listening players

An example of an event when some player is talking

  • Data format is pcm_s16le
  • Sequence number goes in order from zero, some packet may be skipped when using the UDP protocol
    bot.on("plasmovoice_voice", (data) => {
    /*{
    player: string,
    distance: number
    sequenceNumber: BigInt
    data: Buffer
    }*/
    })

An example of an event when some player stopped talking

bot.on("plasmovoice_voice_end", (data) => {
/*{
player: string,
sequenceNumber: BigInt
}*/
})

License

This project uses the MIT license.


Contributors:

This project is accepting PRs and Issues. See something you think can be improved? Go for it! Any and all help is highly appreciated!

For larger changes, it is recommended to discuss these changes in the issues tab before writing any code. It's also preferred to make many smaller PRs than one large one, where applicable.

Made with official PlasmoVoice resources (https://plasmovoice.com)