Skip to content

README.md

Latest commit

 

History

History
61 lines (40 loc) · 1.46 KB

README.md

File metadata and controls

61 lines (40 loc) · 1.46 KB

ExternusAPI

ExtAPI, or Externus API is a lightweight API which wraps around the spigot API to make plugins easier to develop, eliminate common boilerplate, automate common tasks and unify syntax across all versions.

Building ExtAPI

If you would like to build the Externus API it should be done so using Apache Maven.

Maven

  • Open the source directory in your favourite terminal/console
  • Run the command ```mvn clean install```

Including ExtAPI

To include the ExtAPI into your pom.xml do the following steps

Maven

  • Build ExtAPI using the build tutorial above to install ExtAPI into your local .m2 repository
  • Include the following depend tag into your pom.xml that is relevant to the plugin you are making

Bukkit

<dependency>
  <groupId>me.deltaorion</groupId>
  <artifactId>bukkit-api</artifactId>
  <version>1.0-SNAPSHOT</version>
</dependency>

Bungee

<dependency>
  <groupId>me.deltaorion</groupId>
  <artifactId>bungee-api</artifactId>
  <version>1.0-SNAPSHOT</version>
</dependency>

Usage

To learn how to use the API simply follow the wiki which is located in the "wiki" folder in the source. There are also examples avaliable in the bukkit-test-plugin and bungee-test-plugin modules respectively

Licensing

This library is licensed under the MIT license. Furthur details can be found in the License.md file