WorldSeedEntityEngine

<div id="top"></div> <!-- PROJECT SHIELDS --> <!-- *** I'm using markdown "reference style" links for readability. *** Reference links are enclosed in brackets [ ] instead of parentheses ( ). *** See the bottom of this document for the declaration of the reference variables *** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use. *** https://www.markdownguide.org/basic-syntax/#reference-style-links -->

<!-- PROJECT LOGO --> <br /> <div align="center"> <a href="https://github.com/AtlasEngineCa/WorldSeedEntityEngine"> <img src=".github/icon.png" alt="Logo" width="180" height="180"> </a> <h3 align="center">WSEE</h3> <p align="center"> WorldSeed Entity Engine <br /> <br /> <br /> <a href="https://github.com/AtlasEngineCa/WorldSeedEntityEngine/issues">Report Bug</a> · <a href="https://github.com/AtlasEngineCa/WorldSeedEntityEngine/issues">Request Feature</a> </p> </div> <!-- ABOUT THE PROJECT -->

About The Project

<div align="center"> <a href="https://github.com/AtlasEngineCa/WorldSeedEntityEngine"> <img src=".github/hitbox.gif" alt="Logo" width="720" height="405"> </a> </div>

This is a library that allows users to add bedrock models from blockbench in to Vanilla Minecraft!

WSEE lets you create multipart entities, using display entities. The framework provided allows users to easily create multipart entities, define animations, and write AI that fully utilises the entity's animations.

Currently WSEE only supports Minestom

<!-- GETTING STARTED -->

Getting Started

A full, runnable example server can be found here

Adding as a dependency

Add the following to your build.gradle.kts file:

repositories {
    maven("https://reposilite.atlasengine.ca/public")
}

Add the library as a dependency

dependencies {
    implementation("net.worldseed.multipart:WorldSeedEntityEngine:<version>")
}

The lastest version number can be found here

VM Arguments

Add the following VM arguments to your run configuration

--add-opens java.base/java.lang=ALL-UNNAMED

This is required for the molang compiler library.

Restrictions

Some restrictions are imposed by Minecraft

• Bones must be less than 64 blocks in size

Wiki

Learn what this project is, how it works and how you can use it on your server

FAQ

Q: Why are my bones positioned incorrectly in minecraft?
A: Entities used for bones will be placed at the pivot point of the bone in blockbench. To fix this, move the pivot point closer to the bone

Q: Why is my model not working?
A: Make sure you have the type set to Bedrock Model in blockbench

Q: Why am I getting the exception InaccessibleObjectException
A: Make sure you have the VM arguments set up correctly, as described in the Getting Started section

Q: Why are ModelDamageEvent and ModelInteractEvent not triggering?
A: You need to create hitboxes for the model Hitboxes

Comparisons

| Feature | Minestom Support | Paper Support | Math Animations | Cube Rotation | Hurt Colour | Accurate Hitboxes | |----------------------------------------------------------------------------------------------------------------------------------|------------------|---------------|----------------|-----------------|---------------------|-------------------| | WSEE | ✔️ | ❌ | ✔️ | ✔️ any | ✔️ Texture Swapping | ✔️ | | Model Engine | ️❌ | ✔️ | ❌ | ❌ 22.5 multiple | ❌ Leather Armour | ❌ | | hephaestus-engine | ✔️ | ✔️ | ❌ | ❌ 22.5 multiple | ❌ Leather Armour | ❌ |

<p align="right">(<a href="#top">back to top</a>)</p> <!-- MARKDOWN LINKS & IMAGES --> <!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->