docs: add minecraft knowledge base #1

Merged
halofourteen merged 6 commits from feat/knowledge-base into main 2026-05-25 13:11:09 +03:00
halofourteen commented 2026-05-25 13:04:01 +03:00 (Migrated from github.com)

What changed

Added a public reference layer so pepa-pi-bot can consult common Mineflayer and Minecraft facts before drafting its own skills:

  • docs/mineflayer-cheatsheet.md (305 lines): Mineflayer 4.37.x API surface by namespace, including lifecycle, state, world interaction, inventory/windows, chat, crafting, movement, sleep/time/weather, events, and gotchas.
  • docs/plugin-roster.md (248 lines): plugin install/use/gotcha roster, with universal dependencies separated from opt-in/debug plugins.
  • docs/minecraft-knowledge.md (377 lines): concise 1.21.x survival/farmer-bot reference for world rules, mobs, biomes, food, farming, ore layers, tools, recipes, smelting, and safe building.
  • docs/minecraft-recipes.json (228 lines): machine-readable index with 38 important starter recipes.
  • package.json / package-lock.json: added mineflayer-collectblock, mineflayer-auto-eat, mineflayer-tool, and mineflayer-armor-manager.
  • AGENTS.md: added one sentence telling the bot to glance at the new docs before trying new Mineflayer/world tasks.

Total new/changed reference surface: 1,158 lines across the four docs/reference files.

30-second summary

The bot can now skip rediscovering the basics: Mineflayer method signatures and events, which plugin to install for common survival tasks, 1.21.x farming/food/mob/ore rules, core crafting and smelting recipes, and conservative building/light safety heuristics. It still writes its own skills after trying tasks; these docs are the library, not the notebook.

Sources cited

Primary Mineflayer and Prismarine sources:

Plugin sources:

Minecraft Wiki sources used across the mechanics/recipes docs:

Validation

  • npm install mineflayer-collectblock mineflayer-auto-eat mineflayer-tool mineflayer-armor-manager succeeded and updated the lockfile.
  • npm ls --depth=0 succeeds with Mineflayer 4.37.1 and the four new plugin dependencies present.
  • node -e "JSON.parse(...)" validates docs/minecraft-recipes.json; recipe count is 38.
  • git diff --check origin/main..HEAD passes.

Note: npm install reported 10 moderate audit findings and suggested npm audit fix --force; I did not run a breaking audit fix as part of this docs/dependency task.

## What changed Added a public reference layer so pepa-pi-bot can consult common Mineflayer and Minecraft facts before drafting its own skills: - `docs/mineflayer-cheatsheet.md` (305 lines): Mineflayer 4.37.x API surface by namespace, including lifecycle, state, world interaction, inventory/windows, chat, crafting, movement, sleep/time/weather, events, and gotchas. - `docs/plugin-roster.md` (248 lines): plugin install/use/gotcha roster, with universal dependencies separated from opt-in/debug plugins. - `docs/minecraft-knowledge.md` (377 lines): concise 1.21.x survival/farmer-bot reference for world rules, mobs, biomes, food, farming, ore layers, tools, recipes, smelting, and safe building. - `docs/minecraft-recipes.json` (228 lines): machine-readable index with 38 important starter recipes. - `package.json` / `package-lock.json`: added `mineflayer-collectblock`, `mineflayer-auto-eat`, `mineflayer-tool`, and `mineflayer-armor-manager`. - `AGENTS.md`: added one sentence telling the bot to glance at the new docs before trying new Mineflayer/world tasks. Total new/changed reference surface: 1,158 lines across the four docs/reference files. ## 30-second summary The bot can now skip rediscovering the basics: Mineflayer method signatures and events, which plugin to install for common survival tasks, 1.21.x farming/food/mob/ore rules, core crafting and smelting recipes, and conservative building/light safety heuristics. It still writes its own skills after trying tasks; these docs are the library, not the notebook. ## Sources cited Primary Mineflayer and Prismarine sources: - https://github.com/PrismarineJS/mineflayer/blob/master/docs/api.md - https://github.com/PrismarineJS/mineflayer/blob/master/index.d.ts - https://github.com/PrismarineJS/mineflayer/tree/master/examples - https://github.com/PrismarineJS/prismarine-block - https://github.com/PrismarineJS/prismarine-item - https://github.com/PrismarineJS/prismarine-windows - https://github.com/PrismarineJS/prismarine-world - https://github.com/PrismarineJS/node-minecraft-data Plugin sources: - https://github.com/PrismarineJS/mineflayer-pathfinder - https://github.com/PrismarineJS/mineflayer-pathfinder/blob/master/examples/tutorial/goalsExplained.md - https://github.com/TheDudeFromCI/mineflayer-collectblock - https://github.com/linkle69/mineflayer-auto-eat - https://github.com/PrismarineJS/mineflayer-tool - https://github.com/PrismarineJS/MineflayerArmorManager - https://github.com/Darthfett/mineflayer-blockfinder - https://github.com/PrismarineJS/mineflayer-statemachine - https://github.com/PrismarineJS/prismarine-viewer - https://github.com/TheDudeFromCI/mineflayer-pvp - https://github.com/ImHarvol/mineflayer-web-inventory Minecraft Wiki sources used across the mechanics/recipes docs: - https://minecraft.wiki/w/Daylight_cycle - https://minecraft.wiki/w/Sleeping - https://minecraft.wiki/w/Weather - https://minecraft.wiki/w/Light - https://minecraft.wiki/w/Mob_spawning - https://minecraft.wiki/w/Spawn - https://minecraft.wiki/w/Zombie - https://minecraft.wiki/w/Skeleton - https://minecraft.wiki/w/Creeper - https://minecraft.wiki/w/Spider - https://minecraft.wiki/w/Enderman - https://minecraft.wiki/w/Slime - https://minecraft.wiki/w/Witch - https://minecraft.wiki/w/Drowned - https://minecraft.wiki/w/Husk - https://minecraft.wiki/w/Phantom - https://minecraft.wiki/w/Cow - https://minecraft.wiki/w/Sheep - https://minecraft.wiki/w/Pig - https://minecraft.wiki/w/Chicken - https://minecraft.wiki/w/Bee - https://minecraft.wiki/w/Wolf - https://minecraft.wiki/w/Plains - https://minecraft.wiki/w/Forest - https://minecraft.wiki/w/River - https://minecraft.wiki/w/Savanna - https://minecraft.wiki/w/Biome - https://minecraft.wiki/w/Food - https://minecraft.wiki/w/Hunger - https://minecraft.wiki/w/Tutorial:Crop_farming - https://minecraft.wiki/w/Farmland - https://minecraft.wiki/w/Bone_Meal - https://minecraft.wiki/w/Breeding - https://minecraft.wiki/w/Ore - https://minecraft.wiki/w/Ore_(feature) - https://minecraft.wiki/w/Altitude - https://minecraft.wiki/w/Tools - https://minecraft.wiki/w/Pickaxe - https://minecraft.wiki/w/Axe - https://minecraft.wiki/w/Shovel - https://minecraft.wiki/w/Hoe - https://minecraft.wiki/w/Sword - https://minecraft.wiki/w/Durability - https://minecraft.wiki/w/Breaking - https://minecraft.wiki/w/Crafting - https://minecraft.wiki/w/Recipe - https://minecraft.wiki/w/Smelting - https://minecraft.wiki/w/Furnace - https://minecraft.wiki/w/Fuel ## Validation - `npm install mineflayer-collectblock mineflayer-auto-eat mineflayer-tool mineflayer-armor-manager` succeeded and updated the lockfile. - `npm ls --depth=0` succeeds with Mineflayer 4.37.1 and the four new plugin dependencies present. - `node -e "JSON.parse(...)"` validates `docs/minecraft-recipes.json`; recipe count is 38. - `git diff --check origin/main..HEAD` passes. Note: `npm install` reported 10 moderate audit findings and suggested `npm audit fix --force`; I did not run a breaking audit fix as part of this docs/dependency task.
Sign in to join this conversation.