Skip to content

zt64/plugins-template

 
 

Repository files navigation

Aliucord Plugin Repo Template


Template for an Aliucord plugin repo

⚠️ Make sure you check "Include all branches" when using this template
⚠️ Consider getting familiar with Java and/or Kotlin and Gradle before starting

Pre-requisites

Getting started with writing your first plugin

This template includes an example plugin written in Kotlin and Java, demonstrating how to implement a command and patches.

To set up your development environment:

  1. Clone this repository to your local machine.
  2. Open the cloned repository in Android Studio.
  3. Open the gradle build script at plugin/build.gradle.kts, read the comments and replace all the placeholders
  4. Familiarize yourself with the project structure. Most files are commented

To build and deploy your plugin:

  • On Linux & Mac, run ./gradlew MyFirstKotlinPlugin:make to build the plugin. Use ./gradlew MyFirstKotlinPlugin:deployWithAdb to deploy directly to a connected device.
  • On Windows, use .\gradlew.bat MyFirstKotlinPlugin:make and .\gradlew.bat MyFirstKotlinPlugin:deployWithAdb for building and deploying, respectively.

License

Everything in this repo is released into the public domain. You may use it however you want with no conditions whatsoever

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Kotlin 50.4%
  • Java 49.6%