Skip to main content

✦ ModManifest

Inspect the package. Understand the metadata.

Read-only mod inspection, validation & metadata auditing for The Sims 4 and inZOI.

PyPI Python License Status

A developer utility from CyberStudios™.

Website · Documentation · GitHub · PyPI


Know what was checked. Know what wasn't.

◇ Meet ModManifest

Mod packages are more than the files you see at first glance.

Archives, compiled scripts, manifests, dependencies, and metadata all contain information about how a package is structured.

ModManifest is an open-source command-line utility designed to help modders and developers inspect that information without modifying the original package.

It examines supported mod structures, identifies potential issues, audits available AI-related metadata, and generates transparent reports.

Rather than making assumptions about unfamiliar content, ModManifest separates verified findings, observed information, and unsupported checks.

No executing unfamiliar scripts. No uploading your mods. No modifying package contents.

Just structured findings, clear boundaries, and a better understanding of what you're working with.


✧ Features

Capability Description
📦 Package Inspection Examine supported mod structures and identify recognized formats.
🎮 Game-Aware Validation Run supported structural checks for The Sims 4 and inZOI.
🛡️ Archive Safety Identify suspicious paths, duplicate entries, archive limits, and other structural risks.
🔎 Script Indicators Flag static references to network access, process execution, dynamic code, and exfiltration-style endpoints in Python, Lua, and JavaScript files.
✦ AI Metadata Audit Detect supported AI-related metadata indicators without making unsupported authorship claims.
◇ Structured Reports Generate human-readable results or machine-readable JSON.
🔒 Read-Only Design Inspect without executing scripts, extracting archives, modifying files, or uploading content.

🎮 Supported Games

The Sims 4

Supported formats

  • .package files using DBPF 2.1
  • .ts4script ZIP-based archives

Available checks

  • Package headers and signatures

  • Index and resource boundaries

  • Duplicate resource keys

  • Archive structure

  • Applicable compiled Python header information

  • Static script indicators in .py, compiled .pyc, .lua, and .js files

Package resources are not decoded. Scripts are never imported or executed, and their behavior is not analyzed. Script findings are static pointers for human review, not a malware verdict.

inZOI

Supported inspection

  • Candidate mod folders containing mod_manifest.json
  • Manifest syntax and observed metadata fields
  • Project identity, version, author, and dependency declarations
  • File references and path safety
  • Recognition of .pak, .ucas, and .utoc containers

Important: inZOI inspection follows observed package conventions. It is not an official game format specification.

Declared dependencies, compatibility, and unestablished checksum algorithms are not independently verified.


01 / Installation

Requirements: Python 3.11 or newer.

Install the latest published version from PyPI:

python -m pip install modmanifest

Verify installation:

modmanifest --version

Upgrade an existing installation:

python -m pip install --upgrade modmanifest

Package: modmanifest on PyPI

02 / Quick Start

Inspect a mod

modmanifest inspect "./MyMod"

Runs applicable archive safety, package recognition, validation, and supported metadata checks.

Validate a Sims 4 package

modmanifest validate "./MyMod.package" --game sims4

Validate an inZOI mod

modmanifest validate "./MyInZOIMod" --game inzoi
modmanifest audit-ai "./MyMod.zip"

Export a JSON report

modmanifest inspect "./MyMod" --json

Command Reference

Command Purpose
inspect Run applicable inspection and auditing checks
validate Validate supported structures for a selected game
audit-ai Search supported metadata for AI-related indicators
--version Display the installed version

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


03 / Understanding Your Results

ModManifest reports findings using explicit statuses.

Status Meaning
PASS A specific check passed
WARNING A condition deserves attention
ERROR A check identified an error
UNSUPPORTED The condition is outside supported inspection coverage
NOT CHECKED Available evidence cannot establish the result

Each finding includes diagnostic information explaining the basis of the result.

Exit Codes

Code Meaning
0 Scan completed without error findings
1 One or more error findings
2 Invalid arguments or missing target
3 Incomplete scan or unrecognized validation target

A successful scan is not a guarantee that a mod is safe, authentic, compatible, or functional in-game.


04 / AI Metadata Auditing

Metadata can provide clues. It cannot tell the entire story.

ModManifest examines supported metadata sources for potential AI-related indicators.

Sources include:

  • JSON, TOML, YAML, and XML
  • Text and Markdown
  • PNG text metadata
  • XMP and selected EXIF fields
  • Potential C2PA structures (detection only)

Findings are categorized as:

Category Interpretation
Explicit Declaration Metadata directly declares relevant AI involvement
Tool Reference Metadata references an AI-associated tool or service
Ambiguous Indicator A possible signal without sufficient evidence for a stronger conclusion

What if nothing is detected?

A report stating that no supported AI metadata indicators were found means only that none were identified within the supported inspection scope.

It does not prove that a mod was created without AI.

Likewise, detecting an AI-associated tool name does not establish that a mod was AI-generated.

ModManifest reports evidence, not assumptions.


05 / Archive Safety

ModManifest includes configurable safeguards for inspecting supported archives and folders.

Area Examples
Paths Traversal, absolute paths, drive letters, alternate streams
Entries Duplicate names and case collisions
File types Symlinks and special files
Resources Entry count, file size, compression ratios
Integrity Signature mismatches and encrypted entries
Nested archives Identification without recursively opening contents

Scan limits can be adjusted using the available CLI options.

The tool does not extract archives or execute their contents.


06 / JSON Reporting

For developers building automation or analysis workflows, ModManifest provides structured JSON output.

modmanifest inspect "./MyMod" --json

Current report schema: 1

Reports include information about:

  • Target and command
  • Game recognition
  • Inspection coverage
  • Recognized file types
  • Package metadata
  • Diagnostic findings
  • Unsupported conditions
  • AI-related metadata indicators

JSON output is designed to make results easier to process programmatically.


07 / Scope & Limitations

IMPORTANT

ModManifest is not antivirus software, a malware scanner, an official game validator, or a runtime compatibility tester.

Current limitations include:

  • Sims 4 package resources are not decoded.
  • Scripts are checked for static risk indicators only. They are never executed, and obfuscated or novel behavior may not be detected.
  • Unreal content container internals are not parsed.
  • Game compatibility and dependencies are not independently verified.
  • Unsupported archive formats may be recognized without being opened.
  • AI auditing is limited to supported metadata sources.
  • Passing checks does not guarantee a mod is safe or functional.

Transparency is part of the design.

When something cannot be verified, ModManifest reports that limitation rather than guessing.


✧ Documentation & Resources

Resource Link
☁️ Project Website Explore ModManifest
📖 Documentation Wiki Read the Documentation
💻 Source Code GitHub Repository
📦 PyPI Python Package
🐛 Issues & Feedback Report an Issue
✧ Changelog Version History
♡ Contributing Contribution Guide

✦ Built within CyberStudios™

Creative technology, developer tools, and interactive experiences.

Inspect with curiosity. Report with precision.

CyberStudios Website · GitHub Organization

MIT Licensed · © CyberStudios™

Metadata

Release files for modmanifest 0.1.1

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.1
File Size Uploaded Provenance Actions
modmanifest-0.1.1.tar.gz 46.2 kB With provenance Details for modmanifest-0.1.1.tar.gz

Built distribution (wheel)

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

Total release size: 90.3 kB

Release files / modmanifest-0.1.1.tar.gz

Download URL modmanifest-0.1.1.tar.gz
Size 46.2 kB
Tags Source
SHA-256 checksum
How to use checksums
6b865ff4d6193dbf9bb93507535cfe54868c74da079012a383b9e87c63c11218
BLAKE2b-256 checksum
How to use checksums
dc5a9fb26640da7c43b8aca6f4c146c4a463011e644c8e49cffca2283a59f4c8
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.1-py3-none-any.whl

Download URL modmanifest-0.1.1-py3-none-any.whl
Size 44.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
0878df5806c0073f71208fe485568e38252977520d2ebc1a10c68ab6aeae1146
BLAKE2b-256 checksum
How to use checksums
84ff0c38c6afb2c48b7739d8a01fe4fd2f8e75e9d4e50dec976a5207eb482221
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.1

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.1.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.1 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