Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/citizensdev/citizensapi

API for Citizens
https://github.com/citizensdev/citizensapi

citizens citizens-plugin java minecraft minecraft-plugin npc papermc spigot

Last synced: 6 days ago
JSON representation

API for Citizens

Awesome Lists containing this project

README

        

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:
- All versions of Minecraft with Spigot/Bukkit (http://wiki.citizensnpcs.co/Versions for more)

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.)
```xml

citizens-repo
https://maven.citizensnpcs.co/repo

net.citizensnpcs
citizensapi
CITIZENS_VERSION
jar
compile

```

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