34 lines
2.5 KiB
Markdown
34 lines
2.5 KiB
Markdown
# Plugin metadata file
|
||
|
||
The build metadata file should be placed in one of the [following locations][CONFIG_LOCATIONS]:
|
||
|
||
- `build.yaml`
|
||
- `meta.yaml`
|
||
- `jprm.yaml`
|
||
- `.jprm.yaml`
|
||
- `.ci/jprm.yaml`
|
||
- `.github/jprm.yaml`
|
||
- `.gitlab/jprm.yaml`
|
||
|
||
If there are multiple, the first file found is used.
|
||
|
||
| key | type | required | comment |
|
||
|---------------|---------------|----------|---------|
|
||
| `name` | string | ✔️ | Full plugin name |
|
||
| `guid` | string | ✔️ | Plugin GUID – Must be unique! You can use https://www.uuidgenerator.net/guid if you don't know how to generate one. |
|
||
| `overview` | string | ✔️ | A short single-line description (tagline) of your plugin |
|
||
| `description` | string | ✔️ | A longer multi-line description (this is not actually multi-line, no formatting is preserved when looking in Jellyfin) |
|
||
| `category` | string | ✔️ | `Administration`/`General`/`Anime`/`Books`/`Live TV`/`Movies and Shows`/`Music`/`Subtitles`/`Other` |
|
||
| `owner` | string | ✔️ | Name of maintainer |
|
||
| `image` | string | ❌ | Path relative to build.yaml for the logo to include in the release zip. This is shown in Jellyfin even if there is no manifest or repository configured. Defaults to [`image.png`][DEFAULT_IMAGE_FILE] if present |
|
||
| `imageUrl` | string | ❌ | Fully qualified link to the image to display in the plugin catalog. This is what is displayed before a user installs the plugin. |
|
||
| `version` | int \| string | ❌ | Plugin version – must be a valid C# assembly version number (`major.minor.build.revision`) – only major is required, the rest defaults to `0`. Can be specified as a CLI argument |
|
||
| `targetAbi` | string | ❌ | Minimum Jellyfin version. Can be specified on the CLI |
|
||
| `framework` | string | ❌ | Framework version to build with – must be same or higher than what your targeted Jellyfin version is built with. Defaults to [`net9.0`][DEFAULT_FRAMEWORK]. |
|
||
| `artifacts` | list[string] | ❌ | List of artifacts to include in the plugin zip. Leave empty to automatically trim based on Jellyfin dependencies |
|
||
| `changelog` | string | ❌ | Changes since last release. Can be specified on the CLI |
|
||
|
||
[DEFAULT_IMAGE_FILE]: jprm/__init__.py#L139
|
||
[DEFAULT_FRAMEWORK]: jprm/__init__.py#L140
|
||
[CONFIG_LOCATIONS]: jprm/__init__.py#L141-L149
|