NeatUI Framework [B42]

Build Support: Project Zomboid Build 42 — SP / MP Host / Dedicated

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

You normally do not use this mod by itself. Install and enable it when another mod lists NeatUI Framework as a requirement.

Important: NeatUI Framework must load before mods that depend on it.

[hr]

What NeatUI Provides

NeatUI contains reusable interface components and compatibility helpers shared by multiple mods:

• UI widgets, panels and layouts
• Scrolling, list and rendering helpers
• Shared styling, text and tooltip utilities
• Reusable textures and UI assets
• Compatibility helpers for UI/API differences across Build 42 versions
• Shared infrastructure that reduces duplicated UI code between mods

Recent versions also include rendering optimizations for frequently used UI components such as ThreePatch elements.

NeatUI does not add recipes, items, traits, world objects or gameplay features by itself.

Its visible effects come from the mods that use it.

[hr]

Mods Using NeatUI Framework

Rocco / Afyrmo Mods

• CleanUI
• Modern Status
• The Shortcut
• Neat Crafting
• Neat Building
• Project Cook
• Neat Crafting & Neat Building – XP & Mod Display

Other Mods Using NeatUI

• Neat Rocco's UI — ArtNod
• NeatUI Hairstyler — Gimmi
• NeatUI XP Drop — Gimmi
• NeatUI Equipment — Gimmi
• Try Before You Wear — Diakøe
• RPG Inventory — Raziel Nomack

If your mod uses NeatUI Framework and you would like it listed here, feel free to contact me.

[hr]

Installation & Load Order

Enable NeatUI Framework before every mod that requires it.

Example:

NeatUI Framework
Neat Crafting
Project Cook
Other NeatUI-dependent mods

The dependent mods can normally be reordered relative to each other; the important rule is that NeatUI Framework loads first.

If NeatUI does not appear in the Mods list, make sure you are using Project Zomboid Build 42.

[hr]

Multiplayer / Dedicated Server

For MP Host and Dedicated Server, NeatUI must be included in both server lists:

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

Adding only `NeatUI_Framework` to `Mods=` is not enough. Workshop ID 3508537032 must also be present in `WorkshopItems=`.

After Workshop updates, fully restart the server before players reconnect so clients and server use matching files.

[hr]

Build 42 Compatibility

NeatUI is maintained for Build 42 and includes compatibility helpers for UI/API changes introduced across different B42 versions.

Current compatibility work includes:

• SP / MP Host / Dedicated support
• Compatibility fallbacks for Build 42 UI API changes
• Normalized Lua paths and line endings for case-sensitive Linux servers

Build-specific compatibility is handled internally where possible instead of requiring users to select separate versions manually.

[hr]

Linux Dedicated Servers / Lua Checksum

NeatUI includes path, filename and line-ending cleanup intended to reduce checksum and case-sensitivity problems on Linux servers using:

DoLuaChecksum=true[/code]

If you previously used `DoLuaChecksum=false` as a workaround, update NeatUI and all dependent mods before testing again with checksum validation enabled.

For Linux/checksum reports:
[url=https://steamcommunity.com/workshop/filedetails/discussion/3508537032/844005195821120294/][b]Linux Server Checksum Feedback[/b][/url]

Useful information includes:
[list]
[*]Server OS / distro and PZ version
[*]Enabled NeatUI-dependent mods
[*]Exact checksum or missing-file error
[*]Relevant Mods= and WorkshopItems= lines
[/list]

[hr]
[h2]Troubleshooting[/h2]
If NeatUI or a dependent mod behaves incorrectly:
[list]
[*]Close Project Zomboid completely
[*]Check that NeatUI loads before its dependent mods
[*]Make sure Steam downloaded the latest Workshop files
[*]For MP, verify both Mods= and WorkshopItems=
[*]Make sure server and clients use matching current files
[*]Test with only NeatUI + the affected dependent mod
[/list]

If the minimal setup works correctly, add other mods back in small groups to identify the interaction.

[h3]Clean Workshop Redownload[/h3]
If files appear outdated or mismatched:
[list]
[*]Close Project Zomboid
[*]Unsubscribe from NeatUI Framework
[*]Wait for Steam to remove it
[*]If necessary, remove:
[b]...\Steam\steamapps\workshop\content\108600\3508537032[/b]
[*]Subscribe again and let Steam finish downloading before launching the game
[/list]