SettingsConfig.java

package hunternif.mc.atlas;

import net.minecraftforge.common.config.Configuration;

import java.io.File;

/** Config for various performance and interface settings. */
public class SettingsConfig {
	private static final int VERSION = 4;
	
	private static final String GAMEPLAY = "Gameplay";
	private static final String INTERFACE = "Interface";
	private static final String PERFORMANCE = "Performance";

	private File configFile;
	private Configuration config;
	
	//TODO make these options configurable via an in-game GUI menu
	
	//============= Gameplay settings =============
	public boolean doSaveBrowsingPos = true;
	public boolean autoDeathMarker = true;
	public boolean autoVillageMarkers = true;
	public boolean itemNeeded = true;
	
	//============ Interface settings =============
	public boolean doScaleMarkers = false;
	public double defaultScale = 0.5f;
	public double minScale = 1.0 / 32.0;
	public double maxScale = 4;
	public boolean doReverseWheelZoom = false;
	
	//=========== Performance settings ============
	public int scanRadius = 11;
	public boolean forceChunkLoading = false;
	public float newScanInterval = 1f;
	public boolean doRescan = true;
	public int rescanRate = 4;
	public boolean doScanPonds = true;
	public boolean debugRender = false;
	
	public void load(File file) {
		configFile = file;
		config = new Configuration(file, String.valueOf(VERSION));
		config.setCategoryComment(GAMEPLAY,
				"These settings will affect how the mod behaves in certain situations and the players' overall gameplay,\n"
				+ "but generally won't affect performance.");
		config.setCategoryComment(INTERFACE,
				"These setting will affect the look and feel of the Atlas' interface.");
		config.setCategoryComment(PERFORMANCE,
				"These settings affect the algorithms for scanning the world, drawing the map etc. Changing them may\n"
				+ "improve the game's overall stability and performance at the cost of Atlas' functionality.");
		
		doSaveBrowsingPos = config.getBoolean("do_save_browsing_pos", GAMEPLAY, doSaveBrowsingPos,
				"Whether to remember last open browsing position and zoom level for each dimension in every atlas.\n"
				+ "If disabled, all dimensions and all atlases will be \"synchronized\" at the same coordinates and\n"
				+ "zoom level, and map will \"follow\" player by default.");
		autoDeathMarker = config.getBoolean("auto_death_marker", GAMEPLAY, autoDeathMarker,
				"Whether to add local marker for the spot where the player died.");
		autoVillageMarkers = config.getBoolean("auto_village_markers", GAMEPLAY, autoVillageMarkers,
				"Whether to add global markers for NPC villages.");
		itemNeeded = config.getBoolean("item_needed", GAMEPLAY, itemNeeded,
				"Player will need to craft atlas item to use atlas.");
		
		defaultScale = config.getFloat("default_scale", INTERFACE, (float)defaultScale, 0.001953125f, 16,
				"Default zoom level. The number corresponds to the size of a block on the map relative to the size of\n"
				+ "a GUI pixel. Preferrably a power of 2.");
		minScale = config.getFloat("min_scale", INTERFACE, (float)minScale, 0.001953125f, 16,
				"Minimum zoom level. The number corresponds to the size of a block on the map relative to the size of\n"
				+ "a GUI pixel. Preferrably a power of 2. Smaller values may decrease performance!");
		maxScale = config.getFloat("max_scale", INTERFACE, (float)maxScale, 0.001953125f, 16,
				"Maximum zoom level. The number corresponds to the size of a block on the map relative to the size of\n"
				+ "a GUI pixel. Preferrably a power of 2.");
		doScaleMarkers = config.getBoolean("do_scale_markers", INTERFACE, doScaleMarkers, "Whether to change markers size depending on zoom level.");
		doReverseWheelZoom = config.getBoolean("do_reverse_wheel_zoom", INTERFACE, doReverseWheelZoom,
				"If false (by default), then mousewheel up is zoom in, mousewheel down is zoom out.\nIf true, then the direction is reversed.");
		
		scanRadius = config.getInt("area_scan_radius", PERFORMANCE, scanRadius, 1, 256,
				"The radius of the area around the player which is scanned by the Atlas at regular intervals.\n"
				+ "Note that this will not force faraway chunks to load, unless force_chunk_loading is enabled.\n"
				+ "Lower value gives better performance.");
		forceChunkLoading = config.getBoolean("force_chunk_loading", PERFORMANCE, forceChunkLoading, 
				"Force loading of chunks within scan radius even if it exceeds regular chunk loading distance.\n"
				+ "Enabling this may SEVERELY decrease performance!");
		newScanInterval = config.getFloat("area_scan_interval", PERFORMANCE, newScanInterval, 1f/20f, 3600, 
				"Time in seconds between two scans of the area.\nHigher value gives better performance.");
		doRescan = config.getBoolean("do_rescan", PERFORMANCE, doRescan, 
				"Whether to rescan chunks in the area that have been previously mapped. This is useful in case of\n"
				+ "changes in coastline (including small ponds of water and lava), or if land disappears completely\n"
				+ "(for sky worlds).\nDisable for better performance.");
		rescanRate = config.getInt("area_rescan_rate", PERFORMANCE, rescanRate, 1, 1000, 
				"The number of area scans between full rescans.\nHigher value gives better performance.");
		doScanPonds = config.getBoolean("do_scan_ponds", PERFORMANCE, doScanPonds,
				"Whether to perform additional scanning to locate small ponds of water or lava.\nDisable for better performance.");
		
		debugRender = config.getBoolean("debug_rendering", PERFORMANCE, debugRender,
				"If true, map render time will be output.");


		config.save();
	}
	
	public void save(File file) {
		if (configFile == null || !configFile.equals(file)) {
			load(file);
		}

		config.save();
	}
}