Merge branch 'develop' into album-stickers-metadata

Author: Starexify

.gitignore

@@ -13,6 +13,10 @@ shitAudio/
 .swp
 NewgroundsCredentials.hx
 
+# Exclude IntelliJ IDEA stuff
+.idea/
+*.iml
+
 # Mobile signing stuff
 .apple/
 .env

hmm.json

@@ -123,10 +123,8 @@
     },
     {
       "name": "hxdiscord_rpc",
-      "type": "git",
-      "dir": null,
-      "ref": "82c47ecc1a454b7dd644e4fcac7e91155f176dec",
-      "url": "https://github.com/FunkinCrew/hxdiscord_rpc"
+      "type": "haxelib",
+      "version": "1.3.0"
     },
     {
       "name": "hxjsonast",
@@ -154,7 +152,7 @@
       "name": "json2object",
       "type": "git",
       "dir": null,
-      "ref": "589cad78fe2ff91eb3253a673071293ba0233c2c",
+      "ref": "a7e4cef3d444bea8d8244d6e59ab82f5a593f597",
       "url": "https://github.com/FunkinCrew/json2object"
     },
     {

project.hxp

@@ -493,6 +493,13 @@ class Project extends HXProject
    */
   static final FEATURE_VIDEO_SUBTITLES:FeatureFlag = "FEATURE_VIDEO_SUBTITLES";
 
+  /**
+   * `-DFEATURE_DEBUG_DISPLAY`
+   * If this flag is enabled, the game will be able to show a framerate counter with the memory and current FPS
+   * This flag is disabled on non debug mobile builds
+   */
+  static final FEATURE_DEBUG_DISPLAY:FeatureFlag = "FEATURE_DEBUG_DISPLAY";
+
   //
   // CONFIGURATION FUNCTIONS
   //
@@ -892,6 +899,10 @@ class Project extends HXProject
     // It's kept off for desktop due to the low ASTC support on desktop GPUs (which seem to be only among Intergrated Graphics).
     FEATURE_COMPRESSED_TEXTURES.apply(this, isMobile() && isRelease() && !isIOSSimulator());
 
+    // Turns the debug display off if you are on a non debug mobile build
+    // Desktop (Native and Web) always has it | Used for mobile debugging purposes
+    FEATURE_DEBUG_DISPLAY.apply(this, !isMobile() || FEATURE_DEBUG_FUNCTIONS.isEnabled(this));
+
     renderFlagsTable();
   }
 
@@ -1385,6 +1396,11 @@ class Project extends HXProject
     addAssetLibrary("default", shouldEmbed, shouldPreloadDefault);
     addAssetPath("assets/preload", "assets", "default", ["*"], exclude, shouldEmbed, "assets");
 
+    if (!HARDCODED_CREDITS.isEnabled(this))
+    {
+      addAsset("assets/exclude/data/credits.json", "assets/data/credits.json", "default", shouldEmbed);
+    }
+
     if (!FEATURE_ANIMATION_EDITOR.isEnabled(this))
       removeAssetPath('assets/preload/data/ui/animation-editor', "default");
 
@@ -1457,13 +1473,21 @@ class Project extends HXProject
     var basePath:String = Path.join([exportPath, platform, "bin"]);
     var assetsPath:String = "";
 
-    if (isMacHost())
+    switch(platformType)
     {
-      assetsPath = Path.join([basePath, '${this.app.file}.app', "Contents", "Resources", "assets"]);
-    }
-    else
-    {
-      assetsPath = Path.join([basePath, "assets"]);
+      case PlatformType.DESKTOP:
+        if (isMacHost())
+        {
+          assetsPath = Path.join([basePath, '${this.app.file}.app', "Contents", "Resources", "assets"]);
+        }
+        else
+        {
+          assetsPath = Path.join([basePath, "assets"]);
+        }
+
+      default:
+        // Don't do this for other platform types yet.
+        return;
     }
 
     if (sys.FileSystem.exists(assetsPath))

source/funkin/InitState.hx

@@ -402,7 +402,11 @@ class InitState extends FlxState
     }
     else if (params.song.shouldLoadSong && params.song.songPath != null)
     {
+      #if sys
       FlxG.switchState(() -> new ChartPlaytestMenu(params.song.songPath));
+      #else
+      FlxG.switchState(() -> new TitleState());
+      #end
     }
     else
     {

source/funkin/Preferences.hx

@@ -137,14 +137,14 @@ class Preferences
 
   /**
    * If enabled, an FPS and memory counter will be displayed even if this is not a debug build.
-   * Always disabled on mobile.
+   * Always disabled on release mobile builds.
    * @default `Off`
    */
   public static var debugDisplay(get, set):DebugDisplayMode;
 
   static function get_debugDisplay():DebugDisplayMode
   {
-    #if mobile
+    #if NO_FEATURE_DEBUG_DISPLAY
     return DebugDisplayMode.Off;
     #end
 
@@ -267,27 +267,6 @@ class Preferences
     return value;
   }
 
-  #if FEATURE_VIDEO_SUBTITLES
-  /**
-   * If enabled, subtitles will be shown on video cutscenes.
-   * @default `true`
-   */
-  public static var videoSubtitles(get, set):Bool;
-
-  static function get_videoSubtitles():Bool
-  {
-    return Save?.instance?.options?.videoSubtitles ?? true;
-  }
-
-  static function set_videoSubtitles(value:Bool):Bool
-  {
-    var save:Save = Save.instance;
-    save.options.videoSubtitles = value;
-    save.flush();
-    return value;
-  }
-  #end
-
   /**
    * If enabled, the game will automatically launch in fullscreen on startup.
    * @default `true`
@@ -541,6 +520,25 @@ class Preferences
     Main.debugDisplay.backgroundOpacity = value;
   }
 
+  /**
+   * If enabled, subtitles will appear during some songs and cutscenes.
+   * @default `true`
+   */
+  public static var subtitles(get, set):Bool;
+
+  static function get_subtitles():Bool
+  {
+    return Save?.instance?.options?.subtitles ?? true;
+  }
+
+  static function set_subtitles(value:Bool):Bool
+  {
+    var save:Save = Save.instance;
+    save.options.subtitles = value;
+    save.flush();
+    return value;
+  }
+
   #if mobile
   /**
    * If enabled, device will be able to sleep on its own.

source/funkin/api/discord/DiscordClient.hx

@@ -31,7 +31,7 @@ class DiscordClient
   {
     trace('[DISCORD] Initializing event handlers...');
 
-    handlers = DiscordEventHandlers.create();
+    handlers = new DiscordEventHandlers();
 
     handlers.ready = cpp.Function.fromStaticFunction(onReady);
     handlers.disconnected = cpp.Function.fromStaticFunction(onDisconnected);
@@ -50,7 +50,7 @@ class DiscordClient
 
     @:nullSafety(Off)
     {
-      Discord.Initialize(DISCORD_CLIENT_ID, cpp.RawPointer.addressOf(handlers), 1, "");
+      Discord.Initialize(DISCORD_CLIENT_ID, cpp.RawPointer.addressOf(handlers), false, "");
     }
 
     createDaemon();
@@ -79,7 +79,7 @@ class DiscordClient
       Discord.updateConnection();
       #end
 
-      Discord.runCallbacks();
+      Discord.RunCallbacks();
       Sys.sleep(2);
     }
   }
@@ -88,17 +88,12 @@ class DiscordClient
   {
     trace('[DISCORD] Shutting down...');
 
-    Discord.shutdown();
+    Discord.Shutdown();
   }
 
   public function setPresence(params:DiscordClientPresenceParams):Void
   {
-    Discord.updatePresence(buildPresence(params));
-  }
-
-  function buildPresence(params:DiscordClientPresenceParams):DiscordRichPresence
-  {
-    var presence = DiscordRichPresence.create();
+    var presence:DiscordRichPresence = new DiscordRichPresence();
 
     // Presence should always be playing the game.
     presence.type = DiscordActivityType_Playing;
@@ -129,17 +124,17 @@ class DiscordClient
     // presence.startTimestamp = time - 10;
     // presence.endTimestamp = time + 30;
 
-    final button1:DiscordButton = DiscordButton.create();
+    final button1:DiscordButton = new DiscordButton();
     button1.label = "Play on Web";
     button1.url = Constants.URL_NEWGROUNDS;
     presence.buttons[0] = button1;
 
-    final button2:DiscordButton = DiscordButton.create();
+    final button2:DiscordButton = new DiscordButton();
     button2.label = "Download";
     button2.url = Constants.URL_ITCH;
     presence.buttons[1] = button2;
 
-    return presence;
+    Discord.UpdatePresence(cpp.RawConstPointer.addressOf(presence));
   }
 
   // TODO: WHAT THE FUCK get this pointer bullfuckery out of here

source/funkin/play/GameOverSubState.hx

@@ -499,9 +499,9 @@ class GameOverSubState extends MusicBeatSubState
       else
       {
         onComplete = function() {
-          isStarting = true;
+          isStarting = false;
           // We need to force to ensure that the non-starting music plays.
-          startDeathMusic(0.0, true);
+          startDeathMusic(1.0, true);
         };
       }
     }

source/funkin/play/PlayState.hx

@@ -38,6 +38,7 @@ import funkin.play.character.BaseCharacter;
 import funkin.data.character.CharacterData.CharacterDataParser;
 import funkin.play.components.HealthIcon;
 import funkin.play.components.PopUpStuff;
+import funkin.play.components.Subtitles;
 import funkin.play.cutscene.dialogue.Conversation;
 import funkin.play.cutscene.VanillaCutscenes;
 import funkin.play.cutscene.VideoCutscene;
@@ -512,6 +513,11 @@ class PlayState extends MusicBeatSubState
    */
   public var healthBarBG:FunkinSprite;
 
+  /**
+   * A sprite group for subtitle display.
+   */
+  public var subtitles:Null<Subtitles>;
+
   /**
    * The health icon representing the player.
    */
@@ -558,6 +564,11 @@ class PlayState extends MusicBeatSubState
    */
   public var camCutouts:FlxCamera;
 
+  /**
+   * The camera which contains, and controls visibility of, the subtitles.
+   */
+  public var camSubtitles:FlxCamera;
+
   /**
    * The camera which contains, and controls visibility of, pause menu.
    */
@@ -724,6 +735,7 @@ class PlayState extends MusicBeatSubState
     camHUD = new FlxCamera();
     camCutscene = new FlxCamera();
     camCutouts = new FlxCamera();
+    camSubtitles = new FlxCamera();
     camPause = new FlxCamera();
 
     var currentChart = currentSong.getDifficulty(currentDifficulty, currentVariation);
@@ -1856,12 +1868,14 @@ class PlayState extends MusicBeatSubState
     camCutouts.setPosition((FlxG.width - FlxG.initialWidth) / 2, (FlxG.height - FlxG.initialHeight) / 2);
     camCutouts.setSize(FlxG.initialWidth, FlxG.initialHeight);
     camCutouts.bgColor.alpha = 0; // Show the game scene behind the camera.
+    if (Preferences.subtitles) camSubtitles.bgColor.alpha = 0; // Show the game scene behind the camera.
     camPause.bgColor.alpha = 0; // Show the game scene behind the camera.
 
     FlxG.cameras.reset(camGame);
     FlxG.cameras.add(camHUD, false);
     FlxG.cameras.add(camCutscene, false);
     FlxG.cameras.add(camCutouts, false);
+    if (Preferences.subtitles) FlxG.cameras.add(camSubtitles, false);
     FlxG.cameras.add(camPause, false);
 
     // Configure camera follow point.
@@ -1878,11 +1892,11 @@ class PlayState extends MusicBeatSubState
      */
   function initHealthBar():Void
   {
-    var healthBarYPos:Float = Preferences.downscroll ? FlxG.height * 0.1 : FlxG.height * 0.9;
-    #if mobile
-    if (Preferences.controlsScheme == FunkinHitboxControlSchemes.Arrows
-      && !ControlsHandler.usingExternalInputDevice) healthBarYPos = FlxG.height * 0.1;
-    #end
+    final isDownscroll:Bool = #if mobile (Preferences.controlsScheme == FunkinHitboxControlSchemes.Arrows
+      && !ControlsHandler.usingExternalInputDevice)
+      || #end Preferences.downscroll;
+
+    var healthBarYPos:Float = isDownscroll ? FlxG.height * 0.1 : FlxG.height * 0.9;
 
     healthBarBG.y = healthBarYPos;
     healthBarBG.screenCenter(X);
@@ -1911,6 +1925,21 @@ class PlayState extends MusicBeatSubState
     healthBar.cameras = [camHUD];
     healthBarBG.cameras = [camHUD];
     scoreText.cameras = [camHUD];
+
+    // Create subtitles if they are enabled.
+    if (Preferences.subtitles)
+    {
+      final isDownscroll:Bool = #if mobile (Preferences.controlsScheme == FunkinHitboxControlSchemes.Arrows
+        && !ControlsHandler.usingExternalInputDevice)
+        || #end Preferences.downscroll;
+
+      final subtitlesAlignment:SubtitlesAlignment = isDownscroll ? SubtitlesAlignment.SUBTITLES_TOP : SubtitlesAlignment.SUBTITLES_BOTTOM;
+      subtitles = new Subtitles(0, 139, subtitlesAlignment);
+      subtitles.zIndex = 10000;
+      add(subtitles);
+
+      subtitles.cameras = [camSubtitles];
+    }
   }
 
   /**
@@ -2472,6 +2501,16 @@ class PlayState extends MusicBeatSubState
     FlxG.sound.music.time = startTimestamp;
     FlxG.sound.music.pitch = playbackRate;
 
+    if (Preferences.subtitles)
+    {
+      var subtitlesFile:String = 'songs/${currentSong.id}/subtitles/song-lyrics';
+      if (currentVariation != Constants.DEFAULT_VARIATION)
+      {
+        subtitlesFile += '-${currentVariation}';
+      }
+      if (subtitles != null) subtitles.assignSubtitles(subtitlesFile, FlxG.sound.music);
+    }
+
     // Prevent the volume from being wrong.
     FlxG.sound.music.volume = 1.0;
     if (FlxG.sound.music.fadeTween != null) FlxG.sound.music.fadeTween.cancel();

source/funkin/play/cutscene/VideoCutscene.hx

@@ -73,13 +73,10 @@ class VideoCutscene
     if (!openfl.Assets.exists(filePath))
     {
       // Display a popup.
-      // funkin.util.WindowUtil.showError('Error playing video', 'Video file does not exist: ${filePath}');
-      // return;
-
-      // TODO: After moving videos to their own library,
-      // this function ALWAYS FAILS on web, but the video still plays.
-      // I think that's due to a weird quirk with how OpenFL libraries work.
+      funkin.util.WindowUtil.showError('Error playing video', 'Video file does not exist: ${filePath}');
       trace('Video file does not exist: ${filePath}');
+
+      return;
     }
 
     var rawFilePath = Paths.stripLibrary(filePath);
@@ -186,7 +183,7 @@ class VideoCutscene
       final fileOptions:Array<String> = [];
 
       #if FEATURE_VIDEO_SUBTITLES
-      if (Preferences.videoSubtitles)
+      if (Preferences.subtitles)
       {
         fileOptions.push(':sub-language=$DEFAULT_LANGUAGE');
       }