Skip to content

Commit cc11dcc

Browse files
committed
docs: Refresh README
1 parent fcdae83 commit cc11dcc

File tree

1 file changed

+28
-19
lines changed

1 file changed

+28
-19
lines changed

README.md

Lines changed: 28 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Gradle utilities for easier writing Bukkit plugins.
3232

3333
## Apply plugin
3434
[BukkitGradle on plugins.gradle.org](https://plugins.gradle.org/plugin/ru.endlesscode.bukkitgradle)
35-
> **NOTE:** Gradle 5.0+ required
35+
> **Note:** Gradle 6.6+ required
3636
3737
#### With new plugins mechanism
3838
```groovy
@@ -66,7 +66,7 @@ plugins {
6666
}
6767
6868
// Project information
69-
group = "com.example"
69+
group = "com.example.myplugin"
7070
description = "My first Bukkit plugin with Gradle"
7171
version = "0.1"
7272
@@ -76,23 +76,27 @@ dependencies {
7676
// see section 'Dependencies' for more info
7777
}
7878
```
79-
`compileOnly` - it's like provided scope in Maven. It means that this dependncy will not included to your final jar.
80-
It's enough! Will be hooked latest version of Bukkit and automatically generated `plugin.yml` with next content:
79+
> **Note:** `compileOnly` - it's like `provided` scope in Maven.
80+
It means that this dependency will not be included to your final jar.
81+
82+
It's enough!
83+
Will be hooked the latest version of Bukkit and automatically generated `plugin.yml` with next content:
8184
```yaml
8285
name: MyPlugin
8386
description: My first Bukkit plugin with Gradle
8487
main: com.example.myplugin.MyPlugin
8588
version: 0.1
89+
api-version: 1.16
8690
```
87-
Main class build by pattern: `<groupId>.<lower case name>.<name>`
91+
> **Note:** Main class built by following pattern: `<groupId>.<name>`
8892

8993
### Configuring plugin
9094
You can configure attributes that will be placed to `plugin.yml`:
9195
```groovy
9296
// Override default configurations
9397
bukkit {
94-
// Version of API (if you will not set this property, will be used latest available)
95-
version = "1.12.2"
98+
// Version of API (if you will not set this property, will be used latest version at moment of BukkitGradle release)
99+
apiVersion = "1.15.2"
96100
97101
// Attributes for plugin.yml
98102
meta {
@@ -106,12 +110,13 @@ bukkit {
106110
}
107111
```
108112

109-
Will be generated next `plugin.yml` file:
113+
Will be generated `plugin.yml` file:
110114
```yaml
111115
name: MyPlugin
112116
description: My amazing plugin, that doing nothing
113117
main: com.example.plugin.MyPlugin
114118
version: 1.0
119+
api-version: 1.15
115120
website: http://www.example.com
116121
authors: [OsipXD, Contributors]
117122
```
@@ -137,13 +142,13 @@ dependencies {
137142
##### Repositories:
138143
Name | Url
139144
----------------|-------------------------------------------------------------------
140-
spigot | https://hub.spigotmc.org/nexus/content/repositories/snapshots/
141-
sk98q | http://maven.sk89q.com/repo/
142-
destroystokyo | https://repo.destroystokyo.com/repository/maven-public/
143-
dmulloy2 | http://repo.dmulloy2.net/nexus/repository/public/
144-
md5 | http://repo.md-5.net/content/groups/public/
145-
vault | http://nexus.hc.to/content/repositories/pub_releases/
146-
placeholderapi | http://repo.extendedclip.com/content/repositories/placeholderapi/
145+
spigot | https://hub.spigotmc.org/nexus/content/repositories/snapshots/
146+
sk98q | https://maven.sk89q.com/repo/
147+
papermc | https://papermc.io/repo/repository/maven-public/
148+
dmulloy2 | https://repo.dmulloy2.net/nexus/repository/public/
149+
md5 | https://repo.md-5.net/content/groups/public/
150+
jitpack | https://jitpack.io/
151+
placeholderapi | https://repo.extendedclip.com/content/repositories/placeholderapi/
147152
aikar | https://repo.aikar.co/content/groups/aikar/
148153

149154
##### Dependencies:
@@ -177,17 +182,19 @@ buildtools.dir=/path/to/buildtools/
177182
```
178183
If there no BuildTools.jar it will be automatically downloaded.
179184

180-
**TIP:** you can define it globally (for all projects that uses BukkitGradle) with environment variables `BUKKIT_DEV_SERVER_HOME`
185+
> **Tip:** you can define it globally, for all projects that uses BukkitGradle.
186+
> Specify environment variables `BUKKIT_DEV_SERVER_HOME`
181187
and `BUKKIT_BUILDTOOLS_HOME`.
182188

183189
##### On IntelliJ IDEA
184-
Run `:buildIdeaRun` task. To your IDE will be added Run Configuration that will dynamically refreshes when you change
185-
server configurations.
190+
Run `:buildIdeaRun` task.
191+
Run Configuration will be added to your IDE.
192+
It will be automatically refreshed when you change server configurations.
186193

187194
![Run Configuration](http://image.prntscr.com/image/1a12a03b8ac54fccb7d5b70a335fa996.png)
188195

189196
##### On other IDEs
190-
Run `:startServer` task.
197+
Run `:runServer` task.
191198

192199
#### Dev server configuration
193200
To accept EULA and change settings use `bukkit.server` section:
@@ -197,6 +204,8 @@ bukkit {
197204
server {
198205
// Core type. It can be 'spigot' or 'paper'
199206
core = "spigot"
207+
// Server version
208+
version = "1.16.4" // If not specified, apiVersion will be used
200209
// Accept EULA
201210
eula = false
202211
// Set online-mode flag

0 commit comments

Comments
 (0)