Skip to content

Commit a119607

Browse files
Update readme
1 parent 47b8fc2 commit a119607

File tree

1 file changed

+13
-8
lines changed

1 file changed

+13
-8
lines changed

README.md

+13-8
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# 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.
66

77
## Usage
88
[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
160160
To create those classes set `generateLibClass` and `generateReposClass` to true.
161161
Those classes are enums and provide all listed repositories and dependencies to you.
162162
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.
164164
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.
166166
It is highly recommended to give your repositories a name if you want to use them directly.
167167

168-
An example `Loader` implementation could look like this:
168+
An example `PluginLoader` implementation could look like this:
169169
```java
170170
public class Loader implements PluginLoader {
171171
@Override
@@ -210,7 +210,9 @@ paper {
210210
// The package where Repos and Libraries class are stored
211211
generatedPackageName = 'com.example.testplugin'
212212
213-
213+
// Mark plugin for supporting Folia
214+
foliaSupported = true
215+
214216
// API version (Needs to be 1.19 or higher)
215217
apiVersion = '1.19'
216218
@@ -293,6 +295,9 @@ bukkit {
293295
generateReposClass = true
294296
// The package where Repos and Libraries class are stored
295297
generatedPackageName = "com.example.testplugin"
298+
299+
// Mark plugin for supporting Folia
300+
foliaSupported = true
296301

297302
// API version (Needs to be 1.19 or higher)
298303
apiVersion = "1.19"

0 commit comments

Comments
 (0)