2020-04-16 20:22:57 +00:00
# Cubbot <!-- omit in toc -->
[](https://build.wadza.fr/me/cubbot)
Mostly AFK Minecraft bot
Scalliony API and UI
- [Setup ](#setup )
- [Building ](#building )
- [Usage ](#usage )
- [Config ](#config )
- [Run ](#run )
2020-04-20 21:07:23 +00:00
- [Note ](#note )
2020-04-16 20:22:57 +00:00
- [Tests ](#tests )
- [License ](#license )
## Setup
Cubbot uses modules with could be enabled at compile time in `src/modules/index.ts`
## Building
```
2020-04-20 21:07:23 +00:00
yarn run build
2020-04-16 20:22:57 +00:00
```
## Usage
### Config
- Copy `.env.sample` as `.env`
- Edit `CORE_HOST` , `CORE_USER` , `CORE_PASS` and maybe others.
### Run
```
2020-04-20 21:07:23 +00:00
yarn run test
2020-04-16 20:22:57 +00:00
```
2020-04-20 21:07:23 +00:00
### Note
2020-04-22 22:08:52 +00:00
`minecraft-data` package isn't updated for 1.15+. As a workaround, data will be downloader from `https://pokechu22.github.io/Burger/{version}.json` and cached in `data` folder
2020-04-20 21:07:23 +00:00
2020-04-16 20:22:57 +00:00
## Tests
```
2020-04-20 21:07:23 +00:00
yarn run test
2020-04-16 20:22:57 +00:00
```
## License
Distributed under the GPL3 license. Copyright (c) 2020, Maelys Bois.
