Publishing
The public list lives in Blockheads-Club/mods and is shown on the Mods page. Mods are added by pull request.
Before you submit
Add a
LICENSEfile (any licence you like).Put the
.bhmodsomewhere public over HTTPS, for example as a GitHub release asset. It is mirrored on merge.Check it with the public-list rules:
shbhmod check . --index bhmod pack .
Submit
- Add one file,
mods/<first letter>/<id>.toml, with your mod's details, the download URL, its SHA-256 and size. - Open a pull request. CI checks the entry and the package and comments with the permissions it asks for.
- A maintainer reads the code of every new mod (and of updates that add permissions or native code) before it is listed.
Want your mod's name and description in other languages? Add [i18n.tr], [i18n.ru], [i18n.kk] ... tables with name and/or description to the entry. Readers see their language and fall back to English for anything missing; you can change these any time.
All fields and an example: Submit a mod.
Updates
- Add a new version to your entry; published versions are never edited or deleted.
- A broken version can be marked
yanked = true. - Only the mod's
ownersmay change it.
Run the same checks as CI locally: bhmod index validate.