Upstream/ProtocolLib
1
0
Fork 0
mirror of https://github.com/dmulloy2/ProtocolLib.git synced 2024-11-24 03:25:29 +01:00
Code Issues Projects Releases Wiki Activity

Update Readme to contain Maven info

Browse Source
This commit is contained in:
Dan Mulloy 2014-12-09 17:41:37 -05:00
parent 4c1fac9aa3
commit 2a51e16ef0
1 changed files with 25 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
Readme.md
View File

@ -11,41 +11,57 @@ Critically, different plugins that use this approach may _hook_ into the same cl
with unpredictable outcomes. More than often this causes plugins to crash, but it may also with unpredictable outcomes. More than often this causes plugins to crash, but it may also
lead to more subtle bugs. lead to more subtle bugs.
Currently maintained by dmulloy2 on behalf of [SpigotMC](http://www.spigotmc.org/) Currently maintained by dmulloy2 on behalf of [Spigot](http://www.spigotmc.org/).
### Resources ### Resources
* [Resource Page](http://www.spigotmc.org/resources/protocollib.1997/)
* [Downloads](http://ci.shadowvolt.com/job/ProtocolLib) * [Downloads](http://ci.shadowvolt.com/job/ProtocolLib)
* [JavaDoc](http://ci.shadowvolt.com/job/ProtocolLib/javadoc) * [JavaDoc](http://ci.shadowvolt.com/job/ProtocolLib/javadoc)
Compilation Compilation
---------- ----------
ProtocolLib requires Maven, as well as Spigot and SpigotAPI, which can be found [here](http://www.spigotmc.org/wiki/buildtools/). ProtocolLib is built with Maven and requires Spigot and SpigotAPI, which can be found [here](http://www.spigotmc.org/wiki/buildtools/).
A new API A new API
--------- ---------
__ProtocolLib__ attempts to solve this problem by providing a event API, much like Bukkit, __ProtocolLib__ attempts to solve this problem by providing a event API, much like Bukkit,
that allow plugins to monitor, modify or cancel packets sent and received. But more importantly, that allows plugins to monitor, modify, or cancel packets sent and received. But, more importantly,
the API also hides all the gritty, obfuscated classes with a simple index based read/write system. the API also hides all the gritty, obfuscated classes with a simple index based read/write system.
You no longer have to reference CraftBukkit! You no longer have to reference CraftBukkit!
### Using ProtocolLib ### Using ProtocolLib
To use the library, first add ProtocolLib.jar to your Java build path. Then, add ProtocolLib To use this library, first add ProtocolLib.jar to your Java build path. Then, add ProtocolLib
as a dependency (or soft-dependency, if you can live without it) to your plugin.yml file: as a dependency (or soft-dependency, if you can live without it) to your plugin.yml file:
````yml ````yml
depends: [ProtocolLib] depends: [ProtocolLib]
```` ````
Future versions will be available in a public Maven repository, possibly on Maven central. But it You can also add ProtocolLib as a Maven dependency:
will always be possible to reference ProtocolLib manually.
Then get a reference to ProtocolManager in onLoad() and you're good to go. ````xml
<repositories>
<repository>
<id>shadowvolt-repo</id>
<url>http://ci.shadowvolt.com/plugin/repository/everything/</url>
</repository>
...
</repository>
<dependencies>
<dependency>
<groupId>com.comphenix.protocol</groupId>
<artifactId>ProtocolLib</artifactId>
<version>3.6.3-SNAPSHOT</version>
</dependency>
</dependencies>
````
Then get a reference to ProtocolManager in onLoad() or onEnable() and you're good to go.
````java ````java
private ProtocolManager protocolManager; private ProtocolManager protocolManager;