feat: optional patches

1 files changed, 19 insertions, 6 deletions

diff --git a/README.md b/README.md
index 5bf7207..c9c8736 100644
--- a/README.md
+++ b/README.md
@@ -4,7 +4,7 @@ This project enables anyone to fully decompile WorldsPlayer to Java source
 files, edit them in any way, and recompile them back to a working WorldsPlayer
 Java Archive.
 
-# Usage
+## Usage
 
 WorldsPlayer, and this project, require Java 6 to run. You can obtain a copy
 of Java 6 for your platform from the [Oracle Java Archive](https://www.oracle.com/java/technologies/javase-java-archive-javase6-downloads.html).
@@ -13,7 +13,7 @@ This project additionally requires the
 [Vineflower](https://vineflower.org/usage/) Java decompiler. Make sure that
 `vineflower` is accessible from your `PATH` environment variable.
 
-## Decompiling WorldsPlayer
+### Decompiling WorldsPlayer
 
 To decompile WorldsPlayer, you will need to run the `decompile` Make task. This
 task will decompile the full source tree of the WorldsPlayer Java Archive to the
@@ -26,11 +26,11 @@ Archive as the `WORLDSPLAYER_JAR` environment variable.
 WORLDSPLAYER_JAR=/path/to/worlds.jar make decompile
 ```
 
-## Editing WorldsPlayer
+### Editing WorldsPlayer
 
 You can edit the decompiled source files in any way you like.
 
-## Recompiling WorldsPlayer
+### Recompiling WorldsPlayer
 
 To recompile WorldsPlayer, you will need to run the `compile` Make task. This
 task will recompile the full source tree of the WorldsPlayer Java Archive to the
@@ -47,7 +47,7 @@ The recompiled WorldsPlayer Java Archive will be located at
 [`out/worlds.jar`](./out/worlds.jar) and requires no additional configuration
 to run in the WorldsPlayer client.
 
-## Step-by-Step
+### Step-by-Step
 
 ```shell
 # Decompile WorldsPlayer
@@ -67,6 +67,19 @@ Now that we've changed the username format from `username` to `username (usernam
 
 ![](./assets/step_by_step.png)
 
-# Licence
+## Optional Patches
+
+This project includes a number of optional patches that can be applied to
+WorldsPlayer. These patches are located in the
+[`patches/optional`](./patches/optional) directory.
+
+- [Free VIP](./patches/optional/free_vip.patch): Enables level two VIP for free
+  at all times
+- [Bypass `assertFail` `exit`](./patches/optional/bypass_assert_fail_exit.patch):
+  WorldsPlayer crashes when it encounters a failed assertion. This patch
+  continues to show any failed assertion popups, but attempts to continue
+  running the client, **if possible**.
+
+## Licence
 
 This project is licensed with the [GNU General Public License v3.0](./LICENSE).
\ No newline at end of file