Tidy Up Meister

The vanilla game added automatic item return behavior in Build 42.8.0. However, some actions are still not covered by the vanilla implementation, including certain firearm operations and restoring items to their original placement on the ground. Tidy Up Meister complements the vanilla behavior and is designed to work alongside it rather than disable or replace it.

Overview :

Automatically restores your equipment and returns temporarily moved items after an action is completed. Confirmed to work with Build 41/42 Stable and in MP.

Features :

• After an action temporarily changes your equipment, the items in your hands and worn equipment are restored to their previous state.
• Items temporarily moved out of a bag or other container are returned to their original container.
• Items taken from the ground are returned to their original square, position, and rotation.
• Replacement items, such as food left after opening or partially consuming an item, can also be returned to the original location.
• You can toggle automatic re-equipping from the context menu. This setting is stored separately for each character, making it useful when you want to perform several actions continuously without restoring your equipment each time.
• For a visual demonstration, please check the introduction video above.

Build 42 V2 :

The Build 42.20 implementation has been completely redesigned. Instead of individually modifying every supported action, V2 observes the Timed Action queue and identifies sequences in which equipment or items are temporarily moved for another operation.

This allows V2 to support a much wider range of vanilla and modded actions without requiring a separate patch for every action. Explicit player actions, such as manually equipping, unequipping, or placing an item, are distinguished from temporary equipment changes and are not automatically reverted.

Because actions from other mods may use unusual queue behavior, compatibility with every modded action cannot be guaranteed. Please report any action that is not detected correctly.

Options :

Build 42 options are available from the built-in Mod Options screen. Build 41 uses Mod Options, and the available legacy options may differ.

• Show Re-Equip Toggle in Context Menu : Adds an option to the context menu that enables or disables automatic re-equipping after actions.
• Re-Equip Held Items After Interruptions : By default, interrupted actions do not restore your equipment. Enable this option to restore only the items that were in your hands before the interrupted action.
• Return Materials from Dismantling : Returns materials obtained by dismantling an item to the container the dismantled item came from.
• Diagnostic Output : Outputs troubleshooting information to the game log. Detailed logging may affect performance, so enable it only while reproducing an issue.

Compatibility :

• V2 is designed to work alongside the automatic return behavior included in the vanilla game.
• Because V2 observes general Timed Action sequences instead of modifying individual actions, many modded actions can work without dedicated compatibility code.
• Inventory placement information is preserved where the current game APIs provide it.
• Compatibility with unusual or custom Timed Actions cannot be guaranteed. Please report any action that does not restore correctly or is reverted when it should not be.

For Modders :

Most Timed Actions do not require any special integration with Tidy Up Meister. However, compatibility registration may be necessary if your action intentionally changes equipment, clothing, or an item's container as its final result. Without registration, Tidy Up Meister may interpret those changes as temporary preparation and restore the previous state. Please consider implementing the compatibility enhancements based on the For Modders: Compatibility API thread.

Known Issues :

• Some modded actions may use queue or cancellation behavior that V2 cannot identify correctly.
• [h3]If you encounter a problem, please report it in Bug & Issue Reports. I generally do not respond to posts that simply say “It doesn't work” or “It's broken.” Please provide at least a description of the issue and log information, and, if possible, the debugging information listed below.[/h3]
• [list]
• Use the character context menu to disable re-equipping, reproduce the problem again, and state whether this changes the behavior.
• If the issue occurs only when this mod is enabled, please follow the steps below to gather and report detailed information.
• [list]
• Enable "Diagnostic Output" and select "Log only" or "Log + overhead text."
• Reproduce the problem.
• Open the "console.txt" file in your Zomboid user folder.
• Include the lines containing "[P4TidyUpMeister]" in your report.
• Describe the action you were performing and the exact steps that caused the problem.
• List any mods that may be related.
• State whether the problem occurred in SP or MP.

[/list] [/list]

Future plans :

• Bug fixes and compatibility improvements as needed.

Remarks :

• You may include this mod in a mod pack without requesting permission or providing credit. However, please use it at your own risk.
• The mod has been tested in both SP and MP, but behavior may differ depending on the game version, server configuration, and other installed mods.

Release Notes :