MinePal is a desktop Minecraft companion app built with Electron that adds an AI agent to your Minecraft world.
- Frontend: Located in
frontend/
, built with React and Vite. - Agent: Minecraft agent logic in
src/agent/
. - Libraries: Located in
libs/
, contains several submodules:node-minecraft-protocol-forge/
mineflayer-collectblock/
mineflayer-auto-eat/
mineflayer-pvp/
prismarine-world/
mineflayer/
minecraft-protocol/
-
Clone the repository
-
Install dependencies:
npm install
-
Install and build submodules:
cd libs for dir in */; do cd "$dir" npm install if [ -f "package.json" ] && grep -q "\"build\"" "package.json"; then npm run build fi if [ -f "package.json" ] && grep -q "\"prepare\"" "package.json"; then npm run prepare fi cd .. done cd ..
-
Build the app:
npm run buildLocal
npm start
- Navigate to
src/agent/
. - Actions that the bot can take are in
src/agent/commands/actions.js
orsrc/agent/commands/queries.js
.
MIT