ShizukuPlus

# Agent Guidelines (Claude / Gemini / Cursor / Aider / et al.)

This file is the canonical entry point for AI coding agents. It points to
the per-agent guides that already exist in this repo and lists the rules
that apply to every agent regardless of vendor.

## Per-agent guides

| Agent | File |
|-------|------|
| Claude Code | [`CLAUDE.md`](CLAUDE.md) |
| Gemini | [`GEMINI.md`](GEMINI.md) |
| Jules | [`JULES.md`](JULES.md) |

Read the guide for the agent you are. They share most rules but the
Claude file is the most fleshed-out — start there if your guide is sparse.

## Rules that apply to every agent

1. **Never reintroduce the items in `CLAUDE.md` → "Critical Crash Rules"**.
   Those each correspond to a real production crash.
2. **The build target is `:manager:assembleRelease`** for verification.
   Debug builds skip Sentry symbol upload and are fine for fast iteration.
3. **Do not edit `key.jks`, `signing.properties`, or files matching
   `secrets*`** — they are signing material.
4. **CI is GitHub Actions**, single workflow at `.github/workflows/app.yml`.
   Inspect it before assuming how a build works.
5. **Use `scripts/dev/*`** for common commands instead of re-deriving from
   `build.gradle` each session.

## Project quick-ref

- **Entry activity:** `MainActivity` (NOT `HomeActivity` — that's abstract)
- **Settings keys:** `manager/src/main/java/af/shizuku/manager/ShizukuSettings.java` inner class `Keys`
- **Preference XML:** `manager/src/main/res/xml/settings_*.xml`
- **Theme:** `Theme.Material3Expressive.*` — use M3 components, not AppCompat
- **App widgets:** `RemoteViews` only allows framework views — do NOT use
  `MaterialButton` / `MaterialSwitch` etc. inside `widget_*.xml`

## Branding

- Two manager flavors (`manager/build.gradle` → `productFlavors`):
  - `shizukuplus`: app name `Shizuku+`, `af.shizuku.plus.api` — coexists with stock Shizuku.
  - `dropin`: app name `Shizuku`, `moe.shizuku.privileged.api` — replaces stock Shizuku for apps hard-coded to its package.
- Compat stub (`compat/`) is labelled `Shizuku (Compat Hub)`.
- Code namespaces are `af.shizuku.*`; keep `rikka.shizuku.*` namespaces that come from upstream modules (shell, starter) as-is.
- Launcher icon: cat + hexagon with a plus badge. The Themed Icons (monochrome) layer contains only the plus badge — don't add the cat/hexagon to it.
- Never re-declare `moe.shizuku.manager.permission.API_V23` in the Plus flavor (breaks coexistence).
- Upstream credit (`CHANGES.md`, `NOTICE`, README) must keep naming thedjchi/Shizuku and RikkaApps/Shizuku.

### Project family (all by thejaustin)

| Product | Display name | Repo | Package / coordinates | Upstream |
|---------|-------------|------|------------------------|----------|
| Shizuku+ | `Shizuku+` | `thejaustin/ShizukuPlus` | `af.shizuku.plus.api` (Plus flavor), `moe.shizuku.privileged.api` (Drop-In flavor) | thedjchi/Shizuku ← RikkaApps/Shizuku |
| Shizuku+-API | `Shizuku+-API` | `thejaustin/ShizukuPlus-API` | Maven group `af.shizuku.plus`; JitPack `com.github.thejaustin:Shizuku+-API:<ver>-plus` | RikkaApps/Shizuku-API |
| Obtainium+ | `Obtainium+` | `thejaustin/ObtainiumPlus` | `dev.thejaustin.obtainiumplus` | ImranR98/Obtainium |
| SuperShade | `SuperShade` | `thejaustin/SuperShade` | `com.supershade` | original (no upstream) |

Naming rules:
- User-facing text uses the `+` form (`Shizuku+`, `Obtainium+`); repo names, URLs, and code identifiers spell it `Plus` (`ShizukuPlus`, `PlusSettingsProvider`). Never write "Shizuku Plus" or "ObtainiumPlus" in UI strings.
- `SuperShade` is one word, capital S twice — never "Super Shade" / "Supershade".
- Refer to upstreams by their own names (Shizuku, Obtainium) and credit them; don't rebrand upstream attributions or license notices.

More agent context in thejaustin/ShizukuPlus

6 other files this repository gives its agents.