1.8 KiB
1.8 KiB
Connected Library
Connected Library tracks a .mrpack export through a small JSON manifest hosted in a Git repository.
Repository layout
The manifest must be named modrinth-plus.json and must live in the repository root:
my-modpack-repo/
|-- modrinth-plus.json
|-- CHANGELOG.md
|-- README.md
`-- exports/
`-- MyModpack-1.0.0.mrpack
When a user enters a repository URL, Modrinth Plus checks these raw URLs:
https://host/owner/repo/raw/branch/main/modrinth-plus.json
https://host/owner/repo/raw/branch/master/modrinth-plus.json
You can also paste the raw modrinth-plus.json URL directly.
Manifest
{
"schemaVersion": 1,
"name": "My Modpack",
"version": "1.0.0",
"versionId": "my-modpack-1.0.0",
"mrpackUrl": "https://git.example.com/owner/my-modpack/raw/branch/main/exports/MyModpack-1.0.0.mrpack",
"sha512": "replace-with-the-lowercase-sha512-of-the-mrpack",
"changelog": "Initial Connected Library release."
}
Fields:
schemaVersion: Must be1.name: Display name in Connected Library.version: Human-readable version label.versionId: Stable unique id for this release. Change it for every update.mrpackUrl: Public HTTPS raw URL to the.mrpackfile.sha512: SHA-512 checksum of the.mrpackfile.changelog: Optional short release note shown in the app.
Release workflow
- Export a new
.mrpackfrom the Modrinth App. - Put it in
exports/with a versioned filename. - Calculate its SHA-512 checksum.
- Update
modrinth-plus.jsonwith the newversion,versionId,mrpackUrl,sha512, andchangelog. - Commit and push the changes.
- In Modrinth Plus, click
Check for updates.
On Windows, calculate the checksum with:
Get-FileHash -Algorithm SHA512 exports\MyModpack-1.0.0.mrpack