Simple yet powerful API for easy operation with fake ArmorStands

Features 🤩

PacketStands have almost all the functionality of regular armorstands
they don't tick or cause lag, they aren't real entities
they can be attached to any entity, including head pitch and yaw (can be customized)
they can be hidden for certain players
StandAPI also has a custom event for when player hits a PacketStand
saving and loading are built-in (but can be disabled)
serializable and deserializable in one line of code
extremely fast, async code powered by coroutines

Kotlin? But I use Java? 😢

Don't worry, you can use this library from either Kotlin or Java

How do I use this thing? 😯

import StandAPI into your project and create an instance of PacketStand like so:

val packetStand = PacketStand(location)

If you want StandAPI to also save and load said stand, provide plugin name in constructor:

val packetStand = PacketStand(location, "my-plugin-name")

then you can alter or get properties, for example

packetStand.setInvisible(true)
packetStand.isInvisible()

packetStand.setGlowingEffect(false)
packetStand.hasGlowingEffect()

packetStand.setCustomName("Bob")
packetStand.getCustomName()

//since non-final operations return back instance of PacketStand, you can chain them
packetStand.setArms(true)
		   .setSmall(true)
		   .setCustomNameVisible(true)

or you can attach the PacketStand to an entity
note 1: if a stand is attached to a Player, due to the nature of packets, that player will not see the stand moving smoothly (all others will, however), but rather with small delay, more or less said player's ping. It is recommended to hide the stand for the player using .excludePlayer(player)
note 2: if the entity dies, stand will detach, unless the entity is a player

//this will directly copy location of entity
packetStand.attachTo(entity)

//PacketStand will copy every move but will be two blocks above it's location
val offset = Offset(0.0,2.0,0.0)
packetStand.attachTo(entity, offset)

this also copies the entity's head pitch and yaw movements by default
however, it can be disabled

packetStand.setAttachPitch(false)
packetStand.setAttachYaw(false)

stand can be made hidden for any number of players

packetStand.excludePlayer(player)

of course it can be moved

packetStand.setLocation(location)

head, body and each limb's rotation can be gotten or changed
StandAPI operates in regular degrees, 0f-360f, so no EulerAngles or any of that stuff

val pitch = packetStand.getHeadRotation().pitch
val yaw = packetStand.getHeadRotation().yaw

to change any rotation, create and pass Rotation object like this

val rotation = Rotation(0f, 90f, 0f)
packetStand.setHeadRotation(rotation)

though there are two extension methods to convert from and to EulerAngle

//kotlin
val rotation = eulerAngle.toRotation()
val eulerAngle = rotation.toEulerAngle()

//java
Rotation rotation = Rotation.toRotation(eulerAngle);
EulerAngle eulerAngle = Rotation.toEulerAngle(rotation);

to remove PacketStand, simply

packetStand.remove()

alternatively, you can set the PacketStand to be removed some time later or even execute an async task after it is removed

//removes the stand after 20 ticks
packetStand.remove(20)

//removes the stand after 20 ticks and prints "Stand removed" to console
packetStand.remove(20, () -> {
    System.out.println("Stand removed")
})

There are also methods to convert from and to a real Armorstand. This removes the previous stand.

//converts it to real stand copying all it's properties
val armorStand = packetStand.toRealStand()

//converts it to packet stand copying all it's properties
val packetStand = armorStand.fromRealStand()

StandManager

Here are some useful methods to retrieve PacketStands

StandManager.all()
StandManager.inWorld(world)
StandManager.ofPlugin(pluginName)
StandManager.byId(standId)
StandManager.attachedTo(entityId)

PacketStandEvent

custom async event fired when player right or left clicks a PacketStand
it is registered and used as any other event in spigot

//in main class onEnable
server.pluginManager.registerEvents(ExampleListener(), this)

class ExampleListener: Listener {  
  
    @EventHandler  
	fun onStandClick(e: PacketStandEvent){  
        if(e.action = Action.LEFT_CLICK){
	        //do whatever
        }
        val stand = e.packetStand
        val player = e.player
    }
	
}

for full view of all methods, visit javadoc:

Serialization and deserialization 💽

let's say you have disabled StandAPI's saving and loading, but still want to save PacketStands in some way or pass them as strings?
Very easy using Kotlin's serialization.
There are more formats to choose from, but here is json:

//serialize
val string = Json.encodeToString(packetStand)

//deserialize
val packetStand = Json.decodeFromString(string) as PacketStand

Import 👇

it is not advised to shade StandAPI into your plugin

plugin.yml:

depend: [StandAPI]

maven:

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

<dependency>
	<groupId>com.github.justADeni</groupId>
	<artifactId>StandAPI</artifactId>
	<version>(latest version)</version>
	<scope>provided</scope>
</dependency>

gradle:

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

dependencies {
	implementation 'com.github.justADeni:StandAPI:(latest version)'
}

Dependencies 🤝

StandAPI also depends on kLib for kotlin runtime and ProtocolLib for version-independent packet manipulation. Do not forget to also add those to your project

Showcase

What you're seeing here is cca 7000 PacketStands (my minecraft client crashed soon after). However the server handles at least 100000 PacketStands with no TPS drops whatsoever

justADeni / StandAPI