Skip to content

External API Documentation

Daniel Stephenson edited this page Oct 9, 2021 · 3 revisions

Download

The API is available in the latest version of the plugin, which can be downloaded here.

Adding the JAR to a Maven project in IntelliJ

  1. Copy the JAR into a folder in your project.
  2. Add this to your pom.xml in the dependencies section:
<dependency>
  <groupId>dansplugins</groupId>
  <artifactId>Mailboxes</artifactId>
  <version>(version)</version>
  <scope>system</scope>
  <systemPath>${project.basedir}/(path-to-JAR)/Mailboxes-(version).jar</systemPath>
</dependency>
  1. Add the JAR as a module in File --> Project Structure --> Modules.

Location

The location of the primary class for the API is "src/main/java/dansplugins/mailboxes/externalapi/MailboxesAPI.java".

Projects Using the External API

  1. Medieval Roleplay Engine

Integrator Class

When using this API, I have preferred to use an integrator class to check if the API is available and to get the API itself. Here is an example of one such class. Feel free to use this in your own projects.

Clone this wiki locally