# prismarinejs/mineflayer

**Attribution required: if you use, quote, or summarise this content, you must credit and link back to [awesome-repositories.com](https://awesome-repositories.com/repository/prismarinejs-mineflayer).**

7,139 stars · 1,356 forks · JavaScript · MIT

## Links

- GitHub: https://github.com/PrismarineJS/mineflayer
- Homepage: https://prismarinejs.github.io/mineflayer/
- awesome-repositories: https://awesome-repositories.com/repository/prismarinejs-mineflayer.md

## Topics

`bot` `minecraft` `minecraft-api` `minecraft-bot` `network` `nodejs`

## Description

Mineflayer is a Node.js game automation framework and JavaScript API for creating programmable Minecraft bots. It functions as a headless game client that implements the Minecraft protocol to connect external applications to game servers without a graphical user interface.

The project enables the automation of character actions, including movement, combat, and interaction with the game world. It provides specialized systems for calculating navigation routes through 3D environments, manipulating blocks to build or mine, and managing user account authentication and session tokens.

The framework also covers inventory and resource management, tracking item storage and crafting processes. Additionally, it includes capabilities for monitoring real-time entity locations, exchanging chat messages, and mirroring the world state from server packets.

## Tags

### Game Development

- [Minecraft Bot Frameworks](https://awesome-repositories.com/f/game-development/minecraft-bot-frameworks.md) — Provides a JavaScript API to automate character actions, movement, and combat within Minecraft.
- [Character Automation](https://awesome-repositories.com/f/game-development/character-automation.md) — Automates character movements and world interactions via high-level commands. ([source](https://github.com/prismarinejs/mineflayer#readme))
- [Game Automation Frameworks](https://awesome-repositories.com/f/game-development/game-automation-frameworks.md) — Provides a comprehensive set of tools for automating movements, block manipulation, and entity tracking.
- [Headless Game Clients](https://awesome-repositories.com/f/game-development/headless-game-clients.md) — Implements a game client that runs without a GUI to control entities programmatically.
- [Minecraft Server Integrations](https://awesome-repositories.com/f/game-development/minecraft-server-integrations.md) — Connects external applications to Minecraft servers to monitor events and interact with players.
- [Programmable Game Characters](https://awesome-repositories.com/f/game-development/programmable-game-characters.md) — Provides a JavaScript library for creating programmable characters that interact with game servers.
- [Agent Navigation Systems](https://awesome-repositories.com/f/game-development/agent-navigation-systems.md) — Calculates physics and movement to navigate entities to target locations while avoiding obstacles. ([source](https://github.com/prismarinejs/mineflayer#readme))
- [Entity Movement Tracking](https://awesome-repositories.com/f/game-development/entity-movement-tracking.md) — Monitors positional data and state updates for all entities within the game world.
- [Environmental Voxel Manipulation](https://awesome-repositories.com/f/game-development/environmental-voxel-manipulation.md) — Automates the placement and removal of blocks to build structures or mine resources.
- [In-Game Inventory Systems](https://awesome-repositories.com/f/game-development/in-game-inventory-systems.md) — Provides utilities to track item storage, manage crafting processes, and coordinate interactions with chests and dispensers. ([source](https://github.com/prismarinejs/mineflayer#readme))
- [Minecraft Session Management](https://awesome-repositories.com/f/game-development/minecraft-session-management.md) — Manages user authentication and session tokens to allow bots to log into servers securely.
- [Pathfinding Integration](https://awesome-repositories.com/f/game-development/pathfinding-integration.md) — Implements a programmatic navigation engine to calculate optimal 3D movement routes for bots.
- [Voxel Interaction Utilities](https://awesome-repositories.com/f/game-development/voxel-interaction-utilities.md) — Provides capabilities to query block locations and perform actions like digging and building. ([source](https://github.com/prismarinejs/mineflayer#readme))
- [World Entity Tracking](https://awesome-repositories.com/f/game-development/world-entity-tracking.md) — Monitors the real-time location and status of players and other entities within the game environment. ([source](https://github.com/prismarinejs/mineflayer#readme))

### Data & Databases

- [Protocol Packet Parsers](https://awesome-repositories.com/f/data-databases/data-processing-pipelines/stream-processing-systems/packet-based-stream-processors/protocol-packet-parsers.md) — Parses raw TCP streams into structured JavaScript objects according to the Minecraft binary protocol.
- [Game World Mirroring](https://awesome-repositories.com/f/data-databases/entity-modeling/entity-table-synchronizers/remote-to-local-database-synchronizers/state-mirroring/game-world-mirroring.md) — Maintains a local memory cache of the game environment based on server packets.

### Networking & Communication

- [Game Protocol Implementations](https://awesome-repositories.com/f/networking-communication/game-protocol-implementations.md) — Implements a high-level interface for authentication, chat, and world synchronization via the Minecraft protocol.
- [Game State Event Listeners](https://awesome-repositories.com/f/networking-communication/distributed-systems-p2p/distributed-computing/communication-protocols/websocket-implementations/websocket-event-systems/game-state-event-listeners.md) — Listens and reacts to real-time game state changes including chat messages, health, and weather. ([source](https://github.com/prismarinejs/mineflayer#readme))

### Business & Productivity Software

- [Game Inventory Management](https://awesome-repositories.com/f/business-productivity-software/bookmark-managers/bulk-management-tools/game-inventory-management.md) — Automates the organization of items, material crafting, and storage container management.

### Security & Cryptography

- [User Authentication Systems](https://awesome-repositories.com/f/security-cryptography/user-authentication-systems.md) — Provides mechanisms for verifying user identities and managing session tokens for secure server access. ([source](https://github.com/prismarinejs/mineflayer#readme))