VibedByKaKi/aliucord-plugins
1
0
Fork 0
mirror of https://github.com/VibedByKaKi/aliucord-plugins.git synced 2026-10-08 23:01:13 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions
aliucord-plugins/guide
History
Exact
KaKi87 60e0e86113 Add a practical Aliucord plugin guide distilled from docs and examples. 
Co-authored-by: Cursor <cursoragent@cursor.com>
2026-09-27 14:34:59 +02:00
..
01-setup.md Add a practical Aliucord plugin guide distilled from docs and examples. 2026-09-27 14:34:59 +02:00
02-plugin-anatomy.md Add a practical Aliucord plugin guide distilled from docs and examples. 2026-09-27 14:34:59 +02:00
03-commands.md Add a practical Aliucord plugin guide distilled from docs and examples. 2026-09-27 14:34:59 +02:00
04-patching.md Add a practical Aliucord plugin guide distilled from docs and examples. 2026-09-27 14:34:59 +02:00
05-settings.md Add a practical Aliucord plugin guide distilled from docs and examples. 2026-09-27 14:34:59 +02:00
06-discord-and-reflection.md Add a practical Aliucord plugin guide distilled from docs and examples. 2026-09-27 14:34:59 +02:00
07-build-deploy-publish.md Add a practical Aliucord plugin guide distilled from docs and examples. 2026-09-27 14:34:59 +02:00
08-learning-from-examples.md Add a practical Aliucord plugin guide distilled from docs and examples. 2026-09-27 14:34:59 +02:00
README.md Add a practical Aliucord plugin guide distilled from docs and examples. 2026-09-27 14:34:59 +02:00

README.md

Aliucord plugin guide

How to build plugins for Aliucord, the legacy Android Discord client mod.

This guide is distilled from the upstream material in docs/ and real plugins in examples/. Prefer Kotlin for new work. Java still works.

Contents

  1. Setup — tools, template repo, first Gradle sync
  2. Plugin anatomy — class, annotation, lifecycle
  3. Commands — slash commands via CommandsAPI
  4. Patching — hook Discord methods with PatcherAPI
  5. Settings — persist config and add a settings UI
  6. Discord code and reflection — find targets, reach private members
  7. Build, deploy, publish — zip, ADB, builds branch, review
  8. Learning from examples — which cloned repos to read for what

Upstream sources

Local path What it is
docs/documentation Official plugin/theme/smali docs
docs/plugins-template Official monorepo template with sample plugins
docs/gradle-plugin Gradle plugin that packages and deploys plugins
examples/* Distributed community and official plugin repos

API reference: Aliucord Dokka

Quick path

  1. Fork/use docs/plugins-template (or clone the GitHub template with all branches).
  2. Fill the // TODO placeholders in plugins/build.gradle.kts.
  3. Copy MyFirstKotlinPlugin, rename it, write your start/stop.
  4. Run deployWithAdb against a test account on Aliucord.
  5. Read a small real plugin from examples/ when something is unclear.