Kvist

Build Kvist's Nest and a friendly greydwarf named Kvist moves in. He keeps your base in order: he sorts what you drop in the nest into labelled chests, keeps your smelters, kilns and eitr refineries running, refuels your fires, and farms your crops.

Beta. Single-player is well tested; multiplayer is designed for but less tested. Back up your world before trying it on a server.

Getting started

1. Build a workbench, then Kvist's Nest from the hammer menu (Misc): 3 Ancient Seeds.
2. Kvist appears beside it. The nest is also a 10×5 chest.
3. Hover a chest and press L to give it a label. On a chest that already holds items, the first press labels it after its contents. Shift+L cycles backwards. Unlabelled chests are never touched.
4. Hover the nest and press L to switch Kvist's job: Sorting → Smelting → Upkeep → Farming (Shift+L goes back).
5. Look at Kvist to see his job and what he's carrying, and press E to pet him. The nest shows today's tally, and tells you if something is stopping him.

Kvist works within 50 m of his nest. He runs, opens and closes doors on his way (only doors he opened), and never touches chests a player has open.

Jobs

Sorting

Put anything in the nest. Kvist carries up to 10 stacks per trip to the nearest chest with the right label.

• Auto chests: an empty chest labelled Auto is claimed for the first category that needs a home.
• No chest for something? It waits in the nest, and the nest tells you which label is missing. (Optional: turn on UseAreaFallback to let him use another chest in the same area instead.)
• Incoming Loot: anything uncategorised waits in the nest until you label a chest Incoming Loot.

Categories: Valuables & Boss Items · Trophies · Weapons & Ammo · Armour & Accessories · Tools · Cooked Food & Meads · Cooking & Mead Ingredients · Farming · Raw Food · Wood · Stone & Minerals · Building Extras · Ore & Coal · Metals & Parts · Creature Materials · Incoming Loot.

Smelting

Kvist runs every smelter, blast furnace, charcoal kiln and eitr refinery in range:

• Fuel first (Coal, Sap), then ore, scrap or Soft Tissue, taken from the nest or the matching chests.
• Coal is made on demand: kilns get plain Wood only when a furnace has ore to smelt and no coal is left anywhere. Fine Wood and Core Wood are never burned.
• Bars, Eitr and charcoal are picked up and put away.

Upkeep

• Refuels hearths, campfires, torches, braziers and sconces with their own fuel. Fires you switched off are left alone.
• Empties beehives and sap collectors and stores the honey and sap.

Farming

• Harvests ripe crops on cultivated soil and stores them.
• Plants every empty patch of cultivated soil, sharing it evenly between crops, only where they'll grow.
• When a crop runs out of seeds, plants the vegetable as a seed plant so the farm makes its own seed again.
• Picks up chicken eggs and feathers, and empties beehives.
• Looks after tamed animals: keeps the 2 best-starred adults of each kind as breeders and butchers the rest, feeds hungry animals from your chests, and keeps a flock of chickens (leaving eggs alone to hatch while it is small). Named animals and saddled mounts are never touched. Butchering is off until you pick a species: look at one of your animals and press Shift+L.

If Kvist dies

He drops what he was carrying and returns to the nest after 120 seconds. Removing the nest sends him away (he drops his load first).

Configuration

BepInEx/config/com.ryan.greydwarfsorter.cfg: work radius, carry size, respawn time, running, idle check, pickup batch size, label key, nest sound. On a server running the mod, the server's values apply.

Categories live in BepInEx/config/GreydwarfSorter/categories.yaml: rename, reorder or move items between categories. * works as a wildcard.

Console commands

Command
gs_debug	Label over Kvist showing his job, target and what he carries
gs_classify <item>	Which category an item sorts into
gs_classify_all	Reload categories.yaml and write every item's category to classified.csv
gs_dumpitems	Write every item to items.csv
gs_fillcarry, gs_killkvist, gs_stress	Testing (need devcommands)

Multiplayer

Works on servers that don't run the mod. If the server does run it, every player needs it. Players without the mod won't see the nest or Kvist.

Known limits

• Players can't hurt Kvist unless PvP is on (the game protects tamed creatures).
• A target behind two doors that both need opening (an airlock) is skipped.
• Kvist only works while someone is near enough for his area to be loaded.

Feedback

Bugs, ideas and questions: post on the Nexus page (Posts or Bugs tab).