diff --git a/README.md b/README.md index e187800..bb1f825 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/docs/grab_supplies.md b/docs/grab_supplies.md new file mode 100644 index 0000000..3adf2ec --- /dev/null +++ b/docs/grab_supplies.md @@ -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. diff --git a/docs/media/grab_supplies.png b/docs/media/grab_supplies.png new file mode 100644 index 0000000..8101805 Binary files /dev/null and b/docs/media/grab_supplies.png differ