From b2728526608c9e8c00dfab520b7e38d5c7baa4a5 Mon Sep 17 00:00:00 2001 From: zaaarf Date: Fri, 8 Sep 2023 11:40:56 +0200 Subject: [PATCH] feat: readme/foreword --- README.md | 4 + index.html | 217 +++++++++++++++++++++++++++++++++++++++++++++++++ src/SUMMARY.md | 1 + 3 files changed, 222 insertions(+) create mode 100644 index.html diff --git a/README.md b/README.md index e1d5d3c..c64b010 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,6 @@ # The Lillero Book This is meant as an in-depth guide to ASM manipulation with the [Lillero](https://github.com/zaaarf/lillero) framework. While that's the main focus, it's written to also be useful to anyone wanting to learn ASM patching in general. Some parts (which will be flagged appropriately) may be applicable to Minecraft alone, but most of the book is meant to be generic. + +The [ASM](https://asm.ow2.io/) library that Lillero is built with is capable of so much more than what is described in this book. In fact, the [official ASM guide](https://asm.ow2.io/asm4-guide.pdf) is a must-read for anyone wishing to understand its inner workings more in depth. While very well written, the ASM guide reads more like a scientific paper than a user manual, and this is part of my reasons for creating the Lillero Book. Much like Lillero is an intermediary layer meant to simplify working with ASM, this book is an intermediary step meant to give you a passable understanding of patching before plunging deep into the obscure inner workings of Java bytecode. + +In short, this is no replacement for the ASM manual: think of the Lillero Book as a (relatively) simple introduction to its topics. diff --git a/index.html b/index.html new file mode 100644 index 0000000..14ff119 --- /dev/null +++ b/index.html @@ -0,0 +1,217 @@ + + + + + + Foreword + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + +
+ +
+ + + + + + + + +
+
+

The Lillero Book

+

This is meant as an in-depth guide to ASM manipulation with the Lillero framework. While that's the main focus, it's written to also be useful to anyone wanting to learn ASM patching in general. Some parts (which will be flagged appropriately) may be applicable to Minecraft alone, but most of the book is meant to be generic.

+

The ASM library that Lillero is built with is capable of so much more than what is described in this book. In fact, the official ASM guide is a must-read for anyone wishing to understand its inner workings more in depth. In fact, this is no replacement for that guide: think of the Lillero Book as a (relatively) simple introduction to the topics covered by the ASM guide in detail.

+ +
+ + +
+
+ + + +
+ + + + + + + + + + + + + + + + + + +
+ + diff --git a/src/SUMMARY.md b/src/SUMMARY.md index 3cca68b..7cfe081 100644 --- a/src/SUMMARY.md +++ b/src/SUMMARY.md @@ -1,4 +1,5 @@ # Summary +[Foreword](../README.md) [What is Lillero?](./what_is_lillero.md) - [An introduction to ASM Patching](./1_introduction/asm_patching.md) - [Why (not) Mixin?](./1_introduction/why_mixin.md)