From ee6bc93ee04f20f6d22f800d60cd6a32795f4d2d Mon Sep 17 00:00:00 2001 From: Albert Pham Date: Thu, 13 Jun 2013 17:09:29 -0700 Subject: Updated README with some command line hints. --- README.md | 8 ++++++-- 1 file 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 ---------- -- cgit