Skip to content

Latest commit

 

History

History
39 lines (29 loc) · 1.41 KB

README.md

File metadata and controls

39 lines (29 loc) · 1.41 KB
Raw

CitizensAPI README

CitizensAPI is an API framework for developers to use. It provides methods for creating and maintaining NPCs, as well as attaching custom data to NPCs.

Compatible With:

Maven

IF YOU ARE USING THE API (which you probably should not be if you're just integrating the Citizens plugin!), Include CitizensAPI in your pom.xml like this: (If you are integrating your own plugin with the Citizens plugin, see https://wiki.citizensnpcs.co/API for information on appropriate maven linkage.)

<repository>
            <id>citizens-repo</id>
            <url>https://maven.citizensnpcs.co/repo</url>
</repository>
<dependency>
	<groupId>net.citizensnpcs</groupId>
	<artifactId>citizensapi</artifactId>
	<version>CITIZENS_VERSION</version>
	<type>jar</type>
	<scope>compile</scope>
</dependency>

The correct CITIZENS_VERSION to use can depend on your minecraft version. A list can be found here https://maven.citizensnpcs.co/#/repo/net/citizensnpcs/ - or you can use the version listed in the Citizens2 JAR you downloaded (e.g. 2.0.30-SNAPSHOT).

Javadoc

http://jd.citizensnpcs.co

Extra information

Spigot page: https://www.spigotmc.org/resources/citizens.13811/

For questions/help join our discord at: https://discord.gg/Q6pZGSR