Mod options support (#58)

* mod options wip

* add more types

* yeah

* add 2nd arg

Author: Vortex2Oblivion

CHANGELOG.md

@@ -6,9 +6,13 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [1.0.3] - Unreleased
+
+### Added
+ - Added the ability for mods to create their own options through an `options.json` file
 
 ### Fixed
  - Note type textures not loading sometimes
+ - Switch Mod Menu not having a scrollfactor of 0, making mod options scroll with the camera.
 
 ## [1.0.2] - 7/20/25
 

source/modding/ModOptions.hx

@@ -0,0 +1,27 @@
+package modding;
+
+typedef ModOptions = {
+	var options:Array<ModOption>;
+}
+
+typedef ModOption = {
+	var name:String;
+	var description:String;
+	var type:ModOptionType;
+
+    @:optional
+	var save:String;
+    @:optional
+	var defaultValue:Dynamic;
+	@:optional
+	var values:Array<String>;
+    @:optional
+    var script:String;
+}
+
+enum abstract ModOptionType(String) to String from String {
+	var BOOL:String = "bool";
+    var STRING:String = "string";
+    var STATE:String = "state";
+    var SUBSTATE:String = "substate";
+}

source/modding/SwitchModSubstate.hx

@@ -1,5 +1,6 @@
 package modding;
 
+import flixel.group.FlxSpriteContainer.FlxTypedSpriteContainer;
 #if MODDING_ALLOWED
 import substates.MusicBeatSubstate;
 import utilities.Options;
@@ -16,7 +17,7 @@ class SwitchModSubstate extends MusicBeatSubstate {
 	var curSelected:Int = 0;
 	var ui_Skin:Null<String>;
 
-	public var page:FlxTypedGroup<ChangeModOption> = new FlxTypedGroup<ChangeModOption>();
+	public var page:FlxTypedSpriteContainer<ChangeModOption> = new FlxTypedSpriteContainer<ChangeModOption>();
 
 	public static var instance:SwitchModSubstate;
 
@@ -39,6 +40,7 @@ class SwitchModSubstate extends MusicBeatSubstate {
 		add(menuBG);
 
 		super.create();
+		page.scrollFactor.set();
 		add(page);
 
 		PolymodHandler.loadModMetadata();

source/modding/custom/CustomState.hx

@@ -1,5 +1,6 @@
 package modding.custom;
 
+#if HSCRIPT_ALLOWED
 import modding.scripts.ExecuteOn;
 import openfl.utils.Assets;
 import flixel.FlxG;
@@ -9,46 +10,50 @@ import flixel.FlxObject;
 import states.TitleState;
 import flixel.FlxObject;
 
+class CustomState extends MusicBeatState {
+	public var script:HScript;
+    public var scriptPath:String;
 
-class CustomState extends MusicBeatState{
-    public var script:HScript;
-    public static var instance:CustomState = null;
-    override function new(script:String){
-        if(Assets.exists(Paths.hx("classes/states/" + script))){
-            instance = this;
-            this.script = new HScript(Paths.hx("classes/states/" + script));
-            this.script.interp.variables.set("add", function(obj:FlxObject)
-            {
-                add(obj);
-            });
-        }
-        else{
-            trace('Could not find script at path ${script}', ERROR);
-            FlxG.switchState(() -> new TitleState());
-        }
-        super();
-    }
-    override function create(){
-        super.create();
-        call("createPost");
-    }
-    override function update(elapsed:Float){
-        call("update", [elapsed]);
+	public static var instance:CustomState = null;
+
+	override public function new(scriptPath:String) {
+		super();
+        this.scriptPath = scriptPath;
+	}
+
+	override function create() {
+		if (Assets.exists(Paths.hx("classes/states/" + scriptPath))) {
+			instance = this;
+			this.script = new HScript(Paths.hx("classes/states/" + scriptPath));
+		} else {
+			trace('Could not find script at path ${scriptPath}', ERROR);
+			FlxG.switchState(() -> new TitleState());
+		}
+		super.create();
+		call("createPost");
+	}
+
+	override function update(elapsed:Float) {
+		call("update", [elapsed]);
 		super.update(elapsed);
 		call("updatePost", [elapsed]);
-    }
-    override function beatHit(){
-        call("beatHit");
+	}
+
+	override function beatHit() {
+		call("beatHit");
 		super.beatHit();
 		call("beatHitPost");
-    }
-    override function stepHit(){
-        call("stepHit");
+	}
+
+	override function stepHit() {
+		call("stepHit");
 		super.stepHit();
 		call("stepHitPost");
-    }
-    override public function call(func:String, ?args:Array<Any>, executeOn:ExecuteOn = BOTH) {
-        super.call(func, args);
+	}
+
+	override public function call(func:String, ?args:Array<Any>, executeOn:ExecuteOn = BOTH) {
+		super.call(func, args);
 		script?.call(func, args);
 	}
-}
+}
+#end

source/modding/custom/CustomSubstate.hx

@@ -1,46 +1,53 @@
 package modding.custom;
 
+#if HSCRIPT_ALLOWED
 import openfl.utils.Assets;
 import modding.scripts.languages.HScript;
 import substates.MusicBeatSubstate;
 import flixel.FlxObject;
 
-class CustomSubstate extends MusicBeatSubstate{
-    public var script:HScript;
-    public static var instance:CustomSubstate = null;
-    override function new(script:String){
-        if(Assets.exists(Paths.hx("classes/substates/" + script))){
-            instance = this;
-            this.script = new HScript(Paths.hx("classes/substates/" + script));
-            this.script.interp.variables.set("add", function(obj:FlxObject)
-                {
-                    add(obj);
-                });
-        }
-        else
-            trace('Could not find script at path ${script}', ERROR);
-        super();
-    }
-    override function create(){
-        super.create();
-        call("createPost");
-    }
-    override function update(elapsed:Float){
-        call("update", [elapsed]);
+class CustomSubstate extends MusicBeatSubstate {
+	public var script:HScript;
+
+	public static var instance:CustomSubstate = null;
+    public var scriptPath:String;
+
+	override public function new(scriptPath:String) {
+		super();
+		this.scriptPath = scriptPath;
+	}
+
+	override public function create() {
+		if (Assets.exists(Paths.hx("classes/substates/" + scriptPath))) {
+			instance = this;
+			this.script = new HScript(Paths.hx("classes/substates/" + scriptPath));
+		} else {
+			trace('Could not find script at path ${scriptPath}', ERROR);
+		}
+		super.create();
+		call("createPost");
+	}
+
+	override public function update(elapsed:Float) {
+		call("update", [elapsed]);
 		super.update(elapsed);
 		call("updatePost", [elapsed]);
-    }
-    override function beatHit(){
-        call("beatHit");
+	}
+
+	override public function beatHit() {
+		call("beatHit");
 		super.beatHit();
 		call("beatHitPost");
-    }
-    override function stepHit(){
-        call("stepHit");
+	}
+
+	override function stepHit() {
+		call("stepHit");
 		super.stepHit();
 		call("stepHitPost");
-    }
-    public inline function call(func:String, ?args:Array<Dynamic>) {
-		script.call(func, args);
 	}
-}
+
+	public inline function call(func:String, ?args:Array<Dynamic>) {
+		script?.call(func, args);
+	}
+}
+#end

source/modding/scripts/languages/LuaScript.hx

@@ -3255,8 +3255,8 @@ class LuaScript extends Script {
 			return '${FlxG.random.int(100, 999)}.${FlxG.random.int(1, 99)}.${FlxG.random.int(1, 99)}.${FlxG.random.int(1, 99)}';
 		});
 
-		setFunction("getOption", function(saveStr:String) {
-			return Options.getData(saveStr);
+		setFunction("getOption", function(saveStr:String, saveKey:String = "main") {
+			return Options.getData(saveStr, saveKey);
 		});
 
 		setFunction("getCurrentMod", function(saveStr:String) {

source/states/OptionsMenu.hx

@@ -1,5 +1,6 @@
 package states;
 
+import haxe.Json;
 import flixel.text.FlxText;
 import flixel.util.FlxColor;
 import utilities.MusicUtilities;
@@ -21,6 +22,9 @@ class OptionsMenu extends MusicBeatState {
 			new PageOption("Gameplay", "Gameplay", "Change gameplay-related options,\nsuch as downscroll and ghost tapping."),
 			new PageOption("Graphics", "Graphics", "Change graphical-related options,\nsuch as max FPS."),
 			new PageOption("Misc", "Misc", "Change miscellaneous options that\ndon't fit in the other categories."),
+			#if MODDING_ALLOWED
+			new PageOption("Mod Options", "Mod Options", "Change options for specific mods."),
+			#end
 			new PageOption("Developer Options", "Developer Options", "Change options for developing mods.")
 		],
 		"Gameplay" => [
@@ -40,7 +44,7 @@ class OptionsMenu extends MusicBeatState {
 			new StringSaveOption("Hitsound", CoolUtil.coolTextFile(Paths.txt("hitsoundList")), "hitsound", "Change the hitsound used when hitting a note.")
 		],
 		"Graphics" => [
-			new PageOption("Back", "Categories",  "Go back to the main menu."),
+			new PageOption("Back", "Categories", "Go back to the main menu."),
 			new PageOption("Note Options", "Note Options", "Change note-related options."),
 			new PageOption("Info Display", "Info Display", "Change optiosn related to the info display.\n(FPS counter, memory display, etc)."),
 			new PageOption("Optimizations", "Optimizations", "Change optimization options, such as anitaliasing."),
@@ -155,12 +159,16 @@ class OptionsMenu extends MusicBeatState {
 		"Developer Options" => [
 			new PageOption("Back", "Categories", "Go back to the main menu."),
 			new BoolOption("Developer Mode", "developer", "When toggled, enables developer tools.\n(traced lines display, toolbox, etc)"),
-			new DeveloperOption("Throw Exception On Error", "throwExceptionOnError", "When toggled, the game will throw an\nexception when an error is thrown."),
+			new DeveloperOption("Throw Exception On Error", "throwExceptionOnError",
+				"When toggled, the game will throw an\nexception when an error is thrown."),
 			new DeveloperOption("Auto Open Charter", "autoOpenCharter",
 				"When toggled, the game will automatically\nopen the chart editor when no chart is found."),
 			new StepperSaveDeveloperOption("Chart Backup Interval", 1, 10, "backupDuration", 1,
 				"Change how long the game will wait\nbefore creating a chart backup.\n(in minutes.)"),
-		]
+		],
+		#if MODDING_ALLOWED
+		"Mod Options" => [new PageOption("Back", "Categories", "Go back to the main menu."),]
+		#end
 	];
 
 	public var page:FlxTypedGroup<Option> = new FlxTypedGroup<Option>();
@@ -185,6 +193,31 @@ class OptionsMenu extends MusicBeatState {
 	}
 
 	public override function create():Void {
+		#if MODDING_ALLOWED
+		for (mod in modding.ModList.getActiveMods(modding.PolymodHandler.metadataArrays)) {
+			pages.get("Mod Options").push(new PageOption(mod, mod, modding.ModList.modMetadatas.get(mod).description));
+			pages.set(mod, [new PageOption("Back", "Mod Options", "Go back to mod options.")]);
+			if (sys.FileSystem.exists('mods/$mod/data/options.json')) {
+				var modOptions:modding.ModOptions = cast Json.parse(sys.io.File.getContent('mods/$mod/data/options.json'));
+				for (option in modOptions.options) {
+					switch (StringTools.trim(option.type).toLowerCase()) { // thank you haxe for not wanting to cast it to a string.
+						case "bool":
+							pages.get(mod).push(new BoolOption(option.name, option.save, option.description, mod));
+						case "string":
+							pages.get(mod).push(new StringSaveOption(option.name, option.values, option.save, option.description, mod));
+						#if HSCRIPT_ALLOWED
+						case "state":
+							pages.get(mod).push(new GameStateOption(option.name, new modding.custom.CustomState(option.script), option.description));
+						case "substate":
+							pages.get(mod).push(new GameSubStateOption(option.name, new modding.custom.CustomSubstate(option.script), option.description));
+						#end
+						default:
+							throw 'Option type \'${option.type}\' is not a valid option type!';
+					}
+				}
+			}
+		}
+		#end
 		MusicBeatState.windowNameSuffix = "";
 		instance = this;
 

source/states/TitleState.hx

@@ -71,7 +71,6 @@ class TitleState extends MusicBeatState {
 			NoteVariables.init();
 
 			Options.init();
-			Options.fixBinds();
 
 			LogStyle.ERROR.throwException = Options.getData("throwExceptionOnError");
 
@@ -89,6 +88,7 @@ class TitleState extends MusicBeatState {
 			PolymodHandler.loadMods();
 			MusicBeatState.windowNamePrefix = Options.getData("curMod");
 			CoolUtil.setWindowIcon("mods/" + Options.getData("curMod") + "/_polymod_icon.png");
+			Options.initModOptions();
 			#end
 			NoteVariables.init();
 			Options.fixBinds();