Skip to content

HyPixelic/mineflayer

Repository files navigation

HyPixelic/mineflayer (Hyflayer)

Caution

Using Mineflayer and an Minecraft Account to log into Hypixel as a Bot violates Hypixels Terms of Service.
This may get your Minecraft Account banned if abused for non chat related things that give you an unfair advantage.

✨ Quick Start

npm » npx jsr add @hypixelic/mineflayer
pnpm » pnpm dlx jsr add @hypixelic/mineflayer
bun » bunx jsr add @hypixelic/mineflayer

import mineflayer from "mineflayer";
import { HyFlayer } from "@hypixelic/mineflayer"

const bot = mineflayer.createBot({
  host: "hypixel.net",
  username: "MICROSOFT_ACCOUNT_EMAIL",
  auth: "microsoft",
  version: "1.8.9",
});

bot.loadPlugin(HyFlayer);

bot.on("HYFLAYER_GUILD_CHAT", (event) => {
  /*
  On every Message sent in the Guild Chat you will now receive an Event Object structured like below:
  {
    "UUID":"14727faefbdc4aff848cd2713eb9939e",
    "username":"Pixelic",
    "message":"Hey",
    "timestamp":1742216120
  }
  */
});

⚙️ Development

  • pnpm install: Installs all required dependencies
  • pnpm build: Runs the TypeScript compiler
  • pnpm test: Launches the Mineflayer Bot for testing purposes

Note

This Project is not affiliated or endorsed by Hypixel, Inc.