Skip to content
This repository was archived by the owner on Feb 18, 2025. It is now read-only.

Latest commit

 

History

History
122 lines (86 loc) · 3.67 KB

README.md

File metadata and controls

122 lines (86 loc) · 3.67 KB

⛏️ Minecraft agent player for アイリ (Airi)

Warning

As the PoC and initial implementation has been achieved, as well as since all the airi-minecraft history of changes has been merged in to the meta repo of airi under services/minecraft directory with 219407a commit, this repository will be archived and no longer maintained.

If you wish to take a closer look on how we implemented it, please go to: services/minecraft.

This doesn't mean アイリ (Airi) was discontinued, we are still actively maintain and developing it to achieve out roadmap. As always, you are welcome to join us and contribute to airi.

Note

This project is part of the Project アイリ (Airi), we aim to build a LLM-driven VTuber like Neuro-sama (subscribe if you didn't!) if you are interested in, please do give it a try on live demo.

An intelligent Minecraft bot powered by LLM. AIRI can understand natural language commands, interact with the world, and assist players in various tasks.

🎥 Preview

demo

✨ Features

  • 🗣️ Natural language understanding
  • 🏃‍♂️ Advanced pathfinding and navigation
  • 🛠️ Block breaking and placing
  • 🎯 Combat and PvP capabilities
  • 🔄 Auto-reconnect on disconnection
  • 📦 Inventory management
  • 🤝 Player following and interaction
  • 🌍 World exploration and mapping

🚀 Getting Started

📋 Prerequisites

  • 📦 Node.js 22+
  • 🔧 pnpm
  • 🎮 A Minecraft server (1.20+)

🔨 Installation

  1. Clone the repository:
git clone https://github.com/moeru-ai/airi-minecraft.git
cd airi-mc
  1. Install dependencies:
pnpm install
  1. Create a .env.local file with your configuration:
OPENAI_API_KEY=your_openai_api_key
OPENAI_API_BASEURL=your_openai_api_baseurl

BOT_USERNAME=your_bot_username
BOT_HOSTNAME=localhost
BOT_PORT=25565
BOT_PASSWORD=optional_password
BOT_VERSION=1.20
  1. Start the bot:
pnpm dev

🎮 Usage

Once the bot is connected, you can interact with it using chat commands in Minecraft. All commands start with #.

Basic Commands

  • #help - Show available commands
  • #follow - Make the bot follow you
  • #stop - Stop the current action
  • #come - Make the bot come to your location

Natural Language Commands

You can also give the bot natural language commands, and it will try to understand and execute them. For example:

  • "Build a house"
  • "Find some diamonds"
  • "Help me fight these zombies"
  • "Collect wood from nearby trees"

🛠️ Development

Project Structure

src/
├── agents/     # AI agent implementations
├── composables/# Reusable composable functions
├── libs/       # Core library code
├── mineflayer/ # Mineflayer plugin implementations
├── prompts/    # AI prompt templates
├── skills/     # Bot skills and actions
└── utils/      # Utility functions

Commands

  • pnpm dev - Start the bot in development mode
  • pnpm lint - Run ESLint
  • pnpm typecheck - Run TypeScript type checking
  • pnpm test - Run tests

🙏 Acknowledgements

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.