webadmin/WorldGuardWrapper
1
0
Fork 0
forked from clone/WorldGuardWrapper
Code Pull Requests Activity

Merge branch 'master' of https://github.com/CodeMC/WorldGuardWrapper

Browse Source
This commit is contained in:
Gabriele C 2018-08-20 00:57:04 +02:00
commit 2cd268f3e9
1 changed files with 50 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
README.md
View File

@ -2,3 +2,53 @@
[![Build Status](https://ci.codemc.org/buildStatus/icon?job=CodeMC/WorldEditWrapper)](https://ci.codemc.org/view/Author/job/CodeMC/job/WorldEditWrapper/)
A wrapper for the WorldGuard API that allows plugins to support both v6 and v7 APIs.
## Maven dependency
How to include WorldEditWrapper into your maven project:
```xml
<repositories>
<repository>
<id>codemc-repo</id>
<url>https://repo.codemc.org/repository/maven-public/</url>
</repository>
</repositories>
<dependencies>
<dependency>
<groupId>org.codemc.worldguardwrapper</groupId>
<artifactId>worldguardwrapper</artifactId>
<version>1.0.0-SNAPSHOT</version>
</dependency>
</dependencies>
```
Remember to include/relocate the library into your final jar, example:
```xml
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-shade-plugin</artifactId>
<version>3.1.1</version>
<executions>
<execution>
<phase>package</phase>
<goals>
<goal>shade</goal>
</goals>
</execution>
</executions>
<configuration>
<relocations>
<relocation>
<pattern>org.codemc.worldguardwrapper</pattern>
<shadedPattern>YOUR.PLUGIN.PACKAGE.libs.worldguardwrapper</shadedPattern>
</relocation>
</relocations>
</configuration>
</plugin>
</plugins>
</build>
```