NeatUI Framework [B42]

NeatUI Framework is a lightweight shared UI framework for Project Zomboid Build 42 mods.

You usually do not use this mod directly. Install and enable it when another mod lists NeatUI Framework as a requirement.

Important: if another mod depends on NeatUI Framework, load NeatUI Framework BEFORE that mod.

---

NeatUI Framework provides shared UI tools used by other Project Zomboid mods. It helps dependent mods keep their interfaces cleaner, more consistent, and easier to maintain across different Build 42 versions.

• Shared UI framework / library for Build 42 mods
• Reusable UI helpers, widgets, layout tools, rendering utilities, and styling support
• Compatibility helpers for UI changes across different B42 builds
• Cleaner and more consistent interfaces for supported mods
• Less duplicated UI code between related mods

You need this mod only if another mod requires it.

If none of your enabled mods depend on NeatUI Framework, you can leave it disabled.

This framework does not add gameplay features by itself. Its visible effects depend on the mods that use it.

NeatUI Framework is used by several UI-focused mods originally created by Rocco and maintained / updated for newer Build 42 versions by Afyrmo, including:

• CleanUI
• Modern Status
• The Shortcut
• Neat Crafting
• Neat Building
• Project Cook

It is also used by:

• Neat Crafting & Neat Building – XP & Mod Display — created by Afyrmo
• Neat Rocco’s UI — created by ArtNod

You may also like Clean HotBar, which follows a similar clean UI approach.

Enable NeatUI Framework in your mod list and place it before any mod that depends on it.

For multiplayer, NeatUI Framework must be added to both server lists:

• Mods:
  NeatUI_Framework
• Steam Workshop:
  3508537032

You can check this in your server config:

It should include:

NeatUI Framework must be loaded before any mod that depends on it.

If a dependent mod works in Single Player but not when hosting a server, this is one of the first things to check.

• Build 42 only
• Supports Build 42.0.2 to 42.19.x
• Intended for SP / MP Host / Dedicated Server setups
• Includes compatibility maintenance for UI changes introduced across newer Build 42 versions
• This framework is a library; visible behavior depends on the mods that use it

Recent versions include cleanup intended to improve compatibility with Linux dedicated servers using:

Lua file paths and line endings have been normalized to help avoid checksum issues on case-sensitive servers.

If you previously used this workaround:

you may be able to re-enable Lua checksum validation after updating.

Recommended: update NeatUI Framework and all dependent mods, then test your server with:

Linux dedicated server testing is especially welcome.

Please use the Linux Server Checksum Feedback discussion if you can test NeatUI Framework or any dependent mod on Linux with

Useful reports include:

• Server OS / distro
• Project Zomboid version
• Enabled NeatUI-dependent mods
• Whether clients can join successfully
• Exact checksum or “file does not exist” error, if any
• Relevant server config lines:
  • Mods=…
  • WorkshopItems=…
  • DoLuaChecksum=true

If a mod that depends on NeatUI Framework does not work:

• Make sure NeatUI Framework is enabled
• Make sure it is loaded before dependent mods
• In MP, make sure both Mods and WorkshopItems include it
• Make sure the host/server and clients have the same updated Workshop files
• Try a clean Workshop redownload if files appear mismatched between host and client

For a clean redownload:

• Close Project Zomboid completely
• Unsubscribe from NeatUI Framework
• Delete the Workshop folder if it still exists:
  …Steamsteamappsworkshopcontent1086003508537032
• Subscribe again
• Let Steam finish downloading the mod before starting Project Zomboid

If you find an issue, please use the Bug Reports discussion and include:

• Project Zomboid version
• SP / MP Host / Dedicated Server
• Operating system for client and server
• Mod list and load order
• Relevant part of console.txt / coop-console.txt / server console
• Exact red error message, if any
• Screenshot if possible, especially if the issue is visual

For Linux dedicated server checksum testing, please use the separate Linux Server Checksum Feedback discussion.

• Original mod by Rocco: PZ Workshop Items
• Maintenance, compatibility updates, and newer Build 42 support by Afyrmo: PZ Workshop Items

Workshop ID: 3508537032
Mod ID: NeatUI_Framework