๐Ÿ‘‹๐Ÿงฉ Morphe Patches template

July 7, 2026 ยท View on GitHub

Template repository for Morphe Patches.

โ“ About

Patches for apps I like.

TODO: Update this about section with a brief introduction/summary about this repo and what it offers.

๐Ÿฉน Patches list

A list of your patches will automatically be shown here after your first patches release is created.

ย 

๐Ÿš€ Get started

To start using this template, follow these steps:

  1. Setup your development environment including adding a GitHub PAT as described here.
  2. Create a new repository using this template. Select create a new repository, and enable 'Include all branches'
  3. Enable "Allow GitHub Actions to create and approve pull requests" in your repo Settings > Actions > General > Workflow permissions
  4. Update the build.gradle.kts file (Specifically, the group of the project, and the About)
  5. Update the README.md file to be specific of your repo, and update the links in the issue templates.
  6. Choose a name for your patches project. Keep in mind you must use a name that does not imply authorship by the Morphe open source project. If unsure, then simply name these patches after yourself ("UserXYZ Morphe patches"). See the NOTICE for details.
  7. (Optional): Add patches-bundle.png to the project if you want a custom icon to show in Morphe Manager instead of your GitHub profile avatar.

๐ŸŽ‰ You are now ready to start creating patches!

๐Ÿง‘โ€๐Ÿ’ป Usage

To develop and release your Patches using this template:

  • Do all development work in the dev branch.
  • For local development work build your patches using the gradle task ./gradlew buildAndroid to generate the mpp file found in patches/build/libs/patches-*.mpp. Apply your patches locally using Morphe CLI tool like any other patch bundle.
  • Always use Semantic commit messages for commits. To keep it simple use only 3 commit message types: feat: Added a new feature, fix: Some problem now fixed, chore: Random change you do not want in the user facing changelog
  • Commits of fix: and feat: will automatically generate new pre-releases and chore: will not create a new release.
  • Users can apply your dev branch releases by enabling pre-release in Morphe Manager patch sources.
  • When your dev branch is ready and you want a stable release, merge dev branch to main (do not squash, and only merge).
  • Always use semantic release (release.yml). Do not manually upload or creating releases by hand because many files must be updated and release.yml handles everything.

๐Ÿค“ Tips

  • See the patcher documentation for more examples of creating patches and fingerprints.
  • Do not manually edit any generated files such as: patches-list.json, patches-bundle.json, CHANGELOG.md. These files will be automatically updated in the release action.
  • Do not force push any semantic release commits or you will break the release. To 'redo' the last release then:
    • Git drop the last dev/main semantic release commit you want to redo.
    • Delete the release from the release area of this repo and delete the tag
    • Make any other changes you wish to do
    • Force push dev/main branch
    • A new replacement release will be created by release.yml

How to use these patches

Click here to add these patches to Morphe: https://morphe.software/add-source?github=xyz-user/xyz-patches

Or manually add this repository url as a patch source in Morphe: https://github.com/xyz-user/xyz-patches

๐Ÿ› ๏ธ Building

To build UserXYZ Patches, you can follow the Morphe documentation.

๐Ÿ“œ License

UserXYZ Patches are licensed under the GNU General Public License v3.0