mirror of
https://github.com/recloudstream/plugin-template.git
synced 2024-08-15 03:16:05 +00:00
28 lines
1.1 KiB
Markdown
28 lines
1.1 KiB
Markdown
|
**⚠️ This is currently under development, dont use it yet if you're not comfortable with constantly merging new changes**
|
||
|
|
|
||
|
|
# `Cloudstream3 Plugin Repo Template`
|
||
|
|
|
||
|
|
Template for a [Cloudstream3](https://github.com/recloudstream) plugin repo
|
||
|
|
|
||
|
|
**⚠️ Make sure you check "Include all branches" when using this template**
|
||
|
|
|
||
|
|
|
||
|
|
## Getting started with writing your first plugin
|
||
|
|
|
||
|
|
This template includes 1 example 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 ExampleProvider:make` or `.\gradlew.bat ExampleProvider:deployWithAdb`
|
||
|
|
- Linux & Mac: `./gradlew ExampleProvider:make` or `./gradlew ExampleProvider:deployWithAdb`
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
Everything in this repo is released into the public domain. You may use it however you want with no conditions whatsoever
|
||
|
|
|
||
|
|
|
||
|
|
## Attribution
|
||
|
|
|
||
|
|
This template as well as the gradle plugin and the whole plugin system is **heavily** based on [Aliucord](https://github.com/Aliucord).
|
||
|
|
*Go use it, it's a great mobile discord client mod!*
|