aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlbert Pham <the.sk89q@gmail.com>2013-06-13 17:09:29 -0700
committerAlbert Pham <the.sk89q@gmail.com>2013-06-13 17:09:29 -0700
commitee6bc93ee04f20f6d22f800d60cd6a32795f4d2d (patch)
treefa9b9922dee65e5d1c16ebecd72cc725ee08a0a9
parent280ad8b8bf2942f055daf5fb6f8ae55a7f88243a (diff)
downloadspark-ee6bc93ee04f20f6d22f800d60cd6a32795f4d2d.tar.gz
spark-ee6bc93ee04f20f6d22f800d60cd6a32795f4d2d.tar.bz2
spark-ee6bc93ee04f20f6d22f800d60cd6a32795f4d2d.zip
Updated README with some command line hints.
-rw-r--r--README.md8
1 files changed, 6 insertions, 2 deletions
diff --git a/README.md b/README.md
index f8edd13..a86743d 100644
--- a/README.md
+++ b/README.md
@@ -30,13 +30,17 @@ Usage
3. Replace `/path/to/jdk` in the following command line with the path to your JDK and execute the program.
+**Note:** The example command line below includes `--thread "Server thread"`, which filters all threads but the main server thread. You can remove it to show all threads.
+
+**Modded/vanilla servers:** If you are using a modded server, get a copy of [MCP](http://mcp.ocean-labs.de/index.php/MCP_Releases) for your server's Minecraft version, copy the files from conf/ somewhere, and point WarmRoast to it with `--mapping path/to/folder`. This helps readability a lot. Bukkit uses its own mapping, so a pure non-modded Bukkit server can't use MCP mappings.
+
### Linux ###
- java -Djava.library.path=/path/to/jdk/jre/bin -cp /path/to/jdk/lib/tools.jar:warmroast.jar com.sk89q.warmroast.WarmRoast
+ java -Djava.library.path=/path/to/jdk/jre/bin -cp /path/to/jdk/lib/tools.jar:warmroast.jar com.sk89q.warmroast.WarmRoast --thread "Server thread"
### Windows ###
- java -Djava.library.path=/path/to/jdk/jre/bin -cp /path/to/jdk/lib/tools.jar;warmroast.jar com.sk89q.warmroast.WarmRoast
+ java -Djava.library.path=/path/to/jdk/jre/bin -cp /path/to/jdk/lib/tools.jar;warmroast.jar com.sk89q.warmroast.WarmRoast --thread "Server thread"
Parameters
----------