Skip to content

Commit 7cb8f3c

Browse files
committed
Update README
1 parent 3ae389c commit 7cb8f3c

File tree

1 file changed

+15
-11
lines changed

1 file changed

+15
-11
lines changed

README.md

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,16 @@ Gradle utilities for easier writing Bukkit plugins.
1515
#### Features:
1616
- Automatically applies plugins: java, idea, eclipse
1717
- Sets up compiler encoding to UTF-8
18+
- Sets archivesBaseName to plugin name
19+
- Supports APIs: Bukkit, CraftBukkit, Spigot, Paper
1820
- Provides short extension-functions to add common repositories and dependencies
1921
- Generates plugin.yml from Gradle project information
2022
- Allows to run dev server from IDE
23+
- Supports two cores for dev server: Spigot and Paper
24+
- Automatically downloads and updates BuildTools or Paperclip
2125
- Automatically copies your plugin to plugins dir on server running
2226

2327
#### TODO:
24-
- Add extension function for PaperApi
25-
- Add possibility to use Paper/CraftBukkit as dev server core
26-
- Add automatically downloading of BuildTools
2728
- Add smart dependency system
2829

2930
## Apply plugin
@@ -157,7 +158,7 @@ dependencies {
157158

158159
##### Repositories:
159160
Name | Url
160-
----------------|----------------------------------------------------------------
161+
----------------|-------------------------------------------------------------------
161162
spigot | https://hub.spigotmc.org/nexus/content/repositories/snapshots/
162163
sk98q | http://maven.sk89q.com/repo/
163164
destroystokyo | https://repo.destroystokyo.com/repository/maven-public/
@@ -167,16 +168,19 @@ dependencies {
167168
placeholderapi | http://repo.extendedclip.com/content/repositories/placeholderapi/
168169

169170
##### Dependencies:
170-
Name | Signature
171-
-------------|-----------------------------------------------
172-
spigot | org.spigotmc:spigot:$apiVersion
173-
spigotApi | org.spigotmc:spigot-api:$apiVersion
174-
bukkit | org.bukkit:bukkit:$apiVersion
175-
craftbukkit | org.bukkit:craftbukkit:$apiVersion
176-
paperApi | com.destroystokyo.paper:paper-api:$apiVersion
171+
Some dependencies also applies repo that needed for them.
172+
173+
Name | Signature | Applies repo
174+
-------------|-----------------------------------------------|---------------
175+
spigot | org.spigotmc:spigot:$apiVersion | -
176+
spigotApi | org.spigotmc:spigot-api:$apiVersion | spigot
177+
bukkit | org.bukkit:bukkit:$apiVersion | spigot
178+
craftbukkit | org.bukkit:craftbukkit:$apiVersion | -
179+
paperApi | com.destroystokyo.paper:paper-api:$apiVersion | destroystokyo
177180

178181
**Note:** `$apiVersion` - is `${version}-R0.1-SNAPSHOT` (where `$version` is `bukkit.version`)
179182

183+
If you want more extension-functions - you can [write issue](https://github.com/EndlessCodeGroup/BukkitGradle/issues/new).
180184

181185
### Running Dev server
182186
Before running server you should configure dev server location.

0 commit comments

Comments
 (0)