Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
KosmX authored Sep 15, 2022
1 parent 2442065 commit 8e83a4e
Showing 1 changed file with 15 additions and 2 deletions.
17 changes: 15 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,14 @@ If you want to add new entities, use [Geckolib](https://geckolib.com/#mods)

If you want to trigger simple animations from the server, you might want to use [Emotecraft's server-side API](https://github.com/KosmX/emotes/tree/dev/emotesAPI/src/main/java/io/github/kosmx/emotes/api/events/server).

## Official projects
**GitHub project** https://github.com/KosmX/minecraftPlayerAnimator
**Modrinth** https://modrinth.com/mod/playeranimator
**CurseForge** https://www.curseforge.com/minecraft/mc-mods/playeranimator
**KosmX's Maven (for API use)** https://maven.kosmx.dev/dev/kosmx/player-anim/
> Avoid downloading the library from other sources!

## Example mods
[Fabric example](https://github.com/KosmX/fabricPlayerAnimatorExample)
[Forge example](https://github.com/KosmX/forgePlayerAnimatorExample)
Expand Down Expand Up @@ -146,8 +154,13 @@ To load an animation, put the file(s) into `assets/modid/player_animation/`
Then you can get the animation with `dev.kosmx.playerAnim.minecraftApi.PlayerAnimationRegistry#getAnimation()`

## Notes
> GeckoLib is not guaranteed to work, but you can try! (It will work most of the time)
> [molang](https://docs.microsoft.com/minecraft/creator/reference/content/molangreference/) is not supported
GeckoLib is not guaranteed to work, but you can try! (It will work most of the time)
[molang](https://docs.microsoft.com/minecraft/creator/reference/content/molangreference/) is not supported
***
Do **not** shadow the library in your mod, this library can not be loaded multiple times safely. (even from different packages)
> The license would allow it, but it would break many things.
You may use `include`(fabric any version) or JarJar(forge 1.19.1+).



## If you have questions, feel free to ask on Discord:
Expand Down

0 comments on commit 8e83a4e

Please sign in to comment.