|
1 | 1 | # plugin-yml
|
2 |
| -[plugin-yml] is a simple Gradle plugin that generates the `plugin.yml` plugin description file for Bukkit plugins, |
3 |
| -`bungee.yml` for Bungee plugins or `nukkit.yml` for Nukkit plugins based on the Gradle project. Various properties |
4 |
| -are set automatically (e.g. project name, version or description) and additional properties can be added using a |
5 |
| -simple DSL. |
| 2 | +[plugin-yml] is a simple Gradle plugin that generates the `plugin.yml` plugin description file for Bukkit plugins, |
| 3 | +`paper-plugin.yml` for Paper plugins, `bungee.yml` for Bungee plugins or `nukkit.yml` for Nukkit plugins based on |
| 4 | +the Gradle project. Various properties are set automatically (e.g. project name, version or description) and |
| 5 | +additional properties can be added using a simple DSL. |
6 | 6 |
|
7 | 7 | ## Usage
|
8 | 8 | [plugin-yml] requires at least **Gradle 7.4**. Using the latest version of Gradle is recommended.
|
@@ -160,12 +160,12 @@ To give you access to repositories and dependencies marked as `paperLibrary` the
|
160 | 160 | To create those classes set `generateLibClass` and `generateReposClass` to true.
|
161 | 161 | Those classes are enums and provide all listed repositories and dependencies to you.
|
162 | 162 | Build your plugin once to generate them.
|
163 |
| -You can reference them inside the code afterwards. |
| 163 | +You can reference them inside the code afterward. |
164 | 164 | Repositories will be named via their defined names.
|
165 |
| -If you do not define a name they will be named MAVENX where x is a number counting up. |
| 165 | +If you do not define a name they will be named `MAVENX` where x is a number counting up. |
166 | 166 | It is highly recommended to give your repositories a name if you want to use them directly.
|
167 | 167 |
|
168 |
| -An example `Loader` implementation could look like this: |
| 168 | +An example `PluginLoader` implementation could look like this: |
169 | 169 | ```java
|
170 | 170 | public class Loader implements PluginLoader {
|
171 | 171 | @Override
|
@@ -210,7 +210,9 @@ paper {
|
210 | 210 | // The package where Repos and Libraries class are stored
|
211 | 211 | generatedPackageName = 'com.example.testplugin'
|
212 | 212 |
|
213 |
| - |
| 213 | + // Mark plugin for supporting Folia |
| 214 | + foliaSupported = true |
| 215 | +
|
214 | 216 | // API version (Needs to be 1.19 or higher)
|
215 | 217 | apiVersion = '1.19'
|
216 | 218 |
|
@@ -293,6 +295,9 @@ bukkit {
|
293 | 295 | generateReposClass = true
|
294 | 296 | // The package where Repos and Libraries class are stored
|
295 | 297 | generatedPackageName = "com.example.testplugin"
|
| 298 | + |
| 299 | + // Mark plugin for supporting Folia |
| 300 | + foliaSupported = true |
296 | 301 |
|
297 | 302 | // API version (Needs to be 1.19 or higher)
|
298 | 303 | apiVersion = "1.19"
|
|
0 commit comments