Commit b49b0acd1cd4df80f37904045ccb8ffc2efe17e2
1 parent
7ca84e15
Add basic README
Showing
2 changed files
with
38 additions
and
0 deletions
README.MD
0 → 100644
1 | +![LiteLoader Logo](docs/logo.png?raw=true) | |
2 | + | |
3 | +**LiteLoader** is a lightweight mod framework designed primarily for client-side | |
4 | +mods. It aims to provide a wide array of features as possible whilst having | |
5 | +minimal footprint and very low impact game performance when features are not in | |
6 | +use. | |
7 | + | |
8 | +### Features | |
9 | + | |
10 | +* __Simple callback system based on interfaces__. Simply implement the | |
11 | +interfaces your mod needs | |
12 | +* __Powerful class transformers__. If LiteLoader can't meet your needs "out of | |
13 | +the box", you have a wide selection of powerful class transformers at your | |
14 | +fingertips. It provides access to cutting edge transformers developed for | |
15 | +LiteLoader but also used by the wider modding community. This guarantees that | |
16 | +LiteLoader's transformers are the most stable and powerful libraries available | |
17 | +* __Tiny footprint__. Liteloader injects minimal code into the game, and uses | |
18 | +native bytecode injection for maximum performance. LiteLoader makes use of Java | |
19 | +libraries shipped with the base game such as Gson rather than bundling a slew of | |
20 | +optional libraries | |
21 | +* __Native bytecode event handlers__. Liteloader generates raw java bytecode for | |
22 | +event callbacks, this makes its event handlers blazing fast | |
23 | + | |
24 | +### License and Permissions | |
25 | + | |
26 | +LiteLoader is Copyright 2012-2016 Adam Mummery-Smith All Rights Reserved | |
27 | +You are free to use the source code for personal reference. | |
28 | +You may not redistribute modified versions of the loader. | |
29 | +You may not redistribute the source code in any form without written permission. | |
30 | + | |
31 | +### Building the project | |
32 | +**LiteLoader** uses the [Gradle](http://gradle.org/) build automation | |
33 | +system. You must have Gradle installed on your system. To build the project | |
34 | +simply navigate to the project directory in a terminal and execute | |
35 | + | |
36 | +``` | |
37 | +gradle | |
38 | +``` | |
0 | 39 | \ No newline at end of file | ... | ... |
docs/logo.png
0 → 100644
6.6 KB