NeatUI Framework

A shared interface library for Project Zomboid Build 42. On its own it changes nothing in the game; it's the foundation other mods are built on.

Do you need it? Usually you won't install this mod on its own. Enable it when another mod lists NeatUI Framework as a requirement.

Important: NeatUI Framework must load before every mod that depends on it.

What it's for

NeatUI is a set of ready-made interface components and helper tools shared by several mods. Instead of every author writing the same code over again, they all pull common code from here:

• UI widgets, layouts and rendering tools;
• shared styles and text utilities;
• ready-made scrolling lists and panels;
• compatibility layers for UI and API changes in newer Build 42 versions;
• less duplicated interface code across related mods.

NeatUI adds no gameplay mechanics, recipes, items or world objects of its own. Everything you see comes from the mods that use it.

Mods that use NeatUI

Rocco's mods

Originally created by Rocco, now maintained and updated for newer B42 versions by Afyrmo:

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

Mods by other authors

If your mod uses NeatUI as well and you'd like it listed, get in touch with the framework's author.

Installation and load order

Singleplayer

Enable NeatUI Framework and place it above the mods that depend on it. For example:

NeatUI Framework
Neat Crafting
Neat Crafting addons

If NeatUI doesn't show up in the Mods list, make sure you're running Build 42.

Multiplayer, host and dedicated server

NeatUI has to be added to both server lists:

• Mod ID: NeatUI_Framework
• Workshop ID: 3508537032

Server settings file: Zomboid\Server\<YourServer>.ini

Mods=NeatUI_Framework;DependentMod1;DependentMod2;...
WorkshopItems=3508537032;WorkshopID1;WorkshopID2;...

Common mistake: adding NeatUI_Framework to Mods= alone isn't enough. Workshop ID 3508537032 must also be in WorkshopItems=.

In the Mods= line, NeatUI should come before dependent mods. The server and all clients need the same, up-to-date Workshop files.

Compatibility

• Build 42 only, builds B42.0.2 through B42.21.0.
• Singleplayer, host and dedicated server.
• Kept up to date with UI and API changes in newer B42 builds.
• File paths and filename casing cleaned up for Linux servers.
• Includes the AnimSets and actiongroups folders that media scanning expects on newer B42 servers.

Linux servers and Lua checksums

Recent versions clean up paths and line endings to improve compatibility with Linux servers, where filename case matters, running with:

DoLuaChecksum=true

If you previously worked around problems with DoLuaChecksum=false, update NeatUI and its dependent mods first, then test again with checksum validation turned on.

Post checksum errors and test results in the Linux Server Checksum Feedback thread. Helpful details: - server OS or distro and PZ version; - enabled mods that depend on NeatUI; - the exact checksum or missing-file error; - your Mods= and WorkshopItems= lines.

If something isn't working

1. Close Project Zomboid completely.
2. Check that NeatUI is enabled and loads first.
3. In multiplayer, check both lines: Mods= and WorkshopItems=.
4. Make sure the server and clients have updated Workshop files.
5. If needed, verify the game files in Steam.
6. Launch with only NeatUI and the problem mod.

If that minimal setup works, add your other mods back in small groups until you find the culprit.

Clean Workshop redownload

If the files seem outdated or mismatched:

1. Close Project Zomboid.
2. Unsubscribe from NeatUI Framework.
3. Wait for Steam to remove the mod.
4. If a folder is left behind, delete it manually: ...\Steam\steamapps\workshop\content\108600\3508537032
5. Subscribe again and wait for Steam to finish downloading before you launch the game.

On a dedicated server, also check that the server (SteamCMD) actually downloaded Workshop ID 3508537032.

Removing it

NeatUI itself adds no world objects or gameplay content.

⚠️ But don't disable or remove it while mods that need it are still enabled.

Check each dependent mod's own removal instructions separately: some of them register recipes, entities, XUI/WorldDictionary data or objects already placed in the world.

For mod authors

You're welcome to build your mods on NeatUI Framework.

Add it as a Workshop dependency rather than copying its files into your mod. That way players don't end up with outdated duplicates, and server and client versions stay in sync.

Reporting bugs

Use the Bug Reports thread and include:

• your Project Zomboid version;
• the mode: singleplayer, host or dedicated server;
• which NeatUI-dependent mod is affected;
• your mod list and load order;
• the relevant part of console.txt, coop-console.txt or the server log;
• the first ERROR and its stack trace;
• a screenshot or video, if it helps.

Credits

• Original framework by Rocco: Workshop items
• Maintenance, compatibility updates and newer Build 42 support by Afyrmo: Workshop items
• Thanks to every mod author using NeatUI Framework in their projects.