EntityLib

EntityLib is a PacketEvents addon that provides an abstraction over raw entity data and packets to make it easier to work with entities as a whole. Currently, EntityLib is only stable for 1.21.9+, but it will support all versions that PacketEvents supports in the future.
For general support and reports of bugs, join the Discord server.

Currently supported platforms are spigot and velocity You can easily use EntityLib platformless by using the api or common module

If you like EntityLib and or want to sponsor me, visit my ko-fi page :D

EntityLib is published to PVPHub. Snapshots are available on pushes to the main branch, and stable releases are published on GitHub releases. Many thanks to the team at PVP Hub and @Bram1903 for hosting EntityLib

Gradle (Groovy DSL):

repositories {
mavenCentral()
maven("https://maven.pvphub.me/tofaa")
}
dependencies {
implementation 'io.github.tofaa2:<platform>:<version>'
}

Gradle (Kotlin DSL):

repositories {
mavenCentral()
maven("https://maven.pvphub.me/tofaa")
}
dependencies {
implementation("io.github.tofaa2:<platform>:<version>")
}

Maven:

<dependency>
<groupId>io.github.tofaa2</groupId>
<artifactId><platform></artifactId>
<version><version></version>
</dependency>

NOTE:

EntityLib does not provide packet-events as a dependency, you must have it in your classpath already. EntityLib will also stay at the latest packet-events version at all times

Features

• Full EntityMeta support
• Creation of WrapperEntities
• Keeping track of entities.

Usage

For more realistic examples, please take a look at the test-plugin module. It has an example Bukkit plugin that uses EntityLib. Examples below show usage of the spigot module of entity lib, but the usage is the same for all platforms.

Using the EntityMeta api

classExample {
publicstaticvoidmain(String[] args) {
PacketEventsAPIapi = ;// create PacketEventsAPI instanceSpigotEntityLibPlatformplatform = newSpigotEntityLibPlatform(this);
APIConfigsettings = newAPIConfig(PacketEvents.getAPI())
.debugMode()
.tickTickables()
.trackPlatformEntities()
.usePlatformLogger();
EntityLib.init(platform, settings);
// Making a random entity using packet events raw, i strongly recommend using the EntityLib#createEntity method insteadintentityID = 1;
WrapperPlayServerSpawnEntitypacket = newWrapperPlayServerSpawnEntity(constructorargs);
EntityMetameta = EntityMeta.createMeta(entityId, EntityType);
// You can cast the meta to the correct type depending on the entity typePigMetapigMeta = (PigMeta) meta;
// Once you're done modifying the meta accordingly, you can convert it to a packet, and send it to whoever you want for them to see the changes.WrapperPlayServerEntityMetadatametaPacket = meta.createPacket();
User.sendPacket(metaPacket);
}
}

Creating a WrapperEntity

importcom.github.retrooper.packetevents.protocol.world.Location;
classExample {
publicstaticvoidmain(String[] args) {
PacketEventsAPIapi = ;// create PacketEventsAPI instanceSpigotEntityLibPlatformplatform = newSpigotEntityLibPlatform(this);
APIConfigsettings = newAPIConfig(PacketEvents.getAPI())
.debugMode()
.tickTickables()
.trackPlatformEntities()
.usePlatformLogger();
EntityLib.init(platform, settings);
WrapperEntityentity = newWrapperEntity(EntityType); // optional uuid and entity id and meta // You can keep track of the entity yourself or store its entityId or uuid and fetch it using EntityLib.getApi().getEntity(UUID or entityId)// Entities also have access to the EntityMeta api, the EntityMeta api can be used seperately from wrapper entities but also can be used togetherEntityMetameta = entity.getEntityMeta();
// Depending on the entity type, you can safely cast the meta to the correct typePigMetameta1 = (PigMeta) meta; // If the entity type is EntityTypes.PIG// adding a viewer to the entity can be done before or after spawn, doesnt matterentity.addViewer(User); // UUID also applicableentity.removeViewer(User); // UUID also applicableentity.spawn(Location); // Spawns the entity at the given locationentity.remove(); // Removes the entity from the worldentity.rotateHead(floatyaw, floatpitch); // Rotates the head of the entityentity.teleport(Location); // Teleports the entity to the given location.// If the entityId provider for WrapperEntities is not working for you or needs changing, you can get it from EntityLib#getEntityIdProvider()// You can also set it to a custom provider if needed by calling EntityLib#setEntityIdProvider(EntityIdProvider)intrandomEntityId = EntityLib.getPlatform().getEntityIdProvider().provide();
}
}

Publishing to Maven Central

EntityLib uses the new Maven Central publishing system via the Central Portal (replacing the deprecated OSSRH). To publish, set up the following GitHub secrets:

• OSSRH_USERNAME: Your Central Portal username (usually your email).
• OSSRH_PASSWORD: Your publishing token from the Central Portal.
• GPG_PRIVATE_KEY: Your GPG private key (for signing artifacts).
• GPG_PASSPHRASE: The passphrase for your GPG key.

Setting Up Central Portal Credentials

1. Go to Central Portal and log in with your GitHub account.
2. Create a namespace: In the "Namespaces" section, create a new namespace for your group ID (io.github.tofaa2). This is crucial for publishing to work.
3. Generate a publishing token from the "Account Settings" > "Publishing Tokens".
4. Use your email as the username and the token as the password.

Snapshots are automatically published on pushes to the master branch. Stable releases are published when a GitHub release is created.

TODO:

Once this list is complete, i will release a stable version of the library.

• Implement checks for each EntityMeta to make sure the version specific data is correct.
• Verify all the EntityMeta packets are working correctly.
• WrapperEntities must seamlessly send packet updates to viewers, currently they are not.
• Add support for more actions using WrapperEntities.
• More javadocs.
• Make ObjectData actually useful.
• Multi-version support, currently only 1.18+ is stable.
• Make class names match the protocol specified names.

Credits

• PacketEvents for providing the API and retrooper being a cool guy in general
• Minestom certain mappings were taken from Minestom cause i have not slept in 4 days and it was faster