https://github.com/ramensoftware/windhawk-mods

The official collection of Windhawk mods
https://github.com/ramensoftware/windhawk-mods

Last synced: 3 months ago
JSON representation

The official collection of Windhawk mods

• Host: GitHub
• URL: https://github.com/ramensoftware/windhawk-mods
• Owner: ramensoftware
• Created: 2022-01-15T11:51:52.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-03-17T03:09:21.000Z (3 months ago)
• Last Synced: 2024-03-17T05:39:17.779Z (3 months ago)
• Language: C++
• Homepage:
• Size: 1.53 MB
• Stars: 169
• Watchers: 6
• Forks: 32
• Open Issues: 110
• Metadata Files:
  • Readme: README.md

Lists

• awesome-stars-copy - ramensoftware/windhawk-mods - The official collection of Windhawk mods (C++)

README

        
# Windhawk Mods

The official collection of Windhawk mods. The mods can be viewed on the [online mods catalog](https://windhawk.net/mods), and can be viewed and installed with [Windhawk](https://windhawk.net/).

## Discussing Mods

You're welcome to participate in [GitHub Discussions](https://github.com/ramensoftware/windhawk-mods/discussions) or join [the Discord channel](https://discord.gg/WZgXScMud7) for a live discussion.

## Creating a New Mod

Please refer to the corresponding wiki page: [Creating a New Mod](https://github.com/ramensoftware/windhawk/wiki/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/.wh.cpp`, where `` 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](https://opensource.org/licenses/MIT). 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/.wh.cpp`, where `` 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.