Add modcharting features (using FunkinModchart)

FEATURES.md

@@ -79,4 +79,5 @@ _**QOL = Quality of Life**_
 		- Features not found in other editors!
     - Every single state & substate can be modified via HScript (`data/states/StateName.hx`)
 - **Instances launched via `lime test windows` will automatically use assets from source.**
-</details>
+- Modcharting features powered by [FunkinModchart](https://lib.haxe.org/p/funkin-modchart/).
+</details>

README.md

@@ -86,4 +86,5 @@ In the future (when the engine won't be a WIP anymore) we're gonna also publish
 - Credits to the [FlxAnimate](https://github.com/Dot-Stuff/flxanimate) team for the Animate Atlas support
 - Credits to Smokey555 for the backup Animate Atlas to spritesheet code
 - Credits to MAJigsaw77 for [hxvlc](https://github.com/MAJigsaw77/hxvlc) (video cutscene/mp4 support) and [hxdiscord_rpc](https://github.com/MAJigsaw77/hxdiscord_rpc) (discord rpc integration)
+- Credits to [TheoDev](https://github.com/TheoDevelops) for [FunkinModchart](https://lib.haxe.org/p/funkin-modchart/). ***(library used for modcharting features)***
 </details>

libs.xml

@@ -13,6 +13,7 @@
 	<git name="flxanimate" url="https://github.com/CodenameCrew/cne-flxanimate" />
 	<git name="hxdiscord_rpc" url="https://github.com/CodenameCrew/cne-hxdiscord_rpc" />
 	<lib name="hxvlc" version="1.9.3" skipDeps="true" />
+	<lib name="funkin-modchart" skipDeps="true" />
 
 	<!-- Documentation and other features -->
 	<git name="away3d" url="https://github.com/CodenameCrew/away3d" />

project.xml

@@ -159,6 +159,9 @@
 	<!-- Comment this out to disable dark mode windows -->
 	<define name="DARK_MODE_WINDOW"/>
 
+	<!-- Comment this out to disable modcharting features -->
+	<define name="MODCHARTING_FEATURES"/>
+
 	<!-- Disable a optimization, to allow reflection to use more functions -->
 	<define name="FLX_NO_GENERIC" />
 
@@ -195,6 +198,14 @@
 
 	<!-- _________________________________ Additional stuff _______________________________ -->
 
+	<section if="MODCHARTING_FEATURES">
+		<haxedef name="FM_ENGINE" value="CODENAME"/>
+		<haxedef name="FM_ENGINE_VERSION" value="1.0"/>
+
+		<haxelib name="funkin-modchart" />
+		<haxeflag name="--macro" value="modchart.core.macros.Macro.includeFiles()"/>
+	</section>
+
 	<section if="COMPILE_ALL_CLASSES">
 		<haxeflag name="-dce" value="no" />
 		<haxeflag name="--macro" value="funkin.backend.system.macros.Macros.addAdditionalClasses()" />

source/funkin/game/Note.hx

@@ -53,6 +53,13 @@ class Note extends FlxSprite
 	 */
 	public var nextSustain:Note;
 
+	/**
+	 * The parent of the sustain.
+	 * 
+	 * If this note is not sustain, this will be null.
+	 */
+	public var sustainParent:Null<Note>;
+
 	/**
 	 * Name of the splash.
 	 */
@@ -128,6 +135,10 @@ class Note extends FlxSprite
 			}
 		}
 
+		// work around to set the `sustainParent`
+		if (isSustainNote)
+			sustainParent = prevNote.isSustainNote ? prevNote.sustainParent : prevNote;
+
 		x += 50;
 		// MAKE SURE ITS DEFINITELY OFF SCREEN?
 		y -= 2000;

source/funkin/game/Strum.hx

@@ -11,6 +11,11 @@ class Strum extends FlxSprite {
 	 */
 	public var animSuffix:String = "";
 
+	/**
+	 * This strum's StrumLine
+	 */
+	public var strumLine:StrumLine;
+
 	public var cpu = false; // Unused
 	public var lastHit:Float = -5000;
 

source/funkin/game/StrumLine.hx

@@ -307,6 +307,7 @@ class StrumLine extends FlxTypedGroup<Strum> {
 			animPrefix = strumAnimPrefix[i % strumAnimPrefix.length];
 		var babyArrow:Strum = new Strum(startingPos.x + ((Note.swagWidth * strumScale) * i), startingPos.y);
 		babyArrow.ID = i;
+		babyArrow.strumLine = this;
 
 		if(data.scrollSpeed != null)
 			babyArrow.scrollSpeed = data.scrollSpeed;

source/funkin/options/Options.hx

@@ -35,6 +35,9 @@ class Options
 	public static var songOffset:Float = 0;
 	public static var framerate:Int = 120;
 	public static var gpuOnlyBitmaps:Bool = #if (mac || web) false #else true #end; // causes issues on mac and web
+	#if MODCHARTING_FEATURES
+	public static var modchartHoldSubdivisions:Int = 4;
+	#end
 
 	public static var lastLoadedMod:String = null;
 

source/funkin/options/OptionsMenu.hx

@@ -24,6 +24,13 @@ class OptionsMenu extends TreeMenu {
 			desc: 'Change Appearance options such as Flashing menus...',
 			state: AppearanceOptions
 		},
+		#if MODCHARTING_FEATURES
+		{
+			name: 'Modchart Settings >',
+			desc: 'Customize your modcharting experience...',
+			state: ModchartingOptions
+		},
+		#end
 		{
 			name: 'Miscellaneous >',
 			desc: 'Use this menu to reset save data or engine settings.',

source/funkin/options/categories/AppearanceOptions.hx

@@ -56,4 +56,4 @@ class AppearanceOptions extends OptionsScreen {
 		else
 			FlxG.updateFramerate = FlxG.drawFramerate = Std.int(change);
 	}
-}
+}

source/funkin/options/categories/ModchartingOptions.hx

@@ -0,0 +1,17 @@
+package funkin.options.categories;
+
+#if MODCHARTING_FEATURES
+class ModchartingOptions extends OptionsScreen {
+	public override function new() {
+		super("Modcharting Options", "Customize your modcharting experience.");
+		add(new NumOption(
+			"Hold Subdivisions",
+			"Softens the tail/hold/sustain of the arrows by subdividing it, giving them greater quality. By higher the subdivisions number is, performance will be affected.",
+			1, // minimum
+			128, // maximum
+			1, // change
+			"modchartHoldSubdivisions" // save name
+			)); // callback
+	}
+}
+#end

source/modchart/standalone/adapters/codename/Codename.hx

@@ -0,0 +1,163 @@
+package modchart.standalone.adapters.codename;
+
+import flixel.FlxCamera;
+import flixel.FlxSprite;
+import funkin.backend.system.Conductor;
+import funkin.game.Note;
+import funkin.game.PlayState;
+import funkin.game.Strum;
+import funkin.options.Options;
+import modchart.standalone.IAdapter;
+
+class Codename implements IAdapter {
+	private var beatCrochet:Float = 0;
+
+	public function onModchartingInitialization() {
+		beatCrochet = Conductor.crochet;
+	}
+
+	public function isTapNote(sprite:FlxSprite) {
+		return sprite is Note;
+	}
+
+	// Song related
+	public function getSongPosition():Float {
+		return Conductor.songPosition;
+	}
+
+	public function getCurrentBeat():Float {
+		return Conductor.curBeatFloat;
+	}
+
+	public function getStaticCrochet():Float {
+		return beatCrochet;
+	}
+
+	public function getBeatFromStep(step:Float):Float {
+		return step * Conductor.stepsPerBeat;
+	}
+
+	public function arrowHit(arrow:FlxSprite) {
+		if (arrow is Note) {
+			final note:Note = cast arrow;
+			return note.wasGoodHit;
+		}
+		return false;
+	}
+
+	public function isHoldEnd(arrow:FlxSprite) {
+		if (arrow is Note) {
+			final note:Note = cast arrow;
+			return note.nextSustain == null;
+		}
+		return false;
+	}
+
+	public function getLaneFromArrow(arrow:FlxSprite) {
+		if (arrow is Note) {
+			final note:Note = cast arrow;
+			return note.strumID;
+		} else if (arrow is Strum) {
+			final strum:Strum = cast arrow;
+			return strum.ID;
+		}
+		return 0;
+	}
+
+	public function getPlayerFromArrow(arrow:FlxSprite) {
+		if (arrow is Note) {
+			final note:Note = cast arrow;
+			return note.strumLine.ID;
+		} else if (arrow is Strum) {
+			final strum:Strum = cast arrow;
+			return strum.strumLine.ID;
+		}
+
+		return 0;
+	}
+
+	public function getHoldParentTime(arrow:FlxSprite) {
+		final note:Note = cast arrow;
+		return note.sustainParent.strumTime;
+	}
+
+	// im so fucking sorry for those conditionals
+	public function getKeyCount(?player:Int = 0):Int {
+		return PlayState.instance != null
+			&& PlayState.instance.strumLines != null
+			&& PlayState.instance.strumLines.members != null
+			&& PlayState.instance.strumLines.members[player] != null
+			&& PlayState.instance.strumLines.members[player].members != null ? PlayState.instance.strumLines.members[player].members.length : 4;
+	}
+
+	public function getPlayerCount():Int {
+		return PlayState.instance != null && PlayState.instance.strumLines != null ? PlayState.instance.strumLines.length : 2;
+	}
+
+	public function getTimeFromArrow(arrow:FlxSprite) {
+		if (arrow is Note) {
+			final note:Note = cast arrow;
+			return note.strumTime;
+		}
+
+		return 0;
+	}
+
+	public function getHoldSubdivisions():Int
+		return Options.modchartHoldSubdivisions;
+
+	public function getDownscroll():Bool
+		return Options.downscroll;
+
+	public function getDefaultReceptorX(lane:Int, player:Int):Float {
+		@:privateAccess
+		return PlayState.instance.strumLines.members[player].members[lane].x;
+	}
+
+	public function getDefaultReceptorY(lane:Int, player:Int):Float {
+		@:privateAccess
+		return PlayState.instance.strumLines.members[player].members[lane].y;
+	}
+
+	public function getArrowCamera():Array<FlxCamera>
+		return [PlayState.instance.camHUD];
+
+	public function getCurrentScrollSpeed():Float {
+		return PlayState.instance.scrollSpeed;
+	}
+
+	public function getArrowItems() {
+		var drawMembers:Array<Array<Array<FlxSprite>>> = [];
+		var strumLineMembers = PlayState.instance.strumLines.members;
+
+		for (i in 0...strumLineMembers.length) {
+			final sl = strumLineMembers[i];
+
+			if (!sl.visible)
+				continue;
+
+			// setup list
+			drawMembers[i] = [
+				cast sl.members.copy(),
+				[],
+				[]
+			];
+
+			// preallocating first
+			var st = 0;
+			var nt = 0;
+			sl.notes.forEachAlive((spr) -> {
+				spr.isSustainNote ? st++ : nt++;
+			});
+
+			drawMembers[i][1].resize(nt);
+			drawMembers[i][2].resize(st);
+
+			var si = 0;
+			var ni = 0;
+			sl.notes.forEachAlive((spr) -> drawMembers[i][spr.isSustainNote ? 2 : 1][spr.isSustainNote ? si++ : ni++] = spr);
+		}
+
+		return drawMembers;
+	}
+}