Skip to main content

ModManifest

Read-only inspection, validation and metadata auditing for game mod packages. Supports The Sims 4 and inZOI. Part of CyberStudios.

ModManifest never extracts, executes, modifies or uploads anything. It reports what it can verify, what it only observed, and what it did not check.

Install

pip install modmanifest

Requires Python 3.11+. From source: pip install .

Usage

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

Options: --json, --verbose, --timeout, --max-entries, --max-total-mb, --max-entry-mb.

Statuses

PASS, WARNING, ERROR, UNSUPPORTED, NOT CHECKED (NOT_CHECKED in JSON). Every finding carries a stable code (MM-ARC-*, MM-SCN-*, MM-S4-*, MM-INZ-*) and a basis: format-rule, observed-convention, safety-limit or scan-coverage.

Exit codes

Code Meaning
0 scan complete, no ERROR findings
1 one or more ERROR findings
2 invalid arguments or missing path
3 incomplete scan (limit, timeout, read failure), or validate recognized nothing

AI indicators never change the exit code.

Example

$ modmanifest validate SampleMod --game inzoi
ModManifest validate  SampleMod
target: folder  scan: complete
game selected: inzoi  recognized: inzoi
Status       Code        Finding
NOT_CHECKED  MM-INZ-015  no official inZOI package specification was used; ...
NOT_CHECKED  MM-INZ-013  declared dependencies are reported as written; ...
NOT_CHECKED  MM-INZ-017  game version metadata is reported as written; ...
NOT_CHECKED  MM-INZ-009  checksum digests were not verified: the algorithm ...
PASS 2  WARNING 0  ERROR 0  UNSUPPORTED 0  NOT_CHECKED 5

Validation coverage

The Sims 4

  • .package (DBPF 2.1): signature, header, index bounds and size, resource ranges, duplicate keys. Resource contents are not decoded.
  • .ts4script: opened as a ZIP, .py/.pyc entries listed, compiled-code header checked. Script contents are not analyzed or executed.
  • No standard Sims 4 manifest is assumed, so dependencies and versions are not extracted.

inZOI

A root mod_manifest.json marks a candidate mod, not a valid package. There is no official specification behind these checks.

  • JSON syntax and field types, compared with sample packages. 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.
  • ProjectName versus folder name is informational.
  • FileChecksums: shape, path safety and listed-file existence are checked. Digests are NOT CHECKED: in sample packages the algorithm and path semantics could not be established, and none is guessed. A matching digest would show consistency with the manifest only, not that a mod is safe or authentic.
  • .pak, .ucas, .utoc: recognized as Unreal content containers and inventoried; internals are not inspected. A lone .ucas or .utoc is reported as a warning.
  • Unrelated folders (mod-manager state, hosted content) are unrecognized, not invalid. Point ModManifest at one mod folder at a time.

Archive and folder safety (all targets)

Traversal and absolute paths, drive letters and alternate streams, backslashes, duplicates, case collisions, symlinks and special files, entry count, total and per-entry size, compression ratio, signature mismatch, encrypted entries (UNSUPPORTED), and nested archives (listed, not opened). Limits are configurable.

AI metadata audit

Reports indicators found in metadata, in three categories: explicit declaration, tool reference, ambiguous indicator. Confidence refers to the interpretation of the metadata only.

Supported sources: JSON, TOML, YAML and XML manifests; text and Markdown notes; PNG text chunks; XMP; EXIF Software/ImageDescription. C2PA is detection only: possible structures are reported, never parsed or signature-validated.

When nothing is found, the result is:

No supported AI metadata indicators found.

Metadata may be absent, incomplete or removed. That result is not evidence about how a package was made. Prompt text is never copied into reports. Name tables used for matching live in src/modmanifest/metadata/ai_signatures.py and are detection data only.

JSON output

Stable schema, schema_version: 1. Top-level keys: tool, version, command, target, game, scan, recognized_files, capabilities_exercised, package, findings, summary, unsupported, inspection_errors, ai_metadata. The target is a base name, never an absolute path. Untrusted text has control and bidirectional characters escaped.

Limitations

  • Format checks reflect observed samples and public format knowledge, not vendor specs.
  • Only listed metadata containers are audited; scripts and binary game data are not.
  • 7z, RAR and other archive formats are listed, not opened.
  • Package validity here does not mean a mod is safe, compatible or working in game.

Development

pip install -e ".[dev]"
ruff check . ; ruff format --check .
pytest

License

MIT. Copyright (c) CyberStudios.

Metadata

Release files for modmanifest 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for modmanifest 0.1.0
File Size Uploaded Provenance Actions
modmanifest-0.1.0.tar.gz 35.4 kB With provenance Details for modmanifest-0.1.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for modmanifest 0.1.0
File Interpreter ABI Platform Actions
modmanifest-0.1.0-py3-none-any.whl Python 3 none any Details for modmanifest-0.1.0-py3-none-any.whl

Total release size: 73.5 kB

Release files / modmanifest-0.1.0.tar.gz

Download URL modmanifest-0.1.0.tar.gz
Size 35.4 kB
Tags Source
SHA-256 checksum
How to use checksums
a67c93b3789719ec2487470338d2ab49f3f584c237c2a0120875610e25ef47b4
BLAKE2b-256 checksum
How to use checksums
76c8e9c532cbeb7b4441d7c314b01d2eb19f61e40b4e4e7df6bf88e62a0d1530
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 11, 2026.

Transparency log

Release files / modmanifest-0.1.0-py3-none-any.whl

Download URL modmanifest-0.1.0-py3-none-any.whl
Size 38.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
bea150297d4650f926ff6a9ed521b82ebfa7c637242f5c32148a3334b5ee4db3
BLAKE2b-256 checksum
How to use checksums
1ec54db825821e491dd3c7d1a367ebf6a387e2ba9024af3fb56aef4e6fa918f3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 11, 2026.

Transparency log

Security for modmanifest 0.1.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for modmanifest-0.1.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 11, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files Full provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page