An open API service indexing awesome lists of open source software.

https://github.com/interrrp/mino

⛏️🤖 A customizable Minecraft bot
https://github.com/interrrp/mino

deno denoland minecraft minecraft-bot mineflayer typescript

Last synced: 3 months ago
JSON representation

⛏️🤖 A customizable Minecraft bot

Awesome Lists containing this project

README

        

# ⛏️🤖 Mino - A customizable Minecraft bot

> Built upon `mineflayer`, Mino is written in [TypeScript](https://www.typescriptlang.org/) with a
> well-documented codebase

## 🔥 Prerequisites

This project only depends on [Deno](https://deno.land).

To install `deno`, follow the instructions on the
[official website](https://deno.land/#installation).

## ⬆️ Usage

To give Mino a try, clone this repository, adjust the [configuration file](mino.config.json) to your
preferences, and start the bot:

```sh
git clone https://github.com/interrrp/mino
# ^ Edit configuration after this step (mino.toml)

# Start the bot
deno task 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 [`deno lint`](https://deno.land/manual/tools/linter)
- Format your code using [`deno fmt`](https://deno.land/manual/tools/formatter)

## 🔑 License

This project is licensed under [GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html).