https://github.com/sizableshrimp/entitymodeljson
A Forge mod that allows entity models to be defined in JSON
https://github.com/sizableshrimp/entitymodeljson
curseforge entity-model forge-mod java json
Last synced: about 1 month ago
JSON representation
A Forge mod that allows entity models to be defined in JSON
- Host: GitHub
- URL: https://github.com/sizableshrimp/entitymodeljson
- Owner: SizableShrimp
- License: mit
- Created: 2021-08-28T22:44:00.000Z (almost 4 years ago)
- Default Branch: 1.19.x
- Last Pushed: 2022-08-28T22:19:48.000Z (almost 3 years ago)
- Last Synced: 2023-03-05T15:04:32.336Z (about 2 years ago)
- Topics: curseforge, entity-model, forge-mod, java, json
- Language: Java
- Homepage: https://www.curseforge.com/minecraft/mc-mods/entity-model-json
- Size: 237 KB
- Stars: 6
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Entity Model JSON
This is a Minecraft mod for Forge which allows declaring entity models in JSON.
It can be used to create powerful entity models both in mods and modpacks.
**This is a 100% clientside only mod. Adding it to a server will do nothing.**
For mods, entity models can be declared in JSON and shipped as assets in the final jar, with a required clientside dependency on this mod.
For modpack makers, vanilla and modded entity models can be overriden in JSON using this system.
This mod also supports declaring entity animations (known as animation definitions) using JSON.
For mods, entity animation definitions can be declared in JSON and shipped as assets in the final jar, with a required clientside dependency on this mod.
This system cannot override animation definitions from vanilla or mods that use Java animations.
However, modpack makers can override animations from other mods that utilize Entity Model JSON for animation.
## Resources
### Entity Models
For resources on how to declare and use JSON entity models, please see the following:
* [All vanilla entity models exported as JSON](vanilla_layers) - This resource allows you to see how all vanilla entity models look in a JSON format.
They can be used as a starting skeleton, or directly copied to override vanilla entity models with a custom variant.
* [The complete JSON spec](docs/SPEC.json5) - This JSON file documents all the properties you can possibly use.
* [The complete JSON schema](docs/SCHEMA.json) - This has the complete JSON Schema of entity models. You can use this for hints in your editor of choice when making a JSON entity model.
* [An example Forge mod using JSON entity models](src/test) - This example mod adds a dummy entity to the game that has an armor stand model defined in JSON.
It also uses a data generator to modify the cat's main model.
Notable places to check out are:
* [Example entity renderer](src/test/java/me/sizableshrimp/entitymodeljsonexample/animal/ExampleAnimalRenderer.java) - Demonstrates the model with its `ModelLayerLocation` and how to determine what file it points to
* [Example entity model datagen provider](src/test/java/me/sizableshrimp/entitymodeljsonexample/datagen/ExampleEntityModelProvider.java) - Demonstrates how to generate JSON entity models through data generation
* [Example entity model datagen output file](src/test_generated/resources/assets/minecraft/models/entity/main/cat.json) - Output file from example entity model datagen provider
* [Entity animal entity model JSON file](src/test/resources/assets/entitymodeljsonexample/models/entity/main/example_animal.json) - Contains the armor stand entity model defined in JSON
* [Entity Model Json dependency in mods.toml](src/test/resources/META-INF/mods.toml#L51-L57) - Demonstrates how to declare a required clientside dependency on the Entity Model JSON mod
### Entity Animation Definitions
For resources on how to declare and use JSON entity animation definitions, please see the following:
* [All vanilla entity animation definitions exported as JSON](vanilla_animations/minecraft) - This resource allows you to see how all vanilla entity animation definitions look in a JSON format.
They can be used as a starting skeleton for animating your entities.
Overriding vanilla entity animation definitions is not currently supported.
* [Example entity model](src/test/java/me/sizableshrimp/entitymodeljsonexample/animated/ExampleAnimatedEntityModel.java) - Demonstrates how to animate your entity using JSON entity animation definitions.
## Creating/Editing Models in Blockbench
Entity Model JSON ships a Blockbench plugin which you can install for exporting and importing of files in the format of Entity Model JSON.
1. Download the [javaentitymodeljson_models.js](https://raw.githubusercontent.com/SizableShrimp/EntityModelJson/1.19.x/javaentitymodeljson_models.js) file (Ctrl+S on most browsers).
Make sure the file is saved with the same name!
You should move this file to a place where you know it won't get deleted, as it will be loaded every time Blockbench starts.
2. Open up Blockbench, and go to `File > Plugins` in the top-left of the window.
Click on the  icon labeled `Load Plugin from File`.
3. Select the `javaentitymodeljson_models.js` you saved previously.
You can use `File > New > Java Entity Model JSON` to create new Entity Model JSON files.
Using `File > Open Model` (Ctrl+O) and selecting an Entity Model JSON file will also import it (without textures) into Blockbench.
To convert existing models to the Entity Model JSON format, go to `File > Convert Project` and select `Java Entity Model JSON`.
To export Entity Model JSON files from Blockbench, navigate to `File > Export > Export Java Entity Model JSON`.
To export animations
## Dumping vanilla & modded layer definitions
Entity Model Json supports dumping existing layer definitions in code to JSON.
These files will export to your running game directory in a folder named `layerexports`!
See `/emj dump` or `/entitymodeljson dump` in game for more information.
## Declaring a mod dependency
To add this mod as a dependency, first add this to your repositories block:
```groovy
repositories {
// Entity Model JSON maven
maven {
url = 'https://maven.100media.dev'
}
}
```
Then, add the dependency to your dependencies block. For the latest version, see [here](https://github.com/SizableShrimp/EntityModelJson/releases).
```groovy
dependencies {
implementation fg.deobf("me.sizableshrimp:entitymodeljson:${minecraft_version}-${entitymodeljson_version}")
}
```