Skip to content

ramensoftware/windhawk-mods

Repository files navigation

Windhawk Mods

The official collection of Windhawk mods. The mods can be viewed on the online mods catalog, and can be viewed and installed with Windhawk.

Discussing Mods

You're welcome to participate in GitHub Discussions or join the Discord channel for a live discussion.

Creating a New Mod

Please refer to the corresponding wiki page: Creating a New Mod.

Submitting a New Mod

Submit a new mod by creating a pull request in this repository. The pull request must consist of a single file, mods/<mod-id>.wh.cpp, where <mod-id> is the mod id as specified in the mod file.

The mod's github metadata value must be specified, and must match the pull request author's GitHub profile.

If the mod's twitter metadata value is specified, the mod author must be the owner of the Twitter profile and must be able to verify it.

Mods which don't specify a license are submitted under the MIT license. It's the author's responsibility to specify the appropriate license for third-party code.

Submitting a Mod Update

Submit a mod update by creating a pull request in this repository. The pull request must consist of changes to a single file, mods/<mod-id>.wh.cpp, where <mod-id> is the mod id.

The mod's version metadata value must be changed to a newer version.

The mod's github metadata value must match the pull request author's GitHub profile. This means that you can only submit an update for a mod that you originally submitted. If you'd like to update a mod that you didn't submit, you can either submit the changes to the mod author, or submit a new mod instead.

The commit message should include information about the new version. The information will be shown in the mod's changelog.