mineflayer 4.5.1 → 4.6.0

package/docs/api.md

@@ -75,6 +75,14 @@
       - [BossBar.isDragonBar](#bossbarisdragonbar)
       - [BossBar.createFog](#bossbarcreatefog)
       - [BossBar.color](#bossbarcolor)
+    - [mineflayer.Particle](#mineflayerparticle)
+      - [Particle.id](#particleid)
+      - [Particle.name](#particlename)
+      - [Particle.position](#particleposition)
+      - [Particle.offset](#particleoffset)
+      - [Particle.longDistanceRender](#particlelongdistancerender)
+      - [Particle.count](#particlecount)
+      - [Particle.movementSpeed](#particlemovementspeed)
   - [Bot](#bot)
     - [mineflayer.createBot(options)](#mineflayercreatebotoptions)
     - [Properties](#properties)
@@ -239,6 +247,7 @@
       - ["heldItemChanged" (heldItem)](#helditemchanged-helditem)
       - ["physicsTick" ()](#physicstick-)
       - ["chat:name" (matches)](#chatname-matches)
+      - ["particle"](#particle)
     - [Functions](#functions)
       - [bot.blockAt(point, extraInfos=true)](#botblockatpoint-extrainfostrue)
       - [bot.waitForChunksToLoad()](#botwaitforchunkstoload)
@@ -725,6 +734,36 @@ Determines whether or not boss bar creates fog
 
 Determines what color the boss bar color is, one of `pink`, `blue`, `red`, `green`, `yellow`, `purple`, `white`
 
+### mineflayer.Particle
+
+#### Particle.id
+
+Particle ID, as defined in the [protocol](https://wiki.vg/Protocol#Particle)
+
+#### Particle.name
+
+Particle Name, as defined in the [protocol](https://wiki.vg/Protocol#Particle)
+
+#### Particle.position
+
+Vec3 instance of where the particle was created
+
+#### Particle.offset
+
+Vec3 instance of the particle's offset
+
+#### Particle.longDistanceRender
+
+Determines whether or not to force the rendering of a particle despite client particle settings and increases maximum view distance from 256 to 65536
+
+#### Particle.count
+
+Amount of particles created
+
+#### Particle.movementSpeed
+
+Particle speed in a random direction
+
 ## Bot
 
 ### mineflayer.createBot(options)
@@ -1465,6 +1504,10 @@ Fires every tick if bot.physicsEnabled is set to true.
 
 Fires when the all of a chat pattern's regexs have matches
 
+#### "particle"
+
+Fires when a particle is created
+
 ### Functions
 
 #### bot.blockAt(point, extraInfos=true)

package/docs/es/README_ES.md

@@ -17,7 +17,7 @@ Crea bots para Minecraft con una API de JavaScript potente, estable y de alto ni
 
 ## Características
 
- * Soporta Minecraft 1.8, 1.9, 1.10, 1.11, 1.12, 1.13, 1.14, 1.15, 1.16, 1.17 y 1.18.
+ * Soporta Minecraft 1.8, 1.9, 1.10, 1.11, 1.12, 1.13, 1.14, 1.15, 1.16, 1.17, 1.18 y 1.19.
  * Rastreo e información de entidades.
  * Información sobre bloques. Puedes solicitar información de todo lo que te rodea. Encuentra bloques en milisegundos
  * Físicas y movimientos básicos - maneja todos los cuadros de colisión

package/docs/fr/FAQ_FR.md

@@ -0,0 +1,182 @@
+## FAQ
+
+Ce document de foire aux questions a pour but d'aider les gens pour les choses les plus courantes.
+
+### Je reçois une erreur lorsque j'essaie de me connecter avec un compte Microsoft.
+
+Assurez-vous que l'email que vous avez entré dans l'option username de createBot peut être utilisé pour vous connecter à `minecraft.net` en utilisant le bouton 'Login with Microsoft'.
+Assurez-vous que vous avez l'option `auth : 'microsoft'` dans vos options createBot.
+
+Lorsque vous obtenez une erreur qui dit quelque chose au sujet des informations d'identification invalides ou "Ce compte possède Minecraft ?", essayez de supprimer le champ du mot de passe dans les options `createBot` et réessayez.
+
+### Comment masquer les erreurs ?
+
+Utiliser `hideErrors : true` dans les options de createBot
+Vous pouvez également choisir d'ajouter ces listeners :
+
+```js
+client.on('error', () => {})
+client.on('end', () => {})
+```
+
+### Je ne reçois pas d'événement de chat sur un serveur personnalisé, comment puis-je résoudre ce problème ?
+
+Les serveurs Spigot, en particulier certains plugins, utilisent des formats de chat personnalisés, vous devez les analyser avec une expression rationnelle / un analyseur syntaxique personnalisé.
+Lisez et adaptez [chat_parsing.js](https://github.com/PrismarineJS/mineflayer/blob/master/examples/chat_parsing.js) pour qu'il fonctionne pour vos besoins particuliers.
+plugin de chat. A lire également <http://mineflayer.prismarine.js.org/#/tutorial?id=custom-chat>
+
+### Comment puis-je collecter les informations d'un plugin personnalisé dans le chat ?
+
+La plupart des serveurs Minecraft personnalisés ont le support des plugins, et beaucoup de ces plugins disent quelque chose dans le chat quand quelque chose se passe. Si c'est juste un message, il est préférable d'utiliser la solution discutée dans la solution ci-dessus, mais quand ces messages sont divisés en plusieurs petits messages, une autre option est d'utiliser l'événement `"messagestr"` car il permet d'analyser facilement les messages de plusieurs lignes.
+
+**Exemple:**
+
+Le message du chat dans le chat ressemble à ceci :
+
+```
+(!) U9G has won the /jackpot and received
+$26,418,402,450! They purchased 2,350,000 (76.32%) ticket(s) out of the
+3,079,185 ticket(s) sold!
+```
+
+```js
+const regex = {
+  first: /\(!\) (.+) has won the \/jackpot and received +/,
+  second: /\$(.+)! They purchased (.+) \((.+)%\) ticket\(s\) out of the /,
+  third: /(.+) ticket\(s\) sold!/
+}
+
+let jackpot = {}
+bot.on('messagestr', msg => {
+  if (regex.first.test(msg)) {
+    const username = msg.match(regex.first)[1]
+    jackpot.username = username
+  } else if (regex.second.test(msg)) {
+    const [, moneyWon, boughtTickets, winPercent] = msg.match(regex.second)
+    jackpot.moneyWon = parseInt(moneyWon.replace(/,/g, ''))
+    jackpot.boughtTickets = parseInt(boughtTickets.replace(/,/g, ''))
+    jackpot.winPercent = parseFloat(winPercent)
+  } else if (regex.third.test(msg)) {
+    const totalTickets = msg.match(regex.third)[1]
+    jackpot.totalTickets = parseInt(totalTickets.replace(/,/g, ''))
+    onDone(jackpot)
+    jackpot = {}
+  }
+})
+```
+
+### Comment puis-je envoyer une commande ?
+
+En utilisant `bot.chat()`.
+
+**Example:**
+
+```js
+bot.chat('/give @p diamond')
+```
+
+### Est-il possible de se connecter à plusieurs comptes en utilisant bot = mineflayer.createbot tout en les contrôlant tous séparément ?
+
+Créer différentes instances de bot en appelant createBot puis faire différentes choses pour chacune, voir multiple.js
+
+### Comment faire pour que le robot lâche tout son inventaire ?
+
+bot.inventory.items() renvoie un tableau des objets du bot. Vous pouvez utiliser une fonction récursive pour les parcourir en boucle et déposer chaque objet en utilisant bot.toss(). Cliquez [ici](https://gist.github.com/dada513/3d88f772be4224b40f9e5d1787bd63e9) pour voir un exemple.
+
+### Comment vérifier les paquets qui sont envoyés/reçus ?
+
+Activation du mode de débogage <https://github.com/PrismarineJS/mineflayer#debug>
+
+### Je veux éviter la déconnexion même en cas de lag du serveur, comment puis-je y parvenir ?
+
+Un moyen est d'augmenter l'option [checkTimeoutInterval](https://github.com/PrismarineJS/node-minecraft-protocol/blob/master/docs/API.md#mccreateclientoptions) (à définir dans createBot) à une valeur plus élevée (par exemple `300*1000` qui est 5min au lieu des 30s par défaut). Si vous êtes toujours déconnecté, vous pouvez vous reconnecter automatiquement en utilisant quelque chose comme cet exemple <https://github.com/PrismarineJS/mineflayer/blob/master/examples/reconnector.js>
+
+### Comment obtenir l'histoire / le texte d'un objet ?
+
+Vous pouvez utiliser la propriété `item.nbt`. Il est également recommandé d'utiliser la bibliothèque `prismarine-nbt`. La méthode `nbt.simplify()` peut être utile.
+
+**Exemple:**
+
+```js
+function getLore (item) {
+  let message = ''
+  if (item.nbt == null) return message
+
+  const nbt = require('prismarine-nbt')
+  const ChatMessage = require('prismarine-chat')(bot.version)
+
+  const data = nbt.simplify(item.nbt)
+  const display = data.display
+  if (display == null) return message
+
+  const lore = display.Lore
+  if (lore == null) return message
+  for (const line of lore) {
+    message += new ChatMessage(line).toString()
+    message += '\n'
+  }
+
+  return message
+}
+```
+
+### Comment puis-je envoyer un message de la console au serveur ?
+
+You can use a library like `repl` to read the console input and use `bot.chat()` to send it. You can find an example [here.](https://github.com/PrismarineJS/mineflayer/blob/master/examples/repl.js)
+
+### Lors de la création d'un plugin, comment puis-je spécifier un autre plugin comme dépendance ?
+
+Dans la fonction `inject()` de votre plugin, vous pouvez appeler sans risque `bot.loadPlugin(anotherPlugin)` pour vous assurer que ce plugin est chargé. Si le plugin a déjà été chargé auparavant, rien ne se passe.
+
+Notez que l'ordre dans lequel les plugins sont chargés est dynamique, donc vous ne devriez jamais appeler un autre plugin dans votre fonction `inject()`.
+
+### Comment puis-je utiliser un proxy socks5 ?
+
+In the options object for `mineflayer.createBot(options)`, remove your `host` option from the options object, have the following variables declared `PROXY_IP, PROXY_PORT, PROXY_USERNAME, PROXY_PASSWORD, MC_SERVER_ADDRESS, MC_SERVER_PORT` and add this to your options object:
+
+```js
+connect: (client) => {
+    socks.createConnection({
+      proxy: {
+        host: PROXY_IP,
+        port: PROXY_PORT,
+        type: 5,
+        userId: PROXY_USERNAME,
+        password: PROXY_PASSWORD
+      },
+      command: 'connect',
+      destination: {
+        host: MC_SERVER_ADDRESS,
+        port: MC_SERVER_PORT
+      }
+    }, (err, info) => {
+      if (err) {
+        console.log(err)
+        return
+      }
+      client.setSocket(info.socket)
+      client.emit('connect')
+    })
+  }
+  ```
+
+`socks` est déclaré avec `const socks = require('socks').SocksClient` et utilise le paquet [this](https://www.npmjs.com/package/socks).
+Certains serveurs peuvent rejeter la connexion. Si cela se produit, essayez d'ajouter `fakeHost : MC_SERVER_ADDRESS` aux options de votre createBot.
+  
+# Erreurs courantes
+
+### `UnhandledPromiseRejectionWarning: Error: Failed to read asymmetric key`
+
+Voici ce qui se passe lorsque vous avez donné à Mineflayer la mauvaise version du serveur, ou que Mineflayer détecte la mauvaise version du serveur.
+
+### `TypeError: Cannot read property '?' of undefined`
+
+Vous essayez peut-être d'utiliser quelque chose sur l'objet bot qui n'existe pas encore, essayez d'appeler l'instruction après l'événement `spawn`.
+
+### `SyntaxError: Unexpected token '?'`
+
+Mettez à jour la version de votre node.
+
+### The bot can't break/place blocks or open chests
+
+Vérifiez que la protection contre le spawn n'empêche pas le bot d'agir.

package/docs/history.md

@@ -1,3 +1,14 @@
+4.6.0
+
+* Fix unhandled promise rejection in onceWithCleanup (@IceTank) [#2833](https://github.com/PrismarineJS/mineflayer/pull/2833)
+* Extend every window that is opened with mineflayer specific window functions (@IceTank) [#2768][https://github.com/PrismarineJS/mineflayer/pull/2768]
+* Fix example command line usage messages (@maximmasiutin) [#2853](https://github.com/PrismarineJS/mineflayer/pull/2853)
+* Update README_ES.md (@PanIntegralus) [#2803](https://github.com/PrismarineJS/mineflayer/pull/2803)
+* Fix block face position target when digging (@WhoTho) [#2801](https://github.com/PrismarineJS/mineflayer/pull/2801)
+* Add a native mineflayer event for particles (@NyxaYu) [#2813](https://github.com/PrismarineJS/mineflayer/pull/2813)
+* Fix viewDistance type (@Nciklol) [#2824](Fix viewDistance type (#2824) ) 
+* Add French FAQ (@AugustinMauroy) [#2817](https://github.com/PrismarineJS/mineflayer/pull/2817)
+
 ## 4.5.1
 
 * Fixed syntax error in TypeScript definitions (@JungleDome) [commit](https://github.com/PrismarineJS/mineflayer/commit/2c6a4036d84bedb5f349ea5a82d743e344c34224)

package/examples/anvil.js

@@ -18,7 +18,7 @@
 const mineflayer = require('mineflayer')
 
 if (process.argv.length < 4 || process.argv.length > 6) {
-  console.log('Usage : node use_anvil.js <host> <port> [<name>] [<password>]')
+  console.log('Usage : node anvil.js <host> <port> [<name>] [<password>]')
   process.exit(1)
 }
 

package/examples/collectblock.js

@@ -6,12 +6,7 @@ const pathfinder = require('mineflayer-pathfinder').pathfinder
 const collectBlock = require('mineflayer-collectblock').plugin
 
 if (process.argv.length < 4 || process.argv.length > 6) {
-  console.log('Usage : node collector.js <host> <port> [<name>] [<password>]')
-  process.exit(1)
-}
-
-if (process.argv.length < 4 || process.argv.length > 6) {
-  console.log('Usage : node collectBlock.js <host> <port> [<name>] [<password>]')
+  console.log('Usage : node collectblock.js <host> <port> [<name>] [<password>]')
   process.exit(1)
 }
 

package/examples/looker.js

@@ -5,7 +5,7 @@
 const mineflayer = require('mineflayer')
 
 if (process.argv.length < 4 || process.argv.length > 6) {
-  console.log('Usage : node echo.js <host> <port> [<name>] [<password>]')
+  console.log('Usage : node looker.js <host> <port> [<name>] [<password>]')
   process.exit(1)
 }
 

package/examples/skin_blinker.js

@@ -7,7 +7,7 @@
 const mineflayer = require('mineflayer')
 
 if (process.argv.length < 4 || process.argv.length > 6) {
-  console.log('Usage : node jumper.js <host> <port> [<name>] [<password>]')
+  console.log('Usage : node skin_blinker.js <host> <port> [<name>] [<password>]')
   process.exit(1)
 }
 

package/index.d.ts

@@ -30,7 +30,7 @@ export interface BotOptions extends ClientOptions {
 }
 
 export type ChatLevel = 'enabled' | 'commandsOnly' | 'disabled'
-export type ViewDistance = 'far' | 'normal' | 'short' | 'tiny'
+export type ViewDistance = 'far' | 'normal' | 'short' | 'tiny' | number
 export type MainHands = 'left' | 'right'
 
 export interface PluginOptions {
@@ -151,6 +151,7 @@ interface BotEvents {
   bossBarDeleted: (bossBar: BossBar) => Promise<void> | void
   bossBarUpdated: (bossBar: BossBar) => Promise<void> | void
   resourcePack: (url: string, hash: string) => Promise<void> | void
+  particle: (particle: Particle) => Promise<void> | void
 }
 
 export interface Bot extends TypedEmitter<BotEvents> {
@@ -826,6 +827,26 @@ export class BossBar {
   );
 }
 
+export class Particle {
+    id: number
+    name: string
+    position: Vec3
+    offset: Vec3
+    count: number
+    movementSpeed: number
+    longDistanceRender: boolean
+    static fromNetwork(packet: Object): Particle
+
+    constructor (
+        id: number,
+        position: Vec3,
+        offset: Vec3,
+        count?: number,
+        movementSpeed?: number,
+        longDistanceRender?: boolean
+    );
+}
+
 export let supportedVersions: string[]
 export let testedVersions: string[]
 

package/lib/loader.js

@@ -41,7 +41,8 @@ const plugins = {
   villager: require('./plugins/villager'),
   anvil: require('./plugins/anvil'),
   place_entity: require('./plugins/place_entity'),
-  generic_place: require('./plugins/generic_place')
+  generic_place: require('./plugins/generic_place'),
+  particle: require('./plugins/particle')
 }
 
 const supportedVersions = require('./version').supportedVersions
@@ -53,6 +54,7 @@ module.exports = {
   Painting: require('./painting'),
   ScoreBoard: require('./scoreboard'),
   BossBar: require('./bossbar'),
+  Particle: require('./particle'),
   supportedVersions,
   testedVersions,
   supportFeature: (feature, version) => require('prismarine-registry')(version).supportFeature(feature)

package/lib/particle.js

@@ -0,0 +1,30 @@
+const { Vec3 } = require('vec3')
+
+module.exports = loader
+
+function loader (registry) {
+  class Particle {
+    constructor (id, position, offset, count = 1, movementSpeed = 0, longDistanceRender = false) {
+      Object.assign(this, registry.particles[id])
+      this.id = id
+      this.position = position
+      this.offset = offset
+      this.count = count
+      this.movementSpeed = movementSpeed
+      this.longDistanceRender = longDistanceRender
+    }
+
+    static fromNetwork (packet) {
+      return new Particle(
+        packet.particleId,
+        new Vec3(packet.x, packet.y, packet.z),
+        new Vec3(packet.offsetX, packet.offsetY, packet.offsetZ),
+        packet.particles,
+        packet.particleData,
+        packet.longDistance
+      )
+    }
+  }
+
+  return Particle
+}

package/lib/plugins/digging.js

@@ -36,15 +36,17 @@ function inject (bot) {
         } else if (digFace.z) {
           diggingFace = digFace.z > 0 ? BlockFaces.SOUTH : BlockFaces.NORTH
         }
-        await bot.lookAt(block.position.offset(0.5, 0.5, 0.5).offset(digFace.x * 0.5, digFace.y * 0.5, digFace.z * 0.5), forceLook)
+        await bot.lookAt(
+          block.position.offset(0.5, 0.5, 0.5).offset(digFace.x * 0.5, digFace.y * 0.5, digFace.z * 0.5),
+          forceLook
+        )
       } else if (digFace === 'raycast') {
         // Check faces that could be seen from the current position. If the delta is smaller then 0.5 that means the
         // bot cam most likely not see the face as the block is 1 block thick
         // this could be false for blocks that have a smaller bounding box then 1x1x1
-        const dx = bot.entity.position.x - block.position.x + 0.5
-        const dy = bot.entity.position.y - block.position.y - 0.5 + bot.entity.height // -0.5 because the bot position
-        // is calculated from the block position that is inside its feet so 0.5 - 1 = -0.5
-        const dz = bot.entity.position.z - block.position.z + 0.5
+        const dx = bot.entity.position.x - (block.position.x + 0.5)
+        const dy = bot.entity.position.y + bot.entity.height - (block.position.y + 0.5)
+        const dz = bot.entity.position.z - (block.position.z + 0.5)
         // Check y first then x and z
         const visibleFaces = {
           y: Math.sign(Math.abs(dy) > 0.5 ? dy : 0),
@@ -55,12 +57,20 @@ function inject (bot) {
         for (const i in visibleFaces) {
           if (!visibleFaces[i]) continue // skip as this face is not visible
           // target position on the target block face. -> 0.5 + (current face) * 0.5
-          const targetPos = block.position.offset(0.5 + (i === 'x' ? visibleFaces[i] * 0.5 : 0), 0.5 + (i === 'y' ? visibleFaces[i] * 0.5 : 0), 0.5 + (i === 'z' ? visibleFaces[i] * 0.5 : 0))
+          const targetPos = block.position.offset(
+            0.5 + (i === 'x' ? visibleFaces[i] * 0.5 : 0),
+            0.5 + (i === 'y' ? visibleFaces[i] * 0.5 : 0),
+            0.5 + (i === 'z' ? visibleFaces[i] * 0.5 : 0)
+          )
           const startPos = bot.entity.position.offset(0, bot.entity.height, 0)
           const rayBlock = bot.world.raycast(startPos, targetPos.clone().subtract(startPos).normalize(), 5)
           if (rayBlock) {
             const rayPos = rayBlock.position
-            if (rayPos.x === block.position.x && rayPos.y === block.position.y && rayPos.z === block.position.z) {
+            if (
+              rayPos.x === block.position.x &&
+                            rayPos.y === block.position.y &&
+                            rayPos.z === block.position.z
+            ) {
               // console.info(rayBlock)
               validFaces.push({
                 face: rayBlock.face,
@@ -75,7 +85,9 @@ function inject (bot) {
           let distSqrt = 999
           for (const i in validFaces) {
             const tPos = validFaces[i].targetPos
-            const cDist = new Vec3(tPos.x, tPos.y, tPos.z).distanceSquared(bot.entity.position.offset(0, bot.entity.height, 0))
+            const cDist = new Vec3(tPos.x, tPos.y, tPos.z).distanceSquared(
+              bot.entity.position.offset(0, bot.entity.height, 0)
+            )
             if (distSqrt > cDist) {
               closest = validFaces[i]
               distSqrt = cDist
@@ -172,7 +184,11 @@ function inject (bot) {
   })
 
   function canDigBlock (block) {
-    return block && block.diggable && block.position.offset(0.5, 0.5, 0.5).distanceTo(bot.entity.position.offset(0, 1.65, 0)) <= 5.1
+    return (
+      block &&
+            block.diggable &&
+            block.position.offset(0.5, 0.5, 0.5).distanceTo(bot.entity.position.offset(0, 1.65, 0)) <= 5.1
+    )
   }
 
   function digTime (block) {
@@ -195,7 +211,14 @@ function inject (bot) {
     }
 
     const creative = bot.game.gameMode === 'creative'
-    return block.digTime(type, creative, bot.entity.isInWater, !bot.entity.onGround, enchantments, bot.entity.effects)
+    return block.digTime(
+      type,
+      creative,
+      bot.entity.isInWater,
+      !bot.entity.onGround,
+      enchantments,
+      bot.entity.effects
+    )
   }
 
   bot.dig = dig

package/lib/plugins/inventory.js

@@ -588,6 +588,7 @@ function inject (bot, { hideErrors }) {
     if (!windowItems || window.id !== windowItems.windowId) {
       // don't emit windowOpen until we have the slot data
       bot.once(`setWindowItems:${window.id}`, () => {
+        extendWindow(window)
         bot.emit('windowOpen', window)
       })
     } else {
@@ -596,6 +597,7 @@ function inject (bot, { hideErrors }) {
         window.updateSlot(i, item)
       }
       updateHeldItem()
+      extendWindow(window)
       bot.emit('windowOpen', window)
     }
   }

package/lib/plugins/particle.js

@@ -0,0 +1,9 @@
+module.exports = inject
+
+function inject (bot, { version }) {
+  const Particle = require('../particle')(bot.registry)
+
+  bot._client.on('world_particles', (packet) => {
+    bot.emit('particle', Particle.fromNetwork(packet))
+  })
+}

package/lib/promise_utils.js

@@ -67,7 +67,7 @@ function onceWithCleanup (emitter, event, { timeout = 0, checkCondition = undefi
     })
   }
 
-  task.promise.finally(() => emitter.removeListener(event, onEvent))
+  task.promise.catch(() => {}).finally(() => emitter.removeListener(event, onEvent))
 
   return task.promise
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mineflayer",
-  "version": "4.5.1",
+  "version": "4.6.0",
   "description": "create minecraft bots with a stable, high level API",
   "main": "index.js",
   "types": "index.d.ts",