Skip to content

Getting Started

ZigyTheBird edited this page Jun 29, 2024 · 61 revisions

Introduction

Hello there!
This is a very cool mod you can see what it does here.
This mod relies on the Player Animator mod for actually animating the player so you will need to add it to the dependencies as well.
You can find the essentials for animating the player here and here, if you are a beginner then the other wiki pages might cause a lot of confusion.
You can see examples of the features of the mod being used here.
If you ever need any help contact me on discord, my username is zigythebird.
This relatively ambitious mod is only maintained by one person (me) so if you spot any bugs be sure to make a GitHub issue.

Mod Downloads

CurseForge: https://www.curseforge.com/minecraft/mc-mods/playeranimatorapi
Modrinth: https://modrinth.com/mod/playeranimatorapi

Including the library in your dev environment

This mod is currently maintained for Minecraft 1.20.4 and 1.20.1 although I won't make any promises about maintaining these versions in the future.
Pull requests that bring bug fixes and features from newer versions to old ones will be merged.

Note

For 1.20.1 replace neoforge with forge.

Latest version of playeranimatorapi: 2.0.5
Latest version of multiloaderutils: 1.2.4

Maven

repositories {
    (...)
	maven {
		name "zigythebirdMods"
		url "https://maven.zigythebird.com/mods"
	}

    //For some external mods.  
    //You won't need to add any mods downloaded from these places as dependencies only player animator.  
    mavenCentral()
    maven { url 'https://libs.azuredoom.com:4443/mods' }  
    maven { url 'https://api.modrinth.com/maven' }  
    maven { url "https://maven.terraformersmc.com/releases/" }
    maven { url = "https://jitpack.io" }
}

NeoForge

dependencies {
    //The 100000000th mod used to do multi-loader stuff.
    //This is included by the mod itself.
    implementation "com.zigythebird.multiloaderutils:zigysmultiloaderutils-neoforge-$project.minecraft_version:$project.multiloaderutils_version"

    implementation "com.zigythebird.playeranimatorapi:playeranimatorapi-neoforge-$project.minecraft_version:$project.playeranimatorapi_version"
}

Architectury Loom (Common)

dependencies {
    //The 100000000th mod used to do multi-loader stuff.
    //This is included by the mod itself.
    modImplementation "com.zigythebird.multiloaderutils:zigysmultiloaderutils-common-$rootProject.minecraft_version:$rootProject.multiloaderutils_version"

    modImplementation "com.zigythebird.playeranimatorapi:playeranimatorapi-common-$rootProject.minecraft_version:$rootProject.playeranimatorapi_version"
}

Fabric Loom

dependencies {
    //The 100000000th mod used to do multi-loader stuff.
    //This is included by the mod itself.
    modImplementation "com.zigythebird.multiloaderutils:zigysmultiloaderutils-fabric-$project.minecraft_version:$project.multiloaderutils_version"

    modImplementation "com.zigythebird.playeranimatorapi:playeranimatorapi-fabric-$project.minecraft_version:$project.playeranimatorapi_version"
}

Architectury Loom (Forge/NeoForge)

dependencies {
    //The 100000000th mod used to do multi-loader stuff.
    //This is included by the mod itself.
    modImplementation "com.zigythebird.multiloaderutils:zigysmultiloaderutils-neoforge-$rootProject.minecraft_version:$rootProject.multiloaderutils_version"

    modImplementation "com.zigythebird.playeranimatorapi:playeranimatorapi-neoforge-$rootProject.minecraft_version:$rootProject.playeranimatorapi_version"
}