Options.java

Go to the documentation of this file.

/*
 * This file is part of JXClient, the Fullscreen Java Crossfire Client.
 *
 * JXClient 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 2 of the License, or
 * (at your option) any later version.
 *
 * JXClient 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 JXClient; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * Copyright (C) 2005-2008 Yann Chachkoff
 * Copyright (C) 2006-2017,2019-2023 Andreas Kirschbaum
 * Copyright (C) 2010-2012,2014-2018,2020-2023 Nicolas Weeger
 */
 
package com.realtime.crossfire.jxclient.main;
 
import com.realtime.crossfire.jxclient.util.Resolution;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
 
public class Options {
 
    private static final int DEFAULT_TILE_SIZE = 64;
 
    private boolean fullScreen;
 
    @Nullable
    private String server;
 
    private boolean debugGui;
 
    @Nullable
    private String debugProtocolFilename;
 
    @Nullable
    private String debugKeyboardFilename;
 
    @Nullable
    private String debugMouseFilename;
 
    @Nullable
    private String debugScreenFilename;
 
    @Nullable
    private String debugSoundFilename;
 
    @Nullable
    private Resolution resolution;
 
    @NotNull
    private String skin = DEFAULT_SKIN;
 
    private int tileSize = DEFAULT_TILE_SIZE;
 
    private float fontScaleFactor = 1.0F;
 
    @NotNull
    public static final String DEFAULT_SKIN = "ragnorok";
 
    private boolean avoidCopyArea;
 
    public void parse(@NotNull final String @NotNull [] args) {
        resolution = null;
        skin = DEFAULT_SKIN;
 
        int i = 0;
        while (i < args.length) {
            if ((args[i].equals("-r") || args[i].equals("--resolution")) && i+1 < args.length) {
                resolution = Resolution.parse(args[++i]);
                if (resolution == null) {
                    System.err.println("Invalid resolution: "+args[i]);
                    System.exit(1);
                }
            } else if ((args[i].equals("-S") || args[i].equals("-s") || args[i].equals("--skin")) && i+1 < args.length) {
                skin = args[++i];
                if (skin.indexOf('@') != -1) {
                    System.err.println("Invalid skin name: "+skin);
                    System.exit(1);
                }
            } else if (args[i].equals("-N") || args[i].equals("-n") || args[i].equals("--no-full-screen")) {
                fullScreen = false;
            } else if (args[i].equals("--full-screen")) {
                fullScreen = true;
            } else if (args[i].equals("--opengl")) {
                System.setProperty("sun.java2d.opengl", "True");
            } else if (args[i].equals("--server") && i+1 < args.length) {
                server = args[++i];
            } else if (args[i].equals("--debug-gui")) {
                debugGui = true;
            } else if (args[i].equals("--debug-protocol") && i+1 < args.length) {
                debugProtocolFilename = args[++i];
            } else if (args[i].equals("--debug-keyboard") && i+1 < args.length) {
                debugKeyboardFilename = args[++i];
            } else if (args[i].equals("--debug-mouse") && i+1 < args.length) {
                debugMouseFilename = args[++i];
            } else if (args[i].equals("--debug-screen") && i+1 < args.length) {
                debugScreenFilename = args[++i];
            } else if (args[i].equals("--debug-sound") && i+1 < args.length) {
                debugSoundFilename = args[++i];
            } else if (args[i].equals("--tile-size") && i+1 < args.length) {
                final String tmp = args[++i];
                try {
                    tileSize = Integer.parseInt(tmp);
                } catch (final NumberFormatException ignored) {
                    System.err.println("Invalid tile size: "+tmp);
                    System.exit(1);
                }
                if (tileSize < 1) {
                    System.err.println("Invalid tile size: "+tileSize);
                    System.exit(1);
                }
            } else if (args[i].equals("--font-scale-factor") && i+1 < args.length) {
                final String tmp = args[++i];
                try {
                    fontScaleFactor = Float.parseFloat(tmp);
                } catch (final NumberFormatException ignored) {
                    System.err.println("Invalid font scale factor: "+tmp);
                    System.exit(1);
                }
                if (fontScaleFactor < 0.01 || fontScaleFactor > 100.0) {
                    System.err.println("Invalid font scale factor: "+fontScaleFactor);
                    System.exit(1);
                }
            } else if (args[i].equals("--avoid-copy-area")) {
                avoidCopyArea = true;
            } else {
                System.out.println();
                System.out.println("Available options:");
                System.out.println(" --full-screen  : Enable full-screen mode.");
                //System.out.println(" --no-full-screen"); // not advertised; it is recognized only for compatibility
                //System.out.println(" -N"); // not advertised as it is considered deprecated
                //System.out.println(" -n             : Disable full-screen mode."); // not advertised; it is recognized only for compatibility
                System.out.println(" --resolution <width>x<height>");
                System.out.println(" -r <width>x<height>");
                System.out.println("                : Resolution to use. [default is maximum not exceeding screen]");
                System.out.println(" --skin <skin>");
                //System.out.println(" -S <skin>"); // not advertised as it is considered deprecated
                System.out.println(" -s <skin>      : Built-in skin name or skin directory to use.");
                System.out.println(" --tile-size <n>: The size of map view tiles in pixels.");
                System.out.println(" --font-scale-factor <factor>: The factor for scaling font sizes. Default to 1.0.");
                System.out.println(" --avoid-copy-area: Do not copy pixel areas when scrolling the map view.");
                System.out.println("                  Instead always repaint all map squares.");
                System.out.println(" --opengl       : Enable the OpenGL rendering pipeline.");
                System.out.println(" --server <host>: Select a server to connect to; skips main and metaserver");
                System.out.println("                  windows.");
                System.out.println(" --debug-gui    : Enable debugging of GUI elements.");
                System.out.println(" --debug-keyboard <log-file>");
                System.out.println("                : Log keyboard input.");
                System.out.println(" --debug-mouse <log-file>");
                System.out.println("                : Log mouse input.");
                System.out.println(" --debug-protocol <log-file>");
                System.out.println("                : Log messages exchanged with the server.");
                System.out.println(" --debug-screen <log-file>");
                System.out.println("                : Log messages related to screen resolution.");
                System.out.println(" --debug-sound <log-file>");
                System.out.println("                : Log messages related to sound.");
                System.out.println();
                System.out.println("Built-in skin names: ragnorok ragnorok-48px ragnorok-64px.");
                System.exit(1);
            }
            i++;
        }
    }
 
    @Nullable
    public String getDebugProtocolFilename() {
        return debugProtocolFilename;
    }
 
    @Nullable
    public String getDebugKeyboardFilename() {
        return debugKeyboardFilename;
    }
 
    @Nullable
    public String getDebugMouseFilename() {
        return debugMouseFilename;
    }
 
    @Nullable
    public String getDebugScreenFilename() {
        return debugScreenFilename;
    }
 
    @Nullable
    public String getDebugSoundFilename() {
        return debugSoundFilename;
    }
 
    public boolean isDebugGui() {
        return debugGui;
    }
 
    @Nullable
    public Resolution getResolution() {
        return resolution;
    }
 
    @NotNull
    public String getSkin() {
        return skin;
    }
 
    public int getTileSize() {
        return tileSize;
    }
 
    public float getFontScaleFactor() {
        return fontScaleFactor;
    }
 
    public boolean isFullScreen() {
        return fullScreen;
    }
 
    @Nullable
    public String getServer() {
        return server;
    }
 
    public boolean isAvoidCopyArea() {
        return avoidCopyArea;
    }
 
}