opsu-dance/src/itdelatrisu/opsu/states/Options.java

/*
 * opsu! - an open-source osu! client
 * Copyright (C) 2014 Jeffrey Han
 *
 * opsu! 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.
 *
 * opsu! 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 opsu!.  If not, see <http://www.gnu.org/licenses/>.
 */

package itdelatrisu.opsu.states;

import itdelatrisu.opsu.GameImage;
import itdelatrisu.opsu.GameMod;
import itdelatrisu.opsu.MenuButton;
import itdelatrisu.opsu.Opsu;
import itdelatrisu.opsu.OsuFile;
import itdelatrisu.opsu.Utils;
import itdelatrisu.opsu.audio.SoundController;
import itdelatrisu.opsu.audio.SoundEffect;

import java.io.BufferedReader;
import java.io.BufferedWriter;
import java.io.File;
import java.io.FileOutputStream;
import java.io.FileReader;
import java.io.IOException;
import java.io.OutputStreamWriter;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.Locale;
import java.util.concurrent.TimeUnit;

import org.lwjgl.input.Keyboard;
import org.newdawn.slick.AppGameContainer;
import org.newdawn.slick.Color;
import org.newdawn.slick.GameContainer;
import org.newdawn.slick.Graphics;
import org.newdawn.slick.Image;
import org.newdawn.slick.Input;
import org.newdawn.slick.SlickException;
import org.newdawn.slick.state.BasicGameState;
import org.newdawn.slick.state.StateBasedGame;
import org.newdawn.slick.state.transition.EmptyTransition;
import org.newdawn.slick.state.transition.FadeInTransition;
import org.newdawn.slick.util.Log;

/**
 * "Game Options" state.
 */
public class Options extends BasicGameState {
	/**
	 * Temporary folder for file conversions, auto-deleted upon successful exit.
	 */
	public static final File TMP_DIR = new File(".opsu_tmp/");
	
	/**
	 * File for logging errors.
	 */
	public static final File LOG_FILE = new File(".opsu.log");

	/**
	 * File for storing user options.
	 */
	private static final File OPTIONS_FILE = new File(".opsu.cfg");

	/**
	 * Beatmap directories (where to search for files).
	 */
	private static final String[] BEATMAP_DIRS = {
		"C:/Program Files (x86)/osu!/Songs/",
		"C:/Program Files/osu!/Songs/",
		"Songs/"
	};

	/**
	 * Font file name.
	 */
	public static final String FONT_NAME = "kochi-gothic.ttf";

	/**
	 * The beatmap directory.
	 */
	private static File beatmapDir;

	/**
	 * The OSZ archive directory.
	 */
	private static File oszDir;

	/**
	 * The screenshot directory (created when needed).
	 */
	private static File screenshotDir;

	/**
	 * The current skin directory (for user skins).
	 */
	private static File skinDir;

	/**
	 * The theme song string:
	 * filename, title, artist, length (ms)
	 */
	private static String themeString = "theme.ogg,welcome to osu!,nekodex,48000";

	/**
	 * Game options.
	 */
	private static enum GameOption {
		NULL,
		SCREEN_RESOLUTION,
//		FULLSCREEN,
		TARGET_FPS,
		MUSIC_VOLUME,
		EFFECT_VOLUME,
		HITSOUND_VOLUME,
		MUSIC_OFFSET,
		SCREENSHOT_FORMAT,
		SHOW_FPS,
		SHOW_HIT_LIGHTING,
		SHOW_COMBO_BURSTS,
		NEW_CURSOR,
		DYNAMIC_BACKGROUND,
		SHOW_PERFECT_HIT,
		BACKGROUND_DIM,
		FORCE_DEFAULT_PLAYFIELD,
		IGNORE_BEATMAP_SKINS,
		FIXED_CS,
		FIXED_HP,
		FIXED_AR,
		FIXED_OD,
		LOAD_VERBOSE,
		CHECKPOINT,
		DISABLE_SOUNDS,
		KEY_LEFT,
		KEY_RIGHT,
		SHOW_UNICODE,
		ENABLE_THEME_SONG;
	};

	/**
	 * Option tab constants.
	 */
	private static final int
		TAB_DISPLAY  = 0,
		TAB_MUSIC    = 1,
		TAB_GAMEPLAY = 2,
		TAB_CUSTOM   = 3,
		TAB_MAX      = 4;  // not a tab

	/**
	 * Option tab names.
	 */
	private static final String[] TAB_NAMES = {
		"Display",
		"Music",
		"Gameplay",
		"Custom"
	};

	/**
	 * Option tab buttons.
	 */
	private static MenuButton[] optionTabs = new MenuButton[TAB_MAX];

	/**
	 * Current tab.
	 */
	private static int currentTab;

	/**
	 * Display options.
	 */
	private static final GameOption[] displayOptions = {
		GameOption.SCREEN_RESOLUTION,
//		GameOption.FULLSCREEN,
		GameOption.TARGET_FPS,
		GameOption.SHOW_FPS,
		GameOption.SHOW_UNICODE,
		GameOption.SCREENSHOT_FORMAT,
		GameOption.NEW_CURSOR,
		GameOption.DYNAMIC_BACKGROUND,
		GameOption.LOAD_VERBOSE
	};

	/**
	 * Music options.
	 */
	private static final GameOption[] musicOptions = {
		GameOption.MUSIC_VOLUME,
		GameOption.EFFECT_VOLUME,
		GameOption.HITSOUND_VOLUME,
		GameOption.MUSIC_OFFSET,
		GameOption.DISABLE_SOUNDS,
		GameOption.ENABLE_THEME_SONG
	};

	/**
	 * Gameplay options.
	 */
	private static final GameOption[] gameplayOptions = {
		GameOption.KEY_LEFT,
		GameOption.KEY_RIGHT,
		GameOption.BACKGROUND_DIM,
		GameOption.FORCE_DEFAULT_PLAYFIELD,
		GameOption.IGNORE_BEATMAP_SKINS,
		GameOption.SHOW_HIT_LIGHTING,
		GameOption.SHOW_COMBO_BURSTS,
		GameOption.SHOW_PERFECT_HIT
	};

	/**
	 * Custom options.
	 */
	private static final GameOption[] customOptions = {
		GameOption.FIXED_CS,
		GameOption.FIXED_HP,
		GameOption.FIXED_AR,
		GameOption.FIXED_OD,
		GameOption.CHECKPOINT
	};

	/**
	 * Max number of options displayed on one screen.
	 */
	private static int maxOptionsScreen = Math.max(
			Math.max(displayOptions.length, musicOptions.length),
			Math.max(gameplayOptions.length, customOptions.length));

	/**
	 * Screen resolutions.
	 */
	private static final int[][] resolutions = {
		{ 800, 600 },
		{ 1024, 600 },
		{ 1024, 768 },
		{ 1280, 800 },
		{ 1280, 960 },
		{ 1366, 768 },
		{ 1440, 900 },
		{ 1600, 900 },
		{ 1680, 1050 },
		{ 1920, 1080 },
		{ 1920, 1200 },
		{ 2560, 1440 },
		{ 2560, 1600 }
	};

	/**
	 * Index (row) in resolutions[][] array.
	 */
	private static int resolutionIndex = 3;

//	/**
//	 * Whether or not the game should run in fullscreen mode.
//	 */
//	private static boolean fullscreen = false;

	/**
	 * Frame limiters.
	 */
	private static final int[] targetFPS = { 60, 120, 240 };
	
	/**
	 * Index in targetFPS[] array.
	 */
	private static int targetFPSindex = 0;

	/**
	 * Whether or not to show the FPS.
	 */
	private static boolean showFPS = false;

	/**
	 * Whether or not to show hit lighting effects.
	 */
	private static boolean showHitLighting = true;

	/**
	 * Whether or not to show combo burst images.
	 */
	private static boolean showComboBursts = true;

	/**
	 * Default music volume.
	 */
	private static int musicVolume = 30;

	/**
	 * Default sound effect volume.
	 */
	private static int effectVolume = 20;

	/**
	 * Default hit sound volume.
	 */
	private static int hitSoundVolume = 20;

	/**
	 * Offset time, in milliseconds, for music position-related elements.
	 */
	private static int musicOffset = -150;

	/**
	 * Screenshot file format.
	 */
	private static String[] screenshotFormat = { "png", "jpg", "bmp" };

	/**
	 * Index in screenshotFormat[] array.
	 */
	private static int screenshotFormatIndex = 0;

	/**
	 * Port binding.
	 */
	private static int port = 49250;

	/**
	 * Whether or not to use the new cursor type.
	 */
	private static boolean newCursor = true;

	/**
	 * Whether or not dynamic backgrounds are enabled.
	 */
	private static boolean dynamicBackground = true;

	/**
	 * Whether or not to display perfect hit results.
	 */
	private static boolean showPerfectHit = true;

	/**
	 * Percentage to dim background images during gameplay.
	 */
	private static int backgroundDim = 30;

	/**
	 * Whether or not to always display the default playfield background.
	 */
	private static boolean forceDefaultPlayfield = false;

	/**
	 * Whether or not to ignore resources in the beatmap folders.
	 */
	private static boolean ignoreBeatmapSkins = false;

	/**
	 * Whether or not to play the theme song.
	 */
	private static boolean themeSongEnabled = true;

	/**
	 * Fixed difficulty overrides.
	 */
	private static float
		fixedCS = 0f, fixedHP = 0f,
		fixedAR = 0f, fixedOD = 0f;

	/**
	 * Whether or not to display the files being loaded in the splash screen.
	 */
	private static boolean loadVerbose = false;

	/**
	 * Track checkpoint time, in seconds.
	 */
	private static int checkpoint = 0;

	/**
	 * Whether or not to disable all sounds.
	 * This will prevent SoundController from loading sound files.
	 * <p>
	 * By default, sound is disabled on Linux due to possible driver issues.
	 */
	private static boolean disableSound =
		(System.getProperty("os.name").toLowerCase().indexOf("linux") > -1);

	/**
	 * Whether or not to display non-English metadata.
	 */
	private static boolean showUnicode = false;

	/**
	 * Left and right game keys.
	 */
	private static int
		keyLeft  = Keyboard.KEY_NONE,
		keyRight = Keyboard.KEY_NONE;

	/**
	 * Key entry states.
	 */
	private boolean keyEntryLeft = false, keyEntryRight = false;

	/**
	 * Game option coordinate modifiers (for drawing).
	 */
	private int textY, offsetY;

	// game-related variables
	private GameContainer container;
	private StateBasedGame game;
	private Input input;
	private Graphics g;
	private int state;

	public Options(int state) {
		this.state = state;
	}

	@Override
	public void init(GameContainer container, StateBasedGame game)
			throws SlickException {
		this.container = container;
		this.game = game;
		this.input = container.getInput();
		this.g = container.getGraphics();

		int width = container.getWidth();
		int height = container.getHeight();

		// game option coordinate modifiers
		textY = 20 + (Utils.FONT_XLARGE.getLineHeight() * 3 / 2);
		offsetY = (int) (((height * 0.8f) - textY) / maxOptionsScreen);

		// option tabs
		Image tab = GameImage.MENU_TAB.getImage();
		int subtextWidth = Utils.FONT_DEFAULT.getWidth("Click or drag an option to change it.");
		float tabX = (width / 50) + (tab.getWidth() / 2f);
		float tabY = 15 + Utils.FONT_XLARGE.getLineHeight() + (tab.getHeight() / 2f);
		float tabOffset = (float) Math.min(tab.getWidth(), 
				((width - subtextWidth - tab.getWidth()) / 2) / TAB_MAX);
		for (int i = 0; i < optionTabs.length; i++)
			optionTabs[i] = new MenuButton(tab, tabX + (i * tabOffset), tabY);
	}

	@Override
	public void render(GameContainer container, StateBasedGame game, Graphics g)
			throws SlickException {
		g.setBackground(Utils.COLOR_BLACK_ALPHA);
		g.setColor(Color.white);

		int width = container.getWidth();
		int height = container.getHeight();

		// title
		Utils.FONT_XLARGE.drawString(
				(width / 2) - (Utils.FONT_XLARGE.getWidth("GAME OPTIONS") / 2),
				10, "GAME OPTIONS"
		);
		Utils.FONT_DEFAULT.drawString(
				(width / 2) - (Utils.FONT_DEFAULT.getWidth("Click or drag an option to change it.") / 2),
				10 + Utils.FONT_XLARGE.getLineHeight(), "Click or drag an option to change it."
		);

		// game options
		g.setLineWidth(1f);
		g.setFont(Utils.FONT_LARGE);
		switch (currentTab) {
		case TAB_DISPLAY:
			for (int i = 0; i < displayOptions.length; i++)
				drawOption(displayOptions[i], i);
			break;
		case TAB_MUSIC:
			for (int i = 0; i < musicOptions.length; i++)
				drawOption(musicOptions[i], i);
			break;
		case TAB_GAMEPLAY:
			for (int i = 0; i < gameplayOptions.length; i++)
				drawOption(gameplayOptions[i], i);
			break;
		case TAB_CUSTOM:
			for (int i = 0; i < customOptions.length; i++)
				drawOption(customOptions[i], i);
			break;
		}

		// option tabs
		g.setColor(Color.white);
		Image tab = optionTabs[0].getImage();
		float tabTextY = optionTabs[0].getY() - (tab.getHeight() / 2f);
		for (int i = optionTabs.length - 1; i >= 0; i--) {
			tab.setAlpha((i == currentTab) ? 1.0f : 0.7f);
			optionTabs[i].draw();
			float tabTextX = optionTabs[i].getX() - (Utils.FONT_MEDIUM.getWidth(TAB_NAMES[i]) / 2);
			Utils.FONT_MEDIUM.drawString(tabTextX, tabTextY, TAB_NAMES[i], Color.white);
		}
		g.setLineWidth(2f);
		float lineY = optionTabs[0].getY() + (tab.getHeight() / 2f);
		g.drawLine(0, lineY, width, lineY);
		g.resetLineWidth();

		// game mods
		Utils.FONT_LARGE.drawString(width / 30, height * 0.8f, "Game Mods:", Color.white);
		for (GameMod mod : GameMod.values())
			mod.draw();

		Utils.getBackButton().draw();

		// key entry state
		if (keyEntryLeft || keyEntryRight) {
			g.setColor(Utils.COLOR_BLACK_ALPHA);
			g.fillRect(0, 0, width, height);
			g.setColor(Color.white);
			Utils.FONT_LARGE.drawString(
					(width / 2) - (Utils.FONT_LARGE.getWidth("Please enter a letter or digit.") / 2),
					(height / 2) - Utils.FONT_LARGE.getLineHeight(), "Please enter a letter or digit."
			);
		}

		Utils.drawFPS();
		Utils.drawCursor();
	}

	@Override
	public void update(GameContainer container, StateBasedGame game, int delta)
			throws SlickException {
		Utils.updateCursor(delta);
		int mouseX = input.getMouseX(), mouseY = input.getMouseY();
		Utils.getBackButton().hoverUpdate(delta, mouseX, mouseY);
		for (GameMod mod : GameMod.values())
			mod.hoverUpdate(delta, mouseX, mouseY);
	}

	@Override
	public int getID() { return state; }

	@Override
	public void mousePressed(int button, int x, int y) {
		// key entry state
		if (keyEntryLeft || keyEntryRight) {
			keyEntryLeft = keyEntryRight = false;
			return;
		}

		// check mouse button 
		if (button == Input.MOUSE_MIDDLE_BUTTON)
			return;

		// back
		if (Utils.getBackButton().contains(x, y)) {
			SoundController.playSound(SoundEffect.MENUBACK);
			game.enterState(Opsu.STATE_SONGMENU, new EmptyTransition(), new FadeInTransition(Color.black));
			return;
		}

		// option tabs
		for (int i = 0; i < optionTabs.length; i++) {
			if (optionTabs[i].contains(x, y)) {
				if (i != currentTab) {
					currentTab = i;
					SoundController.playSound(SoundEffect.MENUCLICK);
				}
				return;
			}
		}

		// game mods
		for (GameMod mod : GameMod.values()) {
			if (mod.contains(x, y)) {
				boolean prevState = mod.isActive();
				mod.toggle(true);
				if (mod.isActive() != prevState)
					SoundController.playSound(SoundEffect.MENUCLICK);
				return;
			}
		}

		// options (click only)
		switch (getClickedOption(y)) {
		case SCREEN_RESOLUTION:
			do {
				resolutionIndex = (resolutionIndex + 1) % resolutions.length;
			} while (resolutionIndex != 0 &&
					(container.getScreenWidth() < resolutions[resolutionIndex][0] ||
					 container.getScreenHeight() < resolutions[resolutionIndex][1]));
			break;
//		case FULLSCREEN:
//			fullscreen = !fullscreen;
//			break;
		case TARGET_FPS:
			targetFPSindex = (targetFPSindex + 1) % targetFPS.length;
			container.setTargetFrameRate(getTargetFPS());
			break;
		case SCREENSHOT_FORMAT:
			screenshotFormatIndex = (screenshotFormatIndex + 1) % screenshotFormat.length;
			break;
		case SHOW_FPS:
			showFPS = !showFPS;
			break;
		case SHOW_HIT_LIGHTING:
			showHitLighting = !showHitLighting;
			break;
		case SHOW_COMBO_BURSTS:
			showComboBursts = !showComboBursts;
			break;
		case NEW_CURSOR:
			newCursor = !newCursor;
			try {
				Utils.loadCursor();
			} catch (SlickException e) {
				Log.error("Failed to load cursor.", e);
			}
			break;
		case DYNAMIC_BACKGROUND:
			dynamicBackground = !dynamicBackground;
			break;
		case SHOW_PERFECT_HIT:
			showPerfectHit = !showPerfectHit;
			break;
		case FORCE_DEFAULT_PLAYFIELD:
			forceDefaultPlayfield = !forceDefaultPlayfield;
			break;
		case IGNORE_BEATMAP_SKINS:
			ignoreBeatmapSkins = !ignoreBeatmapSkins;
			break;
		case LOAD_VERBOSE:
			loadVerbose = !loadVerbose;
			break;
		case DISABLE_SOUNDS:
			disableSound = !disableSound;
			break;
		case KEY_LEFT:
			keyEntryLeft = true;
			keyEntryRight = false;
			break;
		case KEY_RIGHT:
			keyEntryLeft = false;
			keyEntryRight = true;
			break;
		case SHOW_UNICODE:
			showUnicode = !showUnicode;
			if (showUnicode) {
				try {
					Utils.FONT_LARGE.loadGlyphs();
					Utils.FONT_MEDIUM.loadGlyphs();
					Utils.FONT_DEFAULT.loadGlyphs();
				} catch (SlickException e) {
					Log.warn("Failed to load glyphs.", e);
				}
			}
			break;
		case ENABLE_THEME_SONG:
			themeSongEnabled = !themeSongEnabled;
			break;
		default:
			break;
		}
	}

	@Override
	public void mouseDragged(int oldx, int oldy, int newx, int newy) {
		// key entry state
		if (keyEntryLeft || keyEntryRight)
			return;

		// check mouse button (right click scrolls faster)
		int multiplier;
		if (input.isMouseButtonDown(Input.MOUSE_RIGHT_BUTTON))
			multiplier = 4;
		else if (input.isMouseButtonDown(Input.MOUSE_LEFT_BUTTON))
			multiplier = 1;
		else
			return;

		// get direction
		int diff = newx - oldx;
		if (diff == 0)
			return;
		diff = ((diff > 0) ? 1 : -1) * multiplier;

		// options (drag only)
		switch (getClickedOption(oldy)) {
		case MUSIC_VOLUME:
			musicVolume = getBoundedValue(musicVolume, diff, 0, 100);
			container.setMusicVolume(getMusicVolume());
			break;
		case EFFECT_VOLUME:
			effectVolume = getBoundedValue(effectVolume, diff, 0, 100);
			break;
		case HITSOUND_VOLUME:
			hitSoundVolume = getBoundedValue(hitSoundVolume, diff, 0, 100);
			break;
		case MUSIC_OFFSET:
			musicOffset = getBoundedValue(musicOffset, diff, -500, 500);
			break;
		case BACKGROUND_DIM:
			backgroundDim = getBoundedValue(backgroundDim, diff, 0, 100);
			break;
		case FIXED_CS:
			fixedCS = getBoundedValue(fixedCS, diff / 10f, 0f, 10f);
			break;
		case FIXED_HP:
			fixedHP = getBoundedValue(fixedHP, diff / 10f, 0f, 10f);
			break;
		case FIXED_AR:
			fixedAR = getBoundedValue(fixedAR, diff / 10f, 0f, 10f);
			break;
		case FIXED_OD:
			fixedOD = getBoundedValue(fixedOD, diff / 10f, 0f, 10f);
			break;
		case CHECKPOINT:
			checkpoint = getBoundedValue(checkpoint, diff * multiplier, 0, 3599);
			break;
		default:
			break;
		}
	}

	/**
	 * Returns a bounded value for when an option is dragged.
	 * @param var the initial value
	 * @param diff the value change
	 * @param min the minimum value
	 * @param max the maximum value
	 * @return the bounded value
	 */
	private int getBoundedValue(int var, int diff, int min, int max) {
		int val = var + diff;
		if (val < min)
			val = min;
		else if (val > max)
			val = max;
		return val;
	}

	/**
	 * Returns a bounded value for when an option is dragged.
	 * @param var the initial value
	 * @param diff the value change
	 * @param min the minimum value
	 * @param max the maximum value
	 * @return the bounded value
	 */
	private float getBoundedValue(float var, float diff, float min, float max) {
		float val = var + diff;
		if (val < min)
			val = min;
		else if (val > max)
			val = max;
		return val;
	}

	@Override
	public void keyPressed(int key, char c) {
		// key entry state
		if (keyEntryLeft || keyEntryRight) {
			if (Character.isLetterOrDigit(c)) {
				if (keyEntryLeft && keyRight != key)
					keyLeft = key;
				else if (keyEntryRight && keyLeft != key)
					keyRight = key;
			}
			keyEntryLeft = keyEntryRight = false;
			return;
		}

		switch (key) {
		case Input.KEY_ESCAPE:
			SoundController.playSound(SoundEffect.MENUBACK);
			game.enterState(Opsu.STATE_SONGMENU, new EmptyTransition(), new FadeInTransition(Color.black));
			break;
		case Input.KEY_F12:
			Utils.takeScreenShot();
			break;
		case Input.KEY_TAB:
			int i = 1;
			if (input.isKeyDown(Input.KEY_LSHIFT) || input.isKeyDown(Input.KEY_RSHIFT))
				i = TAB_MAX - 1;
			currentTab = (currentTab + i) % TAB_MAX;
			SoundController.playSound(SoundEffect.MENUCLICK);
			break;
		}
	}

	@Override
	public void enter(GameContainer container, StateBasedGame game)
			throws SlickException {
		currentTab = TAB_DISPLAY;
		Utils.getBackButton().setScale(1f);
		for (GameMod mod : GameMod.values())
			mod.setScale(1f);
	}

	/**
	 * Draws a game option.
	 * @param option the option (OPTION_* constant)
	 * @param pos the position to draw at
	 */
	private void drawOption(GameOption option, int pos) {
		switch (option) {
		case SCREEN_RESOLUTION:
			drawOption(pos, "Screen Resolution",
					String.format("%dx%d", resolutions[resolutionIndex][0], resolutions[resolutionIndex][1]),
					"Restart to apply resolution changes."
			);
			break;
//		case FULLSCREEN:
//			drawOption(pos, "Fullscreen Mode",
//					fullscreen ? "Yes" : "No",
//					"Restart to apply changes."
//			);
//			break;
		case TARGET_FPS:
			drawOption(pos, "Frame Limiter",
					String.format("%dfps", getTargetFPS()),
					"Higher values may cause high CPU usage."
			);
			break;
		case SCREENSHOT_FORMAT:
			drawOption(pos, "Screenshot Format",
					screenshotFormat[screenshotFormatIndex].toUpperCase(),
					"Press F12 to take a screenshot."
			);
			break;
		case SHOW_FPS:
			drawOption(pos, "Show FPS Counter",
					showFPS ? "Yes" : "No",
					"Show an FPS counter in the bottom-right hand corner."
			);
			break;
		case SHOW_UNICODE:
			drawOption(pos, "Prefer Non-English Metadata",
					showUnicode ? "Yes" : "No",
					"Where available, song titles will be shown in their native language."
			);
			break;
		case NEW_CURSOR:
			drawOption(pos, "Enable New Cursor",
					newCursor ? "Yes" : "No",
					"Use the new cursor style (may cause higher CPU usage)."
			);
			break;
		case DYNAMIC_BACKGROUND:
			drawOption(pos, "Enable Dynamic Backgrounds",
					dynamicBackground ? "Yes" : "No",
					"The song background will be used as the main menu background."
			);
			break;
		case LOAD_VERBOSE:
			drawOption(pos, "Show Detailed Loading Progress",
					loadVerbose ? "Yes" : "No",
					"Display more specific loading information in the splash screen."
			);
			break;
		case MUSIC_VOLUME:
			drawOption(pos, "Music Volume",
					String.format("%d%%", musicVolume),
					"Global music volume."
			);
			break;
		case EFFECT_VOLUME:
			drawOption(pos, "Effect Volume",
					String.format("%d%%", effectVolume),
					"Volume of menu and game sounds."
			);
			break;
		case HITSOUND_VOLUME:
			drawOption(pos, "Hit Sound Volume",
					String.format("%d%%", hitSoundVolume),
					"Volume of hit sounds."
			);
			break;
		case MUSIC_OFFSET:
			drawOption(pos, "Music Offset",
					String.format("%dms", musicOffset),
					"Adjust this value if hit objects are out of sync."
			);
			break;
		case DISABLE_SOUNDS:
			drawOption(pos, "Disable All Sound Effects",
					disableSound ? "Yes" : "No",
					"May resolve Linux sound driver issues.  Requires a restart."
			);
			break;
		case KEY_LEFT:
			drawOption(pos, "Left Game Key",
					Keyboard.getKeyName(getGameKeyLeft()),
					"Select this option to input a key."
			);
			break;
		case KEY_RIGHT:
			drawOption(pos, "Right Game Key",
					Keyboard.getKeyName(getGameKeyRight()),
					"Select this option to input a key."
			);
			break;
		case BACKGROUND_DIM:
			drawOption(pos, "Background Dim",
					String.format("%d%%", backgroundDim),
					"Percentage to dim the background image during gameplay."
			);
			break;
		case FORCE_DEFAULT_PLAYFIELD:
			drawOption(pos, "Force Default Playfield",
					forceDefaultPlayfield ? "Yes" : "No",
					"Override the song background with the default playfield background."
			);
			break;
		case IGNORE_BEATMAP_SKINS:
			drawOption(pos, "Ignore All Beatmap Skins",
					ignoreBeatmapSkins ? "Yes" : "No",
					"Never use skin element overrides provided by beatmaps."
			);
			break;
		case SHOW_HIT_LIGHTING:
			drawOption(pos, "Show Hit Lighting",
					showHitLighting ? "Yes" : "No",
					"Adds an effect behind hit explosions."
			);
			break;
		case SHOW_COMBO_BURSTS:
			drawOption(pos, "Show Combo Bursts",
					showComboBursts ? "Yes" : "No",
					"A character image is displayed at combo milestones."
			);
			break;
		case SHOW_PERFECT_HIT:
			drawOption(pos, "Show Perfect Hits",
					showPerfectHit ? "Yes" : "No",
					"Whether to show perfect hit result bursts (300s, slider ticks)."
			);
			break;
		case FIXED_CS:
			drawOption(pos, "Fixed Circle Size (CS)",
					(fixedCS == 0f) ? "Disabled" : String.format("%.1f", fixedCS),
					"Determines the size of circles and sliders."
			);
			break;
		case FIXED_HP:
			drawOption(pos, "Fixed HP Drain Rate (HP)",
					(fixedHP == 0f) ? "Disabled" : String.format("%.1f", fixedHP),
					"Determines the rate at which health decreases."
			);
			break;
		case FIXED_AR:
			drawOption(pos, "Fixed Approach Rate (AR)",
					(fixedAR == 0f) ? "Disabled" : String.format("%.1f", fixedAR),
					"Determines how long hit circles stay on the screen."
			);
			break;
		case FIXED_OD:
			drawOption(pos, "Fixed Overall Difficulty (OD)",
					(fixedOD == 0f) ? "Disabled" : String.format("%.1f", fixedOD),
					"Determines the time window for hit results."
			);
			break;
		case CHECKPOINT:
			drawOption(pos, "Track Checkpoint",
					(checkpoint == 0) ? "Disabled" : String.format("%02d:%02d",
							TimeUnit.SECONDS.toMinutes(checkpoint),
							checkpoint - TimeUnit.MINUTES.toSeconds(TimeUnit.SECONDS.toMinutes(checkpoint))),
					"Press CTRL+L while playing to load a checkpoint, and CTRL+S to set one."
			);
			break;
		case ENABLE_THEME_SONG:
			drawOption(pos, "Enable Theme Song",
					themeSongEnabled ? "Yes" : "No",
					"Whether to play the theme song upon starting opsu!"
			);
			break;
		default:
			break;
		}
	}

	/**
	 * Draws a game option.
	 * @param pos the element position
	 * @param label the option name
	 * @param value the option value
	 * @param notes additional notes
	 */
	private void drawOption(int pos, String label, String value, String notes) {
		int width = container.getWidth();
		int textHeight = Utils.FONT_LARGE.getLineHeight();
		float y = textY + (pos * offsetY);

		g.setColor(Color.white);
		g.drawString(label, width / 30, y);
		g.drawString(value, width / 2, y);
		Utils.FONT_SMALL.drawString(width / 30, y + textHeight, notes);
		g.setColor(Utils.COLOR_WHITE_ALPHA);
		g.drawLine(0, y + textHeight, width, y + textHeight);
	}

	/**
	 * Returns the option clicked.
	 * If no option clicked, -1 will be returned.
	 * @param y the y coordinate
	 * @return the option (OPTION_* constant)
	 */
	private GameOption getClickedOption(int y) {
		GameOption option = GameOption.NULL;

		if (y < textY || y > textY + (offsetY * maxOptionsScreen))
			return option;

		int index = (y - textY + Utils.FONT_LARGE.getLineHeight()) / offsetY;
		switch (currentTab) {
		case TAB_DISPLAY:
			if (index < displayOptions.length)
				option = displayOptions[index];
			break;
		case TAB_MUSIC:
			if (index < musicOptions.length)
				option = musicOptions[index];
			break;
		case TAB_GAMEPLAY:
			if (index < gameplayOptions.length)
				option = gameplayOptions[index];
			break;
		case TAB_CUSTOM:
			if (index < customOptions.length)
				option = customOptions[index];
		}
		return option;
	}

	/**
	 * Returns the target frame rate.
	 * @return the target FPS
	 */
	public static int getTargetFPS() { return targetFPS[targetFPSindex]; }

	/**
	 * Returns the default music volume.
	 * @return the volume [0, 1]
	 */
	public static float getMusicVolume() { return musicVolume / 100f; }

	/**
	 * Returns the default sound effect volume.
	 * @return the sound volume [0, 1]
	 */
	public static float getEffectVolume() { return effectVolume / 100f; }

	/**
	 * Returns the default hit sound volume.
	 * @return the hit sound volume [0, 1]
	 */
	public static float getHitSoundVolume() { return hitSoundVolume / 100f; }

	/**
	 * Returns the music offset time.
	 * @return the offset (in milliseconds)
	 */
	public static int getMusicOffset() { return musicOffset; }

	/**
	 * Returns the screenshot file format.
	 * @return the file extension ("png", "jpg", "bmp")
	 */
	public static String getScreenshotFormat() { return screenshotFormat[screenshotFormatIndex]; }

	/**
	 * Sets the container size and makes the window borderless if the container
	 * size is identical to the screen resolution.
	 * <p>
	 * If the configured resolution is larger than the screen size, the smallest
	 * available resolution will be used.
	 * @param app the game container
	 * @throws SlickException failure to set display mode
	 */
	public static void setDisplayMode(AppGameContainer app) throws SlickException {
		int screenWidth = app.getScreenWidth();
		int screenHeight = app.getScreenHeight();
		if (screenWidth < resolutions[resolutionIndex][0] || screenHeight < resolutions[resolutionIndex][1])
			resolutionIndex = 0;

		int containerWidth = resolutions[resolutionIndex][0];
		int containerHeight = resolutions[resolutionIndex][1];
		app.setDisplayMode(containerWidth, containerHeight, false);
		if (screenWidth == containerWidth && screenHeight == containerHeight)
			System.setProperty("org.lwjgl.opengl.Window.undecorated", "true");
	}

//	/**
//	 * Returns whether or not fullscreen mode is enabled.
//	 * @return true if enabled
//	 */
//	public static boolean isFullscreen() { return fullscreen; }

	/**
	 * Returns whether or not the FPS counter display is enabled.
	 * @return true if enabled
	 */
	public static boolean isFPSCounterEnabled() { return showFPS; }

	/**
	 * Returns whether or not hit lighting effects are enabled.
	 * @return true if enabled
	 */
	public static boolean isHitLightingEnabled() { return showHitLighting; }

	/**
	 * Returns whether or not combo burst effects are enabled.
	 * @return true if enabled
	 */
	public static boolean isComboBurstEnabled() { return showComboBursts; }

	/**
	 * Returns the port number to bind to.
	 * @return the port
	 */
	public static int getPort() { return port; }

	/**
	 * Returns whether or not the new cursor type is enabled.
	 * @return true if enabled
	 */
	public static boolean isNewCursorEnabled() { return newCursor; }

	/**
	 * Returns whether or not the main menu background should be the current track image.
	 * @return true if enabled
	 */
	public static boolean isDynamicBackgroundEnabled() { return dynamicBackground; }

	/**
	 * Returns whether or not to show perfect hit result bursts.
	 * @return true if enabled
	 */
	public static boolean isPerfectHitBurstEnabled() { return showPerfectHit; }

	/**
	 * Returns the background dim level.
	 * @return the alpha level [0, 1]
	 */
	public static float getBackgroundDim() { return (100 - backgroundDim) / 100f; }

	/**
	 * Returns whether or not to override the song background with the default playfield background.
	 * @return true if forced
	 */
	public static boolean isDefaultPlayfieldForced() { return forceDefaultPlayfield; }

	/**
	 * Returns whether or not beatmap skins are ignored.
	 * @return true if ignored
	 */
	public static boolean isBeatmapSkinIgnored() { return ignoreBeatmapSkins; }

	/**
	 * Returns the fixed circle size override, if any.
	 * @return the CS value (0, 10], 0 if disabled
	 */
	public static float getFixedCS() { return fixedCS; }

	/**
	 * Returns the fixed HP drain rate override, if any.
	 * @return the HP value (0, 10], 0 if disabled
	 */
	public static float getFixedHP() { return fixedHP; }

	/**
	 * Returns the fixed approach rate override, if any.
	 * @return the AR value (0, 10], 0 if disabled
	 */
	public static float getFixedAR() { return fixedAR; }

	/**
	 * Returns the fixed overall difficulty override, if any.
	 * @return the OD value (0, 10], 0 if disabled
	 */
	public static float getFixedOD() { return fixedOD; }

	/**
	 * Returns whether or not to render loading text in the splash screen.
	 * @return true if enabled
	 */
	public static boolean isLoadVerbose() { return loadVerbose; }

	/**
	 * Returns the track checkpoint time.
	 * @return the checkpoint time (in ms)
	 */
	public static int getCheckpoint() { return checkpoint * 1000; }

	/**
	 * Returns whether or not all sound effects are disabled.
	 * @return true if disabled
	 */
	public static boolean isSoundDisabled() { return disableSound; }

	/**
	 * Returns whether or not to use non-English metadata where available.
	 * @return true if Unicode preferred
	 */
	public static boolean useUnicodeMetadata() { return showUnicode; }

	/**
	 * Returns whether or not to play the theme song.
	 * @return true if enabled
	 */
	public static boolean isThemSongEnabled() { return themeSongEnabled; }

	/**
	 * Sets the track checkpoint time, if within bounds.
	 * @param time the track position (in ms)
	 * @return true if within bounds
	 */
	public static boolean setCheckpoint(int time) {
		if (time >= 0 && time < 3600) {
			checkpoint = time;
			return true;
		}
		return false;
	}

	/**
	 * Returns the left game key.
	 * @return the left key code
	 */
	public static int getGameKeyLeft() {
		if (keyLeft == Keyboard.KEY_NONE)
			keyLeft = Input.KEY_Z;
		return keyLeft;
	}

	/**
	 * Returns the right game key.
	 * @return the right key code
	 */
	public static int getGameKeyRight() {
		if (keyRight == Keyboard.KEY_NONE)
			keyRight = Input.KEY_X;
		return keyRight;
	}

	/**
	 * Returns the beatmap directory.
	 * If invalid, this will attempt to search for the directory,
	 * and if nothing found, will create one.
	 * @return the beatmap directory
	 */
	public static File getBeatmapDir() {
		if (beatmapDir != null && beatmapDir.isDirectory())
			return beatmapDir;

		// search for directory
		for (int i = 0; i < BEATMAP_DIRS.length; i++) {
			beatmapDir = new File(BEATMAP_DIRS[i]);
			if (beatmapDir.isDirectory())
				return beatmapDir;
		}
		beatmapDir.mkdir();  // none found, create new directory
		return beatmapDir;
	}

	/**
	 * Returns the OSZ archive directory.
	 * If invalid, this will create and return a "SongPacks" directory.
	 * @return the OSZ archive directory
	 */
	public static File getOSZDir() {
		if (oszDir != null && oszDir.isDirectory())
			return oszDir;

		oszDir = new File("SongPacks/");
		oszDir.mkdir();
		return oszDir;
	}

	/**
	 * Returns the screenshot directory.
	 * If invalid, this will return a "Screenshot" directory.
	 * @return the screenshot directory
	 */
	public static File getScreenshotDir() {
		if (screenshotDir != null && screenshotDir.isDirectory())
			return screenshotDir;

		screenshotDir = new File("Screenshots/");
		return screenshotDir;
	}

	/**
	 * Returns the current skin directory.
	 * If invalid, this will create a "Skins" folder in the root directory.
	 * @return the skin directory
	 */
	public static File getSkinDir() {
		if (skinDir != null && skinDir.isDirectory())
			return skinDir;

		skinDir = new File("Skins/");
		skinDir.mkdir();
		return skinDir;
	}

	/**
	 * Returns a dummy OsuFile containing the theme song.
	 * @return the theme song OsuFile
	 */
	public static OsuFile getOsuTheme() {
		String[] tokens = themeString.split(",");
		if (tokens.length != 4) {
			Log.error("Theme song string is malformed.");
			return null;
		}

		OsuFile osu = new OsuFile(null);
		osu.audioFilename = new File(tokens[0]);
		osu.title = tokens[1];
		osu.artist = tokens[2];
		try {
			osu.endTime = Integer.parseInt(tokens[3]);
		} catch (NumberFormatException e) {
			Log.error("Theme song length is not a valid integer", e);
			return null;
		}

		return osu;
	}

	/**
	 * Reads user options from the options file, if it exists.
	 */
	public static void parseOptions() {
		// if no config file, use default settings
		if (!OPTIONS_FILE.isFile()) {
			saveOptions();
			return;
		}

		try (BufferedReader in = new BufferedReader(new FileReader(OPTIONS_FILE))) {
			String line;
			String name, value;
			int i;
			while ((line = in.readLine()) != null) {
				line = line.trim();
				if (line.length() < 2 || line.charAt(0) == '#')
					continue;
				int index = line.indexOf('=');
				if (index == -1)
					continue;
				name = line.substring(0, index).trim();
				value = line.substring(index + 1).trim();
				switch (name) {
				case "BeatmapDirectory":
					beatmapDir = new File(value);
					break;
				case "OSZDirectory":
					oszDir = new File(value);
					break;
				case "ScreenshotDirectory":
					screenshotDir = new File(value);
					break;
				case "Skin":
					skinDir = new File(value);
					break;
				case "ThemeSong":
					themeString = value;
					break;
				case "Port":
					i = Integer.parseInt(value);
					if (i > 0 && i <= 65535)
						port = i;
					break;
				case "ScreenResolution":
					i = Integer.parseInt(value);
					if (i >= 0 && i < resolutions.length)
						resolutionIndex = i;
					break;
//				case "Fullscreen":
//					fullscreen = Boolean.parseBoolean(value);
//					break;
				case "FrameSync":
					i = Integer.parseInt(value);
					if (i >= 0 && i <= targetFPS.length)
						targetFPSindex = i;
					break;
				case "ScreenshotFormat":
					i = Integer.parseInt(value);
					if (i >= 0 && i < screenshotFormat.length)
						screenshotFormatIndex = i;
					break;
				case "FpsCounter":
					showFPS = Boolean.parseBoolean(value);
					break;
				case "ShowUnicode":
					showUnicode = Boolean.parseBoolean(value);
					break;
				case "NewCursor":
					newCursor = Boolean.parseBoolean(value);
					break;
				case "DynamicBackground":
					dynamicBackground = Boolean.parseBoolean(value);
					break;
				case "LoadVerbose":
					loadVerbose = Boolean.parseBoolean(value);
					break;
				case "VolumeMusic":
					i = Integer.parseInt(value);
					if (i >= 0 && i <= 100)
						musicVolume = i;
					break;
				case "VolumeEffect":
					i = Integer.parseInt(value);
					if (i >= 0 && i <= 100)
						effectVolume = i;
					break;
				case "VolumeHitSound":
					i = Integer.parseInt(value);
					if (i >= 0 && i <= 100)
						hitSoundVolume = i;
					break;
				case "Offset":
					i = Integer.parseInt(value);
					if (i >= -500 && i <= 500)
						musicOffset = i;
					break;
				case "DisableSound":
					disableSound = Boolean.parseBoolean(value);
					break;
				case "keyOsuLeft":
					if ((value.length() == 1 && Character.isLetterOrDigit(value.charAt(0))) ||
						(value.length() == 7 && value.startsWith("NUMPAD"))) {
						i = Keyboard.getKeyIndex(value);
						if (keyRight != i)
							keyLeft = i;
					}
					break;
				case "keyOsuRight":
					if ((value.length() == 1 && Character.isLetterOrDigit(value.charAt(0))) ||
						(value.length() == 7 && value.startsWith("NUMPAD"))) {
						i = Keyboard.getKeyIndex(value);
						if (keyLeft != i)
							keyRight = i;
					}
					break;
				case "DimLevel":
					i = Integer.parseInt(value);
					if (i >= 0 && i <= 100)
						backgroundDim = i;
					break;
				case "ForceDefaultPlayfield":
					forceDefaultPlayfield = Boolean.parseBoolean(value);
					break;
				case "IgnoreBeatmapSkins":
					ignoreBeatmapSkins = Boolean.parseBoolean(value);
					break;
				case "HitLighting":
					showHitLighting = Boolean.parseBoolean(value);
					break;
				case "ComboBurst":
					showComboBursts = Boolean.parseBoolean(value);
					break;
				case "PerfectHit":
					showPerfectHit = Boolean.parseBoolean(value);
					break;
				case "FixedCS":
					fixedCS = Float.parseFloat(value);
					break;
				case "FixedHP":
					fixedHP = Float.parseFloat(value);
					break;
				case "FixedAR":
					fixedAR = Float.parseFloat(value);
					break;
				case "FixedOD":
					fixedOD = Float.parseFloat(value);
					break;
				case "Checkpoint":
					setCheckpoint(Integer.parseInt(value));
					break;
				case "MenuMusic":
					themeSongEnabled = Boolean.parseBoolean(value);
					break;
				}
			}
		} catch (IOException e) {
			Log.error(String.format("Failed to read file '%s'.", OPTIONS_FILE.getAbsolutePath()), e);
		} catch (NumberFormatException e) {
			Log.warn("Format error in options file.", e);
			return;
		}
	}

	/**
	 * (Over)writes user options to a file.
	 */
	public static void saveOptions() {
		try (BufferedWriter writer = new BufferedWriter(new OutputStreamWriter(
				new FileOutputStream(OPTIONS_FILE), "utf-8"))) {
			// header
			SimpleDateFormat dateFormat = new SimpleDateFormat("EEEE, MMMM dd, yyyy");
			String date = dateFormat.format(new Date());
			writer.write("# opsu! configuration");
			writer.newLine();
			writer.write("# last updated on ");
			writer.write(date);
			writer.newLine();
			writer.newLine();

			// options
			writer.write(String.format("BeatmapDirectory = %s", getBeatmapDir().getAbsolutePath()));
			writer.newLine();
			writer.write(String.format("OSZDirectory = %s", getOSZDir().getAbsolutePath()));
			writer.newLine();
			writer.write(String.format("ScreenshotDirectory = %s", getScreenshotDir().getAbsolutePath()));
			writer.newLine();
			writer.write(String.format("Skin = %s", getSkinDir().getAbsolutePath()));
			writer.newLine();
			writer.write(String.format("ThemeSong = %s", themeString));
			writer.newLine();
			writer.write(String.format("Port = %d", port));
			writer.newLine();
			writer.write(String.format("ScreenResolution = %d", resolutionIndex));
			writer.newLine();
//			writer.write(String.format("Fullscreen = %b", fullscreen));
//			writer.newLine();
			writer.write(String.format("FrameSync = %d", targetFPSindex));
			writer.newLine();
			writer.write(String.format("FpsCounter = %b", showFPS));
			writer.newLine();
			writer.write(String.format("ShowUnicode = %b", showUnicode));
			writer.newLine();
			writer.write(String.format("ScreenshotFormat = %d", screenshotFormatIndex));
			writer.newLine();
			writer.write(String.format("NewCursor = %b", newCursor));
			writer.newLine();
			writer.write(String.format("DynamicBackground = %b", dynamicBackground));
			writer.newLine();
			writer.write(String.format("LoadVerbose = %b", loadVerbose));
			writer.newLine();
			writer.write(String.format("VolumeMusic = %d", musicVolume));
			writer.newLine();
			writer.write(String.format("VolumeEffect = %d", effectVolume));
			writer.newLine();
			writer.write(String.format("VolumeHitSound = %d", hitSoundVolume));
			writer.newLine();
			writer.write(String.format("Offset = %d", musicOffset));
			writer.newLine();
			writer.write(String.format("DisableSound = %b", disableSound));
			writer.newLine();
			writer.write(String.format("keyOsuLeft = %s", Keyboard.getKeyName(getGameKeyLeft())));
			writer.newLine();
			writer.write(String.format("keyOsuRight = %s", Keyboard.getKeyName(getGameKeyRight())));
			writer.newLine();
			writer.write(String.format("DimLevel = %d", backgroundDim));
			writer.newLine();
			writer.write(String.format("ForceDefaultPlayfield = %b", forceDefaultPlayfield));
			writer.newLine();
			writer.write(String.format("IgnoreBeatmapSkins = %b", ignoreBeatmapSkins));
			writer.newLine();
			writer.write(String.format("HitLighting = %b", showHitLighting));
			writer.newLine();
			writer.write(String.format("ComboBurst = %b", showComboBursts));
			writer.newLine();
			writer.write(String.format("PerfectHit = %b", showPerfectHit));
			writer.newLine();
			writer.write(String.format(Locale.US, "FixedCS = %.1f", fixedCS));
			writer.newLine();
			writer.write(String.format(Locale.US, "FixedHP = %.1f", fixedHP));
			writer.newLine();
			writer.write(String.format(Locale.US, "FixedAR = %.1f", fixedAR));
			writer.newLine();
			writer.write(String.format(Locale.US, "FixedOD = %.1f", fixedOD));
			writer.newLine();
			writer.write(String.format("Checkpoint = %d", checkpoint));
			writer.newLine();
			writer.write(String.format("MenuMusic = %b", themeSongEnabled));
			writer.newLine();
			writer.close();
		} catch (IOException e) {
			Log.error(String.format("Failed to write to file '%s'.", OPTIONS_FILE.getAbsolutePath()), e);
		}
	}
}