Crafting minds for Minecraft with LLMs and mineflayer!

FAQ | Discord Support

The open-source platform for crafting intelligent, collaborative agents in Minecraft using Large Language Models.

mce-nano is a lightweight, open-source platform for running intelligent, LLM-powered Minecraft bots using mineflayer. It is designed for simplicity, low resource usage, and easy customization, making it ideal for running on low-end hardware, servers, or as a starting point for your own Minecraft AI experiments.

• Minimalist: No bloat, just the essentials for LLM-driven Minecraft automation.
• Multi-Provider: Supports OpenAI, Gemini, Andy API, Ollama, Pollinations, and more.
• Configurable: Each bot can have its own model, provider, and personality in config.yml.
• Conversation-Aware: Optionally saves and reloads conversation history per bot.
• Docker-Ready: Simple Dockerfile and docker-compose for easy deployment.
• Community-Driven: Maintained by contributors from the Mindcraft community.

• Minecraft Java Edition (up to v1.21.6)
• Node.js (v18 or newer)
• git
• (Optional) API key for your chosen LLM provider (see keys.example.json)
• (Optional) Docker for containerized deployment

1. Clone the repo:

   git clone https://github.com/mindcraft-ce/mce-nano.git
   cd mce-nano

2. Install dependencies:

   npm install

3. Copy and edit your keys:

   • Copy keys.example.json to keys.json and add your API keys (see FAQ for help).

4. Edit your bot config:

   • Edit config.yml to set up your bot(s), model, provider, and options.

5. Start Minecraft and open to LAN (default port: 55916).

6. Run the bot:

   node main.js

   Or use Docker:

   docker-compose up --build

• Bots: Each entry in config.yml under bots: defines a bot with its own username, model, provider, and options.
• Providers: Supported providers include OpenAI, Gemini, Andy API, Ollama, Pollinations, and more.
• Conversation: Enable save_conversation: true to persist chat history for each bot.
• Interactive: idle_timeout_seconds and idle_message can make the bot active when nothing is happening.

See the comments in config.yml for more details.

Bots support a wide range of commands, including movement, inventory, crafting, and more. Commands are listed in prompt.txt.
Example usage:
!goToPlayer("player_name", 2)
!searchForBlock("oak_log", 16)

Parameters can be quoted or unquoted, and the parser is flexible.

• See FAQ.md for solutions to common errors and setup questions.
• Join the Discord Support for help and discussion.

Maintained by @uukelele-scratch, @Sweaterdog, @riqvip, @MrElmida, and the community.

MIT License. See LICENSE for details.