LiteLoader is a lightweight mod bootstrap designed to provide very basic loader functionality for mods which don't need to modify game mechanics. It is designed to run alongside Minecraft Forge and ModLoader (although in 1.6 ModLoader is currently broken by the Tweak system and will crash with an error about "URI is not hierarchical", I expect Risugami will fix this soon) and LiteLoader mods will not conflict with ModLoader or Forge mods.
Important note: if you wish to chain to Forge or FML with 1.6.4 then you will require Forge build 898 or later or FML build 767 or later, previous versions have an error which will cause your game to crash stating that it got multiple values for "version" but was expecting only one. If you experience this problem then upgrading to the requisite version of Forge or FML is the solution.
LiteLoader is aimed squarely at mods which only change the client in some way; some good examples might be a mini-map, a mod which overhauls the in-game chat or a client-side macro system. This type of mod doesn't generally need the awesome power of something like Minecraft Forge to function, so asking players to install an API that's several times larger than the mod itself doesn't make sense. It must however coexist peacefully alongside Forge (so that players can use both platforms if they want to!) and LiteLoader does this.
LiteLoader was primarily developed for use by The VoxelModPack Team but is open source to allow mod developers to make their own mods using the platform.
As a modder, if you're looking for a loader to help you add a new block, item, mob or mechanic into the game, then LiteLoader isn't for you and you should check out Minecraft Forge. If you want to make a mod that displays something on the screen like a heads-up FPS counter, provides an in-game IRC window, or anything else that doesn't alter game mechanics then LiteLoader is probably perfect for you!
As you've probably noticed, Minecraft 1.6 sees the introduction of a new Launcher from Mojang which is considerably more advanced than the old one. Amongst the improvements was the ability for an installed mod to inject itself into the game at load time as a Tweak. A Tweak basically gets free rein over the game startup process and can inject any code it likes into the game. LiteLoader uses this tweak functionality to load itself, and in turn load any mods that you have installed. This is great because it allows loaders to run without touching the minecraft jar at all!
However there's a problem: the new launcher only allows one Tweak at a time to be specified, so if you want to run multiple Tweak classes at the same time, such as LiteLoader and Forge Mod Loader (FML), then you have a problem. How do we fix this?
The answer is with cascadedTweaks. This is a special command-line option sent to the game which the LiteLoader tweaker will recognise and will try to load the other Tweaks thus specified. In a nutshell, Minecraft loads the LiteLoader Tweak, and then the LiteLoader Tweak loads the other Tweaks! Simple!
Since 1.6.4, the tweak system now supports multiple tweaks and you can specify them in the JSON file using multiple --tweakClass arguments!
The LiteLoader installer supports adding these additional tweakClass entries for well-known Tweaks such as FML, or you can add your own by editing the JSON file. I will add more Tweaks to the installer as they become available. If you know of an unsupported Tweak then let me know. To specify additional tweakClasses just check the relevant checkbox when installing LiteLoader.
Note that you still need to install the relevant other mod first. For example to cascade to FML you must install FML or Minecraft Forge from their own installer first!
- What is this for and why do I need it?
Like other loaders and API's, LiteLoader doesn't do much on its own. If you want to run a LiteLoader mod then you need LiteLoader, if you don't then you don't need it! In general, the mods which use LiteLoader will link to this thread as a place to download the loader and provide support.
- Can I load Forge or ModLoader mods with this?
No, LiteLoader is a standalone API used by some client-only mods, however you can run it at the same time as Forge or FML and it won't conflict, so if you want to use Forge mods and Lite mods, then that's fine!
- The game won't load when I specify multiple tweaks, what gives?
Try changing the order of the tweaks, sometimes the load order is important since the first tweak is the "primary" one. Try putting liteloader's tweaker first for example.
- I have a mac, and after installing the 1.5.2 version of LiteLoader I have no sounds at all!
This isn't LiteLoader's fault, there is a problem with the mac archiver that causes it to overwrite the "com" folder inside you minecraft jar with the LiteLoader one instead of merging it. Unfortunately the "com" folder contains the sound codecs for the game!
To work around this, either manually merge the new "com" folder into the existing one in the minecraft jar, or use the Mac LiteLoader Patcher made by chattahippie, which automates the installation.
- I installed a mod into my "mods" folder but it's not detected by LiteLoader.
First, check that the mod is for the correct version of Minecraft. LiteLoader includes a version-checking system designed to prevent out-of-date mods from loading and crashing your client. If the versions mismatch then LiteLoader will not load the mod. For example if you have a mod for Minecraft 1.5.1 do not expect it to work on Minecraft 1.5.2!
Secondly, ensure that the file extension is .litemod. Some browsers detect that the files are .zip files and rename them to .zip when you download. LiteLoader requires the files to have the .litemod extension in order to recognise them as mods.
- Can I redistribute LiteLoader in my mod pack?
Yes, see the Permissions section below.
- Can I make a custom version of LiteLoader and redistribute it?
In general, no. The reason for this is that LiteLoader is an API (albeit a small one), and having multiple incompatible versions of an API in the wild is confusing for users and makes tracking bugs and issues very difficult. We do however work with mod developers who would like custom extensions to LiteLoader or would like to integrate the loader itself into their mod.
- Where can I find information about making LiteLoader mods?
See the section Developing LiteLoader Mods below.
- Where can I find the source code?
liteloader.com conveniently redirects to the LiteLoader Assembla Space.
- When will the next version be out?
Asking for updates is against the Minecraft Forum rules, if you're waiting for an update just be patient. One of LiteLoader's goals is to keep its footprint small to make updating easy, so in general the update speeds are very fast.
- Can I run LiteLoader and ModLoader at the same time?
For 1.5.2 and before: yes, LiteLoader is designed to coexist with ModLoader. However until Risugami updates ModLoader to be compatible with the Tweak system it's unlikely to be compatible in the short term, I recommend using FML instead.
- Won't running two loaders cause some kind of performance impact?
To cut a long story short, no. The loader is a tiny portion of the general footprint of the game and any mods you might install that use those loaders. Any impact on performance as a result of using multiple loaders is entirely lost in the general overhead of running the game itself.
- Can I run LiteLoader and Forge at the same time?
Yes, they are designed to coexist, you can install both without any problems.
- Where can I report bugs?
If you have a question or a problem that you are not sure if it's a bug, then ask right here in this thread. Alternatively if you find a bug in LiteLoader itself you can submit a support ticket on the LiteLoader assembla.
- Can I request new features?
Yes, but bear in mind that LiteLoader's core remit is to stay as light-weight as possible. This means I will generally only add functionality to the loader if it makes sense for it to be there. LiteLoader will never support adding blocks and items to the game so don't ask.
- I accidentally my entire Minecraft. Is this bad?
Probably. If in doubt add more cowbell.
- 2013-07-16 - LiteLoader 1.6.2_00 - Initial release for 1.6.2
- 2013-07-17 - LiteLoader 1.6.2_01 - Re-added crash log hook, installer now auto-detects forge version
- 2013-07-25 - LiteLoader 1.6.2_02 - Fix for SoundSystem issue
- 2013-07-31 - LiteLoader 1.6.2_03 - Updated installer to support chaining to FML
- 2013-07-31 - LiteLoader 1.6.2_04 - Fixed issue with mod key bindings not saving properly
- 2013-09-27 - LiteLoader 1.6.4_00 - Updated for 1.6.4 and LaunchWrapper 1.8
- 2013-09-27 - LiteLoader 1.6.4_01 - Fix for SoundSystem startup issue (again, derp)
You are free to redistribute unmodified LiteLoader binaries in any mod pack or compilation, including on third-party distribution platforms such as Feed The Beast provided that the distribution remains free, eg. no ad.fly links or similar.
You are free to use the source code to make your own LiteLoader mods but you may not redistribute modified versions of the loader.
Developing mods for LiteLoader is based around usage of the Minecraft Coder Pack so you should be familiar with MCP before you start.
Some (very brief and incomplete) documentation is available on the LiteLoader Assembla page and I will be adding to this over time. I also recommend taking a look at my Advanced MCP Tutorial Part 1 and Part 2 (if you can tolerate my voice for that long!) which cover some useful techniques. Part 1 refers to ModLoader but the topics covered are still useful.
If you get stuck feel free to ask questions here in the thread, I always try to help when I can. Or you can find me on IRC espernet #minecraft and #voxelmodpack.
Feel free to ask any questions or any other comments you have here in the thread, we will do our best to answer them!
In the meantime, happy Minecrafting