Mod-Update-Checker_registry

Mod Update Checker Public Registry

Welcome to the public registry used by Mod Update Checker for The Sims 4 (or MUC).

MUC retrieves one small public registry document containing mod version information. Version comparisons are then performed locally in the player’s game.

MUC does not download, install, import, or execute mod files.

Quick links

Resource	Link
Live registry	View registry-v1.json
Registry repository	View on GitHub
Mod repository	Mod Update Checker on GitHub
Contribution guide	Read CONTRIBUTING.md
Registry templates	View templates
Example entries	View examples
Pull Requests	View proposed changes
Creator website	Demeterio on Tumblr

What the registry contains

The registry contains public mod update information such as:

• a stable mod identifier;
• the release channel;
• the latest known version;
• the related release tag;
• the date on which the version information was checked.

The registry does not contain:

• player information;
• EA account information;
• save-game information;
• the contents of a player’s Mods folder;
• a list of installed mods;
• analytics or advertising identifiers;
• authentication credentials.

Live registry document

The current generated registry is available here:

http://muc-registry.demeterio.cc/generated/registry-v1.json

The generated document is managed through the public registry repository. Proposed additions and changes can be reviewed through GitHub Pull Requests.

Why the registry uses HTTP

The Python runtime included with The Sims 4 does not provide the native _ssl extension required by Python’s standard ssl module.

For compatibility with the game’s bundled Python runtime, MUC retrieves the public registry through a dedicated HTTP endpoint:

http://muc-registry.demeterio.cc/generated/registry-v1.json

The registry contains only public version information.

MUC restricts the request to one fixed domain, one fixed port, and one fixed path. Alternate domains, redirects, query strings, credentials, compressed responses, and oversized responses are rejected.

Registry signature

Cryptographic registry verification is currently being implemented.

The completed system will use:

• a public verification key included with MUC;
• a published fingerprint for that public key;
• a signature generated for the registry document.

Once verification is enabled, MUC will reject a registry when its contents or signature do not match the public key included with the mod.

The private signing key will never be published in this repository.

Add or update a mod

Registry changes are submitted through GitHub Pull Requests.

1. Read the contribution guide.
2. Copy the appropriate entry template.
3. Review the available examples.
4. Fork the registry repository.
5. Add or update the required entry.
6. Open a Pull Request.

All submissions must pass the repository’s automated validation before they can be included in the generated registry.

Do not manually edit generated files unless the contribution guide explicitly instructs you to do so.

Transparency

The registry source, contribution history, proposed changes, and generated document are publicly visible.

MUC performs version comparisons locally and never uses the registry to install or execute mod updates.

Disclaimer

Mod Update Checker is an unofficial fan-made project.

It is not affiliated with, authorized by, sponsored by, or endorsed by Electronic Arts or Maxis.

The Sims and all related names and trademarks belong to their respective owners.

Copyright

Copyright © Demeterio.