Awesome Android Root

Contribution Guidelines

Thank you for contributing to Awesome Android Root! This guide helps you add quality entries to our collection of 600+ root apps and modules.

Quick Start ​

Want to add an app or module? Follow these 3 simple steps:

1. Fork & Edit ​

  1. Fork this repository
  2. Edit the category page that best matches the app/module (see Category Pages)
  3. Submit a pull request

The collection lives in docs/apps-and-modules/ - one Markdown file per topic. The root README.md is only a lightweight index, not the database.

2. Use the Correct Format ​

markdown
- **[App Name](link)** - Brief description of what it does. `FOSS` `[M]`

3. Follow the Rules ​

  • ✅ App requires root access
  • ✅ Working links only
  • ✅ No duplicates
  • ✅ Place in correct category (alphabetical order)

Category Pages ​

Every entry belongs to exactly one topic page in docs/apps-and-modules/. Place your entry in the page that matches what the tool does for the user.

Unsure? Look for similar apps inside the category page, or open a Taxonomy Change issue if you believe a whole category should move, merge or split.

Entry Format ​

Template:

markdown
- **[⭐ App Name](primary-link)** - Description of functionality. `FOSS/Proprietary` `[M]` `[K]` `[A]` `[LSP]` | [🌱](f-droid-link) | [▶️](play-store-link)

Required Elements:

  • App Name in bold with link
  • Primary Link (best available source, see priority below)
  • Description (1-2 sentences, focus on what it does)
  • License (FOSS or Proprietary)
  • Framework Tags (if applicable): [M] [K] [A] [LSP]
  • Store Icons (optional): Add | [🌱](link) for F-Droid and/or | [▶️](link) for Play Store alongside the main entry

Link Priority:

  1. GitHub → 2. F-Droid → 3. Official Site → 4. Play Store

Store Icon Reference:

IconSource
🌱Available on F-Droid / IzzyOnDroid
▶️Available on Google Play Store

Examples:

markdown
- **⭐ [AdAway](https://github.com/AdAway/AdAway)** - Open-source ad blocker using the hosts file. Blocks ads without permissions. `FOSS` | [🌱](https://f-droid.org/packages/org.adaway)
- **[Zygisk Detach](https://github.com/j-hc/zygisk-detach)** - Detach apps from Play Store to prevent updates. `FOSS` `[M]`
- **[Magisk](https://github.com/topjohnwu/Magisk)** - Systemless root solution with module support. `FOSS`
- **[CorePatch](https://github.com/LSPosed/CorePatch)** - Disable signature verification for Android. `FOSS` `[LSP]`
- **[bindhosts](https://github.com/bindhosts/bindhosts)** - Systemless hosts for APatch, KernelSU and Magisk. `FOSS` `[M]` `[K]`

Categories & Tags ​

Framework Tags ​

  • [M] = Magisk Module (requires Magisk)
  • [K] = KernelSU Module (requires KernelSU)
  • [A] = APatch Module (requires APatch)
  • [LSP] = LSPosed / Xposed Module (requires LSPosed)

License Tags ​

  • FOSS = Free and Open Source Software (source code available)
  • Proprietary = Closed-source software or unclear licensing

Special Badges ​

  • ⭐ = Community recommended (widely trusted apps)

Store & Source Icons ​

  • 🌱 = Available on F-Droid / IzzyOnDroid
  • ▶️ = Available on Google Play Store

Quality Requirements ​

Must Have:

  • ✅ App requires root access for main features
  • ✅ Working links to official sources
  • ✅ Updated within last 18 months
  • ✅ No duplicates
  • ✅ Proper category placement (alphabetical order)
  • ✅ Correct format and tags

Don't Include:

  • ❌ Broken/dead apps
  • ❌ Malware or suspicious apps
  • ❌ Non-root apps (unless in specific categories)
  • ❌ Promotional language

Pull Request Template ​

Visit Pull Request Template ↗

Need Help? ​

Common Questions:

  • Where to place my app? Look for similar apps inside the category pages
  • What if it's both FOSS and has modules? Use multiple tags: FOSS [M] [K] [LSP]
  • Can I add F-Droid or Play Store links? Yes! Add store icons after the description: | [🌱](f-droid-link) | [▶️](play-store-link)
  • App works without root too? If main features need root, include it
  • Unsure about tags? Check similar apps for examples
  • What if an app supports multiple frameworks? List all applicable tags: [M] [K] [A]

Get Support:

  • 🐛 Issues: For bugs or questions
  • 💬 Discussions: For general help
  • 📝 PR Comments: For specific feedback

Quality over quantity! One good entry is better than multiple rushed ones. Thanks for contributing!