Small updates.
This commit is contained in:
Jitse Boonstra
parent
a945a21a26
commit
ff1472a94f
62
README.md
62
README.md
|
|
@ -1,15 +1,15 @@
|
|||
|
||||
|
||||
NPCLib – Basic non-player character library.<br>
|
||||
[](https://github.com/JitseB/NPCLib/releases)
|
||||
[](https://travis-ci.com/JitseB/NPCLib)
|
||||
[](http://jdk.java.net/8/)
|
||||
[](https://github.com/JitseB/NPCLib/releases)
|
||||
[](https://github.com/JitseB/NPCLib/releases)
|
||||
[](https://www.spigotmc.org/resources/npclib.55884/)
|
||||
=
|
||||
|
||||
This is an API made specifically for spigot servers (Minecraft). Current supported versions: **1.8 - 1.13.2**\*. Lightweight replacement for Citizens. NPCLib only uses packets instead of registering the entity in the actual Minecraft server.
|
||||
This is an API made specifically for spigot servers (Minecraft). Current supported versions: **1.8 - 1.14.4**\*. Lightweight replacement for Citizens. NPCLib only uses packets instead of registering the entity in the actual Minecraft server.
|
||||
|
||||
\*You can find a version of NPCLib with basic support for 1.7.10 on the [legacy branch](https://github.com/JitseB/NPCLib/tree/legacy). This branch is not (as) actively maintained as the master branch. This version does not support multi-line text (yet).
|
||||
\*You can find a version of NPCLib with basic support for 1.7.10 on the [legacy branch](https://github.com/JitseB/NPCLib/tree/legacy). This branch is not actively maintained as the master branch. This version does not support multi-line text.
|
||||
|
||||
### Preview (click to play video)
|
||||
[](http://www.youtube.com/watch?v=LqwdqIxPIvE "NPCLib – Basic non-player character library (Minecraft).")
|
||||
|
|
@ -20,40 +20,52 @@ This is an API made specifically for spigot servers (Minecraft). Current support
|
|||
|
||||
Alternatively, you can help the project by starring the repository or telling others about NPCLib. :smile:
|
||||
|
||||
## Roadmap
|
||||
|
||||
- :heavy_check_mark: Spawn and destroy NPC (version 1.8 - latest).
|
||||
- :heavy_check_mark: Autohide NPC when out of range.
|
||||
- :heavy_check_mark: Add support for 1.7.10 (1.7 R4).
|
||||
- :heavy_check_mark: Documentation material.
|
||||
- :construction: Option to rotate head to player (when nearby).
|
||||
- :construction: Add support for animated text (update-able holograms).
|
||||
- :x: Give NPC armor and items in hand.
|
||||
- :x: Multi-line text support for 1.7.10 (1.7 R4).
|
||||
|
||||
### Roadmad Legend
|
||||
:heavy_check_mark: Feature is fully implemented and functional. <br>
|
||||
:construction: Feature is still in development (or experimental). <br>
|
||||
:x: Development of feature has yet to be started. <br>
|
||||
|
||||
## Developers
|
||||
|
||||
### Usage
|
||||
|
||||
It is recommended to shade `npclib-api-v*.jar` into your plugin.
|
||||
Alternatively, you can put `npclib-plugin-v*.jar` under your `plugins` folder. By doing this, you no longer need to shade the API JAR. Though, do not forget to add `NPCLib` as a dependency in your `plugin.yml`!
|
||||
There are multiple ways you can make use of NPCLib.
|
||||
|
||||
1. The first option is to shade `npclib-plugin.jar` in to your plugin.
|
||||
2. The second option is to put `npclib-plugin.jar` under your `plugins` folder. By doing this, you no longer need to shade the API JAR. Though, do not forget to add `NPCLib` as a dependency in your `plugin.yml`!
|
||||
3. The third option (and the one I recommend most) is to shade the library using Maven. I recently added NPCLib to the OSSRH (OSS Repository Hosting) which allows you to easily import NPCLib into your project.
|
||||
|
||||
#### Maven repository
|
||||
```xml
|
||||
<repositories>
|
||||
<repository>
|
||||
<id>ossrh</id>
|
||||
<url>https://oss.sonatype.org/content/groups/public/</url>
|
||||
</repository>
|
||||
</repositories>
|
||||
```
|
||||
|
||||
#### Maven dependency
|
||||
|
||||
If you have NPCLib under your `plugins` folder, you may use the following:
|
||||
```xml
|
||||
<dependencies>
|
||||
<dependency>
|
||||
<groupId>net.jitse</groupId>
|
||||
<artifactId>npclib-api</artifactId>
|
||||
<version>2.0-SNAPSHOT</version>
|
||||
<scope>compile</scope>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
```
|
||||
If you do not want to have NPCLib in your `plugins` folder, you need to use the `npclib-plugin` artifact and [shade it](https://maven.apache.org/plugins/maven-shade-plugin/) accordingly.
|
||||
|
||||
|
||||
[Click here](https://github.com/JitseB/NPCLib/releases/latest) to download the latest release.
|
||||
|
||||
[Click here](https://github.com/JitseB/NPCLib/blob/master/DOCUMENTATION.md) for an elaborate explanation on how to use NPCLib in your next project.
|
||||
**[Click here](https://github.com/JitseB/NPCLib/blob/master/DOCUMENTATION.md) for an elaborate explanation on how to use NPCLib in your next project.**
|
||||
|
||||
### Building your own version
|
||||
|
||||
1. [Download](https://github.com/JitseB/NPCLib/archive/master.zip) or clone this repository.
|
||||
2. Build the plugin using `sh build.sh`. Alternatively, you can build the API JAR manually using `mvn clean install`.
|
||||
2. You can build the project using `mvn clean install`.
|
||||
|
||||
You can build the plugin using `mvn clean install -pPlugin`.
|
||||
The API JAR will be under `/api/target/` and the plugin JAR (which includes all necessary NMS code) will be under `/plugins/target/`.
|
||||
|
||||
## License and plugins using NPCLib
|
||||
|
||||
|
|
|
|||
|
|
@ -31,12 +31,6 @@
|
|||
<version>1.14.4-R0.1-SNAPSHOT</version>
|
||||
<scope>provided</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.spigotmc</groupId>
|
||||
<artifactId>spigot</artifactId>
|
||||
<version>1.14.4-R0.1-SNAPSHOT</version>
|
||||
<scope>provided</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>com.mojang</groupId>
|
||||
<artifactId>authlib</artifactId>
|
||||
|
|
|
|||
11
build.sh
11
build.sh
|
|
@ -1,11 +0,0 @@
|
|||
#!/bin/bash
|
||||
|
||||
echo "Building JARs..."
|
||||
|
||||
ls jars >> /dev/null 2>&1 || mkdir jars
|
||||
|
||||
echo "Building npclib-api.jar..."
|
||||
/usr/local/apache-maven-3.5.4/bin/mvn clean install >> /dev/null 2>&1 && cp ./api/target/*.jar ./jars && echo "Finished building NPCLib API" || echo "Failed building NPCLib API. Please rebuild manually"
|
||||
|
||||
echo "Building npclib-plugin.jar..."
|
||||
/usr/local/apache-maven-3.5.4/bin/mvn clean install -Pplugin >> /dev/null 2>&1 && cp ./target/*.jar ./jars && echo "Finished building NPCLib plugin" || echo "Failed building NPCLib plugin. Please rebuild manually"
|
||||
44
pom.xml
44
pom.xml
|
|
@ -79,20 +79,6 @@
|
|||
<target>1.8</target>
|
||||
</configuration>
|
||||
</plugin>
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-gpg-plugin</artifactId>
|
||||
<version>1.5</version>
|
||||
<executions>
|
||||
<execution>
|
||||
<id>sign-artifacts</id>
|
||||
<phase>verify</phase>
|
||||
<goals>
|
||||
<goal>sign</goal>
|
||||
</goals>
|
||||
</execution>
|
||||
</executions>
|
||||
</plugin>
|
||||
<plugin>
|
||||
<groupId>org.sonatype.plugins</groupId>
|
||||
<artifactId>nexus-staging-maven-plugin</artifactId>
|
||||
|
|
@ -106,4 +92,34 @@
|
|||
</plugin>
|
||||
</plugins>
|
||||
</build>
|
||||
|
||||
<profiles>
|
||||
<profile>
|
||||
<id>release-sign-artifacts</id>
|
||||
<activation>
|
||||
<property>
|
||||
<name>performRelease</name>
|
||||
<value>true</value>
|
||||
</property>
|
||||
</activation>
|
||||
<build>
|
||||
<plugins>
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-gpg-plugin</artifactId>
|
||||
<version>1.5</version>
|
||||
<executions>
|
||||
<execution>
|
||||
<id>sign-artifacts</id>
|
||||
<phase>verify</phase>
|
||||
<goals>
|
||||
<goal>sign</goal>
|
||||
</goals>
|
||||
</execution>
|
||||
</executions>
|
||||
</plugin>
|
||||
</plugins>
|
||||
</build>
|
||||
</profile>
|
||||
</profiles>
|
||||
</project>
|
||||
Loading…
Reference in New Issue