LittleMaidSomeInstructions

A NeoForge 1.21.1 addon for Touhou Little Maid. It adds the Obey task, allowing players to issue server-authoritative collection, harvesting, fluid pickup, navigation, and delivery commands with a configurable command item.

3 downloads
0 followers

A NeoForge 1.21.1 addon for Touhou Little Maid. It adds the Obey task, allowing players to issue server-authoritative collection, harvesting, fluid pickup, navigation, and delivery commands with a configurable command item.

##This module uses AI for assisted development.

Features

  • Commands one or several owned maids whose task is set to Obey.
  • Collects one block or all matching blocks inside an adjustable spherical range.
  • Groups matching blocks into 26-neighbour connected clusters and distributes whole clusters between maids.
  • Selects a valid tool from each maid's backpack and rechecks when that tool breaks.
  • Works empty-handed when the block produces its complete normal drop without a tool.
  • Harvests mature crops, grass, flowers, berry bushes, special TLM crops, and compatible age-based crops.
  • Replants destructive age-based crops; pumpkins and melons remain ordinary block targets.
  • Collects source fluids with empty buckets.
  • Uses real block hardness and tool speed, including synchronized breaking cracks.
  • Chooses the shortest reachable safe working position around a target.
  • Optionally breaks obstacles and builds solid-block bridges when ordinary navigation fails.
  • Delivers only items acquired by the current command to vanilla or modded ItemHandler containers.
  • Supports dedicated servers, multiplayer ownership checks, per-player range synchronization, and localized messages.

Requirements

Component Required version
Minecraft 1.21.1
NeoForge 21.1.248 or a compatible newer 21.1 build
Touhou Little Maid 1.5.3 NeoForge for Minecraft 1.21.1 or compatible
Java 21

The mod and Touhou Little Maid must be installed on both the server and every joining client.

Installation

  1. Install NeoForge for Minecraft 1.21.1.
  2. Put Touhou Little Maid and this mod's JAR into the mods folder.
  3. Start the game or server once to generate the configuration files.
  4. Set one or more owned maids' task to Obey in the maid GUI.

Basic commands

The default command item is a wooden pickaxe. It can be replaced with any registered item in the common config.

Input Result
Main-hand command item + left-click a block Collect only that block.
Main-hand command item + right-click a block Collect matching blocks inside the selected spherical range.
Right-click a mature crop, grass, flower, or berry plant Harvest all matching eligible targets in range using the appropriate method.
Right-click a source fluid Collect matching source blocks with buckets from maid backpacks.
Use the command item on a container Bind that container as the delivery destination for nearby owned Obey maids.
Hold the range modifier and scroll Increase or decrease the range and display a green particle sphere.

Commands affect living, owned maids within 32 blocks of the clicked position whose current work type is Obey. A server-side cooldown and a maximum of 4,096 targets protect multiplayer servers from excessive scans.

Range and clusters

The default range is 8 blocks and the allowed range is 1–32 blocks. Range is stored per player on the logical server, synchronized on login, and can be changed either with modifier + wheel or in a maid's Obey settings screen.

Matching blocks that touch by a face, edge, or corner form one cluster. Whole clusters are assigned round-robin to available maids, while targets inside a cluster are ordered from the clicked block using a deterministic nearest-neighbour route. This avoids splitting diagonal ore veins and reduces unnecessary backtracking.

Tools, drops, and durability

Before assigning work, the server verifies that the maid has a suitable tool or can obtain a complete drop with an empty hand. The maid equips a matching tool from her backpack, uses block/tool speed to calculate breaking time, consumes durability, and selects a replacement if the tool breaks. If no replacement exists, the task stops with a localized message. A block is not destroyed when the selected tool would produce no drops.

Crops and fluids

  • Sweet berry bushes and berry-bearing vines are harvested without destroying the plant.
  • Mature age-based crops are broken for drops and reset to their minimum age to represent replanting.
  • Touhou Little Maid special crop handlers are used when another mod has registered one.
  • Pumpkins and melons are treated as normal blocks and are not replanted.
  • Only source fluids are collected, and the maid must have an empty bucket.

Navigation, obstacle breaking, and bridges

For every target, the server evaluates safe standing positions within interaction distance, rejects hazardous or obstructed positions, creates real paths, and selects the shortest reachable route. Touhou Little Maid's normal movement controller handles ordinary one-block jumps.

When no route exists or a maid remains stuck, optional fallback behavior can break the blocking foot/head block or place a bridge in the target direction. Bridge blocks must be full solid blocks without block entities and cannot be falling blocks such as sand or gravel. The current GUI switches are re-read during an active task, so disabling bridge building prevents later placements immediately.

Delivery containers and timing

Bind a chest or any modded block exposing NeoForge's ItemHandler capability by using the command item on it. Each maid stores her own container position and dimension.

The Obey GUI offers these delivery triggers:

  • after a configurable time interval;
  • after finishing one connected cluster;
  • after collecting one full stack;
  • when the maid backpack is full.

Regardless of those optional triggers, a bound container is always visited when the command finishes and there are tracked command items to deliver. Only items gained during the current command are moved; existing maid inventory contents are preserved.

Configuration

Common/server configuration

File: config/littlemaidsomeinstructions-common.toml

command_item = "minecraft:wooden_pickaxe"

command_item accepts a registered item resource ID, including items from other mods. The server value is authoritative and is synchronized to players when they log in. Restart the world or dedicated server after changing it.

Client configuration and key binding

File: config/littlemaidsomeinstructions-client.toml

range_modifier_default_key = "key.keyboard.left.control"

This value defines the default/reset binding and requires a game restart after editing. The active binding can be changed normally under:

Options → Controls → Key Binds → Little Maid: Some Instructions → Range adjustment modifier

Minecraft saves the Controls-menu override in its normal options file. Pressing Reset returns to the default specified by the client config.

Per-maid Obey settings

Setting Meaning
Collection range Range copied to the controlling player's current command range.
Break obstacles Allows timed destruction of blocks obstructing fallback movement.
Build bridges Allows safe full solid blocks from the backpack to be placed across gaps.
Timed delivery Enables interval-based delivery.
Cluster delivery Delivers after each connected cluster.
Full-stack delivery Delivers after the command has collected a complete stack.
Full-backpack delivery Delivers when no backpack slot has usable space.
Delivery interval 5–600 seconds when timed delivery is enabled.

Multiplayer and security model

All target discovery, ownership checks, tool validation, path decisions, drops, world changes, and container transfers happen on the logical server. Clients only send a requested range and display particles/messages. The server clamps the range, checks the synchronized command item again, and sends the accepted value back. Work sessions are bound to maid UUID, owner UUID, and dimension and stop when ownership, task type, or player connection changes.

No gallery available for this project.