Blish HUD supports module management via repositories. By default, it references pkgs.blishhud.com which can be contributed to by submitting PRs to the bhud-pkgs repository.
This repository contains the manifest files for Blish HUD modules. You are highly encouraged to submit manifests for your modules so that they can be listed in the Blish HUD module viewer. This also for users to easily discover your modules and automatically update their copies when you submit changes.
Submitting a Package
To submit a package to the repository, you should follow these steps:
- Fork the bhud-pkgs repository
- Author a manifest and place it in the appropriate directory
- Submit your PR
- Respond to any feedback
Authoring a Manifest
The minimal manifest syntax is below. Please only submit one manifest per PR.
Be sure that the manifest filename matches the
Version and the manifest is located in the folder path matching
name.sp.ace is your module's
namespace). It is best to use BhudLib (described below) to ensure that your manifest correctly represents your module.
The majority of these fields should directly mirror their corresponding values found in your module's manifest.json.
To help authors create module package manifests, we have provided BhudLib — a PowerShell library. The library can be used to check that your module (.bhm) is valid, create a package manifest, and automatically save it in the proper manifests path.
From start to finish, in PowerShell:
Once you have pushed your changes, navigate to the repository on GitHub and it should prompt you to PR the changes.
Submit your PR
With the manifest ready, you will need to submit a PR.
The PR request will go through a validation process. This process may contain both automated validation and manual review by maintainers. In the event of validation or review issues, replies will be made in the PR and it assigned back to you to make the appropriate changes.