Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Overhaul project setup #7

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Update README.md
zt64 committed Jul 6, 2024

Unverified

This user has not yet uploaded their public signing key.
commit 0aba41dbfb1b72f9958d7ee7010c6ec502c6b9a5
35 changes: 26 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,36 @@
# `Aliucord Plugin Repo Template`
# Aliucord Plugin Repo Template

---

Template for an [Aliucord](https://github.com/Aliucord) plugin repo

⚠️ Make sure you check "Include all branches" when using this template
⚠️ 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

- Java JDK 11 or newer. OpenJDK recommended
- [Android Studio](https://developer.android.com/studio)

## Getting started with writing your first plugin

This template includes 2 example plugins demonstrating commands and patches which you can find in
the ExamplePlugins folder.
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](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:

1. Open the root build.gradle.kts, read the comments and replace all the placeholders
2. Familiarize yourself with the project structure. Most files are commented
3. Build or deploy your first plugin using:
- Windows: `.\gradlew.bat MyFirstCommand:make` or `.\gradlew.bat MyFirstCommand:deployWithAdb`
- Linux & Mac: `./gradlew MyFirstCommand:make` or `./gradlew MyFirstCommand:deployWithAdb`
- 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