Plexus-Mirror
/
plugin-yml
mirror of https://github.com/plexusorg/plugin-yml.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Collapse examples in README

This commit is contained in:
Minecrell 2018-07-24 15:51:06 +02:00
parent 40b86ec3d1
commit a1ff0b1ab5
1 changed files with 21 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@ -1,7 +1,8 @@
# plugin-yml
[plugin-yml] is a simple Gradle plugin that generates the `plugin.yml` plugin description file for Bukkit plugins,
`bungee.yml` for Bungee plugins or `nukkit.yml` for Nukkit plugins based on the Gradle project. Various properties are set automatically (e.g. project
name, version or description) and additional properties can be added using a simple DSL.
`bungee.yml` for Bungee plugins or `nukkit.yml` for Nukkit plugins based on the Gradle project. Various properties
are set automatically (e.g. project name, version or description) and additional properties can be added using a
simple DSL.
## Usage
[plugin-yml] requires at least **Gradle 4.2**. Using the latest version of Gradle is recommended.
@ -18,7 +19,8 @@ name, version or description) and additional properties can be added using a sim
### Bukkit
#### Groovy
<details>
<summary><strong>Groovy</strong></summary>
```groovy
plugins {
@ -70,8 +72,10 @@ bukkit {
}
}
```
</details>
#### kotlin-dsl
<details>
<summary><strong>kotlin-dsl</strong></summary>
```kotlin
plugins {
@ -123,10 +127,12 @@ bukkit {
}
}
```
</details>
### Bungee
#### Groovy
<details>
<summary><strong>Groovy</strong></summary>
```groovy
plugins {
@ -148,8 +154,10 @@ bungee {
softDepends = ['ServerListPlus']
}
```
</details>
#### kotlin-dsl
<details>
<summary><strong>kotlin-dsl</strong></summary>
```kotlin
plugins {
@ -171,10 +179,12 @@ bungee {
softDepends = setOf("ServerListPlus")
}
```
</details>
### Nukkit
#### Groovy
<details>
<summary><strong>Groovy</strong></summary>
```groovy
plugins {
@ -222,8 +232,10 @@ bukkit {
}
}
```
</details>
#### kotlin-dsl
<details>
<summary><strong>kotlin-dsl</strong></summary>
```kotlin
plugins {
@ -271,5 +283,6 @@ bukkit {
}
}
```
</details>
[plugin-yml]: https://github.com/Minecrell/plugin-yml