Skip to content

API Installation

Eisi05 edited this page May 29, 2026 · 9 revisions

NpcAPI can be used in 2 common ways:

1) As a server plugin dependency (compileOnly/provided)

  • You install NpcPlugin on the server.
  • Your plugin depends on it.

Maven

<repositories>
  <repository>
    <id>jitpack.io</id>
    <url>https://jitpack.io</url>
  </repository>
</repositories>

<dependency>
  <groupId>com.github.Eisi05</groupId>
  <artifactId>NpcApi</artifactId>
  <version>2.2.2</version>
  <scope>provided</scope>
</dependency>

Gradle

repositories {
  mavenCentral()
  maven { url 'https://jitpack.io' }
}

dependencies {
  compileOnly 'com.github.Eisi05:NpcApi:2.2.2'
}

plugin.yml

depend: [NpcPlugin]
# or
soft-depend: [NpcPlugin]

2) Shading NpcAPI into your plugin

You include NpcAPI as a normal dependency and shade/relocate it into your jar.

  • This is useful if you don’t want to require NpcPlugin separately.
  • If you shade it, make sure you don’t end up with multiple copies across plugins.

Maven

<repositories>
  <repository>
    <id>jitpack.io</id>
    <url>https://jitpack.io</url>
  </repository>
</repositories>

<dependency>
  <groupId>com.github.Eisi05</groupId>
  <artifactId>NpcApi</artifactId>
  <version>2.2.2</version>
</dependency>

Gradle

repositories {
  mavenCentral()
  maven { url 'https://jitpack.io' }
}

dependencies {
  implementation 'com.github.Eisi05:NpcApi:2.2.2'
}

Requirements

  • Java 17+
  • Spigot 1.17+ (NpcAPI contains multi-version wrapper logic)

Clone this wiki locally