Feder's Geckolib Plugin Tutorial - Custom Animated Mobs

Started by Argus Obsidian on Wed, 09/09/2020 - 22:17

Topic category: User side tutorials

Last seen on 14:02, 14. Oct 2020
Joined Jun 2020
User points:

User statistics:

  • Modifications:
  • Forum topics:
  • Wiki pages:
  • Tracker tickets:
  • MCreator plugins:
  • Comments:
Feder's Geckolib Plugin Tutorial - Custom Animated Mobs
Wed, 10/14/2020 - 13:56 (edited)

This tutorial will teach you how to use the amazing and much awaited Geckolib plugin! For those of you who don't know, Feder's Geckolib plugin is an MCreator add-on that allows users to create custom animations for modded mobs. This guide will walk you through the steps for installation and some info on how to use it, but will not teach you how to create animations. In the examples I will use a custom zombie model and animations I made.

Installation

Blockbench

The first thing you will need to install is Blockbench. Blockbench is a 3D modeling program aimed towards blockier, Minecraft-style creations, and it is completely free. Without Blockbench, you will not be able to use this plugin, and I'll explain why in a bit. To install Blockbench, simply download the latest release from here and follow the installation wizard.

But you aren't ready to create animations yet! First, you need to install the GeckoLib plugin to Blockbench. To do this, open up Blockbench to the startup page. From there, navigate to Filter -> Plugins. This will open up a menu labeling all your installed and available plugins. Click on the "available" tab and scroll down until you see the GeckoLib Animation Utils option. Hit install, and you're ready to animate!

If you want to learn about animating Java models with this plugin, I suggest this YouTube video by TurtyWurty. It explains everything you need to know in depth.

Image

MCreator

This section will teach you how to install the plugin to MCreator. First, go to this page for the latest download, or this one for a direct download to the current one. Once downloaded, make sure it's in zip file format, and save it to wherever you want! Alright, now you can open up MCreator. Open the workspace you want to add the plugin to first. Then, navigate to File -> Preferences -> Manage Plugins. Here, you should click the "Load plugin..." button. Navigate to where you saved the downloaded zip, and select it. Hit "Save" and let it load.

Now that you have installed the plugin, you will need to activate it. Navigate to Workspace -> Workspace Settings - > External APIs. Here, you will see a checkbox labeled "GeckoLib API". check it and hit "save changes." That's it, you've installed the plugin!

Note: if there were any elements in your workspace prior to adding the plugin, you will be prompted to refactor the workspace. Simply hit "Yes, refactor workspace" and let MCreator handle the rest!

Image

Usage

Exporting From Blockbench

Let's say you finished an animation in Blockbench, but you have no clue how to export it! First, in Blockbench, you will need to save the files. GeckoLib stores it's animations in 2 files: a .java file that stores the 3D model, and a .json file that stores all the animations. To export them, you'll need to start with the .java file. Navigate to File -> Export -> Export Animated Java Entity, and a prompt window will appear. Name the file whatever you need, and save it to a directory of your choice.

Next, to export the .json file, you'll need to be in the animation tab. From there, navigate to Animation -> Export Animations and save the file to whatever name you want. You've finished exporting!

Image

Importing to MCreator

This is a bit harder than exporting. First, let's import the .java file. In your workspace, go to Resources -> 3D models and texture mappings. Hit the "Import JAVA model" button and select your .java file. Click the "Keep current animations" button, and the file should import correctly!

Now we need to import the animations. This requires a bit more effort. In MCreator in the workspace, go to Workspace -> Open workspace folder. This should open a file explorer with wherever on your computer your MCreator workspace is stored. From here, navigate to src/main/resources/assets/<name_of_your_mod>/ and create a new folder called "animations" (minus the parentheses). Now, whenever you create a new animation .json file, just put it in that folder. That's all!

Image

Using Your Animations

 Now that you've installed everything and created an animated entity, you want to figure out how to use those animations. Geckolib allows you to set the animation of any mob using procedures. Simply use the "Play Animation" procedure block by entering the desired entity, animation name, and looping condition, and your mobs will now be animated!

Image

Notes:

This plugin will not work with any versions of MCreator right now! This tutorial is made for when the plugin gets a new update, which we sadly do not know the date of. To make it clear, the plugin will not work on any version of MCreator. This message will be removed when this problem is gone.

Contact:

IMPORTANT! Do not contact me unless you are sure that your question cannot be answered by the post or by a previous comment. If you have an important question though, feel free. My discord is Argus#2498, so message me if you need help or clarification. I will respond as fast as I can!

Changes:

Added and fixed images - 9/23/2020

 

If you guys have any questions or suggestions to add or remove from this tutorial, feel free to post them below!

Edited by Argus Obsidian on Wed, 10/14/2020 - 13:56
Last seen on 01:05, 30. Oct 2020
Joined Mar 2019
User points:

User statistics:

  • Modifications:
  • Forum topics:
  • Wiki pages:
  • Tracker tickets:
  • MCreator plugins:
  • Comments:
Hello ! Thank you deeply for…
Wed, 09/09/2020 - 23:44

Hello ! Thank you deeply for this tutorial. Before i did anything, i wanted to know, Can i use this for 2020.2 (Forge 1.12.2) ? Or I need 2020.4 or latest, to use this ? 

Thanks you in advance,

- LEPRODOR

Last seen on 16:25, 28. Oct 2020
Joined Jul 2017
User points:

User statistics:

  • Modifications:
  • Forum topics:
  • Wiki pages:
  • Tracker tickets:
  • MCreator plugins:
  • Comments:
Nice thx for making that,…
Thu, 09/10/2020 - 00:01

Nice thx for making that, way more precise then my tutorial

Last seen on 03:59, 29. Oct 2020
Joined Jun 2019
User points:

User statistics:

  • Modifications:
  • Forum topics:
  • Wiki pages:
  • Tracker tickets:
  • MCreator plugins:
  • Comments:
Wow! This really helped me!…
Thu, 09/10/2020 - 01:38

Wow! This really helped me! Thank You SOOO Much!!!

Last seen on 01:05, 30. Oct 2020
Joined Mar 2019
User points:

User statistics:

  • Modifications:
  • Forum topics:
  • Wiki pages:
  • Tracker tickets:
  • MCreator plugins:
  • Comments:
yeah.. whoops, could've just…
Thu, 09/10/2020 - 03:25

yeah.. whoops, could've just looked like 2 minutes, no need to anwser now, but i still hope this works, i'll wait until 2020.5 launches before throwing my Mod update into game.

Last seen on 01:12, 29. Oct 2020
Joined Jul 2020
User points:

User statistics:

  • Modifications:
  • Forum topics:
  • Wiki pages:
  • Tracker tickets:
  • MCreator plugins:
  • Comments:
Can you tell me where you…
Sun, 09/13/2020 - 01:51

Can you tell me where you got the procedure block, I don't understand where that is in mcreator and where would see the "Play Animation" procedure block, I am new to this.

Last seen on 23:59, 29. Oct 2020
Joined Feb 2019
User points:

User statistics:

  • Modifications:
  • Forum topics:
  • Wiki pages:
  • Tracker tickets:
  • MCreator plugins:
  • Comments:
Game crashes every time I…
Sun, 09/13/2020 - 18:18

Game crashes every time I load it with a mob using the model in the mod

Last seen on 14:02, 14. Oct 2020
Joined Jun 2020
User points:

User statistics:

  • Modifications:
  • Forum topics:
  • Wiki pages:
  • Tracker tickets:
  • MCreator plugins:
  • Comments:
@HorseAims So if you go into…
Sun, 09/13/2020 - 19:48

@HorseAims So if you go into the procedure editor for MCreator, you will see a list of procedure block categories on the left side of the app. If you read all of them, one of the should say GeckoLib API. In that category, you should be able to access the "Play Animation" procedure block.

@MemerTeamerYT I mentioned that MCreator will crash with any models like that right now, as the plugin is still unstable. However, once the next MCreator 2020.5 snapshot is released, all future versions should be able to support the plugin. Until then, you will have to wait.

Last seen on 01:54, 20. Oct 2020
Joined Sep 2020
User points:

User statistics:

  • Modifications:
  • Forum topics:
  • Wiki pages:
  • Tracker tickets:
  • MCreator plugins:
  • Comments:
i got all the way to…
Tue, 09/15/2020 - 01:18

i got all the way to geckolib being added to MCreator after that I don't understand

 

Last seen on 01:05, 30. Oct 2020
Joined Mar 2019
User points:

User statistics:

  • Modifications:
  • Forum topics:
  • Wiki pages:
  • Tracker tickets:
  • MCreator plugins:
  • Comments:
Hello again ! I am waiting…
Tue, 09/15/2020 - 02:08

Hello again ! I am waiting for the last update, 2020.5 to come out before installing all of this. I'm eager to know if i can have a mob with a "idle" animation and "Moving" animation. I'd be really upset to throw the idle animation in the garbage because wouldn't be able to do that or to have a mob moonwalking while not moving.

Waiting for you anwsers,

thanks.

 

~ ^.^

Last seen on 14:02, 14. Oct 2020
Joined Jun 2020
User points:

User statistics:

  • Modifications:
  • Forum topics:
  • Wiki pages:
  • Tracker tickets:
  • MCreator plugins:
  • Comments:
Absolutely. You can make as…
Tue, 09/15/2020 - 21:18

Absolutely. You can make as many animations you need, and then activate them in-game using procedures. That's what the plugin is all about; making a bunch of animations, and then using them all as need in your mod.

Last seen on 01:05, 30. Oct 2020
Joined Mar 2019
User points:

User statistics:

  • Modifications:
  • Forum topics:
  • Wiki pages:
  • Tracker tickets:
  • MCreator plugins:
  • Comments:
Ha ok thanks, even though it…
Tue, 09/15/2020 - 21:42

Ha ok thanks, even though it’s clearly logic, but i got worried anyways 😅

 

Last seen on 01:54, 20. Oct 2020
Joined Sep 2020
User points:

User statistics:

  • Modifications:
  • Forum topics:
  • Wiki pages:
  • Tracker tickets:
  • MCreator plugins:
  • Comments:
lets say i got a mob and a…
Tue, 09/15/2020 - 21:51

lets say i got a mob and a walking animation for that mob how do i get the mobs walking animation on to the mob 

 

Last seen on 14:02, 14. Oct 2020
Joined Jun 2020
User points:

User statistics:

  • Modifications:
  • Forum topics:
  • Wiki pages:
  • Tracker tickets:
  • MCreator plugins:
  • Comments:
The post is now updated with…
Tue, 09/15/2020 - 22:24

The post is now updated with animated screenshots for every step! If you have trouble seeing them, just Right Click -> Open in new tab to see them!

Last seen on 14:02, 14. Oct 2020
Joined Jun 2020
User points:

User statistics:

  • Modifications:
  • Forum topics:
  • Wiki pages:
  • Tracker tickets:
  • MCreator plugins:
  • Comments:
If the images are broken, I…
Tue, 09/15/2020 - 22:25

If the images are broken, I have no clue how to fix them. If anyone does know, I would love to hear it.