Skip to content

Getting Started

Tslat edited this page Jul 10, 2023 · 31 revisions

Pre-word

GeckoLib, and by extension this wiki, expects you have pre-existing understandings of the following:

  1. Basic java concepts and fundamentals
  2. General Minecraft concepts
  3. Modding with Minecraft in Forge or Fabric

If you do not have these three covered, you'll need to pick them up through some modding tutorials first

If you have not yet installed the mod, you will also need to do so before continuing

Refer to the installation pages listed in the table of contents for instructions on installing the mod

NOTE: This wiki and GeckoLib itself utilise Mojmap with Parchment. If you are using Yarn mappings, you may find some class or method names unfamiliar (such as ResourceLocation instead of Identifier). If this is the case, you'll either need to swap your project to Mojmap, or convert any unfamiliar names to yarn mappings using Linkie

Making the Model in Blockbench

GeckoLib uses Blockbench to construct its models and animations.

For instructions/info on using Blockbench for Geckolib, see here

Getting started in code

Once you've made your models/animations in Blockbench and are ready to get them into your mod, you'll need to start off by making a Geo Model class that represents your assets.

To continue, follow on with the next part of the guide:

For Geckolib3 (MC 1.19.2 and below)

For Geckolib4 (MC 1.19.3 and above)

Marking your project

Want people to know that your mod requires GeckoLib?

Feel free to use the below image on your CurseForge/Modrinth page.

Requires GeckoLib

Table of Contents

Geckolib 3
Geckolib 4

Hosted By: Cloudsmith

Package repository hosting is graciously provided by Cloudsmith.

Cloudsmith is the only fully hosted, cloud-native, universal package management solution that enables your organization to create, store and share packages in any format, to any place, with total confidence.

Clone this wiki locally