Add docs about grabbing supplies

This commit is contained in:
Tanner Collin 2021-05-02 01:26:06 +00:00
parent 2fc08be581
commit 6315f8c309
3 changed files with 32 additions and 0 deletions

View File

@ -48,6 +48,8 @@ $ EMAIL=you@domain.com PASSWORD=supersecret SERVER=minecraft.example.com ./run_l
[How to Cache Items](docs/cache_items.md)
[How to Grab Supplies](docs/grab_supplies.md)
## Commands
The command prefix character is the last character of the bot's name. For

30
docs/grab_supplies.md Normal file
View File

@ -0,0 +1,30 @@
# Mosfet Minecraft Bot
## How to Grab Supplies
![a single barrel with two double chests above it](media/grab_supplies.png)
Mosfet will automatically grab supplies he needs to do his job from nearby
[barrels](https://minecraft.fandom.com/wiki/Barrel#Crafting). Before starting
the job, he will check each barrel for related supplies and grab some depending
on the job. He will recheck the barrels for supplies periodically to try and get
more.
If he can't find any barrels, he will try to continue doing the job anyway. If
his inventory is too full, he will skip grabbing supplies.
### Advanced Details
The global `g.maximum_supply_slots` in `bot.py` controls the maximum amount of
used slots allowed while grabbing supplies.
In `jobs.py`, each job sets the `grab_supplies_states.supplies` dictionary to
specify what items to grab and how many. Here's an example:
```
self.grab_supplies_states.supplies = {
tuple([items.PUMPKIN_ID]): (64, 3),
}
```
This tells Mosfet to grab three stacks of pumpkins if he ever has less than 64.

Binary file not shown.

After

Width:  |  Height:  |  Size: 490 KiB