README.md

⛏️🤖 Mino - A customizable Minecraft bot

Built upon mineflayer, Mino is written in TypeScript with a well-documented codebase

🔥 Prerequisites

This project depends on some software, notably:

• Node.js
• PNPM

  To install pnpm, simply do npm i -g pnpm

⬆️ Usage

To give Mino a try, clone this repository, adjust the configuration file to your preferences, and start the bot:

git clone https://github.com/interrrp/mino
# ^ Edit configuration after this step

# Install dependencies
pnpm i

# Start the bot
pnpm start

🧑‍💻 Contributing

Simply create a pull request! However, there are some guidelines you must follow:

• Code must work (please, this should be common sense.)
• All functions should be documented
• Lint your code using ESLint (pnpm exec eslint .)
• Format your code using Prettier (pnpm exec prettier --write .)

🔑 License

This project is licensed under GPLv3.