mineflayer-elytrafly's Introduction

mineflayer-elytrafly

Plugin for Mineflayer bots to make them fly (i.e. blatantly cheat)

Compatible with both CommonJS and ES syntax

How to use with mineflayer bots

First install the package with npm:

npm i mineflayer-elytrafly

Then load the plugin by adding:

bot.loadPlugin(elytrafly)

In your code (preferably after spawning the bot)

API

Properties

Assuming the bot has already an elytra equipped

bot.elytrafly.options

Options for the plugin, applies even while flying

{
  speed: number // Default: 0.05
  velocityUpRate: number // Default: 0.1
  velocityDownRate: number // Default: 0.01
  proportionalSpeed: boolean // Default: true
}

Warning | I don't recommend changing the speed option, bot.elytrafly.flyTo changes it but reverts it back when it's finished

Methods

bot.elytrafly.start()

Makes the bot fly with the elytra, by default it will go forwards, you can change this before starting with:

bot.elytrafly.setControlState(state: string, value: boolean)

The bot should follow its sight, this means you can change its course by changing the bot's yaw

States:

forward
back
up
down

bot.elytrafly.stop()

Stops the bot without closing the elytra and makes it descend slowly (shouldn't take fall damage)

bot.elytrafly.forceStop()

Stops the bot closing the elytra (could potentially kill the bot with fall damage)

bot.elytrafly.flyTo(position: Vec3)

Experimental | The bot will attempt to go near the position by flying (doesn't pathfind, just looks straight at the position and flies there, needs an open space)

If proportionalSpeed is set to true, the flying speed is proportional to the distance to the goal, but once it gets near, it slows down, and slowly descends to the ground

Events

elytraFlyGoalReached

Self-explanatory, fires when it has reached the goal with bot.elytrafly.flyTo

mineflayer-elytrafly's People

Contributors

Stargazers

Watchers