👋🧩 Morphe Patches template

Template repository for Morphe Patches.

❓ About

Patches for apps I like.

How to use these patches

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

🩹 Patches list

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

 

🚀 Getting development 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!

🧑‍💻 Dev usage

To develop and release your Patches using this template:

• Make all changes to 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 Desktop 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 create 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 use AI to create new release scripts. The release.yml here already handles everything. If you need omething custom with your releases then modify the existing release.yml and .releaserc instead of writing everything new from scratch.
• Do not manually edit or manually commit any generated files such as: patches-list.json, patches-bundle.json, CHANGELOG.md. These files will be automatically updated by release.yml.
• Do not force push any semantic release commits as that will break all future releases. If you need to fix a broken release, it's always easiest to create a new release instead of fixing an existing release.

🛠️ Building locally

• Run ./gradlew buildAndroid
• The built patches .mpp file is found in patches/build/libs/patches-*.mpp
• Patch the mpp file using Morphe-Desktop like any other patch bundle.

See the Morphe documentation for more information.

📜 License

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