aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorFuwn <[email protected]>2024-06-07 23:09:21 +0000
committerFuwn <[email protected]>2024-06-07 23:11:58 +0000
commit154020421b898d6e3f5a09b42a39ef0348d6ea6e (patch)
treeead107c12cabbb7421c558731d709725582ba52d /README.md
parentfeat(decompile): confirm overwrite (diff)
downloadworldsplayer_source_editor-154020421b898d6e3f5a09b42a39ef0348d6ea6e.tar.xz
worldsplayer_source_editor-154020421b898d6e3f5a09b42a39ef0348d6ea6e.zip
build: add makefile
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 9 insertions, 11 deletions
diff --git a/README.md b/README.md
index 2e172e9..5bf7207 100644
--- a/README.md
+++ b/README.md
@@ -15,16 +15,15 @@ This project additionally requires the
## Decompiling WorldsPlayer
-To decompile WorldsPlayer, you will need to run the
-[`bin/decompile`](./bin/decompile) script. This script will decompile the full
-source tree of the WorldsPlayer Java Archive to the
+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
[`source`](./source) directory.
You'll additionally need to provide the location of the WorldsPlayer Java
Archive as the `WORLDSPLAYER_JAR` environment variable.
```bash
-WORLDSPLAYER_JAR=/path/to/worlds.jar bin/decompile
+WORLDSPLAYER_JAR=/path/to/worlds.jar make decompile
```
## Editing WorldsPlayer
@@ -33,16 +32,15 @@ You can edit the decompiled source files in any way you like.
## Recompiling WorldsPlayer
-To recompile WorldsPlayer, you will need to run the
-[`bin/recompile`](./bin/recompile) script. This script will recompile the full
-source tree of the WorldsPlayer Java Archive to the
+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
[`out`](./out) directory.
You'll additionally need to provide the location of the Java 6 compiler as the
`JAVAC` environment variable.
```bash
-JAVAC=/path/to/javac bin/recompile
+JAVAC=/path/to/javac make compile
```
The recompiled WorldsPlayer Java Archive will be located at
@@ -53,16 +51,16 @@ to run in the WorldsPlayer client.
```shell
# Decompile WorldsPlayer
-WORLDSPLAYER_JAR=/path/to/worlds.jar bin/decompile
+WORLDSPLAYER_JAR=/path/to/worlds.jar make decompile
# Edit the source files in the source directory
find source -type f -name "*.java" -exec sed -i.bak 's/this\.setName(longID);/this.setName(longID + " (" + longID + ")");/' {} \;
# Recompile WorldsPlayer
-JAVAC=/path/to/javac bin/recompile
+JAVAC=/path/to/javac make compile
# Copy worlds.jar to your WorldsPlayer client
-cp out/worlds.jar /path/to/worlds.jar
+WORLDSPLAYER_JAR=/path/to/worlds.jar make install
```
Now that we've changed the username format from `username` to `username (username)`, we can run WorldsPlayer to verify that the change has been applied.