Repository navigation
ModManifest
inspect the package. know what was actually checked.
ModManifest v0.1.0 is an open-source, read-only command-line utility for inspecting, validating, and auditing game mod packages for The Sims 4 and inZOI. Not everything inside a mod package can be verified, so ModManifest reports what it found, what it only observed, and where its knowledge ends. ♡
It never extracts, executes, modifies, or uploads anything.
v0.1.0 release · Source on GitHub · README · Changelog · Report an issue
Requires Python 3.11 or newer. ModManifest v0.1.0 is published on PyPI and as GitHub Release assets.
python -m pip install modmanifest
modmanifest inspect "./MyMod"Or download the wheel from the release assets (pip install modmanifest-0.1.0-py3-none-any.whl), or install from source:
git clone https://github.com/CyberStudiosTM/ModManifest.git
cd ModManifest
pip install .modmanifest inspect PATH [--json]
modmanifest validate PATH --game sims4|inzoi [--json]
modmanifest audit-ai PATH [--json]
modmanifest --version
PATH is a folder, .zip, .ts4script, or .package.
| Command | Runs |
|---|---|
inspect |
Archive safety, game recognition and validation, AI metadata audit. |
validate |
Archive safety and the selected game's validation. |
audit-ai |
Archive safety and the AI metadata audit. |
The Sims 4
-
.packagefiles (DBPF 2.1): signature, header, index bounds and size, resource ranges, and duplicate keys. Resource contents are not decoded. -
.ts4scriptfiles: opened as a ZIP, entries listed, compiled-code header checked. Script contents are not analyzed or executed.
inZOI
A root mod_manifest.json marks a candidate mod, not a valid package. These checks are based on observed sample packages, not an official specification.
- JSON syntax and field types are checked, and observed fields are never required.
- Identity, author, version, description, declared dependencies, and game-version metadata are reported as written. Dependencies and compatibility are not verified.
-
FileChecksumsshape, path safety, and listed-file existence are checked. Digests are NOT CHECKED because the algorithm couldn't be established. -
.pak,.ucas, and.utocfiles are recognized as Unreal content containers but their internals are not inspected. - Unrelated folders, such as mod-manager state, are reported as unrecognized rather than invalid.
Checks cover path traversal, absolute paths, drive letters and alternate streams, duplicate and case-colliding entries, symlinks, entry count, size limits, compression ratio, signature mismatch, encrypted entries, and nested archives (listed, not opened). Limits are configurable with --max-entries, --max-total-mb, --max-entry-mb, and --timeout.
Reports AI-related indicators in JSON, TOML, YAML, and XML manifests, text and Markdown notes, PNG text chunks, XMP, and selected EXIF fields. C2PA support is detection only: possible structures are reported but never parsed or signature-validated.
An AI-related metadata reference is not proof that a mod was AI-generated, and finding nothing doesn't prove AI was absent. AI indicators never change the exit code.
Findings are PASS, WARNING, ERROR, UNSUPPORTED, or NOT CHECKED, each with a stable code and an evidence basis. Add --json for stable output using schema_version: 1.
| Exit code | Meaning |
|---|---|
0 |
Scan complete, no ERROR findings. |
1 |
One or more ERROR findings. |
2 |
Invalid arguments or missing path. |
3 |
Incomplete scan, or validate recognized nothing. |
- ModManifest is not an antivirus, malware scanner, official game validator, or runtime compatibility tester.
- A completed inspection doesn't establish that a mod is safe, authentic, compatible, or functional in-game.
- Sims 4 coverage was validated with synthetic fixtures. inZOI coverage used synthetic fixtures plus limited read-only inspection of real mod folders.
- 7z, RAR, and other archive formats are listed, not opened.
dream in pixels. create without limits. ♡
dream in pixels. create without limits.