Skip to content
This repository has been archived by the owner on Dec 30, 2024. It is now read-only.

Latest commit

 

History

History
135 lines (89 loc) · 3.39 KB

README.md

File metadata and controls

135 lines (89 loc) · 3.39 KB

mineflayer-elytrafly-commonjs

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

amoraschi

How to use with mineflayer bots

First install the package with npm:

npm i mineflayer-elytrafly-commonjs

Then load the plugin by adding:

const { elytrafly } = require("mineflayer-elytrafly-commonjs")
bot.loadPlugin(elytrafly)

In your code (preferably after spawning the bot)

Example

const { elytrafly } = require("mineflayer-elytrafly-commonjs");
const Vec3 = require("vec3").Vec3;
const bot = mineflayer.createBot({ username: 'Player' });

bot.loadPlugin(elytrafly);

bot.once("spawn", async () => {
  bot.elytrafly.elytraFlyTo(new Vec3(100, 0, 100));
  // The y level doesn't matter because it will just fall down.
  
  await bot.once("elytraFlyGoalReached", () => {});
  bot.chat("I have arrived at the destination!");
});

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
}

Warning | I don't recommend changing the speed option, bot.elytrafly.elytraFlyTo() 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.elytraFlyTo(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)

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.elytraFlyTo

Credits to Amoraschi https://www.npmjs.com/package/mineflayer-elytrafly https://github.com/amoraschi/mineflayer-elytrafly