Skip to content

Commit a2e821f

Browse files
committed
Update README
1 parent e148100 commit a2e821f

File tree

2 files changed

+45
-5
lines changed

2 files changed

+45
-5
lines changed

README.md

Lines changed: 44 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# SpiGUI
2-
A comprehensive inventory menu API for Spigot with pages support. Supports Bukkit/Spigot 1.7 - 1.19 (see [Version Notes](#version-notes)).
2+
A comprehensive inventory menu API for Spigot with pages support. Supports Bukkit/Spigot 1.7 - 1.20 (see [Version Notes](#version-notes)) (Future versions ought to work just fine too!).
33
<p>
44
<a target="_blank" href="https://github.com/SamJakob/SpiGUI/blob/master/LICENSE">
55
<img alt="License" src="https://img.shields.io/github/license/SamJakob/SpiGUI?style=for-the-badge">
@@ -32,12 +32,52 @@ A comprehensive inventory menu API for Spigot with pages support. Supports Bukki
3232
> _**IMPORTANT!**_ If you have an opinion on how backwards compatibility should be achieved with new versions, please
3333
> feel free to [drop a reply to this open discussion](https://github.com/SamJakob/SpiGUI/issues/21).
3434
35-
- I don't see a reason it shouldn't work in Spigot 1.7 or any version of Bukkit from 1.8 - 1.19 but it hasn't been tested on each individual version.
36-
- This library has been tested on Spigot 1.8, Spigot 1.16 and PaperSpigot 1.19 and is expected to work on every versions in-between for most, if not all, forks of Spigot.
37-
- The [ItemBuilder](https://github.com/SamJakob/SpiGUI/blob/master/src/main/java/com/samjakob/spigui/item/ItemBuilder.java) API does require that `api-version` be `"legacy"` (or not specified) for Spigot versions after 1.13.
35+
- I don't see a reason it shouldn't work in Spigot 1.7 or any version of Bukkit from 1.8 - 1.20 but it hasn't been tested on each individual version.
36+
- This library has been tested on Spigot 1.8, Spigot 1.16, PaperSpigot 1.19, Spigot 1.20 and is expected to work on every versions in-between for most, if not all, forks of Spigot.
37+
- The [ItemBuilder](https://github.com/SamJakob/SpiGUI/blob/master/src/main/java/com/samjakob/spigui/item/ItemBuilder.java) API should work for all versions of Bukkit/Spigot unless you use the `ItemDataColor` (or `data` value) which relies on pre-1.13 item data values. (Though you can just use the relevant `Material` instead - e.g., instead of using `Material.WOOL` and `ItemDataColor.BLUE`, just use `Material.BLUE_WOOL`.)
3838

3939
<br>
4040

41+
## Installation
42+
43+
You can very easily install SpiGUI using [JitPack](https://jitpack.io/#com.samjakob/SpiGUI).
44+
(The JitPack page contains instructions for Gradle, Maven, sbt, etc.)
45+
46+
Gradle users; just add the following to your `build.gradle` file:
47+
```groovy
48+
repositories {
49+
// ...
50+
51+
maven { url 'https://jitpack.io' }
52+
}
53+
54+
dependencies {
55+
// ...
56+
57+
implementation 'com.samjakob:SpiGUI:<insert latest version here>'
58+
}
59+
```
60+
61+
<br>
62+
63+
For distribution, you can just shade the library into your plugin JAR. On
64+
Gradle, this can be done by adding the following to the end of your
65+
`build.gradle`:
66+
67+
```groovy
68+
jar {
69+
duplicatesStrategy(DuplicatesStrategy.EXCLUDE)
70+
71+
from {
72+
configurations.runtimeClasspath.collect { it.isDirectory() ? it : zipTree(it) }
73+
}
74+
}
75+
```
76+
77+
If you aren't using a build system, you can just download the latest JAR and
78+
add it to your project's classpath (just make sure the SpiGUI classes are
79+
included in your JAR when you build it).
80+
4181
## Quick Start
4282

4383
**Step 1: Create an instance of the SpiGUI library in your plugin**

build.gradle

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ plugins {
44
}
55

66
group 'com.samjakob'
7-
version '1.3.1-SNAPSHOT'
7+
version '1.3.1'
88
uri "https://github.com/SamJakob/SpiGUI"
99

1010
java {

0 commit comments

Comments
 (0)