65 lines
1.8 KiB
Markdown
65 lines
1.8 KiB
Markdown
# 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:
|
|
|
|
```text
|
|
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:
|
|
|
|
```text
|
|
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
|
|
|
|
```json
|
|
{
|
|
"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 be `1`.
|
|
- `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 `.mrpack` file.
|
|
- `sha512`: SHA-512 checksum of the `.mrpack` file.
|
|
- `changelog`: Optional short release note shown in the app.
|
|
|
|
## Release workflow
|
|
|
|
1. Export a new `.mrpack` from the Modrinth App.
|
|
2. Put it in `exports/` with a versioned filename.
|
|
3. Calculate its SHA-512 checksum.
|
|
4. Update `modrinth-plus.json` with the new `version`, `versionId`, `mrpackUrl`, `sha512`, and `changelog`.
|
|
5. Commit and push the changes.
|
|
6. In Modrinth Plus, click `Check for updates`.
|
|
|
|
On Windows, calculate the checksum with:
|
|
|
|
```powershell
|
|
Get-FileHash -Algorithm SHA512 exports\MyModpack-1.0.0.mrpack
|
|
```
|