Add --console option to the launcher

The --console option shows the GUI console even in headless mode.

Launcher version bumped to v1.8.11.

Author: llbit

ChangeLog.txt

@@ -1,5 +1,7 @@
 1.3.7 - TBD
 
+* Launcher v1.8.11: added --console option to show the GUI console even in
+  headless mode.
 * Added player entity rendering.
 * Added option to disable player loading in the General tab in the
   Render Controls window.

chunky/src/java/se/llbit/chunky/main/CommandLineOptions.java

@@ -44,6 +44,7 @@
 import se.llbit.json.JsonString;
 import se.llbit.json.JsonValue;
 import se.llbit.util.MCDownloader;
+import se.llbit.util.StringUtil;
 
 public class CommandLineOptions {
 	enum Mode {
@@ -56,41 +57,42 @@ enum Mode {
 	/**
 	 * The help string
 	 */
-	private static final String USAGE =
-		"Usage: chunky [OPTIONS] [WORLD DIRECTORY]\n" +
-		"Options:\n" +
-		"  -texture <FILE>        use FILE as the texture pack (must be a Zip file)\n" +
-		"  -render <SCENE>        render the specified scene (see notes)\n" +
-		"  -snapshot <SCENE> [PNG] create a snapshot of the specified scene\n" +
-		"  -scene-dir <DIR>       use the directory DIR for loading/saving scenes\n" +
-		"  -benchmark             run the benchmark and exit\n" +
-		"  -threads <NUM>         use the specified number of threads for rendering\n" +
-		"  -tile-width <NUM>      use the specified job tile width\n" +
-		"  -target <NUM>          override target SPP to be NUM in headless mode\n" +
-		"  -opencl                enables OpenCL rendering in the GUI\n" +
-		"  -set <NAME> <VALUE>    set a global configuration option and exit\n" +
-		"  -reset <NAME>          reset a global configuration option and exit\n" +
-		"  -set <NAME> <VALUE> <SCENE>\n" +
-		"                         set a configuration option for a scene and exit\n" +
-		"  -reset <NAME> <SCENE>  reset a configuration option for a scene and exit\n" +
-		"  -reset <NAME> <SCENE>  reset a configuration option for a scene and exit\n" +
-		"  -download-mc <VERSION> download the given Minecraft version and exit\n" +
-		"  -help                  show this text\n" +
-		"\n" +
-		"Notes:\n" +
-		"<SCENE> can be either the path to a Scene Description File (" + SceneDescription.SCENE_DESCRIPTION_EXTENSION + "),\n" +
-		"*OR* the name of a scene relative to the scene directory (excluding extension).\n" +
-		"If the scene name is an absolute path then the scene directory will be the\n" +
-		"parent directory of the Scene Description File, otherwise the scene directory\n" +
-		"can be overridden temporarily by the -scene-dir option.\n" +
-		"\n" +
-		"Launcher options:\n" +
-		"  --update              download the latest version of Chunky and exit\n" +
-		"  --setup               configure memory limit and Java options for Chunky\n" +
-		"  --nolauncher          start Chunky as normal, but without opening launcher\n" +
-		"  --launcher            forces the launcher window to be displayed\n" +
-		"  --version             print the launcher version and exit\n" +
-		"  --verbose             verbose logging in the launcher\n";
+	private static final String USAGE = StringUtil.join("\n",
+		"Usage: chunky [OPTIONS] [WORLD DIRECTORY]",
+		"Options:",
+		"  -texture <FILE>        use FILE as the texture pack (must be a Zip file)",
+		"  -render <SCENE>        render the specified scene (see notes)",
+		"  -snapshot <SCENE> [PNG] create a snapshot of the specified scene",
+		"  -scene-dir <DIR>       use the directory DIR for loading/saving scenes",
+		"  -benchmark             run the benchmark and exit",
+		"  -threads <NUM>         use the specified number of threads for rendering",
+		"  -tile-width <NUM>      use the specified job tile width",
+		"  -target <NUM>          override target SPP to be NUM in headless mode",
+		"  -opencl                enables OpenCL rendering in the GUI",
+		"  -set <NAME> <VALUE>    set a global configuration option and exit",
+		"  -reset <NAME>          reset a global configuration option and exit",
+		"  -set <NAME> <VALUE> <SCENE>",
+		"                         set a configuration option for a scene and exit",
+		"  -reset <NAME> <SCENE>  reset a configuration option for a scene and exit",
+		"  -reset <NAME> <SCENE>  reset a configuration option for a scene and exit",
+		"  -download-mc <VERSION> download the given Minecraft version and exit",
+		"  -help                  show this text",
+		"",
+		"Notes:",
+		"<SCENE> can be either the path to a Scene Description File (" + SceneDescription.SCENE_DESCRIPTION_EXTENSION + "),",
+		"*OR* the name of a scene relative to the scene directory (excluding extension).",
+		"If the scene name is an absolute path then the scene directory will be the",
+		"parent directory of the Scene Description File, otherwise the scene directory",
+		"can be overridden temporarily by the -scene-dir option.",
+		"",
+		"Launcher options:",
+		"  --update              download the latest version of Chunky and exit",
+		"  --setup               configure memory limit and Java options for Chunky",
+		"  --nolauncher          start Chunky as normal, but without opening launcher",
+		"  --launcher            forces the launcher window to be displayed",
+		"  --version             print the launcher version and exit",
+		"  --verbose             verbose logging in the launcher",
+		"  --console             show the GUI console in headless mode");
 
 	protected boolean confError = false;
 

chunky/src/java/se/llbit/util/StringUtil.java

@@ -0,0 +1,31 @@
+/* Copyright (c) 2015 Jesper Öqvist <jesper@llbit.se>
+ *
+ * This file is part of Chunky.
+ *
+ * Chunky is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Chunky is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ * You should have received a copy of the GNU General Public License
+ * along with Chunky.  If not, see <http://www.gnu.org/licenses/>.
+ */
+package se.llbit.util;
+
+public abstract class StringUtil {
+	/** Join the string arguments using a separator string.  */
+	public static String join(String separator, String... strings) {
+		StringBuilder buf = new StringBuilder();
+		for (int i = 0; i < strings.length; ++i) {
+			if (i > 0) {
+				buf.append(separator);
+			}
+			buf.append(strings[i]);
+		}
+		return buf.toString();
+	}
+}

launcher/src/se/llbit/chunky/launcher/ChunkyDeployer.java

@@ -63,7 +63,7 @@ public static boolean checkVersionIntegrity(String version) {
 			return false;
 		}
 
-		// check version
+		// Check version.
 		try {
 			FileInputStream in = new FileInputStream(versionFile);
 			JsonParser parser = new JsonParser(in);
@@ -160,7 +160,7 @@ private static void deployEmbeddedVersion(VersionInfo version) {
 
 			ClassLoader parentCL = ChunkyLauncher.class.getClassLoader();
 
-			// deploy libraries that were not already installed correctly
+			// Deploy libraries that were not already installed correctly.
 			for (Library lib: version.libraries) {
 				if (lib.testIntegrity(libDir) != LibraryStatus.PASSED) {
 					unpackLibrary(parentCL, "lib/" + lib.name,
@@ -236,7 +236,7 @@ public int launchChunky(Component parentComponent, LauncherSettings settings, Ve
 		}
 		ProcessBuilder procBuilder = new ProcessBuilder(command);
 		final Logger logger;
-		if (!settings.headless && settings.debugConsole) {
+		if (settings.forceGuiConsole || (!settings.headless && settings.debugConsole)) {
 			DebugConsole console = new DebugConsole(null, settings.closeConsoleOnExit);
 			console.setVisible(true);
 			logger = console;
@@ -248,7 +248,7 @@ public int launchChunky(Component parentComponent, LauncherSettings settings, Ve
 			Runtime.getRuntime().addShutdownHook(new Thread() {
 				@Override
 				public void run() {
-					// kill the subprocess
+					// Kill the subprocess.
 					proc.destroy();
 				}
 			});
@@ -300,30 +300,31 @@ public void run() {
 			shutdownThread.start();
 			try {
 				if (mode == ChunkyMode.GUI) {
-					// just wait a little while to check for startup errors
+					// Just wait a little while to check for startup errors.
 					Thread.sleep(3000);
 					return shutdownThread.exitValue;
 				} else {
-					// wait until completion so we can return correct exit code
+					// Wait until completion so we can return correct exit code.
 					return shutdownThread.exitValue();
 				}
 			} catch (InterruptedException e) {
 			}
 			return 0;
 		} catch (IOException e) {
 			logger.appendErrorLine(e.getMessage());
-			// 3 indicates launcher error
+			// TODO(jesper): Add constant for this return value.
+			// Exit code 3 indicates launcher error.
 			return 3;
 		}
 	}
 
 	/**
-	 * @param command
+	 * Convert a command in list form to string.
 	 * @return command in string form
 	 */
 	public static String commandString(List<String> command) {
 		StringBuilder sb = new StringBuilder();
-		for (String part: command) {
+		for (String part : command) {
 			if (sb.length() > 0) {
 				sb.append(" ");
 			}
@@ -339,7 +340,7 @@ public static List<String> buildCommandLine(VersionInfo version, LauncherSetting
 		cmd.add("-Xmx" + settings.memoryLimit + "m");
 
 		String[] parts = settings.javaOptions.split(" ");
-		for (String part: parts) {
+		for (String part : parts) {
 			if (!part.isEmpty()) {
 				cmd.add(part);
 			}
@@ -355,7 +356,7 @@ public static List<String> buildCommandLine(VersionInfo version, LauncherSetting
 		cmd.add("se.llbit.chunky.main.Chunky");
 
 		parts = settings.chunkyOptions.split(" ");
-		for (String part: parts) {
+		for (String part : parts) {
 			if (!part.isEmpty()) {
 				cmd.add(part);
 			}
@@ -368,7 +369,7 @@ private static String classpath(VersionInfo version, LauncherSettings settings)
 		File chunkyDir = PersistentSettings.getSettingsDirectory();
 		File libDir = new File(chunkyDir, "lib");
 		List<File> jars = new ArrayList<File>();
-		for (VersionInfo.Library library: version.libraries) {
+		for (VersionInfo.Library library : version.libraries) {
 			jars.add(library.getFile(libDir));
 		}
 		String classpath = "";
@@ -429,7 +430,7 @@ public void run() {
 	public static VersionInfo resolveVersion(String name) {
 		List<VersionInfo> versions = availableVersions();
 		VersionInfo version = VersionInfo.LATEST;
-		for (VersionInfo info: versions) {
+		for (VersionInfo info : versions) {
 			if (info.name.equals(name)) {
 				version = info;
 				break;
@@ -448,7 +449,7 @@ public static VersionInfo resolveVersion(String name) {
 
 	public static boolean canLaunch(VersionInfo version, ChunkyLauncher launcher, boolean reportErrors) {
 		if (version == VersionInfo.NONE) {
-			// version not available!
+			// Version not available!
 			System.err.println("No version installed");
 			if (reportErrors) {
 				Dialogs.error(launcher,

launcher/src/se/llbit/chunky/launcher/ChunkyLauncher.java

@@ -58,7 +58,7 @@
 @SuppressWarnings("serial")
 public class ChunkyLauncher extends JFrame implements UpdateListener {
 
-	private static final String LAUNCHER_VERSION = "v1.8.10";
+	private static final String LAUNCHER_VERSION = "v1.8.11";
 
 	protected String java;
 	private final ChunkyDeployer deployer;
@@ -563,8 +563,7 @@ public static void main(String[] args) {
 		final LauncherSettings settings = new LauncherSettings();
 		settings.load();
 
-		/*
-		 * If there are command line arguments then we assume that Chunky should run
+		/* If there are command line arguments then we assume that Chunky should run
 		 * in headless mode, unless the --nolauncher command is present in which case
 		 * we strip that and start regularly, but without launcher. The --launcher
 		 * option overrides everything else and forces the launcher to appear.
@@ -586,6 +585,8 @@ public static void main(String[] args) {
 					return;
 				} else if (arg.equals("--verbose")) {
 					settings.verboseLauncher = true;
+				} else if (arg.equals("--console")) {
+					settings.forceGuiConsole = true;
 				} else if (arg.equals("--update") || arg.equals("--updateAlpha")) {
 					if (arg.equals("--updateAlpha")) {
 						System.out.println("Checking for Chunky alpha/snapshot updates..");

lib/src/se/llbit/chunky/launcher/LauncherSettings.java

@@ -28,6 +28,7 @@ public class LauncherSettings {
 	public String javaDir = "";
 	public int memoryLimit = DEFAULT_MEMORY_LIMIT;
 	public boolean debugConsole = false;
+	public boolean forceGuiConsole = false;
 	public boolean verboseLogging = false;
 	public boolean verboseLauncher = false;
 	public String javaOptions = "";