quick start guide

Quick Start Guide - for advanced users

Creating LiteLoader mods is very simple if you're already comfortable making mods using MCP: Steps to create liteloader mods

  • Setup Eclipse
  • Install an SVN team provider and connector to Eclipse, I recommend Subversive SVN and SVNKit
  • Create your MCP deployment
  • Open the MCP Eclipse project
  • Check out the liteloader source from the SVN. You will need to check out “LiteLoader/trunk” for the latest version of Minecraft, or check out the appropriate tag for older versions.
  • Eclipse will detect the new project and include it in your workspace
  • Edit the “Run Configuration” for Client
    • add the LiteLoader project to the build path
    • set the “Main Class” to com.mumfrey.liteloader.debug.Start
  • Create a Project for your mod and set the dependent projects to “LiteLoader”
  • Make a package in your project for your mod
  • Create a class for your mod, the name of the mod class must begin with the text LiteMod (case sensitive) to allow LiteLoader to discover the class
  • Implement one or more of the LiteLoader Interfaces
  • Create a build script for your mod, I recommend using Ant since it's bundled with Eclipse
  • Include a litemod.json file in your packaged mod otherwise LiteLoader will not load your mod


  • The ModUtilities class contains useful functions for mods to use
  • Never implement both ChatFilter and ChatListener, only implement one of these interfaces.
  • Avoid using the init() method for any tasks besides setting up your mod's resources since it is called before Minecraft is fully initialised. If you need to add hooks into the game or initialise parts of your mod that need Minecraft to be fully initialised, then implement InitCompleteListener and use the onInitCompleted callback instead.