Upstream/SubServers-2
1
0
Fork 0
mirror of https://github.com/ME1312/SubServers-2.git synced 2025-02-16 19:51:26 +01:00
Code Issues Projects Releases Wiki Activity

Updated SubAPI (markdown)

ME1312 2018-07-26 17:11:24 -04:00
parent a56652c4c8
commit e8ff96adcc
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
SubAPI.md

@ -13,12 +13,12 @@ You may want to use Maven to handle the SubAPI dependency for you. If so, here's
<dependency>
<groupId>net.ME1312.SubServers</groupId>
<artifactId>SubServers.Bungee</artifactId>
<version>2.11.2a</version>
<version>18w30a</version>
</dependency>
</dependencies>
```
`artifactId` can be replaced with any of the SubData editions you see on this page.<br>
`version` can be replaced with the plugin version of your choice, `-RELEASE` for the latest release, or `-SNAPSHOT` the latest unreleased version.<br>
`version` can be replaced with the build version of your choice. See the [Jenkins page](https://src.me1312.net/jenkins/job/SubServers%20Platform) for a version list.<br>
### Using SubAPI as a Soft Dependancy
A "Soft Dependancy" is where your plugin will use SubServers, but it is not required for your plugin to function properly.
@ -49,7 +49,7 @@ __Pro-Tips for using SubServers as a Soft-Dependancy:__
## SubServers.Bungee
This will show how to use SubAPI for SubServers.Bungee. For more detailed information visit this page:<br>
[http://subservers.ME1312.net/Javadoc/SubServers.Bungee/](http://subservers.ME1312.net/Javadoc/SubServers.Bungee/)
[https://src.me1312.net/jenkins/job/SubServers Platform/javadoc/SubServers.Bungee/](https://src.me1312.net/jenkins/job/SubServers%20Platform/javadoc/SubServers.Bungee/)
### Using SubAPI for Bungee
Most of SubAPI can be accessed using this simple method `SubAPI.getInstance()`, however there's a bit more to it than just that. SubServers.Bungee works by extending BungeeCord classes to add more functionality, and overriding the methods to serve the extended classes. Knowing this, you can use it to your advantage.
@ -81,16 +81,16 @@ SubServer subserver = (serverinfo instanceof SubServer)?(SubServer)serverinfo:nu
## SubServers.Sync & SubServers.Client
This will show how to use SubAPI for SubServers.Sync and SubServers.Client since they are extremely similar in that regard. For more detailed information visit the page for your platform:<br>
[http://subservers.ME1312.net/Javadoc/SubServers.Sync/](http://subservers.ME1312.net/Javadoc/SubServers.Sync/)<br>
[http://subservers.ME1312.net/Javadoc/SubServers.Client.Bukkit/](http://subservers.ME1312.net/Javadoc/SubServers.Client.Bukkit/)<br>
[http://subservers.ME1312.net/Javadoc/SubServers.Client.Sponge/](http://subservers.ME1312.net/Javadoc/SubServers.Client.Sponge/)
[https://src.me1312.net/jenkins/job/SubServers Platform/javadoc/SubServers.Sync/](https://src.me1312.net/jenkins/job/SubServers%20Platform/javadoc/SubServers.Sync/)<br>
[https://src.me1312.net/jenkins/job/SubServers Platform/javadoc/SubServers.Client.Bukkit/](https://src.me1312.net/jenkins/job/SubServers%20Platform/javadoc/SubServers.Client.Bukkit/)<br>
[https://src.me1312.net/jenkins/job/SubServers Platform/javadoc/SubServers.Client.Sponge/](https://src.me1312.net/jenkins/job/SubServers%20Platform/javadoc/SubServers.Client.Sponge/)
### Using SubAPI for SubServers.Sync/SubServers.Client
Like SubServers.Bungee, SubAPI methods can be accessed using the method `SubAPI.getInstance()`, however here most of the API is SubData packet based. This means you will have to create your own packets, or use the ones provided to you in the `Network.Packet` package. For more info on SubData [click here](https://github.com/ME1312/SubServers-2/wiki/SubData), to see what the JSON responses are for packets, [click here](https://github.com/ME1312/SubServers-2/tree/master/SubServers.Bungee/src/net/ME1312/SubServers/Bungee/Network/Packet).
## SubServers.Host
This will show how to use SubAPI for SubServers.Host. For more detailed information visit this page:<br>
[http://subservers.ME1312.net/Javadoc/SubServers.Host/](http://subservers.ME1312.net/Javadoc/SubServers.Host/)
[https://src.me1312.net/jenkins/job/SubServers Platform/javadoc/SubServers.Host/](https://src.me1312.net/jenkins/job/SubServers%20Platform/javadoc/SubServers.Host/)
### Creating your plugin
To use SubAPI here, you must create a SubPlugin. This section will detail how this is done, step by step.