{"repo": "bohuyeshan-apb/n-t-ai", "files": {"backend/app/plugins/Minecraft-mindcraft/src/README.md": {"6c5b3e1297656338ecd5ae2b503a1d919ed70873": {"t": 1785747292.032052, "n": 13088, "h": "40d06275c91ad98e", "c": "
Crafting minds for Minecraft with LLMs and Mineflayer!
\n\n\n FAQ | \n Discord Support | \n Video Tutorial | \n Blog Post | \n Contributor TODO | \n Paper Website | \n MineCollab\n
\n\n> [!Caution]\nDo not connect this bot to public servers with coding enabled. This project allows an LLM to write/execute code on your computer. The code is sandboxed, but still vulnerable to injection attacks. Code writing is disabled by default, you can enable it by setting `allow_insecure_coding` to `true` in `settings.js`. Ye be warned.\n\n# Getting Started\n## Requirements\n\n- [Minecraft Java Edition](https://www.minecraft.net/en-us/store/minecraft-java-bedrock-edition-pc) (up to v1.21.6, recommend v1.21.6)\n- [Node.js Installed](https://nodejs.org/) (Node v18 or v20 LTS recommended. Node v24+ may cause issues with native dependencies)\n- At least one API key from a supported API provider. See [supported APIs](#model-customization). OpenAI is the default.\n\n> [!Important]\n> If installing node on windows, ensure you check `Automatically install the necessary tools`\n>\n> If you encounter `npm install` errors on macOS, see the [FAQ](FAQ.md#common-issues) for troubleshooting native module build issues\n\n## Install and Run\n\n1. Make sure you have the requirements above.\n\n2. Download the [latest release](https://github.com/mindcraft-bots/mindcraft/releases/latest) and unzip it, or clone the repository.\n\n3. Rename `keys.example.json` to `keys.json` and fill in your API keys (you only need one). The desired model is set in `andy.json` or other profiles. For other models refer to the table below.\n\n4. In terminal/command prompt, run `npm install` from the installed directory\n\n5. Start a minecraft world and open it to LAN on localhost port `55916`\n\n6. Run `node main.js` from the installed directory\n\nIf you encounter issues, check the [FAQ](https://github.com/mindcraft-bots/mindcraft/blob/main/FAQ.md) or find support on [discord](https://discord.gg/mp73p35dzC). We are currently not very responsive to github issues. To run tasks please refer to [Minecollab Instructions](minecollab.md#installation)\n\n\n# Configuration\n## Model Customization\n\nYou can configure project details in `settings.js`. [See file.](settings.js)\n\nYou can configure the agent's name, model, and prompts in their profile like `andy.json`. The model can be specified with the `model` field, with values like `model: \"gemini-2.5-pro\"`. You will need the correct API key for the API provider you choose. See all supported APIs below.\n\nCrafting minds for Minecraft with LLMs and Mineflayer!
\n\n\n FAQ | \n Discord Support | \n Video Tutorial | \n Blog Post | \n Contributor TODO | \n Paper Website | \n MineCollab\n
\n\n> [!Caution]\nDo not connect this bot to public servers with coding enabled. This project allows an LLM to write/execute code on your computer. The code is sandboxed, but still vulnerable to injection attacks. Code writing is disabled by default, you can enable it by setting `allow_insecure_coding` to `true` in `settings.js`. Ye be warned.\n\n# Getting Started\n## Requirements\n\n- [Minecraft Java Edition](https://www.minecraft.net/en-us/store/minecraft-java-bedrock-edition-pc) (up to v1.21.6, recommend v1.21.6)\n- [Node.js Installed](https://nodejs.org/) (Node v18 or v20 LTS recommended. Node v24+ may cause issues with native dependencies)\n- At least one API key from a supported API provider. See [supported APIs](#model-customization). OpenAI is the default.\n\n> [!Important]\n> If installing node on windows, ensure you check `Automatically install the necessary tools`\n>\n> If you encounter `npm install` errors on macOS, see the [FAQ](FAQ.md#common-issues) for troubleshooting native module build issues\n\n## Install and Run\n\n1. Make sure you have the requirements above.\n\n2. Download the [latest release](https://github.com/mindcraft-bots/mindcraft/releases/latest) and unzip it, or clone the repository.\n\n3. Rename `keys.example.json` to `keys.json` and fill in your API keys (you only need one). The desired model is set in `andy.json` or other profiles. For other models refer to the table below.\n\n4. In terminal/command prompt, run `npm install` from the installed directory\n\n5. Start a minecraft world and open it to LAN on localhost port `55916`\n\n6. Run `node main.js` from the installed directory\n\nIf you encounter issues, check the [FAQ](https://github.com/mindcraft-bots/mindcraft/blob/main/FAQ.md) or find support on [discord](https://discord.gg/mp73p35dzC). We are currently not very responsive to github issues. To run tasks please refer to [Minecollab Instructions](minecollab.md#installation)\n\n\n# Configuration\n## Model Customization\n\nYou can configure project details in `settings.js`. [See file.](settings.js)\n\nYou can configure the agent's name, model, and prompts in their profile like `andy.json`. The model can be specified with the `model` field, with values like `model: \"gemini-2.5-pro\"`. You will need the correct API key for the API provider you choose. See all supported APIs below.\n\n