# KnoxBuildWorksViewpoint

Local compatibility patch using sour_kisel's 6244 models for Knox Buildworks in Project Viewpoint. Includes green and white military crates; gray military crates use the green meshes with a `#626763` gray-green retexture. Both orientations and stacked variants are included (18 sprite bindings).

## Mod layout

The repository root is the mod folder, ready to link directly into `Zomboid/mods`:

```text
KnoxBuildWorksViewpoint/
  common/media/           Lua, model manifest, selected meshes/materials/textures
  42.20/mod.info          Build 42.20+ version metadata
  mod.info                Root metadata
  tools/                  Matcher, reviewed rules and regression tests
  reports/                Catalogue coverage and remaining model gaps
  docs/                   Detailed notes and mesh preview
```

The mod ID remains **KnoxBuildworksViewpointCrates**. Enable it after Knox Buildworks, Project Viewpoint and PZVoxelStudioViewpoint. Fully restart Zomboid after updates.

## Link the repository

After moving aside the previous copied folder at `Zomboid/mods/KnoxBuildworksViewpointCrates`, run in PowerShell with symbolic-link support:

```powershell
New-Item -ItemType SymbolicLink -Path "$env:USERPROFILE\Zomboid\mods\KnoxBuildworksViewpointCrates" -Target "$env:USERPROFILE\Git\KnoxBuildWorksViewpoint"
```

The game then reads `common` and `42.20` directly from this checkout. Use one copy of this mod ID in the mods folder. The migration did not replace your existing local installation or create the link.

## Rebuild

From the repository root:

```powershell
.\tools\Match-KnoxViewpoint.ps1
```

Defaults rebuild the runtime files into this repository root, retain the `42.20` layout, and write audit data to `reports/`. Python 3.10+ and Pillow are required; the launcher defaults to this computer's bundled Codex Python. Pass `-PythonExecutable`, `-WorkshopRoot`, or `-GameDirectory` for other installations. Dependencies are listed in `tools/requirements.txt`.

`-Install` copies runtime files to the local mods directory; it never copies `.git`, tools or reports. With a mods symlink pointing to this repository, a normal rebuild is sufficient.

Run regression checks with the same Python interpreter:

```powershell
& "$env:USERPROFILE\.cache\codex-runtimes\codex-primary-runtime\dependencies\python\python.exe" .\tools\Test-KnoxViewpointMatcher.py
```

Manual model choices and tint are stored in `tools/reviewed-matches.json`. [Remaining gaps](reports/unmatched.md), [full matching results](reports/results.md), and [mesh preview](docs/crate-model-preview.png) are included. Native wall/floor/roof rendering is distinguished from authored 6244 model matches; the patch does not claim to replace every buildable.

This is a private local compatibility build. Source models/textures belong to sour_kisel, and the original Workshop files are not modified. The copied model assets do not imply permission to redistribute them.