character sing overides and no anim notes

welp, its fully done
i hope
💯

.github/ISSUE_TEMPLATE/bug.yml

@@ -3,24 +3,30 @@ description: Report a bug or an issue in the game.
 labels: ["type: minor bug", "status: pending triage"]
 title: "Bug Report: "
 body:
+  - type: markdown
+    attributes:
+      value: "# PLEASE READ THE [CONTRIBUTING GUIDE](https://github.com/FunkinCrew/Funkin/blob/main/docs/CONTRIBUTING.md) BEFORE OPENING ISSUES!"
   - type: checkboxes
     attributes:
       label: Issue Checklist
       description: Be sure to complete these steps to increase the chances of your issue being addressed!
       options:
-        - label: I have properly named my issue
+        - label: I have read the [Contributing Guide](https://github.com/FunkinCrew/Funkin/blob/main/docs/CONTRIBUTING.md)
         - label: I have checked the Issues/Discussions pages to see if my issue has already been reported
+        - label: I have properly titled my issue
 
   - type: dropdown
     attributes:
       label: Platform
       description: Which platform are you playing on?
       options:
+        - Android
+        - iOS/iPadOS
         - Newgrounds (Web/HTML5)
         - Itch.io (Web/HTML5)
-        - Itch.io (Downloadable Build) - Windows
-        - Itch.io (Downloadable Build) - MacOS
-        - Itch.io (Downloadable Build) - Linux
+        - Windows (Downloadable Build)
+        - MacOS (Downloadable Build)
+        - Linux (Downloadable Build)
         - Compiled from GitHub Source Code
     validations:
       required: true
@@ -37,14 +43,26 @@ body:
         - Safari
         - Other (Specify in Description field)
 
+  - type: input
+    attributes:
+      label: Mobile Device Model
+      description: (Mobile users only) What mobile device are you playing on?
+      placeholder: ex. iPhone 16, Galaxy S25, iPad 11th Gen
+
+  - type: input
+    attributes:
+      label: Mobile OS Version
+      description: (Mobile users only) What version is your Operating System?
+      placeholder: ex. iOS 18.5, Android 15, iPadOS 18.5
+
   - type: input
     attributes:
       label: Version
-      description: Which version are you playing on? The game version is in the bottom left corner of the main menu. 
-      placeholder: ex. 0.5.3
+      description: Which version are you playing on? The game version is in the bottom left corner of the main menu.
+      placeholder: ex. 0.7.4
     validations:
       required: true
-  
+
   - type: markdown
     attributes:
       value: "## Describe your bug."
@@ -56,11 +74,11 @@ body:
   - type: textarea
     attributes:
       label: Description (include any images, videos, errors, or crash logs)
-      description: Provide as much detail as you can. The better others understand your issue, the more they can help you!  
+      description: Provide as much detail as you can. The better others understand your issue, the more they can help you!
       placeholder: Describe your issue here...
     validations:
       required: true
-      
+
   - type: textarea
     attributes:
       label: Steps to Reproduce

.github/ISSUE_TEMPLATE/charting.yml

@@ -3,48 +3,43 @@ description: Report an issue with the placement of notes in the game.
 labels: ["type: charting issue", "status: pending triage"]
 title: "Charting Issue: "
 body:
+  - type: markdown
+    attributes:
+      value: "# PLEASE READ THE [CONTRIBUTING GUIDE](https://github.com/FunkinCrew/Funkin/blob/main/docs/CONTRIBUTING.md) BEFORE OPENING ISSUES!"
+
   - type: checkboxes
     attributes:
       label: Issue Checklist
       description: Be sure to complete these steps to increase the chances of your issue being addressed!
       options:
-        - label: I have properly named my issue
+        - label: I have read the [Contributing Guide](https://github.com/FunkinCrew/Funkin/blob/main/docs/CONTRIBUTING.md)
         - label: I have checked the Issues/Discussions pages to see if my issue has already been reported
+        - label: I have properly titled my issue
 
   - type: dropdown
     attributes:
       label: Platform
       description: Which platform are you playing on?
       options:
+        - Android
+        - iOS/iPadOS
         - Newgrounds (Web/HTML5)
         - Itch.io (Web/HTML5)
-        - Itch.io (Downloadable Build) - Windows
-        - Itch.io (Downloadable Build) - MacOS
-        - Itch.io (Downloadable Build) - Linux
+        - Windows (Downloadable Build)
+        - MacOS (Downloadable Build)
+        - Linux (Downloadable Build)
         - Compiled from GitHub Source Code
     validations:
       required: true
 
-  - type: dropdown
-    attributes:
-      label: Browser
-      description: (Web/HTML5 users only) Which browser are you playing on?
-      options:
-        - Google Chrome
-        - Microsoft Edge
-        - Firefox
-        - Opera
-        - Safari
-        - Other (Specify in Description field)
-
   - type: input
     attributes:
       label: Version
-      description: Which version are you playing on? The game version is in the bottom left corner of the main menu. 
-      placeholder: ex. 0.5.3
+      description: Which version are you playing on? The game version is in the bottom left corner of the main menu.
+      placeholder: ex. 0.7.4
     validations:
       required: true
-  
+
   - type: markdown
     attributes:
       value: "## Describe the charting issue(s)."

.github/ISSUE_TEMPLATE/compiling.yml

@@ -1,23 +1,33 @@
-name: Compiling Report
+name: Compiling Help
 description: Report an issue with compiling the game.
 labels: ["type: compilation help", "status: pending triage"]
-title: "Compiling Report: "
+title: "Compiling Help: "
 body:
+  - type: markdown
+    attributes:
+      value: "# PLEASE READ THE [CONTRIBUTING GUIDE](https://github.com/FunkinCrew/Funkin/blob/main/docs/CONTRIBUTING.md) BEFORE OPENING ISSUES!"
+
   - type: checkboxes
     attributes:
       label: Issue Checklist
       description: Be sure to complete these steps to increase the chances of your issue being addressed!
       options:
-        - label: I have properly named my issue
+        - label: I have followed the [Compiling Guide](https://github.com/FunkinCrew/Funkin/blob/main/docs/COMPILING.md) and the [Troubleshooting Guide](https://github.com/FunkinCrew/Funkin/blob/main/docs/TROUBLESHOOTING.md)
+        - label: I have read the [Contributing Guide](https://github.com/FunkinCrew/Funkin/blob/main/docs/CONTRIBUTING.md)
         - label: I have checked the Issues/Discussions pages to see if my issue has already been reported
+        - label: I have properly titled my issue
 
   - type: dropdown
     attributes:
       label: Platform
-      description: Which platform are you compiling to/for?
+      description: Which platform are you compiling for?
       options:
+       - Android
+       - iOS/iPadOS
        - Web/HTML5
-       - Desktop
+       - Desktop (Windows)
+       - Desktop (Mac)
+       - Desktop (Linux)
        - Other
     validations:
       required: true
@@ -25,14 +35,14 @@ body:
   - type: input
     attributes:
       label: Version
-      description: Which version are you compiling? The game version is in the bottom left corner of the main menu or in the project.hxp file. 
-      placeholder: ex. 0.5.3
+      description: Which version are you compiling? The game version is in the bottom left corner of the main menu or in the project.hxp file.
+      placeholder: ex. 0.7.4
     validations:
       required: true
-  
+
   - type: markdown
     attributes:
-      value: "## Describe your compiling error."
+      value: "## Describe your compiling issue."
 
   - type: markdown
     attributes:
@@ -40,8 +50,16 @@ body:
 
   - type: textarea
     attributes:
-      label: Description (include any images, videos, errors of terminal or console, error logs)
-      description: Provide as much detail as you can. The better others understand your issue, the more they can help you!  
-      placeholder: Describe your issue here...
+      label: Console Output
+      description: Paste any errors or warnings from the console here.
+      placeholder: Paste output here...
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Context
+      description: Provide as much detail as you can. Did you modify any code? Provide any relevant images or videos.
+      placeholder: Describe the context here...
     validations:
       required: true

.github/ISSUE_TEMPLATE/crash.yml

@@ -3,24 +3,31 @@ description: Report a crash that occurred while playing the game.
 labels: ["type: major bug", "status: pending triage"]
 title: "Crash Report: "
 body:
+  - type: markdown
+    attributes:
+      value: "# PLEASE READ THE [CONTRIBUTING GUIDE](https://github.com/FunkinCrew/Funkin/blob/main/docs/CONTRIBUTING.md) BEFORE OPENING ISSUES!"
+
   - type: checkboxes
     attributes:
       label: Issue Checklist
       description: Be sure to complete these steps to increase the chances of your issue being addressed!
       options:
-        - label: I have properly named my issue
+        - label: I have read the [Contributing Guide](https://github.com/FunkinCrew/Funkin/blob/main/docs/CONTRIBUTING.md)
         - label: I have checked the Issues/Discussions pages to see if my issue has already been reported
+        - label: I have properly titled my issue
 
   - type: dropdown
     attributes:
       label: Platform
       description: Which platform are you playing on?
       options:
+        - Android
+        - iOS/iPadOS
         - Newgrounds (Web/HTML5)
         - Itch.io (Web/HTML5)
-        - Itch.io (Downloadable Build) - Windows
-        - Itch.io (Downloadable Build) - MacOS
-        - Itch.io (Downloadable Build) - Linux
+        - Windows (Downloadable Build)
+        - MacOS (Downloadable Build)
+        - Linux (Downloadable Build)
         - Compiled from GitHub Source Code
     validations:
       required: true
@@ -37,11 +44,23 @@ body:
         - Safari
         - Other (Specify in Description field)
 
+  - type: input
+    attributes:
+      label: Mobile Device Model
+      description: (Mobile users only) What mobile device are you playing on?
+      placeholder: ex. iPhone 16, Galaxy S25, iPad 11th Gen
+
+  - type: input
+    attributes:
+      label: Mobile OS Version
+      description: (Mobile users only) What version is your Operating System?
+      placeholder: ex. iOS 18.5, Android 15, iPadOS 18.5
+
   - type: input
     attributes:
       label: Version
-      description: Which version are you playing on? The game version is in the bottom left corner of the main menu. 
-      placeholder: ex. 0.5.3
+      description: Which version are you playing on? The game version is in the bottom left corner of the main menu.
+      placeholder: ex. 0.7.4
     validations:
       required: true
 
@@ -56,7 +75,7 @@ body:
   - type: textarea
     attributes:
       label: Description
-      description: Include screenshots or videos of the crash happening. Provide as much detail as you can. 
+      description: Include screenshots or videos of the crash happening. Provide as much detail as you can.
       placeholder: Describe the crash here...
     validations:
       required: true
@@ -72,7 +91,7 @@ body:
   - type: textarea
     attributes:
       label: Crash logs
-      description: These can be found in the logs folder where Funkin.exe is.
+      description: These can be found in the logs folder where Funkin.exe is, or in your mobile device's file explorer.
       placeholder: Upload your logs here...
     validations:
       required: true

.github/ISSUE_TEMPLATE/enhancement.yml

@@ -3,13 +3,18 @@ description: Suggest a new feature.
 labels: ["type: enhancement", "status: pending triage"]
 title: "Enhancement: "
 body:
+  - type: markdown
+    attributes:
+      value: "# PLEASE READ THE [CONTRIBUTING GUIDE](https://github.com/FunkinCrew/Funkin/blob/main/docs/CONTRIBUTING.md) BEFORE OPENING ISSUES!"
+      
   - type: checkboxes
     attributes:
       label: Issue Checklist
       description: Be sure to complete these steps to increase the chances of your suggestion being considered!
       options:
-        - label: I have properly named my enhancement
+        - label: I have read the [Contributing Guide](https://github.com/FunkinCrew/Funkin/blob/main/docs/CONTRIBUTING.md)
         - label: I have checked the Issues/Discussions pages to see if my enhancement has already been suggested
+        - label: I have properly titled my enhancement
 
   - type: textarea
     attributes:

.github/actions/setup-haxe/action.yml

@@ -5,7 +5,7 @@ inputs:
   haxe:
     description: 'Version of haxe to install'
     required: true
-    default: '4.3.4'
+    default: '4.3.6'
   hxcpp-cache:
     description: 'Whether to use a shared hxcpp compile cache'
     required: true
@@ -30,7 +30,7 @@ runs:
       echo "TIMER_HAXE=$(date +%s)" >> "$GITHUB_ENV"
 
   - name: Install Haxe
-    uses: funkincrew/ci-haxe@v3.1.0
+    uses: funkincrew/ci-haxe@v3.2.7
     with:
       haxe-version: ${{ inputs.haxe }}
 

.github/changed-lines-count-labeler.yml

@@ -1,12 +1,22 @@
-# Add 'size: small' to any changes below 10 lines
+# Add 'size: tiny' to any changes of at most 4 lines
+'size: tiny':
+  max: 4
+
+# Add 'size: small' to any changes between 5 and 10 lines
 'size: small':
-  max: 9
+  min: 5
+  max: 10
 
-# Add 'size: medium' to any changes between 10 and 100 lines
+# Add 'size: medium' to any changes between 11 and 100 lines
 'size: medium':
-  min: 10
-  max: 99
+  min: 11
+  max: 100
 
-# Add 'size: large' to any changes of at least 100 lines
+# Add 'size: large' to any changes between 101 and 500 lines
 'size: large':
-  min: 100
+  min: 101
+  max: 500
+
+# Add 'size: huge' to any changes of more than 500 lines
+'size: huge':
+  min: 501

.github/label-actions.yml

@@ -16,6 +16,7 @@
       - 'status: bug reproduced'
       - 'status: cannot reproduce'
       - 'status: needs clarification'
+      - 'status: needs r&d'
       - 'status: needs revision'
       - 'status: pending pull request'
       - 'status: pending triage'
@@ -31,14 +32,13 @@
       This pull request is a duplicate. Please direct all discussion to the original pull request.
     # Close the pull request
     close: false
-    # Set a close reason
-    # close-reason: 'not planned'
     # Remove other status labels
     unlabel:
       - 'status: accepted'
       - 'status: bug reproduced'
       - 'status: cannot reproduce'
       - 'status: needs clarification'
+      - 'status: needs r&d'
       - 'status: needs revision'
       - 'status: pending pull request'
       - 'status: pending triage'
@@ -62,6 +62,7 @@
       - 'status: cannot reproduce'
       - 'status: duplicate'
       - 'status: needs clarification'
+      - 'status: needs r&d'
       - 'status: needs revision'
       - 'status: pending pull request'
       - 'status: pending triage'
@@ -73,8 +74,6 @@
   prs:
     # Close the pull request
     close: true
-    # Set a close reason
-    close-reason: 'not planned'
     # Remove other status labels
     unlabel:
       - 'status: accepted'
@@ -82,6 +81,7 @@
       - 'status: cannot reproduce'
       - 'status: duplicate'
       - 'status: needs clarification'
+      - 'status: needs r&d'
       - 'status: needs revision'
       - 'status: pending pull request'
       - 'status: pending triage'
@@ -104,6 +104,7 @@
       - 'status: cannot reproduce'
       - 'status: duplicate'
       - 'status: needs clarification'
+      - 'status: needs r&d'
       - 'status: needs revision'
       - 'status: pending pull request'
       - 'status: pending triage'
@@ -115,8 +116,6 @@
   prs:
     # Close the pull request
     close: true
-    # Set a close reason
-    close-reason: 'not planned'
     # Remove other status labels
     unlabel:
       - 'status: accepted'
@@ -124,6 +123,7 @@
       - 'status: cannot reproduce'
       - 'status: duplicate'
       - 'status: needs clarification'
+      - 'status: needs r&d'
       - 'status: needs revision'
       - 'status: pending pull request'
       - 'status: pending triage'
@@ -146,6 +146,7 @@
       - 'status: cannot reproduce'
       - 'status: duplicate'
       - 'status: needs clarification'
+      - 'status: needs r&d'
       - 'status: needs revision'
       - 'status: pending pull request'
       - 'status: pending triage'

.github/pull_request_template.md

@@ -1,6 +1,10 @@
-<!-- Please check for duplicates or similar PRs before submitting this PR. -->
-## Does this PR close any issues? If so, link them below.
+<!-- Please read the Contributing Guide (https://github.com/FunkinCrew/Funkin/blob/main/docs/CONTRIBUTING.md) before submitting this PR. -->
 
-## Briefly describe the issue(s) fixed.
+<!-- Does this PR close any issues? If so, link them below. -->
+## Linked Issues
 
-## Include any relevant screenshots or videos.
+<!-- Briefly describe the issue(s) fixed. -->
+## Description
+
+<!-- Include any relevant screenshots or videos. -->
+## Screenshots/Videos

.github/workflows/build-docker-image.yml

@@ -1,53 +0,0 @@
-name: Create and publish Docker image
-
-on:
-  workflow_dispatch:
-  push:
-    paths:
-    - '**/Dockerfile'
-    - '.github/workflows/build-docker-image.yml'
-
-jobs:
-  build-and-push-image:
-    runs-on: build-set
-    permissions:
-      contents: read
-      packages: write
-
-    steps:
-    - name: Get checkout token
-      uses: actions/create-github-app-token@v1
-      id: app_token
-      with:
-        app-id: ${{ vars.APP_ID }}
-        private-key: ${{ secrets.APP_PEM }}
-        owner: ${{ github.repository_owner }}
-
-    - name: Checkout repo
-      uses: funkincrew/ci-checkout@v6
-      with:
-        submodules: false
-        token: ${{ steps.app_token.outputs.token }}
-
-    - name: Log into GitHub Container Registry
-      uses: docker/login-action@v3.1.0
-      with:
-        registry: ghcr.io
-        username: ${{ github.actor }}
-        password: ${{ secrets.GITHUB_TOKEN }}
-
-    - name: Build and push Docker image
-      uses: docker/build-push-action@v5.3.0
-      with:
-        context: ./build
-        push: true
-        tags: |
-          ghcr.io/funkincrew/build-dependencies:latest
-          ghcr.io/funkincrew/build-dependencies:${{ github.sha }}
-        labels: |
-          org.opencontainers.image.description=precooked haxe build-dependencies
-          org.opencontainers.image.revision=${{ github.sha }}
-          org.opencontainers.image.source=https://github.com/${{ github.repository }}
-          org.opencontainers.image.title=${{ github.repository_owner }}/build-dependencies
-          org.opencontainers.image.url=https://github.com/${{ github.repository }}
-          org.opencontainers.image.version=${{ github.sha }}

.github/workflows/build-game.yml

@@ -1,3 +1,6 @@
+# Builds the game on all platforms, to ensure it compiles on all target platforms.
+# This helps to ensure workers focus on the master branch.
+
 name: Build and Upload nightly game builds
 
 on:
@@ -12,146 +15,249 @@ on:
         description: Save the build artifact to Github Actions (sends to itch otherwise)
         default: false
   push:
-    paths-ignore:
-    - '**/Dockerfile'
-    - '.github/workflows/build-docker-image.yml'
 
 jobs:
 
+  gather-changes:
+    runs-on: build-set
+    outputs:
+      trigger-build: ${{ steps.should-trigger.outputs.result }}
+    steps:
+      - name: Checkout repo
+        uses: funkincrew/ci-checkout@v7.3.3
+        with:
+          submodules: false
+      - uses: dorny/paths-filter@v3
+        id: filter
+        with:
+          base: ${{ github.ref }}
+          filters: |
+            docker:
+              - '.github/workflows/build-game.yml'
+              - '**/Dockerfile'
+      - uses: actions/github-script@v7
+        id: should-trigger
+        with:
+          result-encoding: string
+          script: |
+            const { payload } = context
+            const changes = ${{ steps.filter.outputs.changes }}
+            const manual = payload.commits
+              .some(c => c.message.toLowerCase().replace(/\W/g, " ").includes("docker rebuild"))
+
+            console.log({ payload, changes, manual, commits: payload.commits })
+
+            return payload.created
+              || payload.forced
+              || changes.includes("docker")
+              || manual
+
+  gather-tags:
+    runs-on: build-set
+    outputs:
+      primary: ${{ steps.build-tags.outputs.primary }}
+      list: ${{ steps.build-tags.outputs.list }}
+    steps:
+      - name: Gather build tags
+        uses: actions/github-script@v7
+        id: build-tags
+        with:
+          script: |
+            const base = "ghcr.io/funkincrew/build-dependencies"
+            const default_branch = "rewrite/master"
+
+            const ref_path = context.ref.split("/").slice(2)
+            const ref = ref_path.join("/")
+            const ref_tag = ref_path.join("-")
+
+            const tags = [ref_tag, context.sha]
+
+            if (ref === default_branch) tags.push("latest")
+
+            console.log([
+              `ref: ${ref}`,
+              `default_branch: ${default_branch}`,
+              `tags: ${tags.join(", ")}`
+            ].join('\n'))
+
+            const tag_list = tags
+              .map(tag => `${base}:${tag}`)
+              .join("\n")
+
+            core.setOutput("primary", ref_tag)
+            core.setOutput("list", tag_list)
+
+  docker-image:
+    needs: [gather-changes, gather-tags]
+    if: needs.gather-changes.outputs.trigger-build == 'true'
+    runs-on: build-set
+    permissions:
+      contents: read
+      packages: write
+    steps:
+      - name: Checkout repo
+        uses: funkincrew/ci-checkout@v7.3.3
+        with:
+          submodules: false
+      - name: Log into GitHub Container Registry
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v6
+        with:
+          context: ./build
+          push: true
+          tags: ${{ needs.gather-tags.outputs.list }}
+          labels: |
+            org.opencontainers.image.description=precooked haxe build dependencies
+            org.opencontainers.image.revision=${{ github.sha }}
+            org.opencontainers.image.source=https://github.com/${{ github.repository }}
+            org.opencontainers.image.title=${{ github.repository_owner }}/build-dependencies
+            org.opencontainers.image.url=https://github.com/${{ github.repository }}
+            org.opencontainers.image.version=${{ github.sha }}
+
   build-game-on-host:
     strategy:
+      fail-fast: false
       matrix:
         include:
-        - target: windows
-        - target: macos
+          - target: windows
+            runs-on: windows
+          - target: macos
+            runs-on: macos
+          # TODO: Install XCode to build iOS
+          # - target: ios
+          #   runs-on: macos
     runs-on:
-    - ${{ matrix.target }}
+      - ${{ matrix.runs-on }}
     defaults:
       run:
         shell: bash
-
+    env:
+      BUILD_DEFINES: ${{ github.event.inputs.build-defines || '-DGITHUB_BUILD' }}
     steps:
-    - name: Make git happy
-      run: |
-        git config --global --replace-all safe.directory $GITHUB_WORKSPACE
-
-    - name: Get checkout token
-      uses: actions/create-github-app-token@v1
-      id: app_token
-      with:
-        app-id: ${{ vars.APP_ID }}
-        private-key: ${{ secrets.APP_PEM }}
-        owner: ${{ github.repository_owner }}
-
-    - name: Checkout repo
-      uses: funkincrew/ci-checkout@v6
-      with:
-        submodules: 'recursive'
-        token: ${{ steps.app_token.outputs.token }}
-        persist-credentials: false
-
-    - name: Setup build environment
-      uses: ./.github/actions/setup-haxe
-      with:
-        gh-token: ${{ steps.app_token.outputs.token }}
-    - name: Setup HXCPP dev commit
-      run: |
-        cd .haxelib/hxcpp/git/tools/hxcpp
-        haxe compile.hxml
-        cd ../../../../..
-    - name: Build game
-      if: ${{ matrix.target == 'windows' }}
-      run: |
-        haxelib run lime build windows -v -release ${{ github.event.inputs.build-defines }}
-      timeout-minutes: 120
-    - name: Build game
-      if: ${{ matrix.target != 'windows' }}
-      run: |
-        haxelib run lime build ${{ matrix.target }} -v -release --times ${{ github.event.inputs.build-defines }}
-      timeout-minutes: 120
-    - name: Save build artifact to Github Actions
-      if: ${{ github.event.inputs.save-artifact }}
-      uses: actions/upload-artifact@v4
-      with:
-        name: build-${{ matrix.target }}
-        path: export/release/${{matrix.target}}/bin/
-
-
-    - name: Upload build artifacts
-      uses: ./.github/actions/upload-itch
-      with:
-        butler-key: ${{ secrets.BUTLER_API_KEY}}
-        target: ${{ matrix.target }}
+      - name: Make git happy
+        run: |
+          git config --global --replace-all safe.directory $GITHUB_WORKSPACE
+      - name: Get checkout token
+        uses: actions/create-github-app-token@v1
+        id: app_token
+        with:
+          app-id: ${{ vars.APP_ID }}
+          private-key: ${{ secrets.APP_PEM }}
+          owner: ${{ github.repository_owner }}
+      - name: Checkout repo
+        uses: funkincrew/ci-checkout@v7.3.3
+        with:
+          submodules: 'recursive'
+          token: ${{ steps.app_token.outputs.token }}
+          persist-credentials: false
+          submodule-aliases: |
+            https://github.com/FunkinCrew/Funkin.assets > https://github.com/FunkinCrew/Funkin-assets-secret
+            https://github.com/FunkinCrew/Funkin.art > https://github.com/FunkinCrew/Funkin-art-secret
+      - name: Setup build environment
+        uses: ./.github/actions/setup-haxe
+        with:
+          gh-token: ${{ steps.app_token.outputs.token }}
+      - name: Setup HXCPP dev commit
+        run: |
+          cd .haxelib/hxcpp/git/tools/hxcpp
+          haxe compile.hxml
+          cd ../../../../..
+      - name: Build game (windows)
+        if: ${{ matrix.target == 'windows' }}
+        run: |
+          haxelib run lime build windows -v -release $BUILD_DEFINES
+        timeout-minutes: 120
+      - name: Build game (unix)
+        if: ${{ matrix.target != 'windows' }}
+        run: |
+          haxelib run lime build ${{ matrix.target }} -v -release --times $BUILD_DEFINES
+        timeout-minutes: 120
+      - name: Save build artifact to Github Actions
+        if: ${{ github.event.inputs.save-artifact }}
+        uses: actions/upload-artifact@v4
+        with:
+          name: build-${{ matrix.target }}
+          path: export/release/${{matrix.target}}/bin/
+      - name: Upload build artifacts
+        uses: ./.github/actions/upload-itch
+        with:
+          butler-key: ${{ secrets.BUTLER_API_KEY}}
+          target: ${{ matrix.target }}
 
   build-game-in-container:
+    needs: [gather-tags, docker-image]
+    if: ${{ ! cancelled() }}
     runs-on: build-set
-    container: ghcr.io/funkincrew/build-dependencies:latest
+    container: ghcr.io/funkincrew/build-dependencies:${{ needs.gather-tags.outputs.primary }}
     strategy:
       matrix:
         include:
-        - target: linux
-        - target: html5
+          - target: linux
+          - target: html5
+          # - target: android
     defaults:
       run:
         shell: bash
-
+    env:
+      BUILD_DEFINES: ${{ github.event.inputs.build-defines || '-DGITHUB_BUILD' }}
     steps:
-    - name: Get checkout token
-      uses: actions/create-github-app-token@v1
-      id: app_token
-      with:
-        app-id: ${{ vars.APP_ID }}
-        private-key: ${{ secrets.APP_PEM }}
-        owner: ${{ github.repository_owner }}
-
-    - name: Checkout repo
-      uses: funkincrew/ci-checkout@v6
-      with:
-        submodules: 'recursive'
-        token: ${{ steps.app_token.outputs.token }}
-        persist-credentials: false
-
-    - name: Config haxelib
-      run: |
-        haxelib --never newrepo
-        echo "HAXEPATH=$(haxelib config)" >> "$GITHUB_ENV"
-
-    - name: Restore cached dependencies
-      id: cache-hmm
-      uses: actions/cache@v4
-      with:
-        path: .haxelib
-        key: haxe-hmm-${{ runner.os }}-${{ hashFiles('**/hmm.json') }}
-
-    - if: ${{ steps.cache-hmm.outputs.cache-hit != 'true' }}
-      name: Install dependencies
-      run: |
-        git config --global 'url.https://x-access-token:${{ steps.app_token.outputs.token }}@github.com/.insteadOf' https://github.com/
-        git config --global advice.detachedHead false
-        haxelib --global run hmm install -q
-        cd .haxelib/hxcpp/git/tools/hxcpp && haxe compile.hxml
-
-    - if: ${{ matrix.target != 'html5' }}
-      name: Restore hxcpp cache
-      uses: actions/cache@v4
-      with:
-        path: /usr/share/hxcpp
-        key: haxe-hxcpp-${{ runner.os }}-${{ github.ref_name }}-${{ github.sha }}
-        restore-keys: haxe-hxcpp-${{ runner.os }}-${{ github.ref_name }}
-
-    - name: Build game
-      run: |
-        haxelib run lime build ${{ matrix.target }} -v -release --times ${{ github.event.inputs.build-defines }}
-      timeout-minutes: 120
-
-    - name: Save build artifact to Github Actions
-      if: ${{ github.event.inputs.save-artifact }}
-      uses: actions/upload-artifact@v4
-      with:
-        name: build-${{ matrix.target }}
-        path: export/release/${{matrix.target}}/bin/
-    - name: Upload build artifacts
-      uses: ./.github/actions/upload-itch
-      with:
-        butler-key: ${{ secrets.BUTLER_API_KEY}}
-        target: ${{ matrix.target }}
+      - name: Get checkout token
+        uses: actions/create-github-app-token@v1
+        id: app_token
+        with:
+          app-id: ${{ vars.APP_ID }}
+          private-key: ${{ secrets.APP_PEM }}
+          owner: ${{ github.repository_owner }}
+      - name: Checkout repo
+        uses: funkincrew/ci-checkout@v7.3.3
+        with:
+          submodules: 'recursive'
+          token: ${{ steps.app_token.outputs.token }}
+          persist-credentials: false
+          submodule-aliases: |
+            https://github.com/FunkinCrew/Funkin.assets > https://github.com/FunkinCrew/Funkin-assets-secret
+            https://github.com/FunkinCrew/Funkin.art > https://github.com/FunkinCrew/Funkin-art-secret
+      - name: Config haxelib
+        run: |
+          haxelib --never newrepo
+          echo "HAXEPATH=$(haxelib config)" >> "$GITHUB_ENV"
+      - name: Restore cached dependencies
+        id: cache-hmm
+        uses: actions/cache@v4
+        with:
+          path: .haxelib
+          key: haxe-hmm-${{ runner.os }}-${{ hashFiles('**/hmm.json') }}
+      - if: ${{ steps.cache-hmm.outputs.cache-hit != 'true' }}
+        name: Install dependencies
+        run: |
+          git config --global 'url.https://x-access-token:${{ steps.app_token.outputs.token }}@github.com/.insteadOf' https://github.com/
+          git config --global advice.detachedHead false
+          haxelib --global run hmm install -q
+          cd .haxelib/hxcpp/git/tools/hxcpp && haxe compile.hxml
+      - if: ${{ matrix.target != 'html5' }}
+        name: Restore hxcpp cache
+        uses: actions/cache@v4
+        with:
+          path: /usr/share/hxcpp
+          key: haxe-hxcpp-${{ runner.os }}-${{ github.ref_name }}-${{ github.sha }}
+          restore-keys: haxe-hxcpp-${{ runner.os }}-${{ github.ref_name }}
+      - name: Build game
+        run: |
+          haxelib run lime build ${{ matrix.target }} -v -release --times $BUILD_DEFINES
+        timeout-minutes: 120
+      - name: Save build artifact to Github Actions
+        if: ${{ github.event.inputs.save-artifact }}
+        uses: actions/upload-artifact@v4
+        with:
+          name: build-${{ matrix.target }}
+          path: export/release/${{matrix.target}}/bin/
+      - name: Upload build artifacts
+        uses: ./.github/actions/upload-itch
+        with:
+          butler-key: ${{ secrets.BUTLER_API_KEY}}
+          target: ${{ matrix.target }}

.github/workflows/cancel-merged-branches.yml

@@ -1,3 +1,6 @@
+# When a pull request is merged, cancel all queued workflows for that branch
+# This helps to ensure workers focus on the master branch.
+
 name: Cancel queued workflows on PR merge
 
 on:
@@ -23,7 +26,7 @@ jobs:
           let branch_workflows = await github.rest.actions.listWorkflowRuns({
             owner: context.repo.owner,
             repo: context.repo.repo,
-            workflow_id: "build-shit.yml",
+            workflow_id: "build-game.yml",
             status: "queued",
             branch: "${{ github.event.pull_request.head.ref }}"
           });

.github/workflows/label-actions.yml

@@ -1,5 +1,6 @@
 # Perform actions when labels are applied to issues, discussions, or pull requests
 # See .github/label-actions.yml
+
 name: 'Label Actions'
 
 on:

.github/workflows/label-issue.yml

@@ -1,22 +0,0 @@
-name: "Issue Labeler"
-on:
-  issues:
-    types:
-      - opened
-      - reopened
-      - edited
-
-jobs:
-  # When an issue is opened, detect if it has an empty body or incomplete issue form.
-  # If it does, close the issue immediately.
-  empty-issues:
-    name: Close empty issues
-    runs-on: ubuntu-latest
-    steps:
-    - name: Run empty issues closer action
-      uses: rickstaa/empty-issues-closer-action@v1
-      env:
-        github_token: ${{ secrets.GITHUB_TOKEN }}
-      with:
-        close_comment: Closing this issue because it appears to be empty. Please update the issue for it to be reopened.
-        open_comment: Reopening this issue because the author provided more information.

.github/workflows/label-pull-request-on-create.yml

@@ -0,0 +1,23 @@
+# Applies the following labels to pull requests when created:
+#  - status: pending triage
+
+name: "Pull Request Labeler 2 (Runs on PR creation)"
+on:
+  pull_request_target:
+    types:
+      - opened
+
+
+jobs:
+  # Apply `status: pending triage` to newly created pull requests
+  apply-pending-triage:
+    permissions:
+      contents: read
+      pull-requests: write
+    runs-on: ubuntu-latest
+    steps:
+      - name: Apply "status pending triage" to new pull requests
+        uses: actions-ecosystem/action-add-labels@v1
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          labels: "status: pending triage"

.github/workflows/label-pull-request.yml

@@ -1,7 +1,19 @@
+# Applies the following labels to pull requests whenver they are created or modified:
+#  - pr: documentation
+#  - pr: haxe
+#  - pr: github
+#  - size: tiny
+#  - size: small
+#  - size: medium
+#  - size: large
+#  - size: huge
+# see .github/labeler.yml and .github/changed-lines-count-labeler.yml
+
 name: "Pull Request Labeler"
 on:
 - pull_request_target
 
+
 jobs:
   # Apply labels to pull requests based on which files were edited
   labeler:

.gitignore

@@ -3,11 +3,20 @@
 .vs/
 APIStuff.hx
 dump/
+temp/
+docs/temp/
 export/
+astc-textures/
 RECOVER_*.fla
 shitAudio/
 .build_time
 .swp
+NewgroundsCredentials.hx
+
+# Mobile signing stuff
+.apple/
+.env
+key.keystore
 
 # Exclude JS stuff
 node_modules/

.vscode/extensions.json

@@ -6,7 +6,6 @@
     "vshaxe.hxcpp-debugger", // CPP debugging
     "openfl.lime-vscode-extension", // Lime integration
     "esbenp.prettier-vscode", // JSON formatting
-    "redhat.vscode-xml", // XML formatting
-    "ryanluker.vscode-coverage-gutters" // Highlight code coverage
+    "redhat.vscode-xml" // XML formatting
   ]
 }

.vscode/schema/hmm.json

@@ -0,0 +1,66 @@
+{
+  "type": "object",
+  "properties": {
+    "dependencies": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "name": {
+            "title": "Name",
+            "type": "string",
+            "description": "The name of the Haxe library"
+          },
+          "type": {
+            "title": "Type",
+            "type": "string",
+            "description": "one of haxelib, git, hg, or dev",
+            "enum": ["haxelib", "git", "hg", "dev"]
+          },
+          "ref": {
+            "type": "string",
+            "description": "the git/hg ref (branch, commit, tag, etc.)"
+          },
+          "url": {
+            "title": "URL",
+            "type": "string",
+            "description": "the git/hg URL"
+          },
+          "version": {
+            "title": "Version",
+            "type": "string",
+            "description": "the haxelib library version. Must be in SemVer format (MAJOR.MINOR.PATCH)",
+            "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$"
+          }
+        },
+        "required": ["name", "type"],
+        "dependentSchemas": {
+          "type": {
+            "if": {
+              "properties": {
+                "type": {
+                  "const": "git"
+                }
+              }
+            },
+            "then": {
+              "required": ["url"]
+            },
+            "else": {
+              "if": {
+                "properties": {
+                  "type": {
+                    "const": "haxelib"
+                  }
+                }
+              },
+              "then": {
+                "required": ["version"]
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}

.vscode/settings.json

@@ -70,7 +70,7 @@
   "files.eol": "\n",
 
   "haxe.displayPort": "auto",
-  "haxe.enableCompilationServer": false,
+  "haxe.enableCompilationServer": true,
   "haxe.enableServerView": true,
   "haxe.displayServer": {
     "arguments": ["-v"]
@@ -90,27 +90,9 @@
   "haxecheckstyle.configurationFile": "checkstyle.json",
   "haxecheckstyle.codeSimilarityBufferSize": 100,
 
+  "lime.projectFile": "project.hxp",
+
   "lime.targetConfigurations": [
-    {
-      "label": "Windows / Debug",
-      "target": "windows",
-      "args": ["-debug", "-DFEATURE_DEBUG_FUNCTIONS"]
-    },
-    {
-      "label": "Windows / Debug (Tracy)",
-      "target": "windows",
-      "args": ["-debug", "-DFEATURE_DEBUG_TRACY", "-DFEATURE_DEBUG_FUNCTIONS"]
-    },
-    {
-      "label": "Linux / Debug",
-      "target": "linux",
-      "args": ["-debug", "-DFEATURE_DEBUG_FUNCTIONS"]
-    },
-    {
-      "label": "HashLink / Debug",
-      "target": "hl",
-      "args": ["-debug"]
-    },
     {
       "label": "Windows / Debug (Discord)",
       "target": "windows",
@@ -171,14 +153,14 @@
       "args": ["-debug", "-DRESULTS"]
     },
     {
-      "label": "Windows / Debug (Straight to Chart Editor)",
+      "label": "Windows / Debug (Straight to Stage Editor)",
       "target": "windows",
-      "args": ["-debug", "-DCHARTING", "-DFEATURE_DEBUG_FUNCTIONS"]
+      "args": ["-debug", "-DSTAGING", "-DFEATURE_DEBUG_FUNCTIONS"]
     },
     {
-      "label": "HashLink / Debug (Straight to Chart Editor)",
-      "target": "hl",
-      "args": ["-debug", "-DCHARTING"]
+      "label": "Windows / Debug (Straight to Stage Builder)",
+      "target": "windows",
+      "args": ["-debug", "-DSTAGEBUILD", "-DFEATURE_DEBUG_FUNCTIONS"]
     },
     {
       "label": "Windows / Debug (Straight to Animation Editor)",
@@ -186,9 +168,9 @@
       "args": ["-debug", "-DANIMDEBUG", "-DFEATURE_DEBUG_FUNCTIONS"]
     },
     {
-      "label": "Windows / Debug (Debug hxCodec)",
+      "label": "Windows / Debug (Debug hxvlc)",
       "target": "windows",
-      "args": ["-debug", "-DHXC_LIBVLC_LOGGING", "-DFEATURE_DEBUG_FUNCTIONS"]
+      "args": ["-debug", "-DHXVLC_LOGGING", "-DFEATURE_DEBUG_FUNCTIONS"]
     },
     {
       "label": "HashLink / Debug (Straight to Animation Editor)",
@@ -210,11 +192,6 @@
       "target": "windows",
       "args": ["-debug", "-DWAVEFORM", "-DFEATURE_DEBUG_FUNCTIONS"]
     },
-    {
-      "label": "Windows / Release",
-      "target": "windows",
-      "args": ["-release"]
-    },
     {
       "label": "Windows / Release (GitHub Actions)",
       "target": "windows",
@@ -225,29 +202,35 @@
       "target": "hl",
       "args": ["-debug", "-DWAVEFORM"]
     },
-    {
-      "label": "HTML5 / Debug",
-      "target": "html5",
-      "args": ["-debug", "-DFEATURE_DEBUG_FUNCTIONS"]
-    },
     {
       "label": "HTML5 / Debug (Watch)",
       "target": "html5",
       "args": ["-debug", "-watch", "-DFEATURE_DEBUG_FUNCTIONS"]
-    },
+    }
+  ],
+  "lime.buildTypes": [
     {
-      "label": "macOS / Debug",
-      "target": "mac",
+      "label": "Debug",
       "args": ["-debug", "-DFEATURE_DEBUG_FUNCTIONS"]
     },
     {
-      "label": "macOS / Release",
-      "target": "mac",
+      "label": "Debug (Unlock Everything)",
+      "args": ["-debug", "-DUNLOCK_EVERYTHING"]
+    },
+    {
+      "label": "Debug (Tracy)",
+      "args": ["-debug", "-DFEATURE_DEBUG_TRACY", "-DFEATURE_DEBUG_FUNCTIONS"]
+    },
+    {
+      "label": "Debug (Straight to Chart Editor)",
+      "args": ["-debug", "-DCHARTING", "-DFEATURE_DEBUG_FUNCTIONS"]
+    },
+    {
+      "label": "Release",
       "args": ["-release"]
     },
     {
-      "label": "macOS / Release (GitHub Actions)",
-      "target": "mac",
+      "label": "Release (GitHub Actions)",
       "args": ["-release", "-DGITHUB_BUILD"]
     }
   ],
@@ -258,5 +241,12 @@
     "coverage.xml",
     "jacoco.xml",
     "coverage.cobertura.xml"
+  ],
+  "vscord.app.privacyMode.enable": true,
+  "json.schemas": [
+    {
+      "fileMatch": ["/hmm.json"],
+      "url": "./.vscode/schema/hmm.json"
+    }
   ]
 }

CODESTYLE.md

@@ -14,8 +14,8 @@ Code Quality is handled by the `vshaxe.haxe-checkstyle` extension, which include
 * `IndentationCharacter` checks what is used to indent, `Indentation` checks how deep the indentation is.
 * `CommentedOutCode` check is in place because old code should be retrieved via Git history.
 * TODO items: Enable these one-by-one and fix them to improve the overall code quality.
-  - Reconfigure `MethodLength`
-  - Reconfigure `CyclomaticComplexity`
+  - Re-configure `MethodLength`
+  - Re-configure `CyclomaticComplexity`
   - Re-enable `MagicNumber`
   - Re-configure `NestedControlFlow`
   - Re-configure `NestedIfDepth`
@@ -28,5 +28,5 @@ Prettier automatically handles formatting of JSON files, and can be configured i
 
 ### Prettier Notes
 * Prettier will automatically attempt to place expressions on a single line if they fit, but will keep them multi-line if they are manually made multi-line.
-  * This means that long singleline objects are automatically expanded, and short multiline objects aren't automatically collapsed.
+  * This means that long single-line objects are automatically expanded, and short multi-line objects aren't automatically collapsed.
   * You may want to use regex replacement to manually remove the first newline in short multi-line objects to convince Prettier to collapse them.

LaunchScreen.storyboard

@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<document type="com.apple.InterfaceBuilder3.CocoaTouch.Storyboard.XIB" version="3.0" toolsVersion="11134" systemVersion="15F34" targetRuntime="iOS.CocoaTouch" propertyAccessControl="none" useAutolayout="YES" launchScreen="YES" useTraitCollections="YES" colorMatched="YES" initialViewController="01J-lp-oVM">
+    <dependencies>
+        <plugIn identifier="com.apple.InterfaceBuilder.IBCocoaTouchPlugin" version="11106"/>
+        <capability name="documents saved in the Xcode 8 format" minToolsVersion="8.0"/>
+    </dependencies>
+    <scenes>
+        <!--View Controller-->
+        <scene sceneID="EHf-IW-A2E">
+            <objects>
+                <viewController id="01J-lp-oVM" sceneMemberID="viewController">
+                    <simulatedScreenMetrics key="simulatedMetrics" type="freeform" size="375x667"/>
+                    <layoutGuides>
+                        <viewControllerLayoutGuide type="top" id="Llm-lL-Icb"/>
+                        <viewControllerLayoutGuide type="bottom" id="xb3-aO-Qok"/>
+                    </layoutGuides>
+                    <view key="view" contentMode="scaleToFill" id="Ze5-6b-2t3">
+                        <rect key="frame" x="0.0" y="0.0" width="375" height="667"/>
+                        <autoresizingMask key="autoresizingMask" widthSizable="YES" heightSizable="YES"/>
+                        <color key="backgroundColor" red="0" green="0" blue="0" alpha="1" colorSpace="custom" customColorSpace="sRGB"/>
+                    </view>
+                </viewController>
+                <placeholder placeholderIdentifier="IBFirstResponder" id="iYj-Kq-Ea1" userLabel="First Responder" sceneMemberID="firstResponder"/>
+            </objects>
+            <point key="canvasLocation" x="53" y="375"/>
+        </scene>
+    </scenes>
+</document>

README.md

@@ -1,48 +1,66 @@
-# Friday Night Funkin' 
-
-Friday Night Funkin' is a rhythm game. Built using HaxeFlixel for Ludum Dare 47.
-
-This game was made with love to Newgrounds and its community. Extra love to Tom Fulp.
-
-- [Playable web demo on Newgrounds!](https://www.newgrounds.com/portal/view/770371)
-- [Demo download builds for Windows, Mac, and Linux from Itch.io!](https://ninja-muffin24.itch.io/funkin)
-
-# Getting Started
-
-**PLEASE USE THE LINKS ABOVE IF YOU JUST WANT TO PLAY THE GAME**
-
-To learn how to install the necessary dependencies and compile the game from source, please check out our [building the game](/docs/COMPILING.md) guide.
-
-# Contributing
-
-You can actively participate in the development of Friday Night Funkin' by opening a [bug report](https://github.com/FunkinCrew/Funkin/issues) or submitting a [code contribution](https://github.com/FunkinCrew/Funkin/pulls)!
-
-# Modding
-
-Feel free to start learning to mod the game by reading our [documentation](https://funkincrew.github.io/funkin-modding-docs/) and guide to modding.
-
-# Credits and Special Thanks
-
-Full credits can be found in-game, or in the `credits.json` file which is located [here](https://github.com/FunkinCrew/funkin.assets/blob/main/exclude/data/credits.json).
-
-## Programming
-- [ninjamuffin99](https://twitter.com/ninja_muffin99) - Lead Programmer
-- [EliteMasterEric](https://twitter.com/EliteMasterEric) - Programmer
-- [MtH](https://twitter.com/emmnyaa) - Charting and Additional Programming
-- [GeoKureli](https://twitter.com/Geokureli/) - Additional Programming
-- Our contributors on GitHub
-
-## Art / Animation / UI
-- [PhantomArcade3K](https://twitter.com/phantomarcade3k) - Artist and Animator
-- [Evilsk8r](https://twitter.com/evilsk8r) - Art
-- [Moawling](https://twitter.com/moawko) - Week 6 Pixel Art
-- [IvanAlmighty](https://twitter.com/IvanA1mighty) - Misc UI Design
-
-## Music
-- [Kawaisprite](https://twitter.com/kawaisprite) - Musician
-- [BassetFilms](https://twitter.com/Bassetfilms) - Music for "Monster", Additional Character Design
-
-## Special Thanks
-- [Tom Fulp](https://twitter.com/tomfulp) - For being a great guy and for Newgrounds
-- [JohnnyUtah](https://twitter.com/JohnnyUtahNG/) - Voice of Tankman
-- [L0Litsmonica](https://twitter.com/L0Litsmonica) - Voice of Mommy Mearest
+<div align='center'><img src="https://upload.wikimedia.org/wikipedia/commons/thumb/d/d2/Friday_Night_Funkin%27_logo.svg/2560px-Friday_Night_Funkin%27_logo.svg.png" width="800">
+
+<h2>Friday Night Funkin' is a rhythm game. Built using HaxeFlixel for <a href="https://ldjam.com/events/ludum-dare/47">Ludum Dare 47.</a></h2>
+
+This game was made with love to Newgrounds and its community. Extra love to Tom Fulp.
+
+</div>
+
+- [Playable web demo on Newgrounds!](https://www.newgrounds.com/portal/view/770371)
+- [Demo download builds for Windows, Mac, and Linux from Itch.io!](https://ninja-muffin24.itch.io/funkin)
+- [Download Android builds from Google Play!](https://play.google.com/store/apps/details?id=me.funkin.fnf)
+- [Download iOS builds from the App Store!](https://apps.apple.com/app/id6740428530)
+
+<div align='center'>
+<table>
+  <tr>
+    <td><img src="https://fridaynightfunkin.wiki.gg/images/d/d7/Title_Card.gif" alt="Title Screen" width="350"/></td>
+    <td><img src="https://fridaynightfunkin.wiki.gg/images/9/99/Menu.png" alt="Main Menu" width="350"/></td>
+  </tr>
+</table>
+</div>
+
+# Getting Started
+
+**PLEASE USE THE LINKS ABOVE IF YOU JUST WANT TO PLAY THE GAME**
+
+To learn how to install the necessary dependencies and compile the game from source, please follow our [Compiling Guide](/docs/COMPILING.md).
+
+# Contributing
+
+Check out our [Contributing Guide](/docs/CONTRIBUTING.md) to learn how you can actively contribute to the development of Friday Night Funkin'!
+
+# Modding
+
+Feel free to start learning to mod the game by reading our [documentation](https://funkincrew.github.io/funkin-modding-docs/) and guide to modding.
+
+# Credits and Special Thanks
+
+Full credits can be found in-game, or in the `credits.json` file which is located [here](https://github.com/FunkinCrew/funkin.assets/blob/main/exclude/data/credits.json).
+
+## Programming
+- [ninjamuffin99](https://twitter.com/ninja_muffin99) - Lead Programmer
+- [EliteMasterEric](https://twitter.com/EliteMasterEric) - Programmer
+- [MtH](https://twitter.com/emmnyaa) - Charting and Additional Programming
+- [GeoKureli](https://twitter.com/Geokureli/) - Additional Programming
+- [ZackDroid](https://x.com/ZackDroidCoder) - Lead Mobile Programmer
+- [MAJigsaw77](https://github.com/MAJigsaw77) - Mobile Programmer
+- [Karim-Akra](https://x.com/KarimAkra_0) - Mobile Programmer
+- [Sector_5](https://github.com/sector-a) - Mobile Programmer
+- [Luckydog7](https://github.com/luckydog7) - Mobile Programmer
+- Our contributors on GitHub
+
+## Art / Animation / UI
+- [PhantomArcade3K](https://twitter.com/phantomarcade3k) - Artist and Animator
+- [Evilsk8r](https://twitter.com/evilsk8r) - Art
+- [Moawling](https://twitter.com/moawko) - Week 6 Pixel Art
+- [IvanAlmighty](https://twitter.com/IvanA1mighty) - Misc UI Design
+
+## Music
+- [Kawaisprite](https://twitter.com/kawaisprite) - Musician
+- [BassetFilms](https://twitter.com/Bassetfilms) - Music for "Monster", Additional Character Design
+
+## Special Thanks
+- [Tom Fulp](https://twitter.com/tomfulp) - For being a great guy and for Newgrounds
+- [JohnnyUtah](https://twitter.com/JohnnyUtahNG/) - Voice of Tankman
+- [L0Litsmonica](https://twitter.com/L0Litsmonica) - Voice of Mommy Mearest

art

@@ -1 +1 @@
-Subproject commit 66572f85d826ce2ec1d45468c12733b161237ffa
+Subproject commit 094ff109197e35d21342bdf2d51132be23948d3f

assets

@@ -1 +1 @@
-Subproject commit c1899ffbefb9a7c98b030c75a33623431d7ea6ba
+Subproject commit 562cc34c473c6999ea26f13a3f83ccebf6e15a9b

astc-compression-data.json

@@ -0,0 +1,64 @@
+{
+  "input": "./assets",
+  "output": "./astc-textures/",
+  "quality": "medium",
+  "blocksize": "10x10",
+  "colorprofile": "cl",
+  "custom": [
+    {
+      "asset": "assets/week1/images/erect/server.png",
+      "blocksize": "8x8"
+    },
+    {
+      "asset": "assets/week1/images/erect/crowd.png",
+      "blocksize": "8x8"
+    },
+    {
+      "asset": "assets/week1/image/erect/bg.png",
+      "blocksize": "8x8"
+    },
+    {
+      "asset": "assets/week1/image/erect/lights.png",
+      "blocksize": "6x6"
+    },
+    {
+      "asset": "assets/week2/images/erect/stairsDark.png",
+      "blocksize": "6x6"
+    },
+    {
+      "asset": "assets/week2/images/erect/stairsLight.png",
+      "blocksize": "6x6"
+    }
+  ],
+  "excludes": [
+    "assets/preload/images/cursor/",
+    "assets/preload/images/freeplay/",
+    "assets/preload/images/icons/",
+    "assets/preload/images/fonts/",
+    "assets/preload/images/titleEnter.png",
+    "assets/preload/images/titleEnter_mobile.png",
+    "assets/preload/images/soundtray/",
+    "assets/preload/images/stageBuild/",
+    "assets/preload/images/ui/popup/pixel/*",
+    "assets/shared/images/characters/abotPixel/*",
+    "assets/shared/images/characters/bfPixel.png",
+    "assets/shared/images/characters/bfPixelsDEAD.png",
+    "assets/shared/images/characters/gfPixel.png",
+    "assets/shared/images/characters/nenePixel/*",
+    "assets/shared/images/characters/picoPixel/*",
+    "assets/shared/images/characters/senpai.png",
+    "assets/shared/images/characters/spirit.png",
+    "assets/shared/images/ui/chart-editor/",
+    "assets/shared/images/ui/countdown/pixel/*",
+    "assets/shared/images/resultScreen/*",
+    "assets/shared/images/resultScreen/clearPercent/",
+    "assets/shared/images/resultScreen/rankText/",
+    "assets/week1/*",
+    "assets/week1/images/erect/brightLightSmall.png",
+    "assets/week1/images/erect/lightAbove.png",
+    "assets/week1/images/erect/lightgreen.png",
+    "assets/week1/images/erect/lightred.png",
+    "assets/week1/images/erect/orangeLight.png",
+    "assets/week6/"
+  ]
+}

build/Dockerfile

@@ -1,8 +1,8 @@
-FROM ubuntu:mantic
+FROM ubuntu:noble
 
-ARG haxe_version=4.3.4
+ARG haxe_version=4.3.6
 ARG haxelib_version=4.1.0
-ARG neko_version=2.3.0
+ARG neko_version=2.4.0
 
 # prepare runner
 ENV GITHUB_HOME="/github/home"
@@ -98,11 +98,12 @@ EOF
 # neko
 # https://github.com/HaxeFoundation/neko/releases/download/v2-3-0/neko-2.3.0-linux64.tar.gz
 RUN <<EOF
-neko_url=$(curl https://api.github.com/repos/HaxeFoundation/neko/releases -sfL \
-  | jq '.[] | select(.name == "'"$neko_version"'")' \
-  | jq '.assets[] | select(.name | endswith("linux64.tar.gz"))' \
-  | jq -r '.browser_download_url')
-curl -sfL "$neko_url" | tar -xz -C /usr/local
+#neko_url=$(curl https://api.github.com/repos/HaxeFoundation/neko/releases -fL \
+#  | jq '.[] | select(.name == "'"$neko_version"'")' \
+#  | jq '.assets[] | select(.name | endswith("linux64.tar.gz"))' \
+#  | jq -r '.browser_download_url')
+neko_url="https://geo.thei.rs/funkin/neko-2.4.1-linux64.tar.gz"
+curl -fL "$neko_url" | tar -xz -C /usr/local
 EOF
 
 RUN <<EOF
@@ -117,11 +118,12 @@ ENV PATH="$NEKOPATH:$PATH"
 # haxe
 # https://github.com/HaxeFoundation/haxe/releases/download/4.0.5/haxe-4.0.5-linux64.tar.gz
 RUN <<EOF
-haxe_url=$(curl https://api.github.com/repos/HaxeFoundation/haxe/releases -sfL \
-  | jq '.[] | select(.name == "'"$haxe_version"'")' \
-  | jq '.assets[] | select(.name | endswith("linux64.tar.gz"))' \
-  | jq -r '.browser_download_url')
-curl -sfL "$haxe_url" | tar -xz -C /usr/local
+#haxe_url=$(curl https://api.github.com/repos/HaxeFoundation/haxe/releases -fL \
+#  | jq '.[] | select(.name == "'"$haxe_version"'")' \
+#  | jq '.assets[] | select(.name | endswith("linux64.tar.gz"))' \
+#  | jq -r '.browser_download_url')
+haxe_url="https://geo.thei.rs/funkin/haxe-4.3.6-linux64.tar.gz"
+curl -fL "$haxe_url" | tar -xz -C /usr/local
 EOF
 
 RUN <<EOF

checkstyle.json

@@ -70,16 +70,17 @@
     },
     {
       "props": {
+        "severity": "IGNORE",
+
         "policy": "aligned",
-        "allowSingleline": true,
-        "severity": "INFO"
+        "allowSingleline": true
       },
       "type": "ConditionalCompilation"
     },
     {
       "props": {
         "ignoreExtern": true,
-        "format": "^[a-zA-Z0-9]+(?:_[a-zA-Z0-9]+)*$",
+        "format": "^?:_[a-zA-Z0-9]+(?:_[a-zA-Z0-9]+)*$",
         "tokens": ["INLINE", "NOTINLINE"]
       },
       "type": "ConstantName"
@@ -347,7 +348,7 @@
     {
       "props": {
         "allowSingleLineStatement": true,
-        "tokens": ["FOR", "IF", "ELSE_IF", "WHILE", "DO_WHILE"]
+        "tokens": ["FOR", "ELSE_IF", "WHILE", "DO_WHILE"]
       },
       "type": "NeedBraces"
     },

cliff.toml

@@ -87,4 +87,3 @@ filter_commits = false
 topo_order = false
 # sort the commits inside sections by oldest/newest order
 sort_commits = "newest"
-

docs/COMPILING.md

@@ -13,17 +13,20 @@
     - NOTE: By performing this operation, you are downloading Content which is proprietary and protected by national and international copyright and trademark laws. See [the LICENSE.md file for the Funkin.assets](https://github.com/FunkinCrew/funkin.assets/blob/main/LICENSE.md) repo for more information.
 5. Run `haxelib --global install hmm` and then `haxelib --global run hmm setup` to install hmm.json
 6. Run `hmm install` to install all haxelibs of the current branch
-7. Run `haxelib run lime setup` to set up lime
-8. Perform additional platform setup
+    - If you have issues installing Lime, try utilizing Funkin's patched libraries for hmm and haxelib: `haxelib --global git haxelib https://github.com/FunkinCrew/haxelib.git` and `haxelib --global git hmm  https://github.com/FunkinCrew/hmm.git`
+8. Run `haxelib run lime setup` to set up Lime
+9. Perform additional platform setup
    - For Windows, download the [Visual Studio Build Tools](https://aka.ms/vs/17/release/vs_BuildTools.exe)
         - When prompted, select "Individual Components" and make sure to download the following:
         - MSVC v143 VS 2022 C++ x64/x86 build tools
         - Windows 10/11 SDK
     - Mac: [`lime setup mac` Documentation](https://lime.openfl.org/docs/advanced-setup/macos/)
     - Linux: [`lime setup linux` Documentation](https://lime.openfl.org/docs/advanced-setup/linux/)
+        - One of Funkin's dependencies uses libVLC, which requires you to install some development packages to be able to compile.
+          Command for Ubuntu/Debian based systems: `sudo apt install libvlc-dev libvlccore-dev libvlccore9`, and for other distros, please refer to [hxvlc's documentation](https://github.com/MAJigsaw77/hxvlc?tab=readme-ov-file#dependencies)
     - HTML5: Compiles without any extra setup
-9. If you are targeting for native, you may need to run `lime rebuild <PLATFORM>` and `lime rebuild <PLATFORM> -debug`
-10. `lime test <PLATFORM>` to build and launch the game for your platform (for example, `lime test windows`)
+10. If you are targeting for native, you may need to run `lime rebuild <PLATFORM>` and `lime rebuild <PLATFORM> -debug`
+11. `lime test <PLATFORM>` to build and launch the game for your platform (for example, `lime test windows`)
 
 ## Build Flags
 
@@ -37,8 +40,8 @@ There are several useful build flags you can add to a build to affect how it wor
     - This feature causes the game to load exported assets from the project's assets folder rather than the exported one. Great for fast iteration, but the game will break if you try to zip it up and send it to someone, so it's disabled for release builds.
 - `-DFEATURE_DISCORD_RPC` or `-DNO_FEATURE_DISCORD_RPC` to forcibly enable or disable support for Discord Rich Presence.
 - `-DFEATURE_VIDEO_PLAYBACK` or `-DNO_FEATURE_VIDEO_PLAYBACK` to forcibly enable or disable video cutscene support.
-- `-DFEATURE_CHART_EDITOR` or `-DNO_FEATURE_CHART_EDITOR` to forcibly enable or disable the chart editor in the Debug menu.
 - `-DFEATURE_SCREENSHOTS` or `-DNO_FEATURE_SCREENSHOTS` to forcibly enable or disable the screenshots feature.
+- `-DFEATURE_CHART_EDITOR` or `-DNO_FEATURE_CHART_EDITOR` to forcibly enable or disable the chart editor in the Debug menu.
 - `-DFEATURE_STAGE_EDITOR` to forcibly enable the experimental stage editor.
 - `-DFEATURE_GHOST_TAPPING` to forcibly enable an experimental gameplay change to the anti-mash system.
 

docs/COMPILING_MAC.md

@@ -0,0 +1,10 @@
+# Mac Compiling Guide + Considerations
+
+There's a few extra considerations when compiling FNF for Mac that *we* have to handle when creating a wider release.
+- [Creating a Universal Binary](#creating-a-universal-binary)
+- Code-signing
+- Notarizing
+
+## Creating a Universal Binary
+
+Run the `art/macos-universal.sh` script, which automatically compiles release versions of both arm64 and x86 of Funkin. You can also see there for reference of how it's done.

docs/COMPILING_MOBILE.md

@@ -0,0 +1,98 @@
+# Compiling Friday Night Funkin' for Mobile Devices
+
+Before starting, **make sure your game builds on desktop.**
+Check [COMPILING.md](./COMPILING.md) if you haven’t done that yet.
+
+## Android
+
+0. **Create a new folder** – this will store Android tools (remember where you put it!).
+1. **Open a terminal as Administrator.**
+2. Run this in the terminal (replace the path with your actual folder):
+   ```bash
+   setx ANDROID_HOME "C:\path\to\your\folder" /M
+   ```
+3. Download [Android Studio Command-line Tools](https://developer.android.com/studio#command-line-tools-only).
+4. Extract the ZIP into your folder from step 1.
+5. (Optional) Close and reopen the terminal if needed.
+6. Run:
+   ```bash
+   sdkmanager --install "build-tools;35.0.0" "ndk;29.0.13113456" "platforms;android-29" "platforms;android-35"
+   ```
+   - The latest NDK is not compatible with Lime you have to use the old one.
+7. Download and install [JDK 17 (MSI)](https://adoptium.net/temurin/releases/?version=17&os=windows).
+8. Run:
+   ```bash
+   lime setup android
+   ```
+   Use these when asked:
+   - **Android SDK:** `C:\path\to\your\folder`
+   - **Android NDK:** `C:\path\to\your\folder\ndk\29.0.13113456`
+   - **JDK:** `C:\Program Files\Java\jdk-17`
+
+9. Now build your game:
+    ```bash
+    lime test android
+    ```
+
+
+### macOS
+
+0. **Create a new folder** – this will store Android tools (remember where you put it!).
+1. Open **Terminal** (Command ⌘ + Space → type “terminal” → Enter).
+2. In Terminal:
+   ```bash
+   cd /path/to/your/folder
+   export ANDROID_HOME=/path/to/your/folder
+   export PATH=$PATH:$ANDROID_HOME/cmdline-tools:$ANDROID_HOME/cmdline-tools/bin:$ANDROID_HOME/platform-tools
+   ```
+3. Download [Android Studio Command-line Tools](https://developer.android.com/studio#command-line-tools-only).
+4. Extract the ZIP into your folder from step 1.
+5. (Optional) Restart Terminal if needed.
+6. Run:
+   ```bash
+   sdkmanager --install "build-tools;35.0.0" "ndk;29.0.13113456" "platforms;android-29" "platforms;android-35"
+   ```
+7. Download and install [JDK 17 for macOS](https://adoptium.net/temurin/releases/?os=mac&version=17).
+8. Run:
+   ```bash
+   lime setup android
+   ```
+   Use these when asked:
+   - **Android SDK:** `/path/to/your/folder`
+   - **Android NDK:** `/path/to/your/folder/ndk/28.0.13004108`
+   - **JDK:** `/Library/Java/JavaVirtualMachines/temurin-17.jdk/Contents/Home`
+     _(If not asked for JDK, don’t worry — just skip it.)_
+
+9. Build your game:
+    ```bash
+    lime test android
+    ```
+
+## iOS
+Note that you can only build the game for iOS on a computer running MacOS.
+
+0. Build the game for desktop to make sure everything works. Check [COMPILING.md](./COMPILING.md).
+1. Get Xcode from the app store on your MacOS Machine.
+2. Download the iPhone SDK (First thing that pops up in Xcode)
+3. Open up a terminal tab and run `lime test ios -xcode`
+4. You will need to sign your own copy in order to run the game with a real iOS device! That requires an Apple Developer account, sorry!
+   - To run with an iOS simulator instead of `-xcode` use `-simulator`
+
+### iOS Troubleshooting
+
+- **A required plugin failed to load. Please ensure system content is up-to-date — try running 'xcodebuild -runFirstLaunch'.**
+Make sure you have the iOS SDK isntalled, see Step 2.
+
+- **error: No Accounts: Add a new account in Accounts settings. (in target 'Funkin' from project 'Funkin')**
+
+Open XCode, press CMD+, to open Settings, select Accounts, add an Apple ID.
+
+- error: No Account for Team "Z7G7AVNGSH". Add a new account in Accounts settings or verify that your accounts have valid credentials.
+
+Open `project.hxp` and change `IOS_TEAM_ID` to your personal team's ID.
+
+- error: Failed Registering Bundle Identifier: The app identifier "me.funkin.fnf" cannot be registered to your development team because it is not available.
+
+The Funkin' Crew are the only ones that can build an iOS app with the identifier `me.funkin.fnf`. Open `project.hxp` and change `PACKAGE_NAME` to a unique value.
+
+- error: No profiles for 'me.funkin.fnf' were found: Xcode couldn't find any iOS App Development provisioning profiles matching 'me.funkin.fnf'

docs/CONTRIBUTING.md

@@ -0,0 +1,418 @@
+# Contributing
+Welcome to the Contributing Guide!
+You can contribute to the Funkin' repository by opening issues or pull requests.
+
+This guide will cover best practices for each type of contribution.
+
+# Table of Contents
+<details open>
+<summary><b>Contents</b></summary>
+
+[Part 1: Etiquette](https://github.com/FunkinCrew/Funkin/blob/main/docs/CONTRIBUTING.md#part-1-etiquette)
+
+<details>
+<summary><a href="https://github.com/FunkinCrew/Funkin/blob/main/docs/CONTRIBUTING.md#part-2-issues">Part 2: Issues</a></summary>
+
+* [Requirements](https://github.com/FunkinCrew/Funkin/blob/main/docs/CONTRIBUTING.md#requirements)
+
+* [Rejected Features](https://github.com/FunkinCrew/Funkin/blob/main/docs/CONTRIBUTING.md#rejected-features)
+
+* [Issue Types](https://github.com/FunkinCrew/Funkin/blob/main/docs/CONTRIBUTING.md#issue-types)
+
+* [Before You Submit...](https://github.com/FunkinCrew/Funkin/blob/main/docs/CONTRIBUTING.md#before-you-submit)
+
+</details>
+
+<details>
+
+<summary><a href="https://github.com/FunkinCrew/Funkin/blob/main/docs/CONTRIBUTING.md#part-3-pull-requests">Part 3: Pull Requests</a></summary>
+
+* [Choosing a base branch](https://github.com/FunkinCrew/Funkin/blob/main/docs/CONTRIBUTING.md#choosing-a-base-branch)
+
+* [Merge conflicts and rebasing](https://github.com/FunkinCrew/Funkin/blob/main/docs/CONTRIBUTING.md#merge-conflicts-and-rebasing)
+
+* [Code PRs](https://github.com/FunkinCrew/Funkin/blob/main/docs/CONTRIBUTING.md#code-prs)
+
+* [Documentation PRs](https://github.com/FunkinCrew/Funkin/blob/main/docs/CONTRIBUTING.md#documentation-prs)
+
+* [GitHub PRs](https://github.com/FunkinCrew/Funkin/blob/main/docs/CONTRIBUTING.md#github-prs)
+
+* [funkin.assets PRs](https://github.com/FunkinCrew/Funkin/blob/main/docs/CONTRIBUTING.md#funkinassets-prs)
+
+  * [Charting PRs](https://github.com/FunkinCrew/Funkin/blob/main/docs/CONTRIBUTING.md#charting-prs)
+
+</details>
+
+[Closing](https://github.com/FunkinCrew/Funkin/blob/main/docs/CONTRIBUTING.md#closing)
+
+</details>
+
+
+# Part 1: Etiquette
+- Be respectful to one another. We're here to help each other out!
+- Keep your titles clear and concise. Do not type the whole description into the title.
+- Do not spam by creating unnecessary issues and pull requests.
+- Use common sense!
+
+# Part 2: Issues
+Issues serve many purposes, from reporting bugs to suggesting new features.
+This section provides guidelines to follow when [opening an issue](https://github.com/FunkinCrew/Funkin/issues).
+
+## Requirements
+Make sure you're playing:
+- the latest version of the game (currently v0.7.4)
+- without any mods
+- on [Newgrounds](https://www.newgrounds.com/portal/view/770371) or downloaded from [itch.io](https://ninja-muffin24.itch.io/funkin)
+
+## Rejected Features
+If you want to **suggest a feature**, make sure it hasn't already been rejected.
+Here's a list of commonly suggested features and the reasons why they won't be added:
+
+| Feature | Reason |
+| ------- | ------- |
+| Combo Break + Accuracy Displays | https://github.com/FunkinCrew/Funkin/pull/2681#issuecomment-2156308982 |
+| Toggleable Ghost Tapping | https://github.com/FunkinCrew/Funkin/pull/2564#issuecomment-2119701802 |
+| Perfectly Centered Strumlines | _same as above^_ |
+| MultiKey, 9k, More than 4 keys, etc. | https://github.com/FunkinCrew/Funkin/issues/4243#issuecomment-2692371969 |
+| Flashy Combo Milestones | https://github.com/FunkinCrew/Funkin/pull/4700#issuecomment-2798916579 |
+| Losing Icons for DD and Parents | https://github.com/FunkinCrew/Funkin/issues/3048#issuecomment-2243491536 |
+| Playable GF / Speaker BF / Speaker Pico | https://github.com/FunkinCrew/Funkin/issues/2953#issuecomment-2216985230 |
+| New Intro Text Lines | https://github.com/FunkinCrew/Funkin/issues/5031#issuecomment-2855593376 |
+| Fresh (Chill Mix) as Title Screen Music | https://github.com/FunkinCrew/Funkin/pull/4282#issuecomment-2709334718 |
+| Difficulty Ratings above 20 | https://github.com/FunkinCrew/Funkin/issues/3075#issuecomment-2368984497 |
+| Quick Restart Keybind (not R) | https://github.com/FunkinCrew/Funkin/issues/3268#issuecomment-2351095232 |
+| Countdown after Unpausing Song | https://github.com/FunkinCrew/Funkin/issues/2721#issuecomment-2159330106 |
+| "Philly Glow" Effect from Psych Engine | https://github.com/FunkinCrew/Funkin/issues/3788#issuecomment-2688966982 |
+| Importing Charts from Psych Engine (and other mod content) | https://github.com/FunkinCrew/Funkin/issues/2586#issuecomment-2125733327 |
+| Backwards Compatibility for Modding | https://github.com/FunkinCrew/Funkin/issues/3949#issuecomment-2608391329 |
+| Lua Support | https://github.com/FunkinCrew/Funkin/issues/2643#issuecomment-2143718093 |
+
+## Issue Types
+Choose the issue template that best suits your needs!
+Here's what each template is designed for:
+
+### Bug Report ([view list](https://github.com/FunkinCrew/Funkin/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22type%3A%20minor%20bug%22))
+For minor bugs and general issues with the game. Choose this one if none of the others fit your needs.
+
+### Crash Report ([view list](https://github.com/FunkinCrew/Funkin/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22type%3A%20major%20bug%22))
+For crashes and freezes like the [Null Object Reference](https://github.com/FunkinCrew/Funkin/issues/2209) problem from v0.3.0.
+
+### Charting Issue ([view list](https://github.com/FunkinCrew/Funkin/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22type%3A%20charting%20issue%22))
+For misplaced notes, wonky camera movements, broken song events, and everything related to the game's charts.
+
+### Enhancement ([view list](https://github.com/FunkinCrew/Funkin/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22type%3A%20enhancement%22))
+For suggestions to add new features or improve existing ones. We'd love to hear your ideas!
+
+### Compiling Help (only after reading the [Troubleshooting Guide](https://github.com/FunkinCrew/Funkin/blob/main/docs/TROUBLESHOOTING.md))
+For issues with compiling the game. Legacy versions (before v0.3.0) are not supported.
+
+> [!TIP]
+> If none of the above Issue templates suit your inquiry (e.g. Questions or Coding Help), please [open a discussion](https://github.com/FunkinCrew/Funkin/discussions).
+
+## Before You Submit...
+Complete the Issue Checklist at the top of your template!
+
+> [!IMPORTANT]
+> If you do not complete each step of the Issue Checklist, **your issue may be closed.**
+
+Be sure to use the search bar on the Issues page to check that your issue hasn't already been reported by someone else.
+Duplicate issues make it harder to keep track of important issues with the game.
+
+Also only report one issue or enhancement at a time! If you have multiple bug reports or suggestions, split them up into separate submissions so they can be checked off one by one.
+
+Once you're sure your issue is unique and specific, feel free to submit it.
+
+> [!IMPORTANT]
+> **DO NOT CLOSE YOUR ISSUE FOR ANY REASON!** Your issue will be taken care of by a moderator!
+
+**Thank you for opening issues!**
+
+# Part 3: Pull Requests
+Community members are welcome to contribute their changes by [opening pull requests](https://github.com/FunkinCrew/Funkin/pulls).
+This section covers guidelines for opening and managing pull requests (PRs).
+
+## Choosing a base branch
+When creating a branch in your fork, base your branch on either the `main` or `develop` branch depending on the types of changes you want to make.
+
+> [!CAUTION]
+> Avoid using your fork's default branch (`main` in this case) for your PR. This is considered an [anti-pattern](https://jmeridth.com/posts/do-not-issue-pull-requests-from-your-master-branch/) by GitHub themselves!
+> Instead, make a separate branch for your additions (ex. `docs/fix-typo` or `minor-bugfix`).
+
+Choose the `main` branch if you modify:
+- Documentation (`.md` files)
+- GitHub files (`.yml` files or anything in the `.github` folder)
+
+Choose the `develop` branch if you modify:
+- Game code (`.hx` files)
+- Any other type of file
+
+> [!TIP]
+> When in doubt, base your branch on the `develop` branch.
+
+Choosing the right base branch helps keep your commit history clean and avoid merge conflicts.
+Once you’re satisfied with the changes you’ve made, open a PR and base it on the same branch you previously chose.
+
+## Maintaining your pull request
+Keeping your pull request clean and easy to review increases the chance that it will be accepted!
+
+Our maintenance policy is as follows:
+- If we require changes to your PR, we will label your PR `status: needs revision`.
+- We may also leave a comment under your PR specifying what changes you should make.
+- If you receive a comment, you have 90 days to implement the requested changes.
+- After this period, your PR will be closed due to inactivity and labeled `status: stale`.
+- Even after your PR is closed, you may request for us to reopen it. Just be sure to address the issues!
+
+This policy ensures that PRs awaiting review are up to date and ready to merge.
+
+### Merge conflicts and rebasing
+Some game updates introduce significant breaking changes that may create merge conflicts in your PR. To resolve them, you will need to update or rebase your PR.
+
+Most merge conflicts are small and will only require you to modify a few files to resolve them.
+However, some changes are so big that your commit history will be a total mess!
+In this case, you will have to perform a [**rebase**](https://docs.github.com/en/get-started/using-git/about-git-rebase).
+This process reapplies your changes on top of the updated branch and cleanly resolves the merge conflicts.
+
+> [!TIP]
+> If your commit history becomes too long, you can use rebase to `squash` your PR's commits into a single commit.
+
+## Code PRs
+
+> [!IMPORTANT]
+> This guide does not cover compiling. If you have trouble compiling the game, refer to the [Compilation Guide](https://github.com/FunkinCrew/Funkin/blob/main/docs/COMPILING.md).
+
+Code-based PRs make changes such as **fixing bugs** or **implementing new features** in the game.
+
+This involves modifying one or several of the repository’s `.hx` files, found within the `source/` folder.
+
+### Codestyle
+Before submitting your PR, check that your code follows the [Style Guide](https://github.com/FunkinCrew/Funkin/blob/main/docs/style-guide.md). This keeps your code consistent with the rest of the codebase!
+
+### Code comments
+Code comments help others understand your changes, so the way you write them is important!
+Here are some guidelines for writing comments in your code:
+- Leave comments only when you believe a piece of code warrants explanation. If a piece of code is self-explanatory, it does not need a comment.
+- Ensure that your comments provide meaningful insight into the function or purpose of the code.
+- Write your comments in a clear and concise manner.
+- Only sign your comments with your name when your changes are complex and may require further explanation.
+
+### Example code comments
+#### DO NOT:
+Below are examples of what you SHOULD NOT do when writing code comments.
+```haxe
+/**
+  * jumps around the song
+  * works with bpm changes but skipped notes still hurt
+  * @param sections how many sections to jump, negative = backwards
+  */
+function changeSection(sections:Int):Void
+{
+  // Pause the music, as you probably guessed
+  // FlxG.sound.music.pause();
+
+  // Set the target time in steps, I don’t really get how this works though lol - [GitHub username]
+  var targetTimeSteps:Float = Conductor.instance.currentStepTime + (Conductor.instance.stepsPerMeasure * sections);
+  var targetTimeMs:Float = Conductor.instance.getStepTimeInMs(targetTimeSteps);
+
+  // Don't go back in time to before the song started, that would probably break a lot of things and cause a bunch of problems!
+  targetTimeMs = Math.max(0, targetTimeMs);
+
+  if (FlxG.sound.music != null) // If the music is not null, set the time to the target time
+  {
+    FlxG.sound.music.time = targetTimeMs;
+  }
+
+  // Handle skipped notes and events and all that jazz
+  handleSkippedNotes();
+  SongEventRegistry.handleSkippedEvents(songEvents, Conductor.instance.songPosition);
+  // regenNoteData(FlxG.sound.music.time);
+
+  Conductor.instance.update(FlxG.sound?.music?.time ?? 0.0);
+
+  // I hate this function - [GitHub username]
+  resyncVocals();
+}
+```
+
+```haxe
+// End the song when the music is complete.
+FlxG.sound.music.onComplete = function() {
+  endSong(skipEndingTransition);
+};
+// A negative instrumental offset means the song skips the first few milliseconds of the track.
+// This just gets added into the startTimestamp behavior so we don't need to do anything extra.
+FlxG.sound.music.play(true, Math.max(0, startTimestamp - Conductor.instance.combinedOffset));
+FlxG.sound.music.pitch = playbackRate;
+
+// Prevent the volume from being wrong.
+FlxG.sound.music.volume = 1.0;
+// IF fadetween is not null we cancel it
+if (FlxG.sound.music.fadeTween != null) FlxG.sound.music.fadeTween.cancel();
+
+// Play the vocals
+trace('Playing vocals...');
+// Add the vocals
+add(vocals);
+// Play the vocals for real this time lol
+vocals.play();
+// Set the vocals volume
+vocals.volume = 1.0;
+// Set the vocals pitch
+vocals.pitch = playbackRate;
+// Set the vocals time to the music time
+vocals.time = FlxG.sound.music.time;
+// trace('${FlxG.sound.music.time}');
+// trace('${vocals.time}');
+// functionThatWasntHereBeforeThisPRorSomethingIdKLOL();
+/* testsprite = new FlxSprite(0, 0);
+testsprite.loadGraphic(Paths.image('test'));
+testsprite.screenCenter();
+add(testsprite); */
+
+// Me too [GitHub username] I hate this function it gave me pain and suffering - Girlfriend
+resyncVocals();
+```
+
+```haxe
+#if FEATURE_DEBUG_FUNCTIONS
+// PAGEUP: who knows what this does
+// SHIFT+PAGEUP: There will be dire consequences.
+if (FlxG.keys.justPressed.PAGEUP) changeSection(FlxG.keys.pressed.SHIFT ? 20 : 2);
+// PAGEUP: who knows what this does
+// SHIFT+PAGEUP: There will be dire consequences.
+if (FlxG.keys.justPressed.PAGEDOWN) changeSection(FlxG.keys.pressed.SHIFT ? -20 : -2);
+#end
+```
+
+#### DO:
+Below are examples on what you SHOULD do when writing code comments.
+```haxe
+/**
+  * Jumps forward or backward a number of sections in the song.
+  * Accounts for BPM changes, does not prevent death from skipped notes.
+  * @param sections The number of sections to jump, negative to go backwards.
+  */
+function changeSection(sections:Int):Void
+{
+  var targetTimeSteps:Float = Conductor.instance.currentStepTime + (Conductor.instance.stepsPerMeasure * sections);
+  var targetTimeMs:Float = Conductor.instance.getStepTimeInMs(targetTimeSteps);
+
+  // Don't go back in time to before the song started.
+  targetTimeMs = Math.max(0, targetTimeMs);
+
+  if (FlxG.sound.music != null)
+  {
+    FlxG.sound.music.time = targetTimeMs;
+  }
+
+  handleSkippedNotes();
+  SongEventRegistry.handleSkippedEvents(songEvents, Conductor.instance.songPosition);
+
+  Conductor.instance.update(FlxG.sound?.music?.time ?? 0.0);
+
+  resyncVocals();
+}
+```
+
+```haxe
+FlxG.sound.music.onComplete = function() {
+  endSong(skipEndingTransition);
+};
+// A negative instrumental offset means the song skips the first few milliseconds of the track.
+// This just gets added into the startTimestamp behavior so we don't need to do anything extra.
+FlxG.sound.music.play(true, Math.max(0, startTimestamp - Conductor.instance.combinedOffset));
+FlxG.sound.music.pitch = playbackRate;
+
+// Prevent the volume from being wrong.
+FlxG.sound.music.volume = 1.0;
+if (FlxG.sound.music.fadeTween != null) FlxG.sound.music.fadeTween.cancel();
+
+trace('Playing vocals...');
+add(vocals);
+vocals.play();
+vocals.volume = 1.0;
+vocals.pitch = playbackRate;
+vocals.time = FlxG.sound.music.time;
+resyncVocals();
+```
+
+```haxe
+#if FEATURE_DEBUG_FUNCTIONS
+// PAGEUP: Skip forward two sections.
+// SHIFT+PAGEUP: Skip forward twenty sections.
+if (FlxG.keys.justPressed.PAGEUP) changeSection(FlxG.keys.pressed.SHIFT ? 20 : 2);
+// PAGEDOWN: Skip backward two section. Doesn't replace notes.
+// SHIFT+PAGEDOWN: Skip backward twenty sections.
+if (FlxG.keys.justPressed.PAGEDOWN) changeSection(FlxG.keys.pressed.SHIFT ? -20 : -2);
+#end
+```
+
+## Documentation PRs
+Documentation-based PRs make changes such as **fixing typos** or **adding new information** in documentation files.
+
+This involves modifying one or several of the repository’s `.md` files, found throughout the repository.
+
+Make sure your changes are easy to understand and formatted consistently to maximize clarity and readability.
+
+> [!CAUTION]
+> DO NOT TOUCH THE `LICENSE.md` FILE, EVEN TO MAKE SMALL CHANGES!
+
+### Example Documentation PR
+#### DO NOT:
+```
+// The original documentation
+- `F2`: ***OVERLAY***: Enables the Flixel debug overlay, which has partial support for scripting.
+- `F3`: ***SCREENSHOT***: Takes a screenshot of the game and saves it to the local `screenshots` directory. Works outside of debug builds too!
+- `F4`: ***EJECT***: Forcibly switch state to the Main Menu (with no extra transition). Useful if you're stuck in a level and you need to get out!
+- `F5`: ***HOT RELOAD***: Forcibly reload the game's scripts and data files, then restart the current state. If any files in the `assets` folder have been modified, the game should process the changes for you! NOTE: Known bug, this does not reset song charts or song scripts, but it should reset everything else (such as stage layout data and character animation data).
+- `CTRL-SHIFT-L`: ***FORCE CRASH***: Immediately crash the game with a detailed crash log and a stack trace.
+
+// The new PR additions
+- `ctrl alt shift e`: No idea what this does
+- `alt-f4`: closes the game
+```
+
+#### DO:
+```
+// The original documentation
+- `F2`: ***OVERLAY***: Enables the Flixel debug overlay, which has partial support for scripting.
+- `F3`: ***SCREENSHOT***: Takes a screenshot of the game and saves it to the local `screenshots` directory. Works outside of debug builds too!
+- `F4`: ***EJECT***: Forcibly switch state to the Main Menu (with no extra transition). Useful if you're stuck in a level and you need to get out!
+- `F5`: ***HOT RELOAD***: Forcibly reload the game's scripts and data files, then restart the current state. If any files in the `assets` folder have been modified, the game should process the changes for you! NOTE: Known bug, this does not reset song charts or song scripts, but it should reset everything else (such as stage layout data and character animation data).
+- `CTRL-SHIFT-L`: ***FORCE CRASH***: Immediately crash the game with a detailed crash log and a stack trace.
+
+// The new PR additions
+- `CTRL-ALT-SHIFT-E`: ***DUMP SAVE DATA***: Prompts the user to save their save data as a JSON file, so its contents can be viewed. Only available on debug builds.
+- `ALT-F4`: ***CLOSE GAME***: Closes the game forcibly on Windows.
+```
+
+## GitHub PRs
+GitHub-related PRs make changes such as **tweaking Issue Templates** or **updating the repository’s workflows**.
+
+This involves modifying one or several of the repository’s `.yml` files, or any other file in the `.github` folder.
+
+Please test these changes on your fork’s main branch to avoid breaking anything in this repository (e.g. GitHub Actions, issue templates, etc.)!
+
+## funkin.assets PRs
+The `assets` submodule has its own repository called [funkin.assets](https://github.com/FunkinCrew/funkin.assets).
+
+If you only modify files in the `assets` folder, open a PR in the `funkin.assets` repository instead of the main repository.
+
+If you simultaneously modify files from both repositories, then open two separate PRs and explain the connection in your PR descriptions.
+
+Be sure to choose `main` as the base branch for `funkin.assets` PRs, as no `develop` branch exists for that repository.
+
+### Charting PRs
+Charting PRs make changes such as **adjusting chart metadata**.
+
+This involves modifying one or several of the `funkin.assets` repository's `*-metadata.json` files, found in the `preload/data/songs/` directory.
+
+> [!CAUTION]
+> We **do not** accept changes to the chart `.json` file itself.
+> If you find an error in the game's charts, please open an issue in the `Funkin` repo, and the Funkin' Crew will review it and make tweaks themselves as necessary.
+
+These PRs should only be opened in the `funkin.assets` repository.
+
+# Closing
+Thank you for reading the Contributing Guide.
+
+We look forward to seeing your contributions to the game!

docs/Funkin' Debug Hotkeys.md

@@ -3,10 +3,13 @@
 Most of this functionality is only available on debug builds of the game!
 
 ## Any State
+- `INSERT`: ***MEMORY GARBAGE COLLECTION***: Immediately perform memory garbage collection.
 - `F2`: ***OVERLAY***: Enables the Flixel debug overlay, which has partial support for scripting.
 - `F3`: ***SCREENSHOT***: Takes a screenshot of the game and saves it to the local `screenshots` directory. Works outside of debug builds too!
 - `F4`: ***EJECT***: Forcibly switch state to the Main Menu (with no extra transition). Useful if you're stuck in a level and you need to get out!
 - `F5`: ***HOT RELOAD***: Forcibly reload the game's scripts and data files, then restart the current state. If any files in the `assets` folder have been modified, the game should process the changes for you! NOTE: Known bug, this does not reset song charts or song scripts, but it should reset everything else (such as stage layout data and character animation data).
+- `CTRL-ALT-SHIFT-L`: ***FORCE CRASH***: Immediately crash the game with a detailed crash log and a stack trace. (Only works in the Main Menu on debug builds).
+
 - `CTRL-SHIFT-L`: ***FORCE CRASH***: Immediately crash the game with a detailed crash log and a stack trace.
 
 ## **Play State**
@@ -17,15 +20,27 @@ Most of this functionality is only available on debug builds of the game!
 - `9`: NEATO!
 - `PAGEUP` (MacOS: `Fn-Up`): ***FORWARDS TIME TRAVEL***: Move forward by 2 sections. Hold SHIFT to move forward by 20 sections instead.
 - `PAGEDOWN` (MacOS: `Fn-Down`): ***BACKWARDS TIME TRAVEL***: Move backward by 2 sections. Hold SHIFT to move backward by 20 sections instead.
+- `CHART Hotkey`: ***OPEN CHART EDITOR***: Open the Chart Editor with the current song loaded.
+- `STAGE Hotkey`: ***OPEN STAGE EDITOR***: Open the old Stage Editor overlay.
 
 ## **Freeplay State**
-- `F` (Freeplay Menu) - Move to Favorites
-- `Q` (Freeplay Menu) - Back one category
-- `E` (Freeplay Menu) - Forward one category
+- `P`: ***SWITCH TO PICO/BF***: Switch to Pico or BF (reopens Freeplay as the other character).
+- `T`: ***TEST RANK ANIMATION***: Play the Gold Perfect rank animation on the currently selected song.
+- `SHIFT-ACCEPT`: ***BOTPLAY MODE***: Start a song with Botplay mode enabled.
+- `CTRL-Switch Song`: Play the first unlocked alternate instrumental as the song preview.
 
 ## **Title State**
-- `Y` - WOAH
+- `ESCAPE`: ***QUIT***: Quit the game.
+- `D`: COOL
+- `UI LEFT`/`UI RIGHT Hotkey`: 2COOL
+- `Y`: WOAH
 
 ## **Main Menu**
 - `~`: ***DEBUG***: Opens a menu to access the Chart Editor and other work-in-progress editors. Rebindable in the options menu.
+- `SHIFT-ACCEPT`: ***OPEN FREEPLAY AS PICO***: When selecting Freeplay, open the Freeplay menu with the playable character set to Pico.
 - `CTRL-ALT-SHIFT-W`: ***ALL ACCESS***: Unlocks all songs in Freeplay. Only available on debug builds.
+- `CTRL-ALT-SHIFT-M`: ***NO MORE ACCESS***: Re-locks all songs in Freeplay except those unlocked by default. Only available on debug builds.
+- `CTRL-ALT-SHIFT-R`: ***GREAT SCORE?***: Give the user a hypothetical overridden score, and see if we can maintain that golden P rank. Only available on debug builds.
+- `CTRL-ALT-SHIFT-P`: ***CHARACTER UNLOCK SCREEN***: Forces the Character Select screen to play Pico's unlocking animation. Only available on debug builds.
+- `CTRL-ALT-SHIFT-N`: ***CHARACTER NOT SEEN***: Marks all characters as not seen and enables BF's new character unlocked animation in Freeplay. Only available on debug builds.
+- `CTRL-ALT-SHIFT-E`: ***DUMP SAVE DATA***: Prompts the user to save their save data as a JSON file, so its contents can be viewed. Only available on debug builds.

docs/INSTALLING_MODS.md

@@ -0,0 +1,32 @@
+# HTML5/Web
+1. Nope
+
+# Windows
+1. Start the game at least once. This will create a `mods` folder if it doesn't already exist, alongside the executable.
+2. Extract the mod you downloaded from its ZIP file, and place the mod folder into the game's `mods` folder.
+3. Restart the game. The game should detect the mod and start with it.
+
+# Linux
+1. Start the game at least once. This will create a `mods` folder if it doesn't already exist, alongside the executable.
+2. Extract the mod you downloaded from its ZIP file, and place the mod folder into the game's `mods` folder.
+3. Restart the game. The game should detect the mod and start with it.
+
+# MacOS
+1. Start the game at least once. This will create a `mods` folder if it doesn't already exist in the game's system files.
+2. Right click `Funkin.app` and select `Show Package Contents`.
+3. Navigate to `Contents/Resources/mods`.
+4. Extract the mod you downloaded from its ZIP file, and place the mod folder into the game's `mods` folder.
+5. Restart the game. The game should detect the mod and start with it.
+
+# Android
+1. Start the game at least once. This will create a `mods` folder deep in your system files.
+2. Get an Android file browser that lets you view the app data files, or use Android Studio and open up the Device Explorer.
+3. Locate the `/sdcard/Android/obb/me.funkin.fnf/mods` folder.
+4. Extract the mod you downloaded from its ZIP file, and place the mod folder into the game's `mods` folder.
+5. Restart the game (you may have to [force close](https://support.google.com/android/answer/9079646?hl=en) the app first). The game should detect the mod and start with it.
+
+# iOS
+1. Start the game at least once. This will create a `mods` folder in your system files.
+2. Open the Files app, and navigate to `On My iPhone` -> `Friday Night Funkin` -> `mods`.
+3. Extract the mod you downloaded from its ZIP file, and place the mod folder into the game's `mods` folder.
+4. Restart the game (you may have to [force close](https://support.apple.com/en-us/109359) the app first). The game should detect the mod and start with it.

docs/TRACY.md

@@ -0,0 +1,12 @@
+# Tracy Performance Profiling
+
+In v0.5.1, Funkin' gained support for a powerful instrumentation-based profiler known as Tracy. This development tool allows you to see exactly what the game is doing at any given moment, how long each function is taking to call, and even how memory is allocated and deallocated. This is the most powerful tool in your toolbox for diagnosing and resolving performance issues.
+
+## How to Use Tracy
+
+1. Download [Tracy](https://github.com/wolfpld/tracy)
+2. Build the game with the `FEATURE_DEBUG_TRACY` flag. For example, `lime build windows -debug -DFEATURE_DEBUG_TRACY`
+3. Start Tracy, click Connect. Tracy will start waiting for Funkin' to start.
+4. Start the game with Tracy enabled.
+
+![Image](https://github.com/user-attachments/assets/2a394ca7-bc21-4fe3-ae55-347768fb5b87)

docs/TROUBLESHOOTING.md

@@ -1,11 +1,19 @@
 # Troubleshooting Common Compilation Issues
 
+- Any output containing `WARNING` or `(WDeprecated)`
+  - Will not disrupt compilation and can be safely ignored.
+
+- `This version of hxcpp` ... `Would you like to do this now [y/n]`
+  - Type "y" into the console and press Enter.
+
 - Weird macro error with a very tall call stack: Restart Visual Studio Code
   - NOTE: This is caused by Polymod somewhere, and seems to only occur when there is another compile error somewhere in the program. There is a bounty up for it.
 
-- `Get Thread Context Failed`: Turn off other expensive applications while building
+- `Get Thread Context Failed`
+  - Turn off other expensive applications while building.
 
-- `Type not found: T1`: This is thrown by `json2object`, make sure the data type of `@:default` is correct.
+- `Type not found: T1`
+  - This is thrown by `json2object`, make sure the data type of `@:default` is correct.
   - NOTE: `flixel.util.typeLimit.OneOfTwo` isn't supported.
 
 - `Class lists not properly generated. Try cleaning out your export folder, restarting your IDE, and rebuilding your project.`
@@ -15,9 +23,31 @@
   - This error occurs if the PDB file located in your `export` folder is in use or exceeds 4 GB. Try deleting the `export` folder and building again from scratch.
 
 - `error: RPC failed; curl 92 HTTP/2 stream 0 was not closed cleanly: PROTOCOL_ERROR (err 1)`
-  - This error can happen during cloning as a result of poor network connectivity. A common fix is to run ` git config --global http.postBuffer 4096M` in your terminal.
+  - This error can happen during cloning as a result of poor network connectivity. A common fix is to run `git config --global http.postBuffer 4096M` in your terminal.
 
 - Repository is missing an `assets` folder, or `assets` folder is empty.
   - You did not clone the repository correctly! Copy the path to your `funkin` folder and run `cd the\path\you\copied`. Then follow the compilation guide starting from **Step 4**.
 
 - Other compilation issues may be caused by installing bad library versions. Try deleting the `.haxelib` folder and following the guide starting from **Step 5**.
+
+## Lime Related Issues
+- Segmentation fault and/or crash after `Done mapping time changes: [SongTimeChange(0ms,102bpm)]`
+  - Caused by using official Lime instead of Funkin's fork. Reinstalling Lime should fix it.  
+    (NOTE: Make sure you do this via `hmm` (e.g `hmm reinstall -f lime`) to guarantee you get Funkin's version of Lime.)
+
+- `Uncaught exception - Could not find lime.ndll.` ... `Advanced users may run "lime rebuild cpp" instead.`
+  - If on Linux:
+    - The binaries GLibC version might more recent than the one your system supports. Running the commands below should fix it.
+      ```
+      cd .haxelib/lime/git
+      git submodule init
+      git submodule sync
+      git submodule update
+      cd ../../..
+      # Note: The command and packages here might be different depending on your distro.
+      sudo apt install libgl1-mesa-dev libglu1-mesa-dev g++ g++-multilib gcc-multilib libasound2-dev libx11-dev libxext-dev libxi-dev libxrandr-dev libxinerama-dev libpulse-dev
+      lime rebuild cpp -64 -release -clean
+      ```
+      
+  - The binaries are missing for some reason. You can download pre-built binaries from [Funkin's Lime](https://github.com/FunkinCrew/lime/tree/dev-funkin/ndll).  
+    You should copy them to `.haxelib/lime/git/ndll/<PLATFORM>64/`, where `<PLATFORM>` is the current platform you're on, which can be either Windows, Linux or MacOS.

docs/setup-android-win64.bat

@@ -0,0 +1,66 @@
+@echo off
+
+set ZIP_FILE="./temp/_temp_jdk.zip"
+set OUTPUT_DIR="./temp/"
+set SIX_LINK="https://drive.usercontent.google.com/download?id=1GqFpIk_bkxFb0tNN3x9LxnN-Zh_oDUX5&export=download&authuser=0&confirm=t&uuid=43108c0a-bd53-4465-86f3-80aaceaa7a38&at=APZUnTVNS_BV9cNyC_iicDInosmz%3A1718921284514"
+set EIGHT_LINK="https://drive.usercontent.google.com/download?id=1X8jjtYYos8aDfZKwehGS9B3zFQa-sCb-&export=download&authuser=0&confirm=t&uuid=07b24a6c-5352-4ba5-9fb8-cff151a6d91e&at=APZUnTUfw26NBAl0nCMn6HBKgHwK%3A1718922303598"
+
+echo MAKING TEMP
+mkdir %OUTPUT_DIR%
+echo MADE TEMP
+
+
+
+echo INSTALLING ANDROID BUILD TOOLS
+call .\asclt\bin\sdkmanager "build-tools;32.0.0" --sdk_root="%LOCALAPPDATA%/Android/Sdk/"
+call .\asclt\bin\sdkmanager "build-tools;32.1.0-rc1" --sdk_root="%LOCALAPPDATA%/Android/Sdk/"
+echo INSTALLED ANDROID BUILD TOOLS
+
+
+
+echo INSTALLING ANDROID SDK
+REM First install the sdks
+call .\asclt\bin\sdkmanager "platforms;android-29" --sdk_root="%LOCALAPPDATA%/Android/Sdk/"
+echo ANDROID SDK INSTALLED
+
+
+
+echo INSTALLING ANDROID NDK
+REM then the ndks
+call ./asclt/bin/sdkmanager "ndk;21.4.7075529" --sdk_root="%LOCALAPPDATA%/Android/Sdk/"
+echo ANDROID NDK INSTALLED
+
+
+
+echo DOWNLOADING JDK
+call curl -o %ZIP_FILE% %SIX_LINK%
+echo DOWNLOADED JDK
+
+
+
+echo UNZIPPING JDK
+call powershell -Command "Expand-Archive -Path '%ZIP_FILE%' -DestinationPath '%OUTPUT_DIR%' -Force"
+echo UNZIPPED JDK
+
+
+
+echo MAKING JDK PATH
+mkdir "%LOCALAPPDATA%/Android/jdk"
+echo MADE JDK PATH
+
+
+
+echo MOVING JDK TO PROPER PATH
+call move "%OUTPUT_DIR%/jdk-17.0.11+9" "%LOCALAPPDATA%/Android/jdk/"
+echo MOVED JDK
+
+
+
+echo LIME SETTING UP
+haxelib run lime config ANDROID_SDK %LOCALAPPDATA%\Android\Sdk
+haxelib run lime config ANDROID_NDK_ROOT %LOCALAPPDATA%\Android\Sdk\ndk\21.4.7075529
+haxelib run lime config JAVA_HOME %LOCALAPPDATA%\Android\Sdk\jdk\jdk-17.0.11+9
+haxelib run lime config ANDROID_SETUP true
+echo DONE
+
+pause

docs/setup-android-win86.bat

@@ -0,0 +1,66 @@
+@echo off
+
+set ZIP_FILE="./temp/_temp_jdk.zip"
+set OUTPUT_DIR="./temp/"
+set SIX_LINK="https://drive.usercontent.google.com/download?id=1GqFpIk_bkxFb0tNN3x9LxnN-Zh_oDUX5&export=download&authuser=0&confirm=t&uuid=43108c0a-bd53-4465-86f3-80aaceaa7a38&at=APZUnTVNS_BV9cNyC_iicDInosmz%3A1718921284514"
+set EIGHT_LINK="https://drive.usercontent.google.com/download?id=1X8jjtYYos8aDfZKwehGS9B3zFQa-sCb-&export=download&authuser=0&confirm=t&uuid=07b24a6c-5352-4ba5-9fb8-cff151a6d91e&at=APZUnTUfw26NBAl0nCMn6HBKgHwK%3A1718922303598"
+
+echo MAKING TEMP
+mkdir %OUTPUT_DIR%
+echo MADE TEMP
+
+
+
+echo INSTALLING ANDROID BUILD TOOLS
+call .\asclt\bin\sdkmanager "build-tools;32.0.0" --sdk_root="%LOCALAPPDATA%/Android/Sdk/"
+call .\asclt\bin\sdkmanager "build-tools;32.1.0-rc1" --sdk_root="%LOCALAPPDATA%/Android/Sdk/"
+echo INSTALLED ANDROID BUILD TOOLS
+
+
+
+echo INSTALLING ANDROID SDK
+REM First install the sdks
+call .\asclt\bin\sdkmanager "platforms;android-29" --sdk_root="%LOCALAPPDATA%/Android/Sdk/"
+echo ANDROID SDK INSTALLED
+
+
+
+echo INSTALLING ANDROID NDK
+REM then the ndks
+call ./asclt/bin/sdkmanager "ndk;21.4.7075529" --sdk_root="%LOCALAPPDATA%/Android/Sdk/"
+echo ANDROID NDK INSTALLED
+
+
+
+echo DOWNLOADING JDK
+call curl -o %ZIP_FILE% %EIGHT_LINK%
+echo DOWNLOADED JDK
+
+
+
+echo UNZIPPING JDK
+call powershell -Command "Expand-Archive -Path '%ZIP_FILE%' -DestinationPath '%OUTPUT_DIR%' -Force"
+echo UNZIPPED JDK
+
+
+
+echo MAKING JDK PATH
+mkdir "%LOCALAPPDATA%/Android/jdk"
+echo MADE JDK PATH
+
+
+
+echo MOVING JDK TO PROPER PATH
+call move "%OUTPUT_DIR%/jdk-17.0.11+9" "%LOCALAPPDATA%/Android/jdk/"
+echo MOVED JDK
+
+
+
+echo LIME SETTING UP
+haxelib run lime config ANDROID_SDK %LOCALAPPDATA%\Android\Sdk
+haxelib run lime config ANDROID_NDK_ROOT %LOCALAPPDATA%\Android\Sdk\ndk\21.4.7075529
+haxelib run lime config JAVA_HOME %LOCALAPPDATA%\Android\Sdk\jdk\jdk-17.0.11+9
+haxelib run lime config ANDROID_SETUP true
+echo DONE
+
+pause

docs/style-guide.md

@@ -4,7 +4,7 @@ This short document is designed to give a run-down on how code should be formatt
 
 ## Notes on IDEs and Extensions
 
-The Visual Studio Code IDE is highly recommended, as this repo contains various configuration that works with VSCode extensions to automatically style certain things for you.
+The Visual Studio Code IDE is highly recommended, as this repo contains various configurations that work with VSCode extensions to automatically style certain things for you.
 
 VSCode is also the only IDE that has any good tools for Haxe so yeah.
 

example_mods/introMod/_polymod_meta.json

@@ -6,7 +6,7 @@
       "name": "EliteMasterEric"
     }
   ],
-  "api_version": "0.5.0",
+  "api_version": "0.7.0",
   "mod_version": "1.0.0",
   "license": "Apache-2.0"
 }

example_mods/testing123/_polymod_meta.json

@@ -6,7 +6,7 @@
       "name": "EliteMasterEric"
     }
   ],
-  "api_version": "0.5.0",
+  "api_version": "0.7.0",
   "mod_version": "1.0.0",
   "license": "Apache-2.0"
 }

hmm.json

@@ -4,36 +4,63 @@
       "name": "FlxPartialSound",
       "type": "git",
       "dir": null,
-      "ref": "a1eab7b9bf507b87200a3341719054fe427f3b15",
-      "url": "https://github.com/FunkinCrew/FlxPartialSound.git"
+      "ref": "3c9f63e3501c20c0b60442089dc05306f5a87968",
+      "url": "https://github.com/FunkinDroidTeam/FlxPartialSound.git"
+    },
+    {
+      "name": "astc-compressor",
+      "type": "git",
+      "dir": null,
+      "ref": "9b0819150b67bf0d49145f250099b75d21be5839",
+      "url": "https://github.com/KarimAkra/astc-compressor"
+    },
+    {
+      "name": "extension-admob",
+      "type": "git",
+      "dir": null,
+      "ref": "02334589ff9603a5f483077a44395009644f6274",
+      "url": "https://github.com/FunkinCrew/extension-admob"
+    },
+    {
+      "name": "extension-androidtools",
+      "type": "haxelib",
+      "version": "2.2.2"
+    },
+    {
+      "name": "extension-haptics",
+      "type": "haxelib",
+      "version": "1.0.4"
+    },
+    {
+      "name": "extension-iapcore",
+      "type": "haxelib",
+      "version": "1.0.4"
+    },
+    {
+      "name": "extension-iarcore",
+      "type": "haxelib",
+      "version": "1.0.3"
     },
     {
       "name": "flixel",
       "type": "git",
       "dir": null,
-      "ref": "ffa691cb2d2d81de35b900a4411e4062ac84ab58",
+      "ref": "ac2a34fe4b3400bc04218f46320a65af0f337fc0",
       "url": "https://github.com/FunkinCrew/flixel"
     },
     {
       "name": "flixel-addons",
       "type": "git",
       "dir": null,
-      "ref": "7424db4e9164ff46f224a7c47de1b732d2542dd7",
+      "ref": "b9118f47f43a66bc0e5fbfcfd9903f0425e918ee",
       "url": "https://github.com/FunkinCrew/flixel-addons"
     },
-    {
-      "name": "flixel-text-input",
-      "type": "git",
-      "dir": null,
-      "ref": "951a0103a17bfa55eed86703ce50b4fb0d7590bc",
-      "url": "https://github.com/FunkinCrew/flixel-text-input"
-    },
     {
       "name": "flxanimate",
       "type": "git",
       "dir": null,
-      "ref": "0654797e5eb7cd7de0c1b2dbaa1efe5a1e1d9412",
-      "url": "https://github.com/Dot-Stuff/flxanimate"
+      "ref": "49214278b9124823582cdcecd94f4a1de9a4b36b",
+      "url": "https://github.com/FunkinCrew/flxanimate"
     },
     {
       "name": "format",
@@ -44,15 +71,15 @@
       "name": "funkin.vis",
       "type": "git",
       "dir": null,
-      "ref": "22b1ce089dd924f15cdc4632397ef3504d464e90",
+      "ref": "1966f8fbbbc509ed90d4b520f3c49c084fc92fd6",
       "url": "https://github.com/FunkinCrew/funkVis"
     },
     {
       "name": "grig.audio",
       "type": "git",
       "dir": "src",
-      "ref": "57f5d47f2533fd0c3dcd025a86cb86c0dfa0b6d2",
-      "url": "https://gitlab.com/haxe-grig/grig.audio.git"
+      "ref": "8567c4dad34cfeaf2ff23fe12c3796f5db80685e",
+      "url": "https://github.com/FunkinCrew/grig.audio"
     },
     {
       "name": "hamcrest",
@@ -63,36 +90,29 @@
       "name": "haxeui-core",
       "type": "git",
       "dir": null,
-      "ref": "51c23588614397089a5ce182cddea729f0be6fa0",
+      "ref": "47ee9f5fa02d422e186e844f87e68220cabfcc5b",
       "url": "https://github.com/haxeui/haxeui-core"
     },
     {
       "name": "haxeui-flixel",
       "type": "git",
       "dir": null,
-      "ref": "da27e833947f32ef007ed11f523aa5524f5a5d54",
+      "ref": "100f2c96beab619cfe72c567a058c41c71e3e998",
       "url": "https://github.com/haxeui/haxeui-flixel"
     },
     {
       "name": "hscript",
       "type": "git",
       "dir": null,
-      "ref": "12785398e2f07082f05034cb580682e5671442a2",
+      "ref": "8c1d238b069ef97cec13f5121b29d2afe2b8985d",
       "url": "https://github.com/FunkinCrew/hscript"
     },
-    {
-      "name": "hxCodec",
-      "type": "git",
-      "dir": null,
-      "ref": "61b98a7a353b7f529a8fec84ed9afc919a2dffdd",
-      "url": "https://github.com/FunkinCrew/hxCodec"
-    },
     {
       "name": "hxcpp",
       "type": "git",
       "dir": null,
-      "ref": "c6bac3d6c7d683f25104296b2f4c50f8c90b8349",
-      "url": "https://github.com/cortex-engine/hxcpp"
+      "ref": "5a0dc3f644dc676a4a092b7e6c8edc8be941f024",
+      "url": "https://github.com/FunkinCrew/hxcpp"
     },
     {
       "name": "hxcpp-debug-server",
@@ -120,6 +140,11 @@
       "type": "haxelib",
       "version": "1.3.0"
     },
+    {
+      "name": "hxvlc",
+      "type": "haxelib",
+      "version": "2.2.2"
+    },
     {
       "name": "json2object",
       "type": "git",
@@ -145,7 +170,7 @@
       "name": "lime",
       "type": "git",
       "dir": null,
-      "ref": "fe3368f611a84a19afc03011353945ae4da8fffd",
+      "ref": "e5f8c27124598505917a001588b560244731adfb",
       "url": "https://github.com/FunkinCrew/lime"
     },
     {
@@ -176,25 +201,32 @@
       "ref": "f61be7f7ba796595f45023ca65164a485aba0e7e",
       "url": "https://github.com/FunkinCrew/MassiveUnit"
     },
+    {
+      "name": "newgrounds",
+      "type": "git",
+      "dir": null,
+      "ref": "c8b30832027fa04f48fe6a45fa7903d5b265d56e",
+      "url": "https://github.com/Geokureli/Newgrounds/"
+    },
     {
       "name": "openfl",
       "type": "git",
       "dir": null,
-      "ref": "8306425c497766739510ab29e876059c96f77bd2",
+      "ref": "a0df7c3afe360c9af59a76e45007dbf4e53b5131",
       "url": "https://github.com/FunkinCrew/openfl"
     },
     {
       "name": "polymod",
       "type": "git",
       "dir": null,
-      "ref": "0fbdf27fe124549730accd540cec8a183f8652c0",
+      "ref": "db5dcf3ac4cb59197188a4442d75d4e76b350f40",
       "url": "https://github.com/larsiusprime/polymod"
     },
     {
       "name": "thx.core",
       "type": "git",
       "dir": null,
-      "ref": "76d87418fadd92eb8e1b61f004cff27d656e53dd",
+      "ref": "2bf2b992e06159510f595554e6b952e47922f128",
       "url": "https://github.com/fponticelli/thx.core"
     },
     {

source/Main.hx

@@ -1,18 +1,24 @@
 package;
 
+import flixel.FlxG;
 import flixel.FlxGame;
 import flixel.FlxState;
+import funkin.ui.FullScreenScaleMode;
 import funkin.Preferences;
 import funkin.util.logging.CrashHandler;
 import funkin.ui.debug.MemoryCounter;
 import funkin.save.Save;
 import haxe.ui.Toolkit;
+#if hxvlc
+import hxvlc.util.Handle;
+#end
 import openfl.display.FPS;
 import openfl.display.Sprite;
 import openfl.events.Event;
 import openfl.Lib;
 import openfl.media.Video;
 import openfl.net.NetStream;
+import funkin.util.WindowUtil;
 
 /**
  * The main class which initializes HaxeFlixel and starts the game in its initial state.
@@ -30,6 +36,15 @@ class Main extends Sprite
 
   public static function main():Void
   {
+    // Set the current working directory for Android and iOS devices
+    #if android
+    // On Android use External Files Dir.
+    Sys.setCwd(haxe.io.Path.addTrailingSlash(extension.androidtools.content.Context.getExternalFilesDir()));
+    #elseif ios
+    // On iOS use Documents Dir.
+    Sys.setCwd(haxe.io.Path.addTrailingSlash(lime.system.System.documentsDirectory));
+    #end
+
     // We need to make the crash handler LITERALLY FIRST so nothing EVER gets past it.
     CrashHandler.initialize();
     CrashHandler.queryStatus();
@@ -61,12 +76,6 @@ class Main extends Sprite
 
   function init(?event:Event):Void
   {
-    #if web
-    // set this variable (which is a function) from the lime version at lime/_internal/backend/html5/HTML5Application.hx
-    // The framerate cap will more thoroughly initialize via Preferences in InitState.hx
-    funkin.Preferences.lockedFramerateFunction = untyped js.Syntax.code("window.requestAnimationFrame");
-    #end
-
     if (hasEventListener(Event.ADDED_TO_STAGE))
     {
       removeEventListener(Event.ADDED_TO_STAGE, init);
@@ -102,12 +111,32 @@ class Main extends Sprite
     memoryCounter = new MemoryCounter(10, 13, 0xFFFFFF);
     #end
 
+    #if mobile
+    // Add this signal so we can reposition and resize the memory and fps counter.
+    FlxG.signals.preUpdate.add(repositionCounters.bind(true));
+    #end
+
     // George recommends binding the save before FlxGame is created.
     Save.load();
+
+    #if hxvlc
+    // Initialize hxvlc's Handle here so the videos are loading faster.
+    Handle.init();
+    #end
+
+    // Don't call anything from the preferences until the save is loaded!
+    #if web
+    // set this variable (which is a function) from the lime version at lime/_internal/backend/html5/HTML5Application.hx
+    // The framerate cap will more thoroughly initialize via Preferences in InitState.hx
+    funkin.Preferences.lockedFramerateFunction = untyped js.Syntax.code("window.requestAnimationFrame");
+    #end
+
+    WindowUtil.setVSyncMode(funkin.Preferences.vsyncMode);
+
     var game:FlxGame = new FlxGame(gameWidth, gameHeight, initialState, Preferences.framerate, Preferences.framerate, skipSplash, startFullscreen);
 
     // FlxG.game._customSoundTray wants just the class, it calls new from
-    // create() in there, which gets called when it's added to stage
+    // create() in there, which gets called when it's added to the stage
     // which is why it needs to be added before addChild(game) here
     @:privateAccess
     game._customSoundTray = funkin.ui.options.FunkinSoundTray;
@@ -118,6 +147,15 @@ class Main extends Sprite
     game.debugger.interaction.addTool(new funkin.util.TrackerToolButtonUtil());
     #end
 
+    #if !html5
+    FlxG.scaleMode = new FullScreenScaleMode();
+    #end
+
+    #if mobile
+    // Reposition and resize the memory and fps counter without lerping.
+    repositionCounters(false);
+    #end
+
     #if hxcpp_debug_server
     trace('hxcpp_debug_server is enabled! You can now connect to the game with a debugger.');
     #else
@@ -139,4 +177,56 @@ class Main extends Sprite
     funkin.input.Cursor.registerHaxeUICursors();
     haxe.ui.tooltips.ToolTipManager.defaultDelay = 200;
   }
+
+  #if mobile
+  function repositionCounters(lerp:Bool):Void
+  {
+    // Calling this so it gets scaled based on the resolution of the game and device's resolution.
+    var scale:Float = Math.min(FlxG.stage.stageWidth / FlxG.width, FlxG.stage.stageHeight / FlxG.height);
+
+    #if android
+    scale = Math.max(scale, 1);
+    #else
+    scale = Math.min(scale, 1);
+    #end
+    final thypos:Float = Math.max(FullScreenScaleMode.notchSize.x, 10);
+    if (fpsCounter != null)
+    {
+      fpsCounter.scaleX = fpsCounter.scaleY = scale;
+
+      if (FlxG.game != null)
+      {
+        if (lerp)
+        {
+          fpsCounter.x = flixel.math.FlxMath.lerp(fpsCounter.x, FlxG.game.x + thypos, FlxG.elapsed * 3);
+        }
+        else
+        {
+          fpsCounter.x = FlxG.game.x + FullScreenScaleMode.notchSize.x + 10;
+        }
+
+        fpsCounter.y = FlxG.game.y + (3 * scale);
+      }
+    }
+
+    if (memoryCounter != null)
+    {
+      memoryCounter.scaleX = memoryCounter.scaleY = scale;
+
+      if (FlxG.game != null)
+      {
+        if (lerp)
+        {
+          memoryCounter.x = flixel.math.FlxMath.lerp(memoryCounter.x, FlxG.game.x + thypos, FlxG.elapsed * 3);
+        }
+        else
+        {
+          memoryCounter.x = FlxG.game.x + FullScreenScaleMode.notchSize.x + 10;
+        }
+
+        memoryCounter.y = FlxG.game.y + (13 * scale);
+      }
+    }
+  }
+  #end
 }

source/Postbuild.hx

@@ -29,7 +29,7 @@ class Postbuild
 
       var buildTime:Float = roundToTwoDecimals(end - start);
 
-      trace('Build took: ${buildTime} seconds');
+      Sys.println('[INFO] Build took: ${buildTime} seconds');
     }
   }
 

source/Prebuild.hx

@@ -11,12 +11,19 @@ class Prebuild
 
   static function main():Void
   {
+    var start:Float = Sys.time();
+    // Sys.println('[INFO] Performing pre-build tasks...');
+
     saveBuildTime();
-    trace('Building...');
+
+    var end:Float = Sys.time();
+    var duration:Float = end - start;
+    // Sys.println('[INFO] Finished pre-build tasks in $duration seconds.');
   }
 
   static function saveBuildTime():Void
   {
+    // PostBuild.hx reads this file and computes the total build duration.
     var fo:sys.io.FileOutput = File.write(BUILD_TIME_FILE);
     var now:Float = Sys.time();
     fo.writeDouble(now);

source/cpp/vm/tracy/TracyProfiler.hx

@@ -24,6 +24,27 @@ extern class Native_TracyProfiler
   @:native('::__hxcpp_tracy_framemark')
   public static function frameMark():Void;
 
+  /**
+    Mark a named frame. Allows creating multiple frame sets for different timing categories.
+    Each unique name creates a separate frame set in the Tracy timeline.
+  **/
+  @:native('::__hxcpp_tracy_framemark_named')
+  public static function frameMarkNamed(_name:String):Void;
+
+  /**
+    Mark the start of a discontinuous frame. Use for periodic work with gaps.
+    Must be paired with frameMarkEnd() using the same name.
+  **/
+  @:native('::__hxcpp_tracy_framemark_start')
+  public static function frameMarkStart(_name:String):Void;
+
+  /**
+    Mark the end of a discontinuous frame. Use for periodic work with gaps.
+    Must be paired with frameMarkStart() using the same name.
+  **/
+  @:native('::__hxcpp_tracy_framemark_end')
+  public static function frameMarkEnd(_name:String):Void;
+
   /**
     Print a message into Tracy's log.
   **/
@@ -71,6 +92,18 @@ class Cppia_TracyProfiler
   public static function frameMark()
     Native_TracyProfiler.frameMark();
 
+  @:inheritDoc(cpp.vm.tracy.Native_TracyProfiler.frameMarkNamed)
+  public static function frameMarkNamed(_name:String)
+    Native_TracyProfiler.frameMarkNamed(_name);
+
+  @:inheritDoc(cpp.vm.tracy.Native_TracyProfiler.frameMarkStart)
+  public static function frameMarkStart(_name:String)
+    Native_TracyProfiler.frameMarkStart(_name);
+
+  @:inheritDoc(cpp.vm.tracy.Native_TracyProfiler.frameMarkEnd)
+  public static function frameMarkEnd(_name:String)
+    Native_TracyProfiler.frameMarkEnd(_name);
+
   @:inheritDoc(cpp.vm.tracy.Native_TracyProfiler.message)
   public static function message(_msg:String, ?_color:Int = 0x000000)
     Native_TracyProfiler.message(_msg, _color);

source/funkin/Assets.hx

@@ -6,8 +6,14 @@ import openfl.utils.Future;
  * A wrapper around `openfl.utils.Assets` which disallows access to the harmful functions.
  * Later we'll add Funkin-specific caching to this.
  */
+@:nullSafety
 class Assets
 {
+  /**
+   * The assets cache.
+   */
+  public static var cache:openfl.utils.IAssetCache = openfl.utils.Assets.cache;
+
   /**
    * Get the file system path for an asset
    * @param path The asset path to load from, relative to the assets folder
@@ -144,16 +150,31 @@ class Assets
     return openfl.utils.Assets.list(type);
   }
 
+  /**
+   * Checks if a library with the given name exists.
+   * @param name The name to check.
+   * @return Whether or not the library exists.
+   */
   public static function hasLibrary(name:String):Bool
   {
     return openfl.utils.Assets.hasLibrary(name);
   }
 
+  /**
+   * Retrieves a library with the given name.
+   * @param name The name of the library to get.
+   * @return The library with the given name.
+   */
   public static function getLibrary(name:String):lime.utils.AssetLibrary
   {
     return openfl.utils.Assets.getLibrary(name);
   }
 
+  /**
+   * Loads a library with the given name.
+   * @param name The name of the library to load.
+   * @return An `AssetLibary` object.
+   */
   public static function loadLibrary(name:String):Future<openfl.utils.AssetLibrary>
   {
     return openfl.utils.Assets.loadLibrary(name);

source/funkin/Conductor.hx

@@ -6,6 +6,7 @@ import flixel.math.FlxMath;
 import funkin.data.song.SongData.SongTimeChange;
 import funkin.data.song.SongDataUtils;
 import funkin.save.Save;
+import funkin.util.TimerUtil.SongSequence;
 import haxe.Timer;
 import flixel.sound.FlxSound;
 
@@ -92,6 +93,12 @@ class Conductor
    */
   public var songPosition(default, null):Float = 0;
 
+  /**
+   * The offset between frame time and music time.
+   * Used in `getTimeWithDelta()` to get a more accurate music time when on higher framerates.
+   */
+  var songPositionDelta(default, null):Float = 0;
+
   var prevTimestamp:Float = 0;
   var prevTime:Float = 0;
 
@@ -242,25 +249,18 @@ class Conductor
    * No matter if you're using a local conductor or not, this always loads
    * to/from the save file
    */
-  public var inputOffset(get, set):Int;
+  public var globalOffset(get, never):Int;
 
   /**
    * An offset set by the user to compensate for audio/visual lag
    * No matter if you're using a local conductor or not, this always loads
    * to/from the save file
    */
-  public var audioVisualOffset(get, set):Int;
+  public var audioVisualOffset(get, never):Int;
 
-  function get_inputOffset():Int
+  function get_globalOffset():Int
   {
-    return Save?.instance?.options?.inputOffset ?? 0;
-  }
-
-  function set_inputOffset(value:Int):Int
-  {
-    Save.instance.options.inputOffset = value;
-    Save.instance.flush();
-    return Save.instance.options.inputOffset;
+    return Preferences.globalOffset;
   }
 
   function get_audioVisualOffset():Int
@@ -268,18 +268,11 @@ class Conductor
     return Save?.instance?.options?.audioVisualOffset ?? 0;
   }
 
-  function set_audioVisualOffset(value:Int):Int
-  {
-    Save.instance.options.audioVisualOffset = value;
-    Save.instance.flush();
-    return Save.instance.options.audioVisualOffset;
-  }
-
   public var combinedOffset(get, never):Float;
 
   function get_combinedOffset():Float
   {
-    return instrumentalOffset + audioVisualOffset + inputOffset;
+    return instrumentalOffset + formatOffset + globalOffset;
   }
 
   /**
@@ -401,8 +394,10 @@ class Conductor
    * @param	songPosition The current position in the song in milliseconds.
    *        Leave blank to use the FlxG.sound.music position.
    * @param applyOffsets If it should apply the instrumentalOffset + formatOffset + audioVisualOffset
+   * @param forceDispatch If it should force the dispatch of onStepHit, onBeatHit, and onMeasureHit
+   *        even if the current step, beat, or measure hasn't changed.
    */
-  public function update(?songPos:Float, applyOffsets:Bool = true, forceDispatch:Bool = false)
+  public function update(?songPos:Float, applyOffsets:Bool = true, forceDispatch:Bool = false):Void
   {
     var currentTime:Float = (FlxG.sound.music != null) ? FlxG.sound.music.time : 0.0;
     var currentLength:Float = (FlxG.sound.music != null) ? FlxG.sound.music.length : 0.0;
@@ -422,7 +417,8 @@ class Conductor
     // If the song is playing, limit the song position to the length of the song or beginning of the song.
     if (FlxG.sound.music != null && FlxG.sound.music.playing)
     {
-      this.songPosition = Math.min(currentLength, Math.max(0, songPos));
+      this.songPosition = Math.min(this.combinedOffset, 0).clamp(songPos, currentLength);
+      this.songPositionDelta += FlxG.elapsed * 1000 * FlxG.sound.music.pitch;
     }
     else
     {
@@ -488,10 +484,23 @@ class Conductor
     // which it doesn't do every frame!
     if (prevTime != this.songPosition)
     {
+      this.songPositionDelta = 0;
+
       // Update the timestamp for use in-between frames
       prevTime = this.songPosition;
       prevTimestamp = Std.int(Timer.stamp() * 1000);
     }
+
+    if (this == Conductor.instance) @:privateAccess SongSequence.update.dispatch();
+  }
+
+  /**
+   * Returns a more accurate music time for higher framerates.
+   * @return Float
+   */
+  public function getTimeWithDelta():Float
+  {
+    return this.songPosition + this.songPositionDelta;
   }
 
   /**

source/funkin/FunkinMemory.hx

@@ -0,0 +1,453 @@
+package funkin;
+
+import flixel.graphics.FlxGraphic;
+import flixel.FlxG;
+import funkin.play.notes.notestyle.NoteStyle;
+import openfl.utils.AssetType;
+import openfl.Assets;
+import openfl.system.System;
+import openfl.media.Sound;
+import lime.app.Future;
+import lime.app.Promise;
+
+/**
+ * Handles caching of textures and sounds for the game.
+ * TODO: Remove this once Eric finishes the memory system.
+ */
+@:nullSafety
+class FunkinMemory
+{
+  static var permanentCachedTextures:Map<String, FlxGraphic> = [];
+  static var currentCachedTextures:Map<String, FlxGraphic> = [];
+  static var previousCachedTextures:Map<String, FlxGraphic> = [];
+
+  // waow
+  static var permanentCachedSounds:Map<String, Sound> = [];
+  static var currentCachedSounds:Map<String, Sound> = [];
+  static var previousCachedSounds:Map<String, Sound> = [];
+
+  static var purgeFilter:Array<String> = ["/week", "/characters", "/charSelect", "/results"];
+
+  /**
+   * Caches textures that are always required.
+   */
+  public static inline function initialCache():Void
+  {
+    var allImages:Array<String> = Assets.list();
+
+    for (file in allImages)
+    {
+      if (!(file.endsWith(".png") #if FEATURE_COMPRESSED_TEXTURES || file.endsWith(".astc") #end)
+        || file.contains("chart-editor")
+        || !file.contains("ui/"))
+      {
+        continue;
+      }
+
+      file = file.replace(" ", ""); // Handle stray spaces.
+
+      if (file.contains("shared") || Assets.exists('shared:$file', AssetType.IMAGE))
+      {
+        file = 'shared:$file';
+      }
+      permanentCacheTexture(file);
+    }
+
+    permanentCacheTexture(Paths.image("healthBar"));
+    permanentCacheTexture(Paths.image("menuDesat"));
+    permanentCacheTexture(Paths.image("notes", "shared"));
+    permanentCacheTexture(Paths.image("noteSplashes", "shared"));
+    permanentCacheTexture(Paths.image("noteStrumline", "shared"));
+    permanentCacheTexture(Paths.image("NOTE_hold_assets"));
+    // dude
+    permanentCacheTexture(Paths.image("fonts/bold", null));
+    permanentCacheTexture(Paths.image("fonts/default", null));
+    permanentCacheTexture(Paths.image("fonts/freeplay-clear", null));
+
+    var allSounds:Array<String> = Assets.list(AssetType.SOUND);
+
+    for (file in allSounds)
+    {
+      if (!file.endsWith(".ogg") || !file.contains("countdown/")) continue;
+
+      file = file.replace(" ", "");
+
+      if (file.contains("shared") || Assets.exists('shared:$file', AssetType.SOUND))
+      {
+        file = 'shared:$file';
+      }
+
+      permanentCacheSound(file);
+    }
+
+    permanentCacheSound(Paths.sound("cancelMenu"));
+    permanentCacheSound(Paths.sound("confirmMenu"));
+    permanentCacheSound(Paths.sound("screenshot"));
+    permanentCacheSound(Paths.sound("scrollMenu"));
+    permanentCacheSound(Paths.sound("soundtray/Voldown"));
+    permanentCacheSound(Paths.sound("soundtray/VolMAX"));
+    permanentCacheSound(Paths.sound("soundtray/Volup"));
+    permanentCacheSound(Paths.music("freakyMenu/freakyMenu"));
+    permanentCacheSound(Paths.music("offsetsLoop/offsetsLoop"));
+    permanentCacheSound(Paths.music("offsetsLoop/drumsLoop"));
+    permanentCacheSound(Paths.sound("missnote1", "shared"));
+    permanentCacheSound(Paths.sound("missnote2", "shared"));
+    permanentCacheSound(Paths.sound("missnote3", "shared"));
+  }
+
+  /**
+   * Clears the current texture and sound caches.
+   */
+  public static inline function purgeCache(callGarbageCollector:Bool = false):Void
+  {
+    preparePurgeTextureCache();
+    purgeTextureCache();
+    preparePurgeSoundCache();
+    purgeSoundCache();
+    #if (cpp || neko || hl)
+    if (callGarbageCollector) funkin.util.MemoryUtil.collect(true);
+    #end
+  }
+
+  ///// TEXTURES /////
+
+  /**
+   * Ensures a texture with the given key is cached.
+   * @param key The key of the texture to cache.
+   */
+  public static function cacheTexture(key:String):Void
+  {
+    if (currentCachedTextures.exists(key)) return;
+
+    if (previousCachedTextures.exists(key))
+    {
+      // Move the texture from the previous cache to the current cache.
+      var graphic:Null<FlxGraphic> = previousCachedTextures.get(key);
+      previousCachedTextures.remove(key);
+      if (graphic != null) currentCachedTextures.set(key, graphic);
+      return;
+    }
+
+    var graphic:Null<FlxGraphic> = FlxGraphic.fromAssetKey(key, false, null, true);
+    if (graphic == null)
+    {
+      FlxG.log.warn('Failed to cache graphic: $key');
+      return;
+    }
+
+    trace('Successfully cached graphic: $key');
+    graphic.persist = true;
+    currentCachedTextures.set(key, graphic);
+    forceRender(graphic);
+  }
+
+  /**
+   * Permanently caches a texture with the given key.
+   * @param key The key of the texture to cache.
+   */
+  static function permanentCacheTexture(key:String):Void
+  {
+    if (permanentCachedTextures.exists(key)) return;
+
+    var graphic:Null<FlxGraphic> = FlxGraphic.fromAssetKey(key, false, null, true);
+    if (graphic == null)
+    {
+      FlxG.log.warn('Failed to cache graphic: $key');
+      return;
+    }
+
+    trace('Successfully cached graphic: $key');
+    graphic.persist = true;
+    permanentCachedTextures.set(key, graphic);
+    forceRender(graphic);
+    currentCachedTextures = permanentCachedTextures;
+  }
+
+  /**
+   * Forces the GPU to load and upload a FlxGraphic.
+   */
+  private static function forceRender(graphic:FlxGraphic):Void
+  {
+    if (graphic == null) return;
+
+    var bmp:Null<FlxGraphic> = FlxG.bitmap.get(graphic.key);
+    if (bmp != null && bmp.bitmap != null) var _:Int = bmp.bitmap.width; // Trigger
+
+    // Draws sprite and actually caches it.
+    var sprite = new flixel.FlxSprite();
+    sprite.loadGraphic(graphic);
+    sprite.draw(); // Draw sprite and load it into game's memory.
+    sprite.destroy();
+  }
+
+  /**
+   * Checks, if graphic with given path cached in memory.
+   */
+  public static inline function isGraphicCached(path:String):Bool
+    return permanentCachedTextures.exists(path) || currentCachedTextures.exists(path) || previousCachedTextures.exists(path);
+
+  public static function getCachedGraphic(path:String):Null<FlxGraphic>
+  {
+    if (permanentCachedTextures.exists(path)) return permanentCachedTextures.get(path);
+    if (currentCachedTextures.exists(path)) return currentCachedTextures.get(path);
+    if (previousCachedTextures.exists(path)) return previousCachedTextures.get(path); // just in case
+
+    return null;
+  }
+
+  /**
+   * Prepares the cache for purging unused textures.
+   */
+  public inline static function preparePurgeTextureCache():Void
+  {
+    previousCachedTextures = currentCachedTextures;
+
+    for (graphicKey in previousCachedTextures.keys())
+    {
+      if (permanentCachedTextures.exists(graphicKey))
+      {
+        previousCachedTextures.remove(graphicKey);
+      }
+    }
+
+    currentCachedTextures = permanentCachedTextures;
+  }
+
+  /**
+   * Purges unused textures from the cache.
+   */
+  public static function purgeTextureCache():Void
+  {
+    for (graphicKey in previousCachedTextures.keys())
+    {
+      if (permanentCachedTextures.exists(graphicKey))
+      {
+        previousCachedTextures.remove(graphicKey);
+        continue;
+      }
+
+      if (graphicKey.contains("fonts")) continue;
+
+      var graphic:Null<FlxGraphic> = previousCachedTextures.get(graphicKey);
+      if (graphic != null)
+      {
+        FlxG.bitmap.remove(graphic);
+        graphic.destroy();
+        previousCachedTextures.remove(graphicKey);
+        Assets.cache.clear(graphicKey);
+      }
+    }
+    @:privateAccess
+    if (FlxG.bitmap._cache == null)
+    {
+      @:privateAccess
+      FlxG.bitmap._cache = new Map();
+    }
+
+    @:privateAccess
+    for (key in FlxG.bitmap._cache.keys())
+    {
+      var obj:Null<FlxGraphic> = FlxG.bitmap.get(key);
+
+      if (obj == null || obj.persist || permanentCachedTextures.exists(key) || key.contains("fonts"))
+      {
+        continue;
+      }
+
+      if (obj.useCount > 0)
+      {
+        for (purgeEntry in purgeFilter)
+        {
+          if (key.contains(purgeEntry))
+          {
+            FlxG.bitmap.removeKey(key);
+            obj.destroy();
+          }
+        }
+      }
+    }
+  }
+
+  ///// NOTE STYLE //////
+
+  public static function cacheNoteStyle(style:NoteStyle):Void
+  {
+    // TODO: Texture paths should fall back to the default values.
+    cacheTexture(Paths.image(style.getNoteAssetPath() ?? "note"));
+    cacheTexture(style.getHoldNoteAssetPath() ?? "noteHold");
+    cacheTexture(Paths.image(style.getStrumlineAssetPath() ?? "strumline"));
+    cacheTexture(Paths.image(style.getSplashAssetPath() ?? "noteSplash"));
+
+    cacheTexture(Paths.image(style.getHoldCoverDirectionAssetPath(LEFT) ?? "LEFT"));
+    cacheTexture(Paths.image(style.getHoldCoverDirectionAssetPath(RIGHT) ?? "RIGHT"));
+    cacheTexture(Paths.image(style.getHoldCoverDirectionAssetPath(UP) ?? "UP"));
+    cacheTexture(Paths.image(style.getHoldCoverDirectionAssetPath(DOWN) ?? "DOWN"));
+
+    // cacheTexture(Paths.image(style.buildCountdownSpritePath(THREE) ?? "THREE"));
+    cacheTexture(Paths.image(style.buildCountdownSpritePath(TWO) ?? "TWO"));
+    cacheTexture(Paths.image(style.buildCountdownSpritePath(ONE) ?? "ONE"));
+    cacheTexture(Paths.image(style.buildCountdownSpritePath(GO) ?? "GO"));
+
+    cacheSound(style.getCountdownSoundPath(THREE) ?? "THREE");
+    cacheSound(style.getCountdownSoundPath(TWO) ?? "TWO");
+    cacheSound(style.getCountdownSoundPath(ONE) ?? "ONE");
+    cacheSound(style.getCountdownSoundPath(GO) ?? "GO");
+
+    cacheTexture(Paths.image(style.buildJudgementSpritePath("sick") ?? 'sick'));
+    cacheTexture(Paths.image(style.buildJudgementSpritePath("good") ?? 'good'));
+    cacheTexture(Paths.image(style.buildJudgementSpritePath("bad") ?? 'bad'));
+    cacheTexture(Paths.image(style.buildJudgementSpritePath("shit") ?? 'shit'));
+
+    cacheTexture(Paths.image(style.buildComboNumSpritePath(0) ?? '0'));
+    cacheTexture(Paths.image(style.buildComboNumSpritePath(1) ?? '1'));
+    cacheTexture(Paths.image(style.buildComboNumSpritePath(2) ?? '2'));
+    cacheTexture(Paths.image(style.buildComboNumSpritePath(3) ?? '3'));
+    cacheTexture(Paths.image(style.buildComboNumSpritePath(4) ?? '4'));
+    cacheTexture(Paths.image(style.buildComboNumSpritePath(5) ?? '5'));
+    cacheTexture(Paths.image(style.buildComboNumSpritePath(6) ?? '6'));
+    cacheTexture(Paths.image(style.buildComboNumSpritePath(7) ?? '7'));
+    cacheTexture(Paths.image(style.buildComboNumSpritePath(8) ?? '8'));
+    cacheTexture(Paths.image(style.buildComboNumSpritePath(9) ?? '9'));
+  }
+
+  ///// SOUND //////
+
+  public static function cacheSound(key:String):Void
+  {
+    if (currentCachedSounds.exists(key)) return;
+
+    if (previousCachedSounds.exists(key))
+    {
+      // Move the texture from the previous cache to the current cache.
+      var sound:Null<Sound> = previousCachedSounds.get(key);
+      previousCachedSounds.remove(key);
+      if (sound != null) currentCachedSounds.set(key, sound);
+      return;
+    }
+
+    var sound:Null<Sound> = Assets.getSound(key, true);
+    if (sound == null) return;
+    else
+      currentCachedSounds.set(key, sound);
+  }
+
+  public static function permanentCacheSound(key:String):Void
+  {
+    if (permanentCachedSounds.exists(key)) return;
+
+    var sound:Null<Sound> = Assets.getSound(key, true);
+    if (sound == null) return;
+    else
+      permanentCachedSounds.set(key, sound);
+
+    if (sound != null) currentCachedSounds.set(key, sound);
+  }
+
+  public static function preparePurgeSoundCache():Void
+  {
+    previousCachedSounds = currentCachedSounds;
+
+    for (key in previousCachedSounds.keys())
+    {
+      if (permanentCachedSounds.exists(key))
+      {
+        previousCachedSounds.remove(key);
+      }
+    }
+
+    currentCachedSounds = permanentCachedSounds;
+  }
+
+  /**
+   * Purges unused sounds from the cache.
+   */
+  public static inline function purgeSoundCache():Void
+  {
+    for (key in previousCachedSounds.keys())
+    {
+      if (permanentCachedSounds.exists(key))
+      {
+        previousCachedSounds.remove(key);
+        continue;
+      }
+
+      var sound:Null<Sound> = previousCachedSounds.get(key);
+      if (sound != null)
+      {
+        Assets.cache.removeSound(key);
+        previousCachedSounds.remove(key);
+      }
+    }
+    Assets.cache.clear("songs");
+    Assets.cache.clear("music");
+    // Felt lazy.
+    var key = Paths.music("freakyMenu/freakyMenu");
+    var sound:Null<Sound> = Assets.getSound(key, true);
+    if (sound != null)
+    {
+      permanentCachedSounds.set(key, sound);
+      currentCachedSounds.set(key, sound);
+    }
+  }
+
+  ///// MISC /////
+
+  public static inline function clearFreeplay():Void
+  {
+    var keysToRemove:Array<String> = [];
+
+    @:privateAccess
+    for (key in FlxG.bitmap._cache.keys())
+    {
+      if (!key.contains("freeplay")) continue;
+      if (permanentCachedTextures.exists(key) || key.contains("fonts")) continue;
+
+      keysToRemove.push(key);
+    }
+
+    @:privateAccess
+    for (key in keysToRemove)
+    {
+      trace('Cleaning up $key');
+      var obj:Null<FlxGraphic> = FlxG.bitmap.get(key);
+      if (obj != null)
+      {
+        obj.destroy();
+      }
+      FlxG.bitmap.removeKey(key);
+      if (currentCachedTextures.exists(key)) currentCachedTextures.remove(key);
+      Assets.cache.clear(key);
+    }
+
+    preparePurgeSoundCache();
+    purgeSoundCache();
+  }
+
+  public static inline function clearStickers():Void
+  {
+    var keysToRemove:Array<String> = [];
+
+    @:privateAccess
+    for (key in FlxG.bitmap._cache.keys())
+    {
+      if (!key.contains("stickers")) continue;
+      if (permanentCachedTextures.exists(key) || key.contains("fonts")) continue;
+
+      keysToRemove.push(key);
+    }
+
+    @:privateAccess
+    for (key in keysToRemove)
+    {
+      trace('Cleaning up $key');
+      var obj:Null<FlxGraphic> = FlxG.bitmap.get(key);
+      if (obj != null)
+      {
+        obj.destroy();
+      }
+      FlxG.bitmap.removeKey(key);
+      if (currentCachedTextures.exists(key)) currentCachedTextures.remove(key);
+      Assets.cache.clear(key);
+    }
+  }
+}

source/funkin/Highscore.hx

@@ -3,6 +3,7 @@ package funkin;
 /**
  * A core class which handles tracking score and combo for the current song.
  */
+@:nullSafety
 class Highscore
 {
   /**

source/funkin/InitState.hx

@@ -10,6 +10,7 @@ import flixel.math.FlxPoint;
 import flixel.math.FlxRect;
 import flixel.system.debug.log.LogStyle;
 import flixel.util.FlxColor;
+import funkin.graphics.FunkinSprite;
 import funkin.data.dialogue.conversation.ConversationRegistry;
 import funkin.data.dialogue.dialoguebox.DialogueBoxRegistry;
 import funkin.data.dialogue.speaker.SpeakerRegistry;
@@ -18,6 +19,7 @@ import funkin.data.freeplay.player.PlayerRegistry;
 import funkin.data.freeplay.style.FreeplayStyleRegistry;
 import funkin.data.notestyle.NoteStyleRegistry;
 import funkin.data.song.SongRegistry;
+import funkin.data.stickers.StickerRegistry;
 import funkin.data.event.SongEventRegistry;
 import funkin.data.stage.StageRegistry;
 import funkin.data.story.level.LevelRegistry;
@@ -26,18 +28,21 @@ import funkin.play.character.CharacterData.CharacterDataParser;
 import funkin.play.notes.notekind.NoteKindManager;
 import funkin.play.PlayStatePlaylist;
 import funkin.ui.debug.charting.ChartEditorState;
+import funkin.ui.debug.stageeditor.StageEditorState;
 import funkin.ui.title.TitleState;
 import funkin.ui.transition.LoadingState;
 import funkin.util.CLIUtil;
 import funkin.util.CLIUtil.CLIParams;
 import funkin.util.macro.MacroUtil;
-import funkin.util.TimerUtil;
 import funkin.util.TrackerUtil;
 import funkin.util.WindowUtil;
 import openfl.display.BitmapData;
 #if FEATURE_DISCORD_RPC
 import funkin.api.discord.DiscordClient;
 #end
+#if FEATURE_NEWGROUNDS
+import funkin.api.newgrounds.NewgroundsClient;
+#end
 
 /**
  * A core class which performs initialization of the game.
@@ -47,6 +52,7 @@ import funkin.api.discord.DiscordClient;
  *
  * It should not contain any sprites or rendering.
  */
+@:nullSafety
 class InitState extends FlxState
 {
   /**
@@ -76,11 +82,37 @@ class InitState extends FlxState
     // GAME SETUP
     //
 
-    // Setup window events (like callbacks for onWindowClose)
-    // and fullscreen keybind setup
+    // Setup window events (like callbacks for onWindowClose) and fullscreen keybind setup
     WindowUtil.initWindowEvents();
-    // Disable the thing on Windows where it tries to send a bug report to Microsoft because why do they care?
-    WindowUtil.disableCrashHandler();
+
+    #if FEATURE_DEBUG_TRACY
+    funkin.util.WindowUtil.initTracy();
+    #end
+
+    #if FEATURE_HAPTICS
+    // Setup Haptic feedback
+    extension.haptics.Haptic.initialize();
+    #end
+
+    #if FEATURE_MOBILE_ADVERTISEMENTS
+    // Setup Admob
+    funkin.mobile.util.AdMobUtil.init();
+    #end
+
+    #if FEATURE_MOBILE_IAP
+    // Setup In-App purchases
+    funkin.mobile.util.InAppPurchasesUtil.init();
+    #end
+
+    #if FEATURE_MOBILE_IAR
+    // Setup In-App purchases
+    funkin.mobile.util.InAppReviewUtil.init();
+    #end
+
+    #if ios
+    // Setup Audio session
+    funkin.external.ios.AudioSession.initialize();
+    #end
 
     // This ain't a pixel art game! (most of the time)
     FlxSprite.defaultAntialiasing = true;
@@ -90,9 +122,20 @@ class InitState extends FlxState
     FlxG.sound.volumeDownKeys = [];
     FlxG.sound.muteKeys = [];
 
+    // A small jumpstart to the soundtray, it usually sets itself to inactive (somewhere...)
+    // but that makes our soundtray not show up on init if we have the game muted.
+    // We set it to active so it at least calls it's update function once (see FlxGame.onEnterFrame(), it's called there)
+    // and also see FunkinSoundTray.update() to see what we do and how we check if we are muted or not
+    #if !mobile
+    FlxG.game.soundTray.active = true;
+    #end
+
     // Set the game to a lower frame rate while it is in the background.
     FlxG.game.focusLostFramerate = 30;
 
+    // Makes Flixel use frame times instead of locked movements per frame for things like tweens
+    FlxG.fixedTimestep = false;
+
     setupFlixelDebug();
 
     //
@@ -114,11 +157,30 @@ class InitState extends FlxState
     // Don't play transition in when entering the title state.
     FlxTransitionableState.skipNextTransIn = true;
 
+    FlxG.signals.gameResized.add(function(width:Int, height:Int) {
+      FlxTransitionableState.defaultTransIn = new TransitionData(FADE, FlxColor.BLACK, 1, new FlxPoint(0, -1), tileData,
+        new FlxRect(-200, -200, FlxG.width * 1.4, FlxG.height * 1.4));
+      FlxTransitionableState.defaultTransOut = new TransitionData(FADE, FlxColor.BLACK, 0.7, new FlxPoint(0, 1), tileData,
+        new FlxRect(-200, -200, FlxG.width * 1.4, FlxG.height * 1.4));
+    });
+
+    // SDL for some reason enables VSync on focus lost/gained in Android
+    // Since we don't really need VSync on Android we're gonna forcefully disable it on these signals for now
+    // This is fixed on SDL3 from what I've heared but that doodoo isn't working poperly for Android
+    #if android
+    FlxG.signals.focusLost.add(function() {
+      WindowUtil.setVSyncMode(lime.ui.WindowVSyncMode.OFF);
+    });
+    FlxG.signals.focusGained.add(function() {
+      WindowUtil.setVSyncMode(lime.ui.WindowVSyncMode.OFF);
+    });
+    #end
+
     //
     // NEWGROUNDS API SETUP
     //
-    #if newgrounds
-    NGio.init();
+    #if FEATURE_NEWGROUNDS
+    NewgroundsClient.instance.init();
     #end
 
     //
@@ -137,6 +199,7 @@ class InitState extends FlxState
     //
     #if android
     FlxG.android.preventDefaultKeys = [flixel.input.android.FlxAndroidKey.BACK];
+    funkin.external.android.CallbackUtil.init();
     #end
 
     //
@@ -151,11 +214,20 @@ class InitState extends FlxState
     #if FEATURE_SCREENSHOTS
     funkin.util.plugins.ScreenshotPlugin.initialize();
     #end
+    #if FEATURE_NEWGROUNDS
+    funkin.util.plugins.NewgroundsMedalPlugin.initialize();
+    #end
     funkin.util.plugins.EvacuateDebugPlugin.initialize();
     funkin.util.plugins.ForceCrashPlugin.initialize();
     funkin.util.plugins.ReloadAssetsDebugPlugin.initialize();
+    #if !mobile
     funkin.util.plugins.VolumePlugin.initialize();
+    #end
     funkin.util.plugins.WatchPlugin.initialize();
+    #if mobile
+    funkin.util.plugins.TouchPointerPlugin.initialize();
+    funkin.mobile.input.ControlsHandler.initInputTrackers();
+    #end
 
     //
     // GAME DATA PARSING
@@ -164,7 +236,6 @@ class InitState extends FlxState
     // NOTE: Registries must be imported and not referenced with fully qualified names,
     // to ensure build macros work properly.
     trace('Parsing game data...');
-    var perfStart:Float = TimerUtil.start();
     SongEventRegistry.loadEventCache(); // SongEventRegistry is structured differently so it's not a BaseRegistry.
     SongRegistry.instance.loadEntries();
     LevelRegistry.instance.loadEntries();
@@ -176,6 +247,7 @@ class InitState extends FlxState
     FreeplayStyleRegistry.instance.loadEntries();
     AlbumRegistry.instance.loadEntries();
     StageRegistry.instance.loadEntries();
+    StickerRegistry.instance.loadEntries();
 
     // TODO: CharacterDataParser doesn't use json2object, so it's way slower than the other parsers and more prone to syntax errors.
     // Move it to use a BaseRegistry.
@@ -187,7 +259,12 @@ class InitState extends FlxState
     ModuleHandler.loadModuleCache();
     ModuleHandler.callOnCreate();
 
-    trace('Parsing game data took: ${TimerUtil.ms(perfStart)}');
+    funkin.input.Cursor.hide();
+
+    #if !html5
+    // This fucking breaks on HTML5 builds because the "shared" library isn't loaded yet.
+    funkin.FunkinMemory.initialCache();
+    #end
   }
 
   /**
@@ -220,6 +297,9 @@ class InitState extends FlxState
     #elseif CHARTING
     // -DCHARTING
     FlxG.switchState(() -> new funkin.ui.debug.charting.ChartEditorState());
+    #elseif STAGING
+    // -DSTAGING
+    FlxG.switchState(() -> new funkin.ui.debug.stageeditor.StageEditorState());
     #elseif STAGEBUILD
     // -DSTAGEBUILD
     FlxG.switchState(() -> new funkin.ui.debug.stage.StageBuilderState());
@@ -230,8 +310,8 @@ class InitState extends FlxState
         storyMode: true,
         title: "Cum Song Erect by Kawai Sprite",
         songId: "cum",
-        characterId: "pico-playable",
-        difficultyId: "nightmare",
+        characterId: "pico",
+        difficultyId: "hard",
         isNewHighscore: true,
         scoreData:
           {
@@ -246,9 +326,10 @@ class InitState extends FlxState
                 combo: 69,
                 maxCombo: 69,
                 totalNotesHit: 140,
-                totalNotes: 190
+                totalNotes: 240
               }
             // 2400 total notes = 7% = LOSS
+            // 275 total notes = 69% = NICE
             // 240 total notes = 79% = GOOD
             // 230 total notes = 82% = GREAT
             // 210 total notes = 91% = EXCELLENT
@@ -281,9 +362,16 @@ class InitState extends FlxState
           fnfcTargetPath: params.chart.chartPath,
         }));
     }
+    else if (params.stage.shouldLoadStage)
+    {
+      FlxG.switchState(() -> new StageEditorState(
+        {
+          fnfsTargetPath: params.stage.stagePath,
+        }));
+    }
     else
     {
-      FlxG.sound.cache(Paths.music('freakyMenu/freakyMenu'));
+      // FlxG.sound.cache(Paths.music('freakyMenu/freakyMenu'));
       FlxG.switchState(() -> new TitleState());
     }
   }
@@ -295,7 +383,7 @@ class InitState extends FlxState
    */
   function startSong(songId:String, difficultyId:String = 'normal'):Void
   {
-    var songData:funkin.play.song.Song = funkin.data.song.SongRegistry.instance.fetchEntry(songId);
+    var songData:Null<funkin.play.song.Song> = funkin.data.song.SongRegistry.instance.fetchEntry(songId);
 
     if (songData == null)
     {
@@ -332,6 +420,7 @@ class InitState extends FlxState
         PlayStatePlaylist.campaignId = 'weekend1';
     }
 
+    @:nullSafety(Off) // Cannot unify?
     LoadingState.loadPlayState(
       {
         targetSong: songData,
@@ -346,7 +435,7 @@ class InitState extends FlxState
    */
   function startLevel(levelId:String, difficultyId:String = 'normal'):Void
   {
-    var currentLevel:funkin.ui.story.Level = funkin.data.story.level.LevelRegistry.instance.fetchEntry(levelId);
+    var currentLevel:Null<funkin.ui.story.Level> = funkin.data.story.level.LevelRegistry.instance.fetchEntry(levelId);
 
     if (currentLevel == null)
     {
@@ -362,10 +451,19 @@ class InitState extends FlxState
     PlayStatePlaylist.isStoryMode = true;
     PlayStatePlaylist.campaignScore = 0;
 
-    var targetSongId:String = PlayStatePlaylist.playlistSongIds.shift();
+    var targetSongId:Null<String> = PlayStatePlaylist.playlistSongIds.shift();
 
-    var targetSong:funkin.play.song.Song = SongRegistry.instance.fetchEntry(targetSongId);
+    var targetSong:Null<funkin.play.song.Song> = null;
 
+    if (targetSongId != null) targetSong = SongRegistry.instance.fetchEntry(targetSongId);
+
+    if (targetSongId == null)
+    {
+      startGameNormally();
+      return;
+    }
+
+    @:nullSafety(Off)
     LoadingState.loadPlayState(
       {
         targetSong: targetSong,
@@ -373,6 +471,7 @@ class InitState extends FlxState
       });
   }
 
+  @:nullSafety(Off) // Meh, remove when flixel.system.debug.log.LogStyle is null safe
   function setupFlixelDebug():Void
   {
     //
@@ -452,17 +551,17 @@ class InitState extends FlxState
     #end
   }
 
-  function defineSong():String
+  function defineSong():Null<String>
   {
     return MacroUtil.getDefine('SONG');
   }
 
-  function defineLevel():String
+  function defineLevel():Null<String>
   {
     return MacroUtil.getDefine('LEVEL');
   }
 
-  function defineDifficulty():String
+  function defineDifficulty():Null<String>
   {
     return MacroUtil.getDefine('DIFFICULTY');
   }

source/funkin/Paths.hx

@@ -6,6 +6,7 @@ import openfl.utils.AssetType;
 /**
  * A core class which handles determining asset paths.
  */
+@:nullSafety
 class Paths
 {
   static var currentLevel:Null<String> = null;
@@ -136,7 +137,7 @@ class Paths
    * @param withExtension if it should return with the audio file extension `.mp3` or `.ogg`.
    * @return String
    */
-  public static function inst(song:String, ?suffix:String = '', ?withExtension:Bool = true):String
+  public static function inst(song:String, ?suffix:String = '', withExtension:Bool = true):String
   {
     var ext:String = withExtension ? '.${Constants.EXT_SOUND}' : '';
     return 'songs:assets/songs/${song.toLowerCase()}/Inst$suffix$ext';

source/funkin/PlayerSettings.hx

@@ -2,21 +2,24 @@ package funkin;
 
 import funkin.save.Save;
 import funkin.input.Controls;
-import flixel.FlxCamera;
 import funkin.input.PreciseInputManager;
-import flixel.input.actions.FlxActionInput;
 import flixel.input.gamepad.FlxGamepad;
-import flixel.util.FlxSignal;
+import flixel.util.FlxSignal.FlxTypedSignal;
 
 /**
  * A core class which represents the current player(s) and their controls and other configuration.
  */
+@:nullSafety
 class PlayerSettings
 {
   // TODO: Finish implementation of second player.
   public static var numPlayers(default, null) = 0;
   public static var numAvatars(default, null) = 0;
+  // TODO: Making both of these null makes a lot of errors with the controls.
+  // That'd explain why unplugging input devices can cause the game to crash?
+  @:nullSafety(Off)
   public static var player1(default, null):PlayerSettings;
+  @:nullSafety(Off)
   public static var player2(default, null):PlayerSettings;
 
   public static var onAvatarAdd(default, null) = new FlxTypedSignal<PlayerSettings->Void>();
@@ -72,6 +75,7 @@ class PlayerSettings
   /**
    * Forcibly destroy the PlayerSettings singletons for each player.
    */
+  @:nullSafety(Off)
   public static function reset():Void
   {
     player1 = null;

source/funkin/Preferences.hx

@@ -1,14 +1,22 @@
 package funkin;
 
+#if mobile
+import funkin.mobile.ui.FunkinHitbox;
+import funkin.mobile.util.InAppPurchasesUtil;
+#end
 import funkin.save.Save;
+import funkin.util.WindowUtil;
+import funkin.util.HapticUtil.HapticsMode;
 
 /**
  * A core class which provides a store of user-configurable, globally relevant values.
  */
+@:nullSafety
 class Preferences
 {
   /**
    * FPS
+   * Always the refresh rate of the display on mobile, or 60 on web.
    * @default `60`
    */
   public static var framerate(get, set):Int;
@@ -17,6 +25,12 @@ class Preferences
   {
     #if web
     return 60;
+    #elseif mobile
+    var refreshRate:Int = FlxG.stage.window.displayMode.refreshRate;
+
+    if (refreshRate < 60) refreshRate = 60;
+
+    return refreshRate;
     #else
     return Save?.instance?.options?.framerate ?? 60;
     #end
@@ -44,11 +58,19 @@ class Preferences
 
   static function get_naughtyness():Bool
   {
-    return Save?.instance?.options?.naughtyness;
+    #if NO_FEATURE_NAUGHTYNESS
+    return false;
+    #else
+    return Save?.instance?.options?.naughtyness ?? true;
+    #end
   }
 
   static function set_naughtyness(value:Bool):Bool
   {
+    #if NO_FEATURE_NAUGHTYNESS
+    value = false;
+    #end
+
     var save:Save = Save.instance;
     save.options.naughtyness = value;
     save.flush();
@@ -63,7 +85,7 @@ class Preferences
 
   static function get_downscroll():Bool
   {
-    return Save?.instance?.options?.downscroll;
+    return Save?.instance?.options?.downscroll #if mobile ?? true #else ?? false #end;
   }
 
   static function set_downscroll(value:Bool):Bool
@@ -101,7 +123,7 @@ class Preferences
 
   static function get_zoomCamera():Bool
   {
-    return Save?.instance?.options?.zoomCamera;
+    return Save?.instance?.options?.zoomCamera ?? true;
   }
 
   static function set_zoomCamera(value:Bool):Bool
@@ -114,13 +136,17 @@ class Preferences
 
   /**
    * If enabled, an FPS and memory counter will be displayed even if this is not a debug build.
+   * Always disabled on mobile.
    * @default `false`
    */
   public static var debugDisplay(get, set):Bool;
 
   static function get_debugDisplay():Bool
   {
-    return Save?.instance?.options?.debugDisplay;
+    #if mobile
+    return false;
+    #end
+    return Save?.instance?.options?.debugDisplay ?? false;
   }
 
   static function set_debugDisplay(value:Bool):Bool
@@ -136,14 +162,78 @@ class Preferences
     return value;
   }
 
+  /**
+   * If enabled, haptic feedback will be enabled.
+   * @default `All`
+   */
+  public static var hapticsMode(get, set):HapticsMode;
+
+  static function get_hapticsMode():HapticsMode
+  {
+    var value = Save?.instance?.options?.hapticsMode ?? "All";
+
+    return switch (value)
+    {
+      case "None":
+        HapticsMode.NONE;
+      case "Notes Only":
+        HapticsMode.NOTES_ONLY;
+      default:
+        HapticsMode.ALL;
+    };
+  }
+
+  static function set_hapticsMode(value:HapticsMode):HapticsMode
+  {
+    var string;
+
+    switch (value)
+    {
+      case HapticsMode.NONE:
+        string = "None";
+      case HapticsMode.NOTES_ONLY:
+        string = "Notes Only";
+      default:
+        string = "All";
+    };
+
+    var save:Save = Save.instance;
+    save.options.hapticsMode = string;
+    save.flush();
+    return value;
+  }
+
+  /**
+   * Multiplier of intensity for all the haptic feedback effects.
+   * @default `2.5`
+   */
+  public static var hapticsIntensityMultiplier(get, set):Float;
+
+  static function get_hapticsIntensityMultiplier():Float
+  {
+    return Save?.instance?.options?.hapticsIntensityMultiplier ?? 1;
+  }
+
+  static function set_hapticsIntensityMultiplier(value:Float):Float
+  {
+    var save:Save = Save.instance;
+    save.options.hapticsIntensityMultiplier = value;
+    save.flush();
+    return value;
+  }
+
   /**
    * If enabled, the game will automatically pause when tabbing out.
+   * Always enabled on mobile.
    * @default `true`
    */
   public static var autoPause(get, set):Bool;
 
   static function get_autoPause():Bool
   {
+    #if mobile
+    return true;
+    #end
     return Save?.instance?.options?.autoPause ?? true;
   }
 
@@ -157,11 +247,97 @@ class Preferences
     return value;
   }
 
+  /**
+   * If enabled, the game will automatically launch in fullscreen on startup.
+   * @default `true`
+   */
+  public static var autoFullscreen(get, set):Bool;
+
+  static function get_autoFullscreen():Bool
+  {
+    return Save?.instance?.options?.autoFullscreen ?? true;
+  }
+
+  static function set_autoFullscreen(value:Bool):Bool
+  {
+    var save:Save = Save.instance;
+    save.options.autoFullscreen = value;
+    save.flush();
+    return value;
+  }
+
+  /**
+   * A global audio offset in milliseconds.
+   * This is used to sync the audio.
+   * @default `0`
+   */
+  public static var globalOffset(get, set):Int;
+
+  static function get_globalOffset():Int
+  {
+    return Save?.instance?.options?.globalOffset ?? 0;
+  }
+
+  static function set_globalOffset(value:Int):Int
+  {
+    var save:Save = Save.instance;
+    save.options.globalOffset = value;
+    save.flush();
+    return value;
+  }
+
+  /**
+   * If enabled, the game will utilize VSync (or adaptive VSync) on startup.
+   * @default `OFF`
+   */
+  public static var vsyncMode(get, set):lime.ui.WindowVSyncMode;
+
+  static function get_vsyncMode():lime.ui.WindowVSyncMode
+  {
+    var value = Save?.instance?.options?.vsyncMode ?? "Off";
+
+    return switch (value)
+    {
+      case "Off":
+        lime.ui.WindowVSyncMode.OFF;
+      case "On":
+        lime.ui.WindowVSyncMode.ON;
+      case "Adaptive":
+        lime.ui.WindowVSyncMode.ADAPTIVE;
+      default:
+        lime.ui.WindowVSyncMode.OFF;
+    };
+  }
+
+  static function set_vsyncMode(value:lime.ui.WindowVSyncMode):lime.ui.WindowVSyncMode
+  {
+    var string;
+
+    switch (value)
+    {
+      case lime.ui.WindowVSyncMode.OFF:
+        string = "Off";
+      case lime.ui.WindowVSyncMode.ON:
+        string = "On";
+      case lime.ui.WindowVSyncMode.ADAPTIVE:
+        string = "Adaptive";
+      default:
+        string = "Off";
+    };
+
+    WindowUtil.setVSyncMode(value);
+
+    var save:Save = Save.instance;
+    save.options.vsyncMode = string;
+    save.flush();
+    return value;
+  }
+
   public static var unlockedFramerate(get, set):Bool;
 
   static function get_unlockedFramerate():Bool
   {
-    return Save?.instance?.options?.unlockedFramerate;
+    return Save?.instance?.options?.unlockedFramerate ?? false;
   }
 
   static function set_unlockedFramerate(value:Bool):Bool
@@ -199,6 +375,83 @@ class Preferences
   public static var lockedFramerateFunction = untyped js.Syntax.code("window.requestAnimationFrame");
   #end
 
+  /**
+   * If >0, the game will display a semi-opaque background under the notes.
+   * `0` for no background, `100` for solid black if you're freaky like that
+   * @default `0`
+   */
+  public static var strumlineBackgroundOpacity(get, set):Int;
+
+  static function get_strumlineBackgroundOpacity():Int
+  {
+    return (Save?.instance?.options?.strumlineBackgroundOpacity ?? 0);
+  }
+
+  static function set_strumlineBackgroundOpacity(value:Int):Int
+  {
+    var save:Save = Save.instance;
+    save.options.strumlineBackgroundOpacity = value;
+    save.flush();
+    return value;
+  }
+
+  /**
+   * If enabled, the game will hide the mouse when taking a screenshot.
+   * @default `true`
+   */
+  public static var shouldHideMouse(get, set):Bool;
+
+  static function get_shouldHideMouse():Bool
+  {
+    return Save?.instance?.options?.screenshot?.shouldHideMouse ?? true;
+  }
+
+  static function set_shouldHideMouse(value:Bool):Bool
+  {
+    var save:Save = Save.instance;
+    save.options.screenshot.shouldHideMouse = value;
+    save.flush();
+    return value;
+  }
+
+  /**
+   * If enabled, the game will show a preview after taking a screenshot.
+   * @default `true`
+   */
+  public static var fancyPreview(get, set):Bool;
+
+  static function get_fancyPreview():Bool
+  {
+    return Save?.instance?.options?.screenshot?.fancyPreview ?? true;
+  }
+
+  static function set_fancyPreview(value:Bool):Bool
+  {
+    var save:Save = Save.instance;
+    save.options.screenshot.fancyPreview = value;
+    save.flush();
+    return value;
+  }
+
+  /**
+   * If enabled, the game will show the preview only after a screenshot is saved.
+   * @default `true`
+   */
+  public static var previewOnSave(get, set):Bool;
+
+  static function get_previewOnSave():Bool
+  {
+    return Save?.instance?.options?.screenshot?.previewOnSave ?? true;
+  }
+
+  static function set_previewOnSave(value:Bool):Bool
+  {
+    var save:Save = Save.instance;
+    save.options.screenshot.previewOnSave = value;
+    save.flush();
+    return value;
+  }
+
   /**
    * Loads the user's preferences from the save data and apply them.
    */
@@ -206,11 +459,22 @@ class Preferences
   {
     // Apply the autoPause setting (enables automatic pausing on focus lost).
     FlxG.autoPause = Preferences.autoPause;
+    // WindowUtil.setVSyncMode(Preferences.vsyncMode);
     // Apply the debugDisplay setting (enables the FPS and RAM display).
     toggleDebugDisplay(Preferences.debugDisplay);
     #if web
     toggleFramerateCap(Preferences.unlockedFramerate);
     #end
+
+    #if desktop
+    // Apply the autoFullscreen setting (launches the game in fullscreen automatically)
+    FlxG.fullscreen = Preferences.autoFullscreen;
+    #end
+
+    #if mobile
+    // Apply the allowScreenTimeout setting.
+    lime.system.System.allowScreenTimeout = Preferences.screenTimeout;
+    #end
   }
 
   static function toggleFramerateCap(unlocked:Bool):Void
@@ -226,18 +490,88 @@ class Preferences
     if (show)
     {
       // Enable the debug display.
-      FlxG.stage.addChild(Main.fpsCounter);
+      FlxG.game.parent.addChild(Main.fpsCounter);
+
       #if !html5
-      FlxG.stage.addChild(Main.memoryCounter);
+      FlxG.game.parent.addChild(Main.memoryCounter);
       #end
     }
     else
     {
       // Disable the debug display.
-      FlxG.stage.removeChild(Main.fpsCounter);
+      FlxG.game.parent.removeChild(Main.fpsCounter);
+
       #if !html5
-      FlxG.stage.removeChild(Main.memoryCounter);
+      FlxG.game.parent.removeChild(Main.memoryCounter);
       #end
     }
   }
+
+  #if mobile
+  /**
+   * If enabled, device will be able to sleep on its own.
+   * @default `false`
+   */
+  public static var screenTimeout(get, set):Bool;
+
+  static function get_screenTimeout():Bool
+  {
+    return Save?.instance?.mobileOptions?.screenTimeout ?? false;
+  }
+
+  static function set_screenTimeout(value:Bool):Bool
+  {
+    if (value != Save.instance.mobileOptions.screenTimeout) lime.system.System.allowScreenTimeout = value;
+
+    var save:Save = Save.instance;
+    save.mobileOptions.screenTimeout = value;
+    save.flush();
+    return value;
+  }
+
+  /**
+   * Controls Scheme for the hitbox.
+   * @default `4 Lanes`
+   */
+  public static var controlsScheme(get, set):String;
+
+  static function get_controlsScheme():String
+  {
+    return Save?.instance?.mobileOptions?.controlsScheme ?? FunkinHitboxControlSchemes.Arrows;
+  }
+
+  static function set_controlsScheme(value:String):String
+  {
+    var save:Save = Save.instance;
+    save.mobileOptions.controlsScheme = value;
+    save.flush();
+    return value;
+  }
+
+  #if FEATURE_MOBILE_IAP
+  /**
+   * If bought, the game will not show any ads.
+   * @default `false`
+   */
+  @:unreflective
+  public static var noAds(get, set):Bool;
+
+  @:unreflective
+  static function get_noAds():Bool
+  {
+    if (InAppPurchasesUtil.hasInitialized) noAds = InAppPurchasesUtil.isPurchased(InAppPurchasesUtil.UPGRADE_PRODUCT_ID);
+    var returnedValue = Save?.instance?.mobileOptions?.noAds ?? false;
+    return returnedValue;
+  }
+
+  @:unreflective
+  static function set_noAds(value:Bool):Bool
+  {
+    var save:Save = Save.instance;
+    save.mobileOptions.noAds = value;
+    save.flush();
+    return value;
+  }
+  #end
+  #end
 }

source/funkin/api/discord/DiscordClient.hx

@@ -1,13 +1,18 @@
 package funkin.api.discord;
 
+import funkin.util.macro.EnvironmentConfigMacro;
 #if FEATURE_DISCORD_RPC
 import hxdiscord_rpc.Discord;
-import hxdiscord_rpc.Types;
+import hxdiscord_rpc.Types.DiscordButton;
+import hxdiscord_rpc.Types.DiscordEventHandlers;
+import hxdiscord_rpc.Types.DiscordRichPresence;
+import hxdiscord_rpc.Types.DiscordUser;
 import sys.thread.Thread;
 
+@:nullSafety
 class DiscordClient
 {
-  static final CLIENT_ID:String = "816168432860790794";
+  static final CLIENT_ID:Null<String> = EnvironmentConfigMacro.environmentConfig?.get("DESKTOP_DISCORD_CLIENT_ID");
 
   public static var instance(get, never):DiscordClient;
   static var _instance:Null<DiscordClient> = null;
@@ -36,13 +41,29 @@ class DiscordClient
   {
     trace('[DISCORD] Initializing connection...');
 
-    // Discord.initialize(CLIENT_ID, handlers, true, null);
-    Discord.Initialize(CLIENT_ID, cpp.RawPointer.addressOf(handlers), 1, null);
+    if (!hasValidCredentials())
+    {
+      FlxG.log.warn("Tried to initialize Discord connection, but credentials are invalid!");
+      return;
+    }
+
+    @:nullSafety(Off)
+    {
+      Discord.Initialize(CLIENT_ID, cpp.RawPointer.addressOf(handlers), 1, "");
+    }
 
     createDaemon();
   }
 
-  var daemon:Thread = null;
+  /**
+   * @returns `false` if the client ID is invalid.
+   */
+  static function hasValidCredentials():Bool
+  {
+    return !(CLIENT_ID == null || CLIENT_ID == "" || (CLIENT_ID != null && CLIENT_ID.contains(" ")));
+  }
+
+  var daemon:Null<Thread> = null;
 
   function createDaemon():Void
   {
@@ -53,8 +74,6 @@ class DiscordClient
   {
     while (true)
     {
-      trace('[DISCORD] Performing client update...');
-
       #if DISCORD_DISABLE_IO_THREAD
       Discord.updateConnection();
       #end
@@ -73,8 +92,6 @@ class DiscordClient
 
   public function setPresence(params:DiscordClientPresenceParams):Void
   {
-    trace('[DISCORD] Updating presence... (${params})');
-
     Discord.updatePresence(buildPresence(params));
   }
 
@@ -89,17 +106,15 @@ class DiscordClient
     presence.largeImageText = "Friday Night Funkin'";
 
     // State should be generally what the person is doing, like "In the Menus" or "Pico (Pico Mix) [Freeplay Hard]"
-    presence.state = cast(params.state, Null<String>);
+    presence.state = cast(params.state, Null<String>) ?? "";
     // Details should be what the person is specifically doing, including stuff like timestamps (maybe something like "03:24 elapsed").
-    presence.details = cast(params.details, Null<String>);
+    presence.details = cast(params.details, Null<String>) ?? "";
 
     // The large image displaying what the user is doing.
     // This should probably be album art.
     // IMPORTANT NOTE: This can be an asset key uploaded to Discord's developer panel OR any URL you like.
     presence.largeImageKey = cast(params.largeImageKey, Null<String>) ?? "album-volume1";
 
-    trace('[DISCORD] largeImageKey: ${presence.largeImageKey}');
-
     // TODO: Make this use the song's album art.
     // presence.largeImageKey = "icon";
     // presence.largeImageKey = "https://f4.bcbits.com/img/a0746694746_16.jpg";
@@ -107,7 +122,7 @@ class DiscordClient
     // The small inset image for what the user is doing.
     // This can be the opponent's health icon?
     // NOTE: Like largeImageKey, this can be a URL, or an asset key.
-    presence.smallImageKey = cast(params.smallImageKey, Null<String>);
+    presence.smallImageKey = cast(params.smallImageKey, Null<String>) ?? "";
 
     // NOTE: In previous versions, this showed as "Elapsed", but now shows as playtime and doesn't look good
     // presence.startTimestamp = time - 10;
@@ -133,9 +148,9 @@ class DiscordClient
 
     final username:String = request[0].username;
     final globalName:String = request[0].username;
-    final discriminator:Int = Std.parseInt(request[0].discriminator);
+    final discriminator:Null<Int> = Std.parseInt(request[0].discriminator);
 
-    if (discriminator != 0)
+    if (discriminator != null && discriminator != 0)
     {
       trace('[DISCORD] User: ${username}#${discriminator} (${globalName})');
     }
@@ -201,4 +216,30 @@ typedef DiscordClientPresenceParams =
    */
   var ?smallImageKey:String;
 }
+
+class DiscordClientSandboxed
+{
+  public static function setPresence(params:DiscordClientPresenceParams):Void
+  {
+    DiscordClient.instance.setPresence(params);
+  }
+
+  public static function shutdown():Void
+  {
+    DiscordClient.instance.shutdown();
+  }
+}
+#else
+class DiscordClientSandboxed
+{
+  public static function setPresence(params:Dynamic):Void
+  {
+    // Do nothing.
+  }
+
+  public static function shutdown():Void
+  {
+    // Do nothing.
+  }
+}
 #end

source/funkin/api/newgrounds/Events.hx

@@ -0,0 +1,110 @@
+package funkin.api.newgrounds;
+
+#if FEATURE_NEWGROUNDS_EVENTS
+import io.newgrounds.Call.CallOutcome;
+import io.newgrounds.NG;
+import io.newgrounds.objects.events.Outcome;
+import io.newgrounds.objects.events.Result;
+#end
+
+/**
+ * Use Newgrounds to perform basic telemetry. Ignore if not logged in to Newgrounds.
+ */
+@:nullSafety
+class Events
+{
+  // Only allow letters, numbers, spaces, dashes, and underscores.
+  static final EVENT_NAME_REGEX:EReg = ~/[^a-zA-Z0-9 -_]/g;
+
+  public static function logEvent(eventName:String):Void
+  {
+    #if (FEATURE_NEWGROUNDS && FEATURE_NEWGROUNDS_EVENTS)
+    if (NewgroundsClient.instance.isLoggedIn())
+    {
+      var eventHandler = NG.core.calls.event;
+
+      if (eventHandler != null)
+      {
+        var sanitizedEventName = EVENT_NAME_REGEX.replace(eventName, '');
+        var outcomeHandler = onEventLogged.bind(sanitizedEventName, _);
+        eventHandler.logEvent(sanitizedEventName).addOutcomeHandler(outcomeHandler).send();
+      }
+    }
+    #end
+  }
+
+  #if FEATURE_NEWGROUNDS_EVENTS
+  static function onEventLogged(eventName:String, outcome:CallOutcome<LogEventData>)
+  {
+    switch (outcome)
+    {
+      case SUCCESS(data):
+        trace('[NEWGROUNDS] Logged event: ${data.eventName}');
+      case FAIL(outcome):
+        switch (outcome)
+        {
+          case HTTP(error):
+            trace('[NEWGROUNDS] HTTP error while logging event: ${error}');
+          case RESPONSE(error):
+            trace('[NEWGROUNDS] Response error (${error.code}) while logging event: ${error.message}');
+          case RESULT(error):
+            switch (error.code)
+            {
+              case 103: // Invalid custom event name
+                trace('[NEWGROUNDS] Invalid custom event name: ${eventName}');
+              default:
+                trace('[NEWGROUNDS] Result error (${error.code}) while logging event: ${error.message}');
+            }
+        }
+    }
+  }
+  #end
+
+  public static inline function logStartGame():Void
+  {
+    logEvent('start-game');
+  }
+
+  public static inline function logStartSong(songId:String, variation:String):Void
+  {
+    logEvent('start-song_${songId}-${variation}');
+  }
+
+  public static inline function logFailSong(songId:String, variation:String):Void
+  {
+    logEvent('blueballs_${songId}-${variation}');
+  }
+
+  public static inline function logCompleteSong(songId:String, variation:String):Void
+  {
+    logEvent('complete-song_${songId}-${variation}');
+  }
+
+  public static inline function logStartLevel(levelId:String):Void
+  {
+    logEvent('start-level_${levelId}');
+  }
+
+  public static inline function logCompleteLevel(levelId:String):Void
+  {
+    logEvent('complete-level_${levelId}');
+  }
+
+  public static inline function logEarnRank(rankName:String):Void
+  {
+    logEvent('earn-rank_${rankName}');
+  }
+
+  public static inline function logWatchCartoon():Void
+  {
+    logEvent('watch-cartoon');
+  }
+
+  // Note there is already a loadReferral call for the merch link
+  // and that gets logged as an event!
+
+  public static inline function logOpenCredits():Void
+  {
+    logEvent('open-credits');
+  }
+}

source/funkin/api/newgrounds/Leaderboards.hx

@@ -0,0 +1,489 @@
+package funkin.api.newgrounds;
+
+#if FEATURE_NEWGROUNDS
+import io.newgrounds.Call.CallError;
+import io.newgrounds.components.ScoreBoardComponent;
+import io.newgrounds.objects.Score;
+import io.newgrounds.objects.ScoreBoard as LeaderboardData;
+import io.newgrounds.objects.User;
+import io.newgrounds.objects.events.Outcome;
+import io.newgrounds.utils.ScoreBoardList;
+
+@:nullSafety
+class Leaderboards
+{
+  public static function listLeaderboardData():Map<Leaderboard, LeaderboardData>
+  {
+    var leaderboardList:Null<ScoreBoardList> = NewgroundsClient.instance.leaderboards;
+    if (leaderboardList == null)
+    {
+      trace('[NEWGROUNDS] Not logged in, cannot fetch medal data!');
+      return [];
+    }
+
+    return @:privateAccess leaderboardList._map?.copy() ?? [];
+  }
+
+  /**
+   * Submit a score to Newgrounds.
+   * @param leaderboard The leaderboard to submit to.
+   * @param score The score to submit.
+   * @param tag An optional tag to attach to the score.
+   */
+  public static function submitScore(leaderboard:Leaderboard, score:Int, ?tag:String):Void
+  {
+    // Silently reject submissions for unknown leaderboards.
+    if (leaderboard == Leaderboard.Unknown) return;
+
+    if (NewgroundsClient.instance.isLoggedIn())
+    {
+      var leaderboardList = NewgroundsClient.instance.leaderboards;
+      if (leaderboardList == null) return;
+
+      var leaderboardData:Null<LeaderboardData> = leaderboardList.get(leaderboard.getId());
+      if (leaderboardData != null)
+      {
+        leaderboardData.postScore(score, function(outcome:Outcome<CallError>):Void {
+          switch (outcome)
+          {
+            case SUCCESS:
+              trace('[NEWGROUNDS] Submitted score!');
+            case FAIL(error):
+              trace('[NEWGROUNDS] Failed to submit score!');
+              trace(error);
+          }
+        });
+      }
+    }
+  }
+
+  /**
+   * Request to receive scores from Newgrounds.
+   * @param leaderboard The leaderboard to fetch scores from.
+   * @param params Additional parameters for fetching the score.
+   */
+  public static function requestScores(leaderboard:Leaderboard, ?params:RequestScoresParams)
+  {
+    // Silently reject retrieving scores from unknown leaderboards.
+    if (leaderboard == Leaderboard.Unknown) return;
+
+    var leaderboardList = NewgroundsClient.instance.leaderboards;
+    if (leaderboardList == null) return;
+
+    var leaderboardData:Null<LeaderboardData> = leaderboardList.get(leaderboard.getId());
+    if (leaderboardData == null) return;
+
+    var user:Null<User> = null;
+    if ((params?.useCurrentUser ?? false) && NewgroundsClient.instance.isLoggedIn()) user = NewgroundsClient.instance.user;
+
+    leaderboardData.requestScores(params?.limit ?? 10, params?.skip ?? 0, params?.period ?? ALL, params?.social ?? false, params?.tag, user,
+      function(outcome:Outcome<CallError>):Void {
+        switch (outcome)
+        {
+          case SUCCESS:
+            trace('[NEWGROUNDS] Fetched scores!');
+            if (params != null && params.onComplete != null) params.onComplete(leaderboardData.scores);
+
+          case FAIL(error):
+            trace('[NEWGROUNDS] Failed to fetch scores!');
+            trace(error);
+            if (params != null && params.onFail != null) params.onFail();
+        }
+      });
+  }
+
+  /**
+   * Submit a score for a Story Level to Newgrounds.
+   */
+  public static function submitLevelScore(levelId:String, difficultyId:String, score:Int):Void
+  {
+    var tag = '${difficultyId}';
+    Leaderboards.submitScore(Leaderboard.getLeaderboardByLevel(levelId), score, tag);
+  }
+
+  /**
+   * Submit a score for a song to Newgrounds.
+   */
+  public static function submitSongScore(songId:String, difficultyId:String, score:Int):Void
+  {
+    var tag = '${difficultyId}';
+    Leaderboards.submitScore(Leaderboard.getLeaderboardBySong(songId, difficultyId), score, tag);
+  }
+}
+
+/**
+ * Wrapper for `Leaderboards` that prevents submitting scores.
+ */
+@:nullSafety
+class LeaderboardsSandboxed
+{
+  public static function getLeaderboardBySong(songId:String, difficultyId:String)
+  {
+    return Leaderboard.getLeaderboardBySong(songId, difficultyId);
+  }
+
+  public static function getLeaderboardByLevel(levelId:String)
+  {
+    return Leaderboard.getLeaderboardByLevel(levelId);
+  }
+
+  public function requestScores(leaderboard:Leaderboard, params:RequestScoresParams)
+  {
+    Leaderboards.requestScores(leaderboard, params);
+  }
+}
+
+/**
+ * Additional parameters for `Leaderboards.requestScores()`
+ */
+typedef RequestScoresParams =
+{
+  /**
+   * How many scores to include in a list.
+   * @default `10`
+   */
+  var ?limit:Int;
+
+  /**
+   * How many scores to skip before starting the list.
+   * @default `0`
+   */
+  var ?skip:Int;
+
+  /**
+   * The time-frame to pull the scores from.
+   * @default `Period.ALL`
+   */
+  var ?period:Period;
+
+  /**
+   * If true, only scores by the user and their friends will be loaded. Ignored if no user is set.
+   * @default `false`
+   */
+  var ?social:Bool;
+
+  /**
+   * An optional tag to filter the results by.
+   * @default `null`
+   */
+  var ?tag:String;
+
+  /**
+   * If true, only the scores from the currently logged in user will be loaded.
+   * Additionally, if `social` is set to true, the scores of the user's friend will be loaded.
+   * @default `false`
+   */
+  var ?useCurrentUser:Bool;
+
+  var ?onComplete:Array<Score>->Void;
+  var ?onFail:Void->Void;
+}
+#end
+
+enum abstract Leaderboard(Int) from Int to Int
+{
+  /**
+   * Represents an undefined or invalid leaderboard.
+   */
+  var Unknown = -1;
+
+  //
+  // STORY LEVELS
+  //
+  var StoryWeek1 = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 14239 #else 9615 #end;
+  var StoryWeek2 = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 14240 #else 9616 #end;
+  var StoryWeek3 = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 14242 #else 9767 #end;
+  var StoryWeek4 = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 14241 #else 9866 #end;
+  var StoryWeek5 = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 14243 #else 9956 #end;
+  var StoryWeek6 = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 14244 #else 9957 #end;
+  var StoryWeek7 = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 14245 #else 14682 #end;
+  var StoryWeekend1 = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 14237 #else 14683 #end;
+
+  //
+  // SONGS
+  //
+  // Tutorial
+  var Tutorial = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 14249 #else 14684 #end;
+
+  // Week 1
+  var Bopeebo = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 14246 #else 9603 #end;
+  var BopeeboErect = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 1000000 #else 14685 #end;
+  var BopeeboPicoMix = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 1000000 #else 14686 #end;
+  var Fresh = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 14247 #else 9602 #end;
+  var FreshErect = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 1000000 #else 14687 #end;
+  var FreshPicoMix = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 1000000 #else 14688 #end;
+  var DadBattle = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 14248 #else 9605 #end;
+  var DadBattleErect = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 1000000 #else 14689 #end;
+  var DadBattlePicoMix = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 1000000 #else 14690 #end;
+
+  // Week 2
+  var Spookeez = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 1000000 #else 9604 #end;
+  var SpookeezErect = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 1000000 #else 14691 #end;
+  var SpookeezPicoMix = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 1000000 #else 14692 #end;
+  var South = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 1000000 #else 9606 #end;
+  var SouthErect = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 1000000 #else 14693 #end;
+  var SouthPicoMix = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 1000000 #else 14694 #end;
+  var Monster = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 1000000 #else 14703 #end;
+
+  // Week 3
+  var Pico = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 1000000 #else 9766 #end;
+  var PicoErect = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 1000000 #else 14695 #end;
+  var PicoPicoMix = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 1000000 #else 14696 #end;
+  var PhillyNice = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 1000000 #else 9769 #end;
+  var PhillyNiceErect = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 1000000 #else 14697 #end;
+  var PhillyNicePicoMix = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 1000000 #else 14698 #end;
+  var Blammed = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 1000000 #else 9768 #end;
+  var BlammedErect = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 1000000 #else 14704 #end;
+  var BlammedPicoMix = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 1000000 #else 14705 #end;
+
+  // Week 4
+  var SatinPanties = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 1000000 #else 9869 #end;
+  var SatinPantiesErect = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 1000000 #else 14701 #end;
+  var High = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 1000000 #else 9867 #end;
+  var HighErect = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 1000000 #else 14699 #end;
+  var MILF = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 1000000 #else 9868 #end;
+
+  // Week 5
+  var Cocoa = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 1000000 #else 14706 #end;
+  var CocoaErect = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 1000000 #else 14707 #end;
+  var CocoaPicoMix = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 1000000 #else 14708 #end;
+  var Eggnog = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 1000000 #else 14709 #end;
+  var EggnogErect = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 1000000 #else 14711 #end;
+  var EggnogPicoMix = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 1000000 #else 14710 #end;
+  var WinterHorrorland = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 1000000 #else 14712 #end;
+
+  // Week 6
+  var Senpai = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 1000000 #else 9958 #end;
+  var SenpaiErect = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 1000000 #else 14713 #end;
+  var SenpaiPicoMix = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 1000000 #else 14716 #end;
+  var Roses = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 1000000 #else 9959 #end;
+  var RosesErect = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 1000000 #else 14714 #end;
+  var RosesPicoMix = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 1000000 #else 14717 #end;
+  var Thorns = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 1000000 #else 9960 #end;
+  var ThornsErect = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 1000000 #else 14715 #end;
+
+  // Week 7
+  var Ugh = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 1000000 #else 14718 #end;
+  var UghErect = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 1000000 #else 14722 #end;
+  var UghPicoMix = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 1000000 #else 14721 #end;
+  var Guns = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 1000000 #else 14719 #end;
+  var GunsPicoMix = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 1000000 #else 14723 #end;
+  var Stress = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 1000000 #else 14720 #end;
+  var StressPicoMix = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 1000000 #else 14724 #end;
+
+  // Weekend 1
+  var Darnell = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 1000000 #else 14725 #end;
+  var DarnellErect = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 1000000 #else 14727 #end;
+  var DarnellBFMix = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 1000000 #else 14726 #end;
+  var LitUp = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 1000000 #else 14728 #end;
+  var LitUpBFMix = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 1000000 #else 14729 #end;
+  var TwoHot = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 1000000 #else 14730 #end; // Variable names can't start with a number!
+  var Blazin = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 1000000 #else 14731 #end;
+
+  public function getId():Int
+  {
+    return this;
+  }
+
+  /**
+   * Get the leaderboard for a given level and difficulty.
+   * @param levelId The ID for the story level.
+   * @param difficulty The current difficulty.
+   * @return The Leaderboard ID for the given level and difficulty.
+   */
+  public static function getLeaderboardByLevel(levelId:String):Leaderboard
+  {
+    switch (levelId)
+    {
+      case "week1":
+        return StoryWeek1;
+      case "week2":
+        return StoryWeek2;
+      case "week3":
+        return StoryWeek3;
+      case "week4":
+        return StoryWeek4;
+      case "week5":
+        return StoryWeek5;
+      case "week6":
+        return StoryWeek6;
+      case "week7":
+        return StoryWeek7;
+      case "weekend1":
+        return StoryWeekend1;
+      default:
+        return Unknown;
+    }
+  }
+
+  /**
+   * Get the leaderboard for a given level and difficulty.
+   * @param levelId The ID for the story level.
+   * @param difficulty The current difficulty, suffixed with the variation, like `easy-pico` or `nightmare`.
+   * @return The Leaderboard ID for the given level and difficulty.
+   */
+  public static function getLeaderboardBySong(songId:String, difficulty:String):Leaderboard
+  {
+    var variation = Constants.DEFAULT_VARIATION;
+    var difficultyParts = difficulty.split('-');
+
+    if (difficultyParts.length >= 2)
+    {
+      variation = difficultyParts[difficultyParts.length - 1];
+    }
+    else if (Constants.DEFAULT_DIFFICULTY_LIST_ERECT.contains(difficulty))
+    {
+      variation = "erect";
+    }
+
+    switch (variation)
+    {
+      case "pico":
+        switch (songId)
+        {
+          case "bopeebo":
+            return BopeeboPicoMix;
+          case "fresh":
+            return FreshPicoMix;
+          case "dadbattle":
+            return DadBattlePicoMix;
+          case "spookeez":
+            return SpookeezPicoMix;
+          case "south":
+            return SouthPicoMix;
+          case "pico":
+            return PicoPicoMix;
+          case "philly-nice":
+            return PhillyNicePicoMix;
+          case "blammed":
+            return BlammedPicoMix;
+          case "cocoa":
+            return CocoaPicoMix;
+          case "eggnog":
+            return EggnogPicoMix;
+          case "senpai":
+            return SenpaiPicoMix;
+          case "roses":
+            return RosesPicoMix;
+          case "ugh":
+            return UghPicoMix;
+          case "guns":
+            return GunsPicoMix;
+          case "stress":
+            return StressPicoMix;
+          default:
+            return Unknown;
+        }
+      case "bf":
+        switch (songId)
+        {
+          case "darnell":
+            return DarnellBFMix;
+          case "lit-up":
+            return LitUpBFMix;
+          default:
+            return Unknown;
+        }
+      case "erect":
+        switch (songId)
+        {
+          case "bopeebo":
+            return BopeeboErect;
+          case "fresh":
+            return FreshErect;
+          case "dadbattle":
+            return DadBattleErect;
+          case "spookeez":
+            return SpookeezErect;
+          case "south":
+            return SouthErect;
+          case "pico":
+            return PicoErect;
+          case "philly-nice":
+            return PhillyNiceErect;
+          case "blammed":
+            return BlammedErect;
+          case "satin-panties":
+            return SatinPantiesErect;
+          case "high":
+            return HighErect;
+          case "cocoa":
+            return CocoaErect;
+          case "eggnog":
+            return EggnogErect;
+          case "senpai":
+            return SenpaiErect;
+          case "roses":
+            return RosesErect;
+          case "thorns":
+            return ThornsErect;
+          case "ugh":
+            return UghErect;
+          case "darnell":
+            return DarnellErect;
+          default:
+            return Unknown;
+        }
+      case "default":
+        switch (songId)
+        {
+          case "tutorial":
+            return Tutorial;
+          case "bopeebo":
+            return Bopeebo;
+          case "fresh":
+            return Fresh;
+          case "dadbattle":
+            return DadBattle;
+          case "spookeez":
+            return Spookeez;
+          case "south":
+            return South;
+          case "monster":
+            return Monster;
+          case "pico":
+            return Pico;
+          case "philly-nice":
+            return PhillyNice;
+          case "blammed":
+            return Blammed;
+          case "satin-panties":
+            return SatinPanties;
+          case "high":
+            return High;
+          case "milf":
+            return MILF;
+          case "cocoa":
+            return Cocoa;
+          case "eggnog":
+            return Eggnog;
+          case "winter-horrorland":
+            return WinterHorrorland;
+          case "senpai":
+            return Senpai;
+          case "roses":
+            return Roses;
+          case "thorns":
+            return Thorns;
+          case "ugh":
+            return Ugh;
+          case "guns":
+            return Guns;
+          case "stress":
+            return Stress;
+          case "darnell":
+            return Darnell;
+          case "lit-up":
+            return LitUp;
+          case "2hot":
+            return TwoHot;
+          case "blazin":
+            return Blazin;
+          default:
+            return Unknown;
+        }
+      default:
+        return Unknown;
+    }
+  }
+}

source/funkin/api/newgrounds/Medals.hx

@@ -0,0 +1,411 @@
+package funkin.api.newgrounds;
+
+#if FEATURE_NEWGROUNDS
+import io.newgrounds.objects.Medal as MedalData;
+import funkin.util.plugins.NewgroundsMedalPlugin;
+import flixel.graphics.FlxGraphic;
+import openfl.display.BitmapData;
+import io.newgrounds.utils.MedalList;
+import haxe.Json;
+
+@:nullSafety
+class Medals
+{
+  public static var medalJSON:Array<MedalJSON> = [];
+
+  public static function listMedalData():Map<Medal, MedalData>
+  {
+    var medalList = NewgroundsClient.instance.medals;
+
+    if (medalList == null)
+    {
+      trace('[NEWGROUNDS] Not logged in, cannot fetch medal data!');
+      return [];
+    }
+
+    return @:privateAccess medalList._map?.copy() ?? [];
+  }
+
+  public static function award(medal:Medal):Void
+  {
+    if (NewgroundsClient.instance.isLoggedIn())
+    {
+      var medalList = NewgroundsClient.instance.medals;
+      @:privateAccess
+      if (medalList == null || medalList._map == null) return;
+
+      var medalData:Null<MedalData> = medalList.get(medal.getId());
+      @:privateAccess
+      if (medalData == null || medalData._data == null)
+      {
+        trace('[NEWGROUNDS] Could not retrieve data for medal: ${medal}');
+        return;
+      }
+      else if (!medalData.unlocked)
+      {
+        trace('[NEWGROUNDS] Awarding medal (${medal}).');
+        medalData.sendUnlock();
+
+        // Play the medal unlock animation, but only if the user has not already unlocked it.
+        #if html5
+        // Web builds support parsing the bitmap data from the URL directly.
+        BitmapData.loadFromFile("https:" + medalData.icon).onComplete(function(bmp:BitmapData) {
+          var medalGraphic = FlxGraphic.fromBitmapData(bmp);
+          medalGraphic.persist = true;
+          NewgroundsMedalPlugin.play(medalData.value, medalData.name, medalGraphic);
+        });
+        #else
+        if ((medalJSON?.length ?? 0) == 0) loadMedalJSON();
+        // We have to use a medal image from the game files. We use a Base64 encoded image that NG spits out.
+        // TODO: Wait, don't they give us the medal icon?
+
+        var localMedalData:Null<MedalJSON> = medalJSON.filter(function(jsonMedal) {
+          #if FEATURE_NEWGROUNDS_TESTING_MEDALS
+          return medal == jsonMedal.idTest;
+          #else
+          return medal == jsonMedal.id;
+          #end
+        })[0];
+
+        if (localMedalData == null) throw "You forgot to encode a Base64 image for medal: " + medal;
+
+        var str:String = localMedalData.icon;
+        // Lime/OpenFL parses it without the included prefix stuff, so we remove it.
+        str = str.replace("data:image/png;base64,", "").trim();
+        var bitmapData = BitmapData.fromBase64(str, "image/png");
+        var medalGraphic:Null<FlxGraphic> = null;
+        if (str != null)
+        {
+          medalGraphic = FlxGraphic.fromBitmapData(bitmapData);
+          medalGraphic.persist = true;
+        }
+
+        NewgroundsMedalPlugin.play(medalData.value, medalData.name, medalGraphic);
+        #end
+      }
+      else
+      {
+        trace('[NEWGROUNDS] User already has medal (${medal}).');
+      }
+    }
+    else
+    {
+      trace('[NEWGROUNDS] Attempted to award medal (${medal}), but not logged into Newgrounds.');
+    }
+  }
+
+  public static function loadMedalJSON():Void
+  {
+    var jsonPath = Paths.json('medals');
+
+    var jsonString = Assets.getText(jsonPath);
+
+    var parser = new json2object.JsonParser<Array<MedalJSON>>();
+    parser.ignoreUnknownVariables = false;
+    trace('[NEWGROUNDS] Parsing local medal data...');
+    parser.fromJson(jsonString, jsonPath);
+
+    if (parser.errors.length > 0)
+    {
+      trace('[NEWGROUNDS] Failed to parse local medal data!');
+      for (error in parser.errors)
+        funkin.data.DataError.printError(error);
+      medalJSON = [];
+    }
+    else
+    {
+      medalJSON = parser.value;
+    }
+  }
+
+  public static function fetchMedalData(medal:Medal):Null<FetchedMedalData>
+  {
+    var medalList = NewgroundsClient.instance.medals;
+    @:privateAccess
+    if (medalList == null || medalList._map == null) return null;
+
+    var medalData:Null<MedalData> = medalList.get(medal.getId());
+    @:privateAccess
+    if (medalData == null || medalData._data == null)
+    {
+      trace('[NEWGROUNDS] Could not retrieve data for medal: ${medal}');
+      return null;
+    }
+
+    return {
+      id: medalData.id,
+      name: medalData.name,
+      description: medalData.description,
+      icon: medalData.icon,
+      value: medalData.value,
+      difficulty: medalData.difficulty,
+      secret: medalData.secret,
+      unlocked: medalData.unlocked
+    }
+  }
+
+  public static function awardStoryLevel(id:String):Void
+  {
+    var medal:Medal = Medal.getMedalByStoryLevel(id);
+    if (medal == Medal.Unknown)
+    {
+      trace('[NEWGROUNDS] Story level does not have a medal! (${id}).');
+      return;
+    }
+    Medals.award(medal);
+  }
+}
+
+/**
+ * Wrapper for `Medals` that prevents awarding medals.
+ */
+class MedalsSandboxed
+{
+  public static function fetchMedalData(medal:Medal):Null<FetchedMedalData>
+  {
+    return Medals.fetchMedalData(medal);
+  }
+
+  public static function getMedalByStoryLevel(id:String):Medal
+  {
+    return Medal.getMedalByStoryLevel(id);
+  }
+
+  public static function getAllMedals():Array<Medal>
+  {
+    return Medal.getAllMedals();
+  }
+}
+
+/**
+ * Contains data for a Medal, but excludes functions like `sendUnlock()`.
+ */
+typedef FetchedMedalData =
+{
+  var id:Int;
+  var name:String;
+  var description:String;
+  var icon:String;
+  var value:Int;
+  var difficulty:Int;
+  var secret:Bool;
+  var unlocked:Bool;
+}
+#end
+
+/**
+ * Represents NG Medal data in a JSON format.
+ */
+typedef MedalJSON =
+{
+  /**
+   * Medal ID to use for release builds
+   */
+  var id:Int;
+
+  /**
+   * Medal ID to use for testing builds
+   */
+  var idTest:Int;
+
+  /**
+   * The English name for the medal
+   */
+  var name:String;
+
+  /**
+   * The English name for the medal
+   */
+  var icon:String;
+}
+
+enum abstract Medal(Int) from Int to Int
+{
+  /**
+   * Represents an undefined or invalid medal.
+   */
+  var Unknown = -1;
+
+  /**
+   * I Said Funkin'!
+   * Start the game for the first time.
+   */
+  var StartGame = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 80894 #else 60960 #end;
+
+  /**
+   * That's How You Do It!
+   * Beat Tutoria l in Story Mode (on any difficulty).
+   */
+  var StoryTutorial = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 80906 #else 83647 #end;
+
+  /**
+   * More Like Daddy Queerest
+   * Beat Week 1 in Story Mode (on any difficulty).
+   */
+  var StoryWeek1 = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 80899 #else 60961 #end;
+
+  /**
+   * IT IS THE SPOOKY MONTH
+   * Beat Week 2 in Story Mode (on any difficulty).
+   */
+  var StoryWeek2 = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 80900 #else 83648 #end;
+
+  /**
+   * Pico Funny
+   * Beat Week 3 in Story Mode (on any difficulty).
+   */
+  var StoryWeek3 = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 80901 #else 83649 #end;
+
+  /**
+   * Mommy Must Murder
+   * Beat Week 4 in Story Mode (on any difficulty).
+   */
+  var StoryWeek4 = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 80902 #else 83650 #end;
+
+  /**
+   * Yule Tide Joy
+   * Beat Week 5 in Story Mode (on any difficulty).
+   */
+  var StoryWeek5 = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 80903 #else 83651 #end;
+
+  /**
+   * A Visual Novelty
+   * Beat Week 6 in Story Mode (on any difficulty).
+   */
+  var StoryWeek6 = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 80904 #else 83652 #end;
+
+  /**
+   * I <3 JohnnyUtah
+   * Beat Week 7 in Story Mode (on any difficulty).
+   */
+  var StoryWeek7 = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 80905 #else 83653 #end;
+
+  /**
+   * Yo, Really Think So?
+   * Beat Weekend 1 in Story Mode (on any difficulty).
+   */
+  var StoryWeekend1 = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 80907 #else 83654 #end;
+
+  /**
+   * Stay Funky
+   * Press TAB in Freeplay and unlock your first character.
+   */
+  var CharSelect = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 83633 #else 83655 #end;
+
+  /**
+   * A Challenger Appears
+   * Beat any Pico remix in Freeplay (on any difficulty).
+   */
+  var FreeplayPicoMix = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 80910 #else 83656 #end;
+
+  /**
+   * De-Stressing
+   * Beat Stress (Pico Mix) in Freeplay (on Normal difficulty or higher).
+   */
+  var FreeplayStressPico = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 83629 #else 83657 #end;
+
+  /**
+   * L
+   * Earn a Loss rating on any song (on any difficulty).
+   */
+  var LossRating = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 80915 #else 83658 #end;
+
+  /**
+   * Getting Freaky
+   * Earn a Perfect rating on any song on Hard difficulty or higher.
+   * NOTE: Should also be awarded for a Gold Perfect because otherwise that would be annoying.
+   */
+  var PerfectRatingHard = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 80908 #else 83659 #end;
+
+  /**
+   * You Should Drink More Water
+   * Earn a Golden Perfect rating on any song on Hard difficulty or higher.
+   */
+  var GoldPerfectRatingHard = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 80909 #else 83660 #end;
+
+  /**
+   * Harder Than Hard
+   * Beat any Erect remix in Freeplay on Erect or Nightmare difficulty.
+   */
+  var ErectDifficulty = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 80911 #else 83661 #end;
+
+  /**
+   * The Rap God
+   * Earn a Gold Perfect rating on any song on Nightmare difficulty.
+   */
+  var GoldPerfectRatingNightmare = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 80912 #else 83662 #end;
+
+  /**
+   * Just like the game!
+   * Get freaky on a Friday.
+   * NOTE: You must beat at least one song on any difficulty.
+   */
+  var FridayNight = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 80913 #else 61034 #end;
+
+  /**
+   * Nice
+   * Earn a rating of EXACTLY 69% (good luck).
+   */
+  var Nice = #if FEATURE_NEWGROUNDS_TESTING_MEDALS 80914 #else 83646 #end;
+
+  public function getId():Int
+  {
+    return this;
+  }
+
+  public static function getMedalByStoryLevel(levelId:String):Medal
+  {
+    switch (levelId)
+    {
+      case "tutorial":
+        return StoryTutorial;
+      case "week1":
+        return StoryWeek1;
+      case "week2":
+        return StoryWeek2;
+      case "week3":
+        return StoryWeek3;
+      case "week4":
+        return StoryWeek4;
+      case "week5":
+        return StoryWeek5;
+      case "week6":
+        return StoryWeek6;
+      case "week7":
+        return StoryWeek7;
+      case "weekend1":
+        return StoryWeekend1;
+      default:
+        return Unknown;
+    }
+  }
+
+  /**
+   * Lists all medals aside from the `Unknown` one.
+   */
+  public static function getAllMedals()
+  {
+    return [
+      StartGame,
+      StoryTutorial,
+      StoryWeek1,
+      StoryWeek2,
+      StoryWeek3,
+      StoryWeek4,
+      StoryWeek5,
+      StoryWeek6,
+      StoryWeek7,
+      StoryWeekend1,
+      CharSelect,
+      FreeplayPicoMix,
+      FreeplayStressPico,
+      LossRating,
+      PerfectRatingHard,
+      GoldPerfectRatingHard,
+      ErectDifficulty,
+      GoldPerfectRatingNightmare,
+      FridayNight,
+      Nice
+    ];
+  }
+}

source/funkin/api/newgrounds/NGSaveSlot.hx

@@ -0,0 +1,156 @@
+package funkin.api.newgrounds;
+
+#if FEATURE_NEWGROUNDS
+import io.newgrounds.utils.SaveSlotList;
+import io.newgrounds.objects.SaveSlot;
+import io.newgrounds.Call.CallError;
+import io.newgrounds.objects.events.Outcome;
+import funkin.save.Save;
+
+@:nullSafety
+@:access(funkin.save.Save)
+class NGSaveSlot
+{
+  public static var instance(get, never):NGSaveSlot;
+  static var _instance:Null<NGSaveSlot> = null;
+
+  static function get_instance():NGSaveSlot
+  {
+    if (_instance == null)
+    {
+      return loadInstance();
+    }
+    return _instance;
+  }
+
+  public static function loadInstance():NGSaveSlot
+  {
+    var loadedSave:NGSaveSlot = loadSlot(Save.BASE_SAVE_SLOT);
+    if (_instance == null) _instance = loadedSave;
+
+    return loadedSave;
+  }
+
+  static function loadSlot(slot:Int):NGSaveSlot
+  {
+    trace('[NEWGROUNDS] Getting save slot from ID $slot');
+
+    var saveSlot:Null<SaveSlot> = NewgroundsClient.instance.saveSlots?.getById(slot);
+
+    var saveSlotObj:NGSaveSlot = new NGSaveSlot(saveSlot);
+    return saveSlotObj;
+  }
+
+  public var ngSaveSlot:Null<SaveSlot> = null;
+
+  public function new(?ngSaveSlot:Null<SaveSlot>)
+  {
+    this.ngSaveSlot = ngSaveSlot;
+
+    #if FLX_DEBUG
+    FlxG.console.registerClass(NGSaveSlot);
+    FlxG.console.registerClass(Save);
+    #end
+  }
+
+  /**
+   * Saves `data` to the newgrounds save slot.
+   * @param data The raw save data.
+   */
+  public function save(data:RawSaveData):Void
+  {
+    var encodedData:String = haxe.Serializer.run(data);
+
+    try
+    {
+      ngSaveSlot?.save(encodedData, function(outcome:Outcome<CallError>) {
+        switch (outcome)
+        {
+          case SUCCESS:
+            trace('[NEWGROUNDS] Successfully saved save data to save slot!');
+          case FAIL(error):
+            trace('[NEWGROUNDS] Failed to save data to save slot!');
+            trace(error);
+        }
+      });
+    }
+    catch (error:String)
+    {
+      trace('[NEWGROUNDS] Failed to save data to save slot!');
+      trace(error);
+    }
+  }
+
+  public function load(?onComplete:Null<Dynamic->Void>, ?onError:Null<CallError->Void>):Void
+  {
+    try
+    {
+      ngSaveSlot?.load(function(outcome:SaveSlotOutcome):Void {
+        switch (outcome)
+        {
+          case SUCCESS(value):
+            trace('[NEWGROUNDS] Loaded save slot with the ID of ${ngSaveSlot?.id}!');
+            #if FEATURE_DEBUG_FUNCTIONS
+            trace('Save Slot Data:');
+            trace(value);
+            #end
+
+            if (onComplete != null && value != null)
+            {
+              var decodedData:Dynamic = haxe.Unserializer.run(value);
+              onComplete(decodedData);
+            }
+          case FAIL(error):
+            trace('[NEWGROUNDS] Failed to load save slot with the ID of ${ngSaveSlot?.id}!');
+            trace(error);
+
+            if (onError != null)
+            {
+              onError(error);
+            }
+        }
+      });
+    }
+    catch (error:String)
+    {
+      trace('[NEWGROUNDS] Failed to load save slot with the ID of ${ngSaveSlot?.id}!');
+      trace(error);
+
+      if (onError != null)
+      {
+        onError(RESPONSE({message: error, code: 500}));
+      }
+    }
+  }
+
+  public function clear():Void
+  {
+    try
+    {
+      ngSaveSlot?.clear(function(outcome:Outcome<CallError>) {
+        switch (outcome)
+        {
+          case SUCCESS:
+            trace('[NEWGROUNDS] Successfully cleared save slot!');
+          case FAIL(error):
+            trace('[NEWGROUNDS] Failed to clear save slot!');
+            trace(error);
+        }
+      });
+    }
+    catch (error:String)
+    {
+      trace('[NEWGROUNDS] Failed to clear save slot!');
+      trace(error);
+    }
+  }
+
+  public function checkSlot():Void
+  {
+    trace('[NEWGROUNDS] Checking save slot with the ID of ${ngSaveSlot?.id}...');
+
+    trace('  Is null? ${ngSaveSlot == null}');
+    trace('  Is empty? ${ngSaveSlot?.isEmpty() ?? false}');
+  }
+}
+#end

source/funkin/api/newgrounds/NGUnsafe.hx

@@ -1,71 +0,0 @@
-package funkin.api.newgrounds;
-
-#if newgrounds
-import io.newgrounds.NG;
-import io.newgrounds.NGLite;
-import io.newgrounds.components.ScoreBoardComponent.Period;
-import io.newgrounds.objects.Error;
-import io.newgrounds.objects.Medal;
-import io.newgrounds.objects.Score;
-import io.newgrounds.objects.ScoreBoard;
-import io.newgrounds.objects.events.Response;
-import io.newgrounds.objects.events.Result.GetCurrentVersionResult;
-import io.newgrounds.objects.events.Result.GetVersionResult;
-#end
-
-/**
- * Contains any script functions which should be BLOCKED from use by modded scripts.
- */
-class NGUnsafe
-{
-  static public function logEvent(event:String)
-  {
-    #if newgrounds
-    NG.core.calls.event.logEvent(event).send();
-    trace('should have logged: ' + event);
-    #else
-    #if FEATURE_DEBUG_FUNCTIONS
-    trace('event:$event - not logged, missing NG.io lib');
-    #end
-    #end
-  }
-
-  static public function unlockMedal(id:Int)
-  {
-    #if newgrounds
-    if (isLoggedIn)
-    {
-      var medal = NG.core.medals.get(id);
-      if (!medal.unlocked) medal.sendUnlock();
-    }
-    #else
-    #if FEATURE_DEBUG_FUNCTIONS
-    trace('medal:$id - not unlocked, missing NG.io lib');
-    #end
-    #end
-  }
-
-  static public function postScore(score:Int = 0, song:String)
-  {
-    #if newgrounds
-    if (isLoggedIn)
-    {
-      for (id in NG.core.scoreBoards.keys())
-      {
-        var board = NG.core.scoreBoards.get(id);
-
-        if (song == board.name)
-        {
-          board.postScore(score, "Uhh meow?");
-        }
-
-        // trace('loaded scoreboard id:$id, name:${board.name}');
-      }
-    }
-    #else
-    #if FEATURE_DEBUG_FUNCTIONS
-    trace('Song:$song, Score:$score - not posted, missing NG.io lib');
-    #end
-    #end
-  }
-}

source/funkin/api/newgrounds/NGUtil.hx

@@ -1,243 +0,0 @@
-package funkin.api.newgrounds;
-
-import flixel.util.FlxSignal;
-import flixel.util.FlxTimer;
-import lime.app.Application;
-import openfl.display.Stage;
-#if newgrounds
-import io.newgrounds.NG;
-import io.newgrounds.NGLite;
-import io.newgrounds.components.ScoreBoardComponent.Period;
-import io.newgrounds.objects.Error;
-import io.newgrounds.objects.Medal;
-import io.newgrounds.objects.Score;
-import io.newgrounds.objects.ScoreBoard;
-import io.newgrounds.objects.events.Response;
-import io.newgrounds.objects.events.Result.GetCurrentVersionResult;
-import io.newgrounds.objects.events.Result.GetVersionResult;
-#end
-
-/**
- * Contains any script functions which should be ALLOWD for use by modded scripts.
- */
-class NGUtil
-{
-  #if newgrounds
-  /**
-   * True, if the saved sessionId was used in the initial login, and failed to connect.
-   * Used in MainMenuState to show a popup to establish a new connection
-   */
-  public static var savedSessionFailed(default, null):Bool = false;
-
-  public static var scoreboardsLoaded:Bool = false;
-  public static var isLoggedIn(get, never):Bool;
-
-  inline static function get_isLoggedIn()
-  {
-    return NG.core != null && NG.core.loggedIn;
-  }
-
-  public static var scoreboardArray:Array<Score> = [];
-
-  public static var ngDataLoaded(default, null):FlxSignal = new FlxSignal();
-  public static var ngScoresLoaded(default, null):FlxSignal = new FlxSignal();
-
-  public static var GAME_VER:String = "";
-
-  static public function checkVersion(callback:String->Void)
-  {
-    trace('checking NG.io version');
-    GAME_VER = "v" + Application.current.meta.get('version');
-
-    NG.core.calls.app.getCurrentVersion(GAME_VER).addDataHandler(function(response) {
-      GAME_VER = response.result.data.currentVersion;
-      trace('CURRENT NG VERSION: ' + GAME_VER);
-      callback(GAME_VER);
-    }).send();
-  }
-
-  static public function init()
-  {
-    var api = APIStuff.API;
-    if (api == null || api.length == 0)
-    {
-      trace("Missing Newgrounds API key, aborting connection");
-      return;
-    }
-    trace("connecting to newgrounds");
-
-    #if NG_FORCE_EXPIRED_SESSION
-    var sessionId:String = "fake_session_id";
-    function onSessionFail(error:Error)
-    {
-      trace("Forcing an expired saved session. " + "To disable, comment out NG_FORCE_EXPIRED_SESSION in Project.xml");
-      savedSessionFailed = true;
-    }
-    #else
-    var sessionId:String = NGLite.getSessionId();
-    if (sessionId != null) trace("found web session id");
-
-    #if (debug)
-    if (sessionId == null && APIStuff.SESSION != null)
-    {
-      trace("using debug session id");
-      sessionId = APIStuff.SESSION;
-    }
-    #end
-
-    var onSessionFail:Error->Void = null;
-    if (sessionId == null && Save.instance.ngSessionId != null)
-    {
-      trace("using stored session id");
-      sessionId = Save.instance.ngSessionId;
-      onSessionFail = function(error) savedSessionFailed = true;
-    }
-    #end
-
-    NG.create(api, sessionId, #if NG_DEBUG true #else false #end, onSessionFail);
-
-    #if NG_VERBOSE
-    NG.core.verbose = true;
-    #end
-    // Set the encryption cipher/format to RC4/Base64. AES128 and Hex are not implemented yet
-    NG.core.initEncryption(APIStuff.EncKey); // Found in you NG project view
-
-    if (NG.core.attemptingLogin)
-    {
-      /* a session_id was found in the loadervars, this means the user is playing on newgrounds.com
-       * and we should login shortly. lets wait for that to happen
-       */
-      trace("attempting login");
-      NG.core.onLogin.add(onNGLogin);
-    }
-    // GK: taking out auto login, adding a login button to the main menu
-    // else
-    // {
-    // 	/* They are NOT playing on newgrounds.com, no session id was found. We must start one manually, if we want to.
-    // 	 * Note: This will cause a new browser window to pop up where they can log in to newgrounds
-    // 	 */
-    // 	NG.core.requestLogin(onNGLogin);
-    // }
-  }
-
-  /**
-   * Attempts to log in to newgrounds by requesting a new session ID, only call if no session ID was found automatically
-   * @param popupLauncher The function to call to open the login url, must be inside
-   * a user input event or the popup blocker will block it.
-   * @param onComplete A callback with the result of the connection.
-   */
-  static public function login(?popupLauncher:(Void->Void)->Void, onComplete:ConnectionResult->Void)
-  {
-    trace("Logging in manually");
-    var onPending:Void->Void = null;
-    if (popupLauncher != null)
-    {
-      onPending = function() popupLauncher(NG.core.openPassportUrl);
-    }
-
-    var onSuccess:Void->Void = onNGLogin;
-    var onFail:Error->Void = null;
-    var onCancel:Void->Void = null;
-    if (onComplete != null)
-    {
-      onSuccess = function() {
-        onNGLogin();
-        onComplete(Success);
-      }
-      onFail = function(e) onComplete(Fail(e.message));
-      onCancel = function() onComplete(Cancelled);
-    }
-
-    NG.core.requestLogin(onSuccess, onPending, onFail, onCancel);
-  }
-
-  inline static public function cancelLogin():Void
-  {
-    NG.core.cancelLoginRequest();
-  }
-
-  static function onNGLogin():Void
-  {
-    trace('logged in! user:${NG.core.user.name}');
-    Save.instance.ngSessionId = NG.core.sessionId;
-    Save.instance.flush();
-    // Load medals then call onNGMedalFetch()
-    NG.core.requestMedals(onNGMedalFetch);
-
-    // Load Scoreboards hten call onNGBoardsFetch()
-    NG.core.requestScoreBoards(onNGBoardsFetch);
-
-    ngDataLoaded.dispatch();
-  }
-
-  static public function logout()
-  {
-    NG.core.logOut();
-
-    Save.instance.ngSessionId = null;
-    Save.instance.flush();
-  }
-
-  // --- MEDALS
-  static function onNGMedalFetch():Void
-  {
-    /*
-      // Reading medal info
-      for (id in NG.core.medals.keys())
-      {
-        var medal = NG.core.medals.get(id);
-        trace('loaded medal id:$id, name:${medal.name}, description:${medal.description}');
-      }
-
-      // Unlocking medals
-      var unlockingMedal = NG.core.medals.get(54352);// medal ids are listed in your NG project viewer
-      if (!unlockingMedal.unlocked)
-        unlockingMedal.sendUnlock();
-     */
-  }
-
-  // --- SCOREBOARDS
-  static function onNGBoardsFetch():Void
-  {
-    /*
-      // Reading medal info
-      for (id in NG.core.scoreBoards.keys())
-      {
-        var board = NG.core.scoreBoards.get(id);
-        trace('loaded scoreboard id:$id, name:${board.name}');
-      }
-     */
-    // var board = NG.core.scoreBoards.get(8004);// ID found in NG project view
-
-    // Posting a score thats OVER 9000!
-    // board.postScore(FlxG.random.int(0, 1000));
-
-    // --- To view the scores you first need to select the range of scores you want to see ---
-
-    // add an update listener so we know when we get the new scores
-    // board.onUpdate.add(onNGScoresFetch);
-    trace("shoulda got score by NOW!");
-    // board.requestScores(20);// get the best 10 scores ever logged
-    // more info on scores --- http://www.newgrounds.io/help/components/#scoreboard-getscores
-  }
-
-  static function onNGScoresFetch():Void
-  {
-    scoreboardsLoaded = true;
-
-    ngScoresLoaded.dispatch();
-    /*
-      for (score in NG.core.scoreBoards.get(8737).scores)
-      {
-        trace('score loaded user:${score.user.name}, score:${score.formatted_value}');
-
-      }
-     */
-
-    // var board = NG.core.scoreBoards.get(8004);// ID found in NG project view
-    // board.postScore(HighScore.score);
-
-    // NGUtil.scoreboardArray = NG.core.scoreBoards.get(8004).scores;
-  }
-  #end
-}

source/funkin/api/newgrounds/NGio.hx

@@ -1,298 +0,0 @@
-package funkin.api.newgrounds;
-
-#if newgrounds
-import flixel.util.FlxSignal;
-import io.newgrounds.NG;
-import io.newgrounds.NGLite;
-import io.newgrounds.objects.Error;
-import io.newgrounds.objects.Score;
-import lime.app.Application;
-#end
-
-/**
- * MADE BY GEOKURELI THE LEGENED GOD HERO MVP
- */
-class NGio
-{
-  #if newgrounds
-  /**
-   * True, if the saved sessionId was used in the initial login, and failed to connect.
-   * Used in MainMenuState to show a popup to establish a new connection
-   */
-  public static var savedSessionFailed(default, null):Bool = false;
-
-  public static var scoreboardsLoaded:Bool = false;
-  public static var isLoggedIn(get, never):Bool;
-
-  inline static function get_isLoggedIn()
-  {
-    return NG.core != null && NG.core.loggedIn;
-  }
-
-  public static var scoreboardArray:Array<Score> = [];
-
-  public static var ngDataLoaded(default, null):FlxSignal = new FlxSignal();
-  public static var ngScoresLoaded(default, null):FlxSignal = new FlxSignal();
-
-  public static var GAME_VER:String = "";
-
-  static public function checkVersion(callback:String->Void)
-  {
-    trace('checking NG.io version');
-    GAME_VER = "v" + Application.current.meta.get('version');
-
-    NG.core.calls.app.getCurrentVersion(GAME_VER).addDataHandler(function(response) {
-      GAME_VER = response.result.data.currentVersion;
-      trace('CURRENT NG VERSION: ' + GAME_VER);
-      callback(GAME_VER);
-    }).send();
-  }
-
-  static public function init()
-  {
-    var api = APIStuff.API;
-    if (api == null || api.length == 0)
-    {
-      trace("Missing Newgrounds API key, aborting connection");
-      return;
-    }
-    trace("connecting to newgrounds");
-
-    #if NG_FORCE_EXPIRED_SESSION
-    var sessionId:String = "fake_session_id";
-    function onSessionFail(error:Error)
-    {
-      trace("Forcing an expired saved session. " + "To disable, comment out NG_FORCE_EXPIRED_SESSION in Project.xml");
-      savedSessionFailed = true;
-    }
-    #else
-    var sessionId:String = NGLite.getSessionId();
-    if (sessionId != null) trace("found web session id");
-
-    #if (debug)
-    if (sessionId == null && APIStuff.SESSION != null)
-    {
-      trace("using debug session id");
-      sessionId = APIStuff.SESSION;
-    }
-    #end
-
-    var onSessionFail:Error->Void = null;
-    if (sessionId == null && Save.instance.ngSessionId != null)
-    {
-      trace("using stored session id");
-      sessionId = Save.instance.ngSessionId;
-      onSessionFail = function(error) savedSessionFailed = true;
-    }
-    #end
-
-    NG.create(api, sessionId, #if NG_DEBUG true #else false #end, onSessionFail);
-
-    #if NG_VERBOSE
-    NG.core.verbose = true;
-    #end
-    // Set the encryption cipher/format to RC4/Base64. AES128 and Hex are not implemented yet
-    NG.core.initEncryption(APIStuff.EncKey); // Found in you NG project view
-
-    if (NG.core.attemptingLogin)
-    {
-      /* a session_id was found in the loadervars, this means the user is playing on newgrounds.com
-       * and we should login shortly. lets wait for that to happen
-       */
-      trace("attempting login");
-      NG.core.onLogin.add(onNGLogin);
-    }
-    // GK: taking out auto login, adding a login button to the main menu
-    // else
-    // {
-    // 	/* They are NOT playing on newgrounds.com, no session id was found. We must start one manually, if we want to.
-    // 	 * Note: This will cause a new browser window to pop up where they can log in to newgrounds
-    // 	 */
-    // 	NG.core.requestLogin(onNGLogin);
-    // }
-  }
-
-  /**
-   * Attempts to log in to newgrounds by requesting a new session ID, only call if no session ID was found automatically
-   * @param popupLauncher The function to call to open the login url, must be inside
-   * a user input event or the popup blocker will block it.
-   * @param onComplete A callback with the result of the connection.
-   */
-  static public function login(?popupLauncher:(Void->Void)->Void, onComplete:ConnectionResult->Void)
-  {
-    trace("Logging in manually");
-    var onPending:Void->Void = null;
-    if (popupLauncher != null)
-    {
-      onPending = function() popupLauncher(NG.core.openPassportUrl);
-    }
-
-    var onSuccess:Void->Void = onNGLogin;
-    var onFail:Error->Void = null;
-    var onCancel:Void->Void = null;
-    if (onComplete != null)
-    {
-      onSuccess = function() {
-        onNGLogin();
-        onComplete(Success);
-      }
-      onFail = function(e) onComplete(Fail(e.message));
-      onCancel = function() onComplete(Cancelled);
-    }
-
-    NG.core.requestLogin(onSuccess, onPending, onFail, onCancel);
-  }
-
-  inline static public function cancelLogin():Void
-  {
-    NG.core.cancelLoginRequest();
-  }
-
-  static function onNGLogin():Void
-  {
-    trace('logged in! user:${NG.core.user.name}');
-    Save.instance.ngSessionId = NG.core.sessionId;
-    Save.instance.flush();
-    // Load medals then call onNGMedalFetch()
-    NG.core.requestMedals(onNGMedalFetch);
-
-    // Load Scoreboards hten call onNGBoardsFetch()
-    NG.core.requestScoreBoards(onNGBoardsFetch);
-
-    ngDataLoaded.dispatch();
-  }
-
-  static public function logout()
-  {
-    NG.core.logOut();
-
-    Save.instance.ngSessionId = null;
-    Save.instance.flush();
-  }
-
-  // --- MEDALS
-  static function onNGMedalFetch():Void
-  {
-    /*
-      // Reading medal info
-      for (id in NG.core.medals.keys())
-      {
-        var medal = NG.core.medals.get(id);
-        trace('loaded medal id:$id, name:${medal.name}, description:${medal.description}');
-      }
-
-      // Unlocking medals
-      var unlockingMedal = NG.core.medals.get(54352);// medal ids are listed in your NG project viewer
-      if (!unlockingMedal.unlocked)
-        unlockingMedal.sendUnlock();
-     */
-  }
-
-  // --- SCOREBOARDS
-  static function onNGBoardsFetch():Void
-  {
-    /*
-      // Reading medal info
-      for (id in NG.core.scoreBoards.keys())
-      {
-        var board = NG.core.scoreBoards.get(id);
-        trace('loaded scoreboard id:$id, name:${board.name}');
-      }
-     */
-    // var board = NG.core.scoreBoards.get(8004);// ID found in NG project view
-
-    // Posting a score thats OVER 9000!
-    // board.postScore(FlxG.random.int(0, 1000));
-
-    // --- To view the scores you first need to select the range of scores you want to see ---
-
-    // add an update listener so we know when we get the new scores
-    // board.onUpdate.add(onNGScoresFetch);
-    trace("shoulda got score by NOW!");
-    // board.requestScores(20);// get the best 10 scores ever logged
-    // more info on scores --- http://www.newgrounds.io/help/components/#scoreboard-getscores
-  }
-
-  static function onNGScoresFetch():Void
-  {
-    scoreboardsLoaded = true;
-
-    ngScoresLoaded.dispatch();
-    /*
-      for (score in NG.core.scoreBoards.get(8737).scores)
-      {
-        trace('score loaded user:${score.user.name}, score:${score.formatted_value}');
-
-      }
-     */
-
-    // var board = NG.core.scoreBoards.get(8004);// ID found in NG project view
-    // board.postScore(HighScore.score);
-
-    // NGio.scoreboardArray = NG.core.scoreBoards.get(8004).scores;
-  }
-  #end
-
-  static public function logEvent(event:String)
-  {
-    #if newgrounds
-    NG.core.calls.event.logEvent(event).send();
-    trace('should have logged: ' + event);
-    #else
-    #if FEATURE_DEBUG_FUNCTIONS
-    trace('event:$event - not logged, missing NG.io lib');
-    #end
-    #end
-  }
-
-  static public function unlockMedal(id:Int)
-  {
-    #if newgrounds
-    if (isLoggedIn)
-    {
-      var medal = NG.core.medals.get(id);
-      if (!medal.unlocked) medal.sendUnlock();
-    }
-    #else
-    #if FEATURE_DEBUG_FUNCTIONS
-    trace('medal:$id - not unlocked, missing NG.io lib');
-    #end
-    #end
-  }
-
-  static public function postScore(score:Int = 0, song:String)
-  {
-    #if newgrounds
-    if (isLoggedIn)
-    {
-      for (id in NG.core.scoreBoards.keys())
-      {
-        var board = NG.core.scoreBoards.get(id);
-
-        if (song == board.name)
-        {
-          board.postScore(score, "Uhh meow?");
-        }
-
-        // trace('loaded scoreboard id:$id, name:${board.name}');
-      }
-    }
-    #else
-    #if FEATURE_DEBUG_FUNCTIONS
-    trace('Song:$song, Score:$score - not posted, missing NG.io lib');
-    #end
-    #end
-  }
-}
-
-enum ConnectionResult
-{
-  /** Log in successful */
-  Success;
-
-  /** Could not login */
-  Fail(msg:String);
-
-  /** User cancelled the login */
-  Cancelled;
-}

source/funkin/api/newgrounds/NewgroundsClient.hx

@@ -0,0 +1,377 @@
+package funkin.api.newgrounds;
+
+import funkin.util.macro.EnvironmentConfigMacro;
+import funkin.save.Save;
+import funkin.api.newgrounds.Medals.Medal;
+#if FEATURE_NEWGROUNDS
+import io.newgrounds.Call.CallError;
+import io.newgrounds.NG;
+import io.newgrounds.NGLite;
+import io.newgrounds.NGLite.LoginOutcome;
+import io.newgrounds.NGLite.LoginFail;
+import io.newgrounds.objects.events.Outcome;
+import io.newgrounds.utils.MedalList;
+import io.newgrounds.utils.SaveSlotList;
+import io.newgrounds.utils.ScoreBoardList;
+import io.newgrounds.objects.User;
+
+@:nullSafety
+class NewgroundsClient
+{
+  static final APP_ID:Null<String> = EnvironmentConfigMacro.environmentConfig?.get("API_NG_APP_ID");
+  static final ENCRYPTION_KEY:Null<String> = EnvironmentConfigMacro.environmentConfig?.get("API_NG_ENC_KEY");
+
+  public static var instance(get, never):NewgroundsClient;
+
+  static var _instance:Null<NewgroundsClient> = null;
+
+  static function get_instance():NewgroundsClient
+  {
+    if (NewgroundsClient._instance == null) _instance = new NewgroundsClient();
+    if (NewgroundsClient._instance == null) throw "Could not initialize singleton NewgroundsClient!";
+    return NewgroundsClient._instance;
+  }
+
+  public var user(get, never):Null<User>;
+  public var medals(get, never):Null<MedalList>;
+  public var leaderboards(get, never):Null<ScoreBoardList>;
+  public var saveSlots(get, never):Null<SaveSlotList>;
+
+  private function new()
+  {
+    trace('[NEWGROUNDS] Initializing client...');
+
+    #if FEATURE_NEWGROUNDS_DEBUG
+    trace('[NEWGROUNDS] App ID: ${APP_ID}');
+    trace('[NEWGROUNDS] Encryption Key: ${ENCRYPTION_KEY}');
+    #end
+
+    if (!hasValidCredentials())
+    {
+      FlxG.log.warn("Tried to initialize Newgrounds client, but credentials are invalid!");
+      return;
+    }
+
+    @:nullSafety(Off)
+    {
+      NG.create(APP_ID, getSessionId(), #if FEATURE_NEWGROUNDS_DEBUG true #else false #end, onLoginResolved);
+
+      NG.core.setupEncryption(ENCRYPTION_KEY);
+    }
+  }
+
+  public function init()
+  {
+    if (NG.core == null) return;
+
+    trace('[NEWGROUNDS] Setting up connection...');
+
+    #if FEATURE_NEWGROUNDS_DEBUG
+    NG.core.verbose = true;
+    #end
+
+    NG.core.onLogin.add(onLoginSuccessful);
+
+    if (NG.core.attemptingLogin)
+    {
+      // Session ID was valid and we should be logged in soon.
+      trace('[NEWGROUNDS] Waiting for existing login!');
+    }
+    else
+    {
+      #if FEATURE_NEWGROUNDS_AUTOLOGIN
+      // Attempt an automatic login.
+      trace('[NEWGROUNDS] Attempting new login immediately!');
+      this.autoLogin();
+      #else
+      trace('[NEWGROUNDS] Not logged in, you have to login manually!');
+      #end
+    }
+  }
+
+  /**
+   * Attempt to log into Newgrounds and create a session ID.
+   * @param onSuccess An optional callback for when the login is successful.
+   * @param onError An optional callback for when the login fails.
+   */
+  public function login(?onSuccess:Void->Void, ?onError:Void->Void):Void
+  {
+    if (NG.core == null)
+    {
+      FlxG.log.warn("No Newgrounds client initialized! Are your credentials invalid?");
+      return;
+    }
+
+    if (onSuccess != null && onError != null)
+    {
+      NG.core.requestLogin(onLoginResolvedWithCallbacks.bind(_, onSuccess, onError));
+    }
+    else
+    {
+      NG.core.requestLogin(onLoginResolved);
+    }
+  }
+
+  public function autoLogin(?onSuccess:Void->Void, ?onError:Void->Void):Void
+  {
+    if (NG.core == null)
+    {
+      FlxG.log.warn("No Newgrounds client initialized! Are your credentials invalid?");
+      return;
+    }
+
+    var dummyPassport:String->Void = function(_) {
+      // just a dummy passport, so we don't create a popup
+      // otherwise `NG.core.requestLogin()` will automatically attempt to open a tab at the beginning of the game
+      // users should go to the Options Menu to login to NG
+      // we cancel the request, so we can call it later
+      NG.core.cancelLoginRequest();
+    };
+
+    if (onSuccess != null && onError != null)
+    {
+      NG.core.requestLogin(onLoginResolvedWithCallbacks.bind(_, onSuccess, onError), dummyPassport);
+    }
+    else
+    {
+      NG.core.requestLogin(onLoginResolved, dummyPassport);
+    }
+  }
+
+  /**
+   * Log out of Newgrounds and invalidate the current session.
+   * @param onSuccess An optional callback for when the logout is successful.
+   */
+  public function logout(?onSuccess:Void->Void, ?onError:Void->Void):Void
+  {
+    if (NG.core != null)
+    {
+      if (onSuccess != null && onError != null)
+      {
+        NG.core.logOut(onLogoutResolvedWithCallbacks.bind(_, onSuccess, onError));
+      }
+      else
+      {
+        NG.core.logOut(onLogoutResolved);
+      }
+    }
+
+    Save.instance.ngSessionId = null;
+  }
+
+  /**
+   * @return `true` if the user is logged in to Newgrounds.
+   */
+  public function isLoggedIn():Bool
+  {
+    #if FEATURE_NEWGROUNDS
+    return NG.core != null && NG.core.loggedIn;
+    #else
+    return false;
+    #end
+  }
+
+  /**
+   * @returns `false` if either the app ID or the encryption key is invalid.
+   */
+  static function hasValidCredentials():Bool
+  {
+    return !(APP_ID == null
+      || APP_ID == ""
+      || (APP_ID != null && APP_ID.contains(" "))
+      || ENCRYPTION_KEY == null
+      || ENCRYPTION_KEY == ""
+      || (ENCRYPTION_KEY != null && ENCRYPTION_KEY.contains(" ")));
+  }
+
+  function onLoginResolved(outcome:LoginOutcome):Void
+  {
+    switch (outcome)
+    {
+      case SUCCESS:
+        onLoginSuccessful();
+      case FAIL(result):
+        onLoginFailed(result);
+    }
+  }
+
+  function onLoginResolvedWithCallbacks(outcome:LoginOutcome, onSuccess:Void->Void, onError:Void->Void):Void
+  {
+    onLoginResolved(outcome);
+
+    switch (outcome)
+    {
+      case SUCCESS:
+        onSuccess();
+      case FAIL(result):
+        onError();
+    }
+  }
+
+  function onLogoutResolved(outcome:Outcome<CallError>):Void
+  {
+    switch (outcome)
+    {
+      case SUCCESS:
+        onLogoutSuccessful();
+      case FAIL(result):
+        onLogoutFailed(result);
+    }
+  }
+
+  function onLogoutResolvedWithCallbacks(outcome:Outcome<CallError>, onSuccess:Void->Void, onError:Void->Void):Void
+  {
+    onLogoutResolved(outcome);
+
+    switch (outcome)
+    {
+      case SUCCESS:
+        onSuccess();
+      case FAIL(result):
+        onError();
+    }
+  }
+
+  function onLoginSuccessful():Void
+  {
+    if (NG.core == null) return;
+
+    trace('[NEWGROUNDS] Login successful!');
+
+    // Persist the session ID.
+    Save.instance.ngSessionId = NG.core.sessionId;
+
+    trace('[NEWGROUNDS] Submitting medal request...');
+    NG.core.requestMedals(onFetchedMedals);
+
+    trace('[NEWGROUNDS] Submitting leaderboard request...');
+    NG.core.scoreBoards.loadList(onFetchedLeaderboards);
+    trace('[NEWGROUNDS] Submitting save slot request...');
+    NG.core.saveSlots.loadList(onFetchedSaveSlots);
+  }
+
+  function onLoginFailed(result:LoginFail):Void
+  {
+    switch (result)
+    {
+      case CANCELLED(type):
+        switch (type)
+        {
+          case PASSPORT:
+            trace('[NEWGROUNDS] Login cancelled by passport website.');
+          case MANUAL:
+            trace('[NEWGROUNDS] Login cancelled by application.');
+          default:
+            trace('[NEWGROUNDS] Login cancelled by unknown source.');
+        }
+      case ERROR(error):
+        switch (error)
+        {
+          case HTTP(error):
+            trace('[NEWGROUNDS] Login failed due to HTTP error: ${error}');
+          case RESPONSE(error):
+            trace('[NEWGROUNDS] Login failed due to response error: ${error.message} (${error.code})');
+          case RESULT(error):
+            trace('[NEWGROUNDS] Login failed due to result error: ${error.message} (${error.code})');
+          default:
+            trace('[NEWGROUNDS] Login failed due to unknown error: ${error}');
+        }
+      default:
+        trace('[NEWGROUNDS] Login failed due to unknown reason.');
+    }
+  }
+
+  function onLogoutSuccessful():Void
+  {
+    trace('[NEWGROUNDS] Logout successful!');
+  }
+
+  function onLogoutFailed(result:CallError):Void
+  {
+    switch (result)
+    {
+      case HTTP(error):
+        trace('[NEWGROUNDS] Logout failed due to HTTP error: ${error}');
+      case RESPONSE(error):
+        trace('[NEWGROUNDS] Logout failed due to response error: ${error.message} (${error.code})');
+      case RESULT(error):
+        trace('[NEWGROUNDS] Logout failed due to result error: ${error.message} (${error.code})');
+      default:
+        trace('[NEWGROUNDS] Logout failed due to unknown error: ${result}');
+    }
+  }
+
+  function onFetchedMedals(outcome:Outcome<CallError>):Void
+  {
+    trace('[NEWGROUNDS] Fetched medals!');
+  }
+
+  function onFetchedLeaderboards(outcome:Outcome<CallError>):Void
+  {
+    trace('[NEWGROUNDS] Fetched leaderboards!');
+
+    // trace(funkin.api.newgrounds.Leaderboards.listLeaderboardData());
+  }
+
+  function onFetchedSaveSlots(outcome:Outcome<CallError>):Void
+  {
+    trace('[NEWGROUNDS] Fetched save slots!');
+
+    NGSaveSlot.instance.checkSlot();
+  }
+
+  function get_user():Null<User>
+  {
+    if (NG.core == null || !this.isLoggedIn()) return null;
+    return NG.core.user;
+  }
+
+  function get_medals():Null<MedalList>
+  {
+    if (NG.core == null || !this.isLoggedIn()) return null;
+    return NG.core.medals;
+  }
+
+  function get_leaderboards():Null<ScoreBoardList>
+  {
+    if (NG.core == null || !this.isLoggedIn()) return null;
+    return NG.core.scoreBoards;
+  }
+
+  function get_saveSlots():Null<SaveSlotList>
+  {
+    if (NG.core == null || !this.isLoggedIn()) return null;
+    return NG.core.saveSlots;
+  }
+
+  static function getSessionId():Null<String>
+  {
+    #if js
+    // We can fetch the session ID from the URL.
+    var result:Null<String> = NGLite.getSessionId();
+    if (result != null) return result;
+    #end
+
+    // We have to fetch the session ID from the save file.
+    return Save.instance.ngSessionId;
+  }
+}
+
+/**
+ * Wrapper for `NewgroundsClient` that prevents submitting cheated data.
+ */
+class NewgroundsClientSandboxed
+{
+  public static var user(get, never):Null<User>;
+
+  static function get_user()
+  {
+    return NewgroundsClient.instance.user;
+  }
+
+  public static function isLoggedIn()
+  {
+    return NewgroundsClient.instance.isLoggedIn();
+  }
+}
+#end

source/funkin/api/newgrounds/NgPrompt.hx

@@ -1,101 +0,0 @@
-package funkin.api.newgrounds;
-
-#if newgrounds
-import funkin.NGio;
-import funkin.ui.Prompt;
-
-class NgPrompt extends Prompt
-{
-  public function new(text:String, style:ButtonStyle = Yes_No)
-  {
-    super(text, style);
-  }
-
-  static public function showLogin()
-  {
-    return showLoginPrompt(true);
-  }
-
-  static public function showSavedSessionFailed()
-  {
-    return showLoginPrompt(false);
-  }
-
-  static function showLoginPrompt(fromUi:Bool)
-  {
-    var prompt = new NgPrompt("Talking to server...", None);
-    prompt.openCallback = NGUtil.login.bind(function popupLauncher(openPassportUrl)
-    {
-      var choiceMsg = fromUi ? #if web "Log in to Newgrounds?" #else null #end // User-input needed to allow popups
-        : "Your session has expired.\n Please login again.";
-
-      if (choiceMsg != null)
-      {
-        prompt.setText(choiceMsg);
-        prompt.setButtons(Yes_No);
-        #if web
-        prompt.buttons.getItem("yes").fireInstantly = true;
-        #end
-        prompt.onYes = function() {
-          prompt.setText("Connecting..." #if web + "\n(check your popup blocker)" #end);
-          prompt.setButtons(None);
-          openPassportUrl();
-        };
-        prompt.onNo = function() {
-          prompt.close();
-          prompt = null;
-          NGio.cancelLogin();
-        };
-      }
-      else
-      {
-        prompt.setText("Connecting...");
-        openPassportUrl();
-      }
-    }, function onLoginComplete(result:ConnectionResult)
-    {
-      switch (result)
-      {
-        case Success:
-          {
-            prompt.setText("Login Successful");
-            prompt.setButtons(Ok);
-            prompt.onYes = prompt.close;
-          }
-        case Fail(msg):
-          {
-            trace("Login Error:" + msg);
-            prompt.setText("Login failed");
-            prompt.setButtons(Ok);
-            prompt.onYes = prompt.close;
-          }
-        case Cancelled:
-          {
-            if (prompt != null)
-            {
-              prompt.setText("Login cancelled by user");
-              prompt.setButtons(Ok);
-              prompt.onYes = prompt.close;
-            }
-            else
-              trace("Login cancelled via prompt");
-          }
-      }
-    });
-
-    return prompt;
-  }
-
-  static public function showLogout()
-  {
-    var user = io.newgrounds.NG.core.user.name;
-    var prompt = new NgPrompt('Log out of $user?', Yes_No);
-    prompt.onYes = function() {
-      NGio.logout();
-      prompt.close();
-    };
-    prompt.onNo = prompt.close;
-    return prompt;
-  }
-}
-#end

source/funkin/api/newgrounds/README.md

@@ -1,9 +0,0 @@
-# funkin.api.newgrounds
-
-This package contains two main classes:
-- `NGUtil` contains utility functions for interacting with the Newgrounds API.
-  - This includes any functions which scripts should be able to use,
-		such as retrieving achievement status.
-- `NGUnsafe` contains sensitive utility functions for interacting with the Newgrounds API.
-	- This includes any functions which scripts should not be able to use,
-		such as writing high scores or posting achievements.

source/funkin/api/newgrounds/Referral.hx

@@ -0,0 +1,55 @@
+package funkin.api.newgrounds;
+
+#if FEATURE_NEWGROUNDS
+import io.newgrounds.NG;
+#end
+import funkin.api.newgrounds.NewgroundsClient;
+import funkin.util.WindowUtil;
+
+/**
+ * Handles referrals to links retrieved from the Newgrounds API.
+ */
+class Referral
+{
+  /**
+   * Opens the referral page with the given name.
+   * @param referralName The name of the referral.
+   * @param fallbackUrl The URL to open if the referral fails or is not available.
+   */
+  static function doReferral(referralName:String, fallbackUrl:String):Void
+  {
+    #if FEATURE_NEWGROUNDS
+    if (NewgroundsClient.instance.isLoggedIn())
+    {
+      NG.core?.calls.loader.loadReferral(false)
+        .addComponentParameter("referral_name", referralName)
+        .addResponseHandler(response -> {
+          trace(response);
+          if (response.success)
+          {
+            WindowUtil.openURL(response.result.data.url);
+          }
+          else
+          {
+            WindowUtil.openURL(fallbackUrl);
+          }
+        })
+        .send();
+    }
+    else
+    {
+      WindowUtil.openURL(fallbackUrl);
+    }
+    #else
+    WindowUtil.openURL(fallbackUrl);
+    #end
+  }
+
+  /**
+   * Opens the merch referral page.
+   */
+  public static function doMerchReferral():Void
+  {
+    doReferral("merch_link", Constants.URL_MERCH_FALLBACK);
+  }
+}

source/funkin/audio/FlxStreamSound.hx

@@ -1,9 +1,6 @@
 package funkin.audio;
 
 import flash.media.Sound;
-#if flash11
-import flash.utils.ByteArray;
-#end
 import flixel.sound.FlxSound;
 import flixel.system.FlxAssets.FlxSoundAsset;
 import openfl.Assets;
@@ -14,6 +11,7 @@ import openfl.utils.AssetType;
 /**
  * a FlxSound that just overrides loadEmbedded to allow for "streamed" sounds to load with better performance!
  */
+@:nullSafety
 class FlxStreamSound extends FlxSound
 {
   public function new()
@@ -21,7 +19,7 @@ class FlxStreamSound extends FlxSound
     super();
   }
 
-  override public function loadEmbedded(EmbeddedSound:FlxSoundAsset, Looped:Bool = false, AutoDestroy:Bool = false, ?OnComplete:Void->Void):FlxSound
+  override public function loadEmbedded(EmbeddedSound:Null<FlxSoundAsset>, Looped:Bool = false, AutoDestroy:Bool = false, ?OnComplete:Void->Void):FlxSound
   {
     if (EmbeddedSound == null) return this;
 

source/funkin/audio/FunkinSound.hx

@@ -13,14 +13,13 @@ import funkin.data.song.SongRegistry;
 import funkin.util.tools.ICloneable;
 import funkin.util.flixel.sound.FlxPartialSound;
 import funkin.Paths.PathsFunction;
-import openfl.Assets;
-import lime.app.Future;
 import lime.app.Promise;
+import lime.media.AudioSource;
+import openfl.events.Event;
+import openfl.media.Sound;
+import openfl.media.SoundChannel;
 import openfl.media.SoundMixer;
 
-#if (openfl >= "8.0.0")
-#end
-
 /**
  * A FlxSound which adds additional functionality:
  * - Delayed playback via negative song position.
@@ -43,9 +42,9 @@ class FunkinSound extends FlxSound implements ICloneable<FunkinSound>
     if (_onVolumeChanged == null)
     {
       _onVolumeChanged = new FlxTypedSignal<Float->Void>();
-      FlxG.sound.volumeHandler = function(volume:Float) {
+      FlxG.sound.onVolumeChange.add(function(volume:Float) {
         _onVolumeChanged.dispatch(volume);
-      }
+      });
     }
     return _onVolumeChanged;
   }
@@ -73,7 +72,7 @@ class FunkinSound extends FlxSound implements ICloneable<FunkinSound>
   override function set_volume(value:Float):Float
   {
     // Uncap the volume.
-    _volume = FlxMath.bound(value, 0.0, MAX_VOLUME);
+    _volume = value.clamp(0.0, MAX_VOLUME);
     updateTransform();
     return _volume;
   }
@@ -110,6 +109,11 @@ class FunkinSound extends FlxSound implements ICloneable<FunkinSound>
     return _waveformData;
   }
 
+  /**
+   * If true, the game will forcefully add this sound's channel to the list of playing sounds.
+   */
+  public var important:Bool = false;
+
   /**
    * Are we in a state where the song should play but time is negative?
    */
@@ -147,6 +151,14 @@ class FunkinSound extends FlxSound implements ICloneable<FunkinSound>
     else
     {
       super.update(elapsedSec);
+
+      @:privateAccess
+      {
+        if (important && _channel != null && !SoundMixer.__soundChannels.contains(_channel))
+        {
+          SoundMixer.__soundChannels.push(_channel);
+        }
+      }
     }
   }
 
@@ -433,13 +445,14 @@ class FunkinSound extends FlxSound implements ICloneable<FunkinSound>
    * @param persist         Whether to keep this `FunkinSound` between states, or destroy it.
    * @param onComplete      Called when the sound finished playing.
    * @param onLoad          Called when the sound finished loading.  Called immediately for succesfully loaded embedded sounds.
+   * @param important       If `true`, the sound channel will forcefully be added onto the channel array, even if full. Use sparingly!
    * @return A `FunkinSound` object, or `null` if the sound could not be loaded.
    */
   public static function load(embeddedSound:FlxSoundAsset, volume:Float = 1.0, looped:Bool = false, autoDestroy:Bool = false, autoPlay:Bool = false,
-      persist:Bool = false, ?onComplete:Void->Void, ?onLoad:Void->Void):Null<FunkinSound>
+      persist:Bool = false, ?onComplete:Void->Void, ?onLoad:Void->Void, important:Bool = false):Null<FunkinSound>
   {
     @:privateAccess
-    if (SoundMixer.__soundChannels.length >= SoundMixer.MAX_ACTIVE_CHANNELS)
+    if (SoundMixer.__soundChannels.length >= SoundMixer.MAX_ACTIVE_CHANNELS && !important)
     {
       FlxG.log.error('FunkinSound could not play sound, channels exhausted! Found ${SoundMixer.__soundChannels.length} active sound channels.');
       return null;
@@ -462,8 +475,9 @@ class FunkinSound extends FlxSound implements ICloneable<FunkinSound>
 
     if (autoPlay) sound.play();
     sound.volume = volume;
-    sound.group = FlxG.sound.defaultSoundGroup;
+    FlxG.sound.defaultSoundGroup.add(sound);
     sound.persist = persist;
+    sound.important = important;
 
     // Make sure to add the sound to the list.
     // If it's already in, it won't get re-added.
@@ -534,6 +548,42 @@ class FunkinSound extends FlxSound implements ICloneable<FunkinSound>
     }
     FlxTween.cancelTweensOf(this);
     this._label = 'unknown';
+    this._waveformData = null;
+  }
+
+  @:access(openfl.media.Sound)
+  @:access(openfl.media.SoundChannel)
+  @:access(openfl.media.SoundMixer)
+  override function startSound(startTime:Float)
+  {
+    if (!important)
+    {
+      super.startSound(startTime);
+      return;
+    }
+
+    _time = startTime;
+    _paused = false;
+
+    if (_sound == null) return;
+
+    // Create a channel manually if the sound is considered important.
+    var pan:Float = (SoundMixer.__soundTransform.pan + _transform.pan).clamp(-1, 1);
+    var volume:Float = (SoundMixer.__soundTransform.volume * _transform.volume).clamp(0, MAX_VOLUME);
+
+    var audioSource:AudioSource = new AudioSource(_sound.__buffer);
+    audioSource.offset = Std.int(startTime);
+    audioSource.gain = volume;
+
+    var position:lime.math.Vector4 = audioSource.position;
+    position.x = pan;
+    position.z = -1 * Math.sqrt(1 - Math.pow(pan, 2));
+    audioSource.position = position;
+
+    _channel = new SoundChannel(_sound, audioSource, _transform);
+    _channel.addEventListener(Event.SOUND_COMPLETE, stopped);
+    pitch = _pitch;
+    active = true;
   }
 
   /**
@@ -542,9 +592,9 @@ class FunkinSound extends FlxSound implements ICloneable<FunkinSound>
    * @param volume
    * @return A `FunkinSound` object, or `null` if the sound could not be loaded.
    */
-  public static function playOnce(key:String, volume:Float = 1.0, ?onComplete:Void->Void, ?onLoad:Void->Void):Null<FunkinSound>
+  public static function playOnce(key:String, volume:Float = 1.0, ?onComplete:Void->Void, ?onLoad:Void->Void, important:Bool = false):Null<FunkinSound>
   {
-    var result:Null<FunkinSound> = FunkinSound.load(key, volume, false, true, true, false, onComplete, onLoad);
+    var result:Null<FunkinSound> = FunkinSound.load(key, volume, false, true, true, false, onComplete, onLoad, important);
     return result;
   }
 

source/funkin/audio/SoundGroup.hx

@@ -1,13 +1,13 @@
 package funkin.audio;
 
 import flixel.group.FlxGroup.FlxTypedGroup;
-import funkin.audio.FunkinSound;
 import flixel.tweens.FlxTween;
 
 /**
  * A group of FunkinSounds that are all synced together.
  * Unlike FlxSoundGroup, you can also control their time and pitch.
  */
+@:nullSafety
 class SoundGroup extends FlxTypedGroup<FunkinSound>
 {
   public var time(get, set):Float;
@@ -37,6 +37,7 @@ class SoundGroup extends FlxTypedGroup<FunkinSound>
       return result;
     }
 
+    @:nullSafety(Off)
     for (sndFile in files)
     {
       var snd:FunkinSound = FunkinSound.load(Paths.voices(song, '$sndFile'));
@@ -71,7 +72,7 @@ class SoundGroup extends FlxTypedGroup<FunkinSound>
   /**
    * Add a sound to the group.
    */
-  public override function add(sound:FunkinSound):FunkinSound
+  public override function add(sound:FunkinSound):Null<FunkinSound>
   {
     var result:FunkinSound = super.add(sound);
 
@@ -135,6 +136,7 @@ class SoundGroup extends FlxTypedGroup<FunkinSound>
   /**
    * Fade in all the sounds in the group.
    */
+  @:nullSafety(Off)
   public function fadeIn(duration:Float, ?from:Float = 0.0, ?to:Float = 1.0, ?onComplete:FlxTween->Void):Void
   {
     forEachAlive(function(sound:FunkinSound) {
@@ -145,6 +147,7 @@ class SoundGroup extends FlxTypedGroup<FunkinSound>
   /**
    * Fade out all the sounds in the group.
    */
+  @:nullSafety(Off)
   public function fadeOut(duration:Float, ?to:Float = 0.0, ?onComplete:FlxTween->Void):Void
   {
     forEachAlive(function(sound:FunkinSound) {
@@ -239,7 +242,7 @@ class SoundGroup extends FlxTypedGroup<FunkinSound>
 
   function get_muted():Bool
   {
-    if (getFirstAlive() != null) return getFirstAlive().muted;
+    if (getFirstAlive() != null) return getFirstAlive()?.muted ?? false;
     else
       return false;
   }

source/funkin/audio/VoicesGroup.hx

@@ -3,10 +3,11 @@ package funkin.audio;
 import flixel.group.FlxGroup.FlxTypedGroup;
 import funkin.audio.waveform.WaveformData;
 
+@:nullSafety
 class VoicesGroup extends SoundGroup
 {
-  var playerVoices:FlxTypedGroup<FunkinSound>;
-  var opponentVoices:FlxTypedGroup<FunkinSound>;
+  var playerVoices:Null<FlxTypedGroup<FunkinSound>>;
+  var opponentVoices:Null<FlxTypedGroup<FunkinSound>>;
 
   /**
    * Control the volume of only the sounds in the player group.
@@ -41,12 +42,12 @@ class VoicesGroup extends SoundGroup
   public function addPlayerVoice(sound:FunkinSound):Void
   {
     super.add(sound);
-    playerVoices.add(sound);
+    playerVoices?.add(sound);
   }
 
   function set_playerVolume(volume:Float):Float
   {
-    playerVoices.forEachAlive(function(voice:FunkinSound) {
+    playerVoices?.forEachAlive(function(voice:FunkinSound) {
       voice.volume = volume;
     });
     return playerVolume = volume;
@@ -59,10 +60,10 @@ class VoicesGroup extends SoundGroup
       snd.time = time;
     });
 
-    playerVoices.forEachAlive(function(voice:FunkinSound) {
+    playerVoices?.forEachAlive(function(voice:FunkinSound) {
       voice.time -= playerVoicesOffset;
     });
-    opponentVoices.forEachAlive(function(voice:FunkinSound) {
+    opponentVoices?.forEachAlive(function(voice:FunkinSound) {
       voice.time -= opponentVoicesOffset;
     });
 
@@ -71,7 +72,7 @@ class VoicesGroup extends SoundGroup
 
   function set_playerVoicesOffset(offset:Float):Float
   {
-    playerVoices.forEachAlive(function(voice:FunkinSound) {
+    playerVoices?.forEachAlive(function(voice:FunkinSound) {
       voice.time += playerVoicesOffset;
       voice.time -= offset;
     });
@@ -80,7 +81,7 @@ class VoicesGroup extends SoundGroup
 
   function set_opponentVoicesOffset(offset:Float):Float
   {
-    opponentVoices.forEachAlive(function(voice:FunkinSound) {
+    opponentVoices?.forEachAlive(function(voice:FunkinSound) {
       voice.time += opponentVoicesOffset;
       voice.time -= offset;
     });
@@ -93,12 +94,12 @@ class VoicesGroup extends SoundGroup
   public function addOpponentVoice(sound:FunkinSound):Void
   {
     super.add(sound);
-    opponentVoices.add(sound);
+    opponentVoices?.add(sound);
   }
 
   function set_opponentVolume(volume:Float):Float
   {
-    opponentVoices.forEachAlive(function(voice:FunkinSound) {
+    opponentVoices?.forEachAlive(function(voice:FunkinSound) {
       voice.volume = volume;
     });
     return opponentVolume = volume;
@@ -106,26 +107,26 @@ class VoicesGroup extends SoundGroup
 
   public function getPlayerVoice(index:Int = 0):Null<FunkinSound>
   {
-    return playerVoices.members[index];
+    return playerVoices?.members[index];
   }
 
   public function getOpponentVoice(index:Int = 0):Null<FunkinSound>
   {
-    return opponentVoices.members[index];
+    return opponentVoices?.members[index];
   }
 
   public function getPlayerVoiceWaveform():Null<WaveformData>
   {
-    if (playerVoices.members.length == 0) return null;
+    if (playerVoices?.members.length == 0) return null;
 
-    return playerVoices.members[0].waveformData;
+    return playerVoices?.members[0].waveformData;
   }
 
   public function getOpponentVoiceWaveform():Null<WaveformData>
   {
-    if (opponentVoices.members.length == 0) return null;
+    if (opponentVoices?.members.length == 0) return null;
 
-    return opponentVoices.members[0].waveformData;
+    return opponentVoices?.members[0].waveformData;
   }
 
   /**
@@ -133,9 +134,9 @@ class VoicesGroup extends SoundGroup
    */
   public function getPlayerVoiceLength():Float
   {
-    if (playerVoices.members.length == 0) return 0.0;
+    if (playerVoices?.members.length == 0) return 0.0;
 
-    return playerVoices.members[0].length;
+    return playerVoices?.members[0]?.length ?? 0.0;
   }
 
   /**
@@ -143,15 +144,15 @@ class VoicesGroup extends SoundGroup
    */
   public function getOpponentVoiceLength():Float
   {
-    if (opponentVoices.members.length == 0) return 0.0;
+    if (opponentVoices?.members.length == 0) return 0.0;
 
-    return opponentVoices.members[0].length;
+    return opponentVoices?.members[0]?.length ?? 0.0;
   }
 
   public override function clear():Void
   {
-    playerVoices.clear();
-    opponentVoices.clear();
+    playerVoices?.clear();
+    opponentVoices?.clear();
     super.clear();
   }
 
@@ -159,13 +160,13 @@ class VoicesGroup extends SoundGroup
   {
     if (playerVoices != null)
     {
-      playerVoices.destroy();
+      playerVoices?.destroy();
       playerVoices = null;
     }
 
     if (opponentVoices != null)
     {
-      opponentVoices.destroy();
+      opponentVoices?.destroy();
       opponentVoices = null;
     }
 

source/funkin/audio/visualize/ABot.hx

@@ -3,6 +3,7 @@ package funkin.audio.visualize;
 import flixel.FlxSprite;
 import flixel.group.FlxSpriteGroup.FlxTypedSpriteGroup;
 
+@:nullSafety
 class ABot extends FlxTypedSpriteGroup<FlxSprite>
 {
   public function new()

source/funkin/audio/visualize/ABotVis.hx

@@ -1,63 +1,79 @@
 package funkin.audio.visualize;
 
+import funkin.graphics.FunkinSprite;
 import flixel.FlxSprite;
 import flixel.graphics.frames.FlxAtlasFrames;
 import flixel.group.FlxSpriteGroup.FlxTypedSpriteGroup;
 import flixel.sound.FlxSound;
 import funkin.vis.dsp.SpectralAnalyzer;
-import funkin.vis.audioclip.frontends.LimeAudioClip;
 
 using Lambda;
 
+@:nullSafety
 class ABotVis extends FlxTypedSpriteGroup<FlxSprite>
 {
   // public var vis:VisShit;
-  var analyzer:SpectralAnalyzer;
+  var analyzer:Null<SpectralAnalyzer> = null;
 
   var volumes:Array<Float> = [];
 
-  public var snd:FlxSound;
+  public var snd:Null<FlxSound> = null;
 
-  public function new(snd:FlxSound)
+  static final BAR_COUNT:Int = 7;
+
+  // TODO: Make the sprites easier to soft code.
+  public function new(snd:FlxSound, pixel:Bool)
   {
     super();
 
     this.snd = snd;
 
-    // vis = new VisShit(snd);
-    // vis.snd = snd;
+    var visCount = pixel ? (BAR_COUNT + 1) : (BAR_COUNT + 1);
+    var visScale = pixel ? 6 : 1;
 
-    var visFrms:FlxAtlasFrames = Paths.getSparrowAtlas('aBotViz');
+    var visFrms:FlxAtlasFrames = Paths.getSparrowAtlas(pixel ? 'characters/abotPixel/aBotVizPixel' : 'characters/abot/aBotViz');
 
     // these are the differences in X position, from left to right
-    var positionX:Array<Float> = [0, 59, 56, 66, 54, 52, 51];
-    var positionY:Array<Float> = [0, -8, -3.5, -0.4, 0.5, 4.7, 7];
+    var positionX:Array<Float> = pixel ? [0, 7 * 6, 8 * 6, 9 * 6, 10 * 6, 6 * 6, 7 * 6] : [0, 59, 56, 66, 54, 52, 51];
+    var positionY:Array<Float> = pixel ? [0, -2 * 6, -1 * 6, 0, 0, 1 * 6, 2 * 6] : [0, -8, -3.5, -0.4, 0.5, 4.7, 7];
 
-    for (lol in 1...8)
+    for (index in 1...visCount)
     {
       // pushes initial value
       volumes.push(0.0);
-      var sum = function(num:Float, total:Float) return total += num;
-      var posX:Float = positionX.slice(0, lol).fold(sum, 0);
-      var posY:Float = positionY.slice(0, lol).fold(sum, 0);
 
-      var viz:FlxSprite = new FlxSprite(posX, posY);
+      // Sum the offsets up to the current index
+      var sum = function(num:Float, total:Float) return total += num;
+      var posX:Float = positionX.slice(0, index).fold(sum, 0);
+      var posY:Float = positionY.slice(0, index).fold(sum, 0);
+
+      var viz:FunkinSprite = new FunkinSprite(posX, posY);
       viz.frames = visFrms;
+      viz.antialiasing = pixel ? false : true;
+      viz.scale.set(visScale, visScale);
       add(viz);
 
       var visStr = 'viz';
-      viz.animation.addByPrefix('VIZ', visStr + lol, 0);
-      viz.animation.play('VIZ', false, false, 6);
+      viz.animation.addByPrefix('VIZ', '$visStr${index}0', 0);
+      viz.animation.play('VIZ', false, false, 1);
     }
   }
 
-  public function initAnalyzer()
+  public function initAnalyzer():Void
   {
-    @:privateAccess
-    analyzer = new SpectralAnalyzer(snd._channel.__audioSource, 7, 0.1, 40);
+    if (snd == null) return;
 
-    #if desktop
-    // On desktop it uses FFT stuff that isn't as optimized as the direct browser stuff we use on HTML5
+    @:privateAccess
+    analyzer = new SpectralAnalyzer(snd._channel.__audioSource, BAR_COUNT, 0.1, 40);
+    // A-Bot tuning...
+    analyzer.minDb = -65;
+    analyzer.maxDb = -25;
+    analyzer.maxFreq = 22000;
+    // we use a very low minFreq since some songs use low low subbass like a boss
+    analyzer.minFreq = 10;
+
+    #if sys
+    // On native it uses FFT stuff that isn't as optimized as the direct browser stuff we use on HTML5
     // So we want to manually change it!
     analyzer.fftN = 256;
     #end
@@ -66,16 +82,17 @@ class ABotVis extends FlxTypedSpriteGroup<FlxSprite>
     // analyzer.fftN = 2048;
   }
 
+  public function dumpSound():Void
+  {
+    snd = null;
+    analyzer = null;
+  }
+
   var visTimer:Float = -1;
   var visTimeMax:Float = 1 / 30;
 
   override function update(elapsed:Float)
   {
-    // updateViz();
-
-    // updateFFT(elapsed);
-
-    //
     super.update(elapsed);
   }
 
@@ -86,8 +103,8 @@ class ABotVis extends FlxTypedSpriteGroup<FlxSprite>
 
   override function draw()
   {
-    if (analyzer != null) drawFFT();
     super.draw();
+    drawFFT();
   }
 
   /**
@@ -95,17 +112,17 @@ class ABotVis extends FlxTypedSpriteGroup<FlxSprite>
    */
   function drawFFT():Void
   {
-    var levels = analyzer.getLevels();
+    var levels = (analyzer != null) ? analyzer.getLevels() : getDefaultLevels();
 
     for (i in 0...min(group.members.length, levels.length))
     {
-      var animFrame:Int = Math.round(levels[i].value * 5);
+      var animFrame:Int = (FlxG.sound.volume == 0 || FlxG.sound.muted) ? 0 : Math.round(levels[i].value * 6);
 
-      #if desktop
-      // Web version scales with the Flixel volume level.
-      // This line brings platform parity but looks worse.
-      // animFrame = Math.round(animFrame * FlxG.sound.volume);
-      #end
+      // don't display if we're at 0 volume from the level
+      group.members[i].visible = animFrame > 0;
+
+      // decrement our animFrame, so we can get a value from 0-5 for animation frames
+      animFrame -= 1;
 
       animFrame = Math.floor(Math.min(5, animFrame));
       animFrame = Math.floor(Math.max(0, animFrame));
@@ -116,79 +133,19 @@ class ABotVis extends FlxTypedSpriteGroup<FlxSprite>
     }
   }
 
-  // function updateFFT(elapsed:Float)
-  // {
-  //   if (vis.snd != null)
-  //   {
-  //     vis.checkAndSetBuffer();
-  //     if (vis.setBuffer)
-  //     {
-  //       var remappedShit:Int = 0;
-  //       if (vis.snd.playing) remappedShit = Std.int(FlxMath.remapToRange(vis.snd.time, 0, vis.snd.length, 0, vis.numSamples));
-  //       else
-  //         remappedShit = Std.int(FlxMath.remapToRange(Conductor.instance.songPosition, 0, vis.snd.length, 0, vis.numSamples));
-  //       var fftSamples:Array<Float> = [];
-  //       var swagBucks = remappedShit;
-  //       for (i in remappedShit...remappedShit + (Std.int((44100 * (1 / 144)))))
-  //       {
-  //         var left = vis.audioData[swagBucks] / 32767;
-  //         var right = vis.audioData[swagBucks + 1] / 32767;
-  //         var balanced = (left + right) / 2;
-  //         swagBucks += 2;
-  //         fftSamples.push(balanced);
-  //       }
-  //       var freqShit = vis.funnyFFT(fftSamples);
-  //       for (i in 0...group.members.length)
-  //       {
-  //         var getSliceShit = function(s:Int) {
-  //           var powShit = FlxMath.remapToRange(s, 0, group.members.length, 0, MathUtil.logBase(10, freqShit[0].length));
-  //           return Math.round(Math.pow(10, powShit));
-  //         };
-  //         // var powShit:Float = getSliceShit(i);
-  //         var hzSliced:Int = getSliceShit(i);
-  //         var sliceLength:Int = Std.int(freqShit[0].length / group.members.length);
-  //         var volSlice = freqShit[0].slice(hzSliced, getSliceShit(i + 1));
-  //         var avgVel:Float = 0;
-  //         for (slice in volSlice)
-  //         {
-  //           avgVel += slice;
-  //         }
-  //         avgVel /= volSlice.length;
-  //         avgVel *= 10000000;
-  //         volumes[i] += avgVel - (elapsed * (volumes[i] * 50));
-  //         var animFrame:Int = Std.int(volumes[i]);
-  //         animFrame = Math.floor(Math.min(5, animFrame));
-  //         animFrame = Math.floor(Math.max(0, animFrame));
-  //         animFrame = Std.int(Math.abs(animFrame - 5)); // shitty dumbass flip, cuz dave got da shit backwards lol!
-  //         group.members[i].animation.curAnim.curFrame = animFrame;
-  //         if (FlxG.keys.justPressed.U)
-  //         {
-  //           trace(avgVel);
-  //           trace(group.members[i].animation.curAnim.curFrame);
-  //         }
-  //       }
-  //       // group.members[0].animation.curAnim.curFrame =
-  //     }
-  //   }
-  // }
-  // public function updateViz()
-  // {
-  //   if (vis.snd != null)
-  //   {
-  //     var remappedShit:Int = 0;
-  //     vis.checkAndSetBuffer();
-  //     if (vis.setBuffer)
-  //     {
-  //       // var startingSample:Int = Std.int(FlxMath.remapToRange)
-  //       if (vis.snd.playing) remappedShit = Std.int(FlxMath.remapToRange(vis.snd.time, 0, vis.snd.length, 0, vis.numSamples));
-  //       for (i in 0...group.members.length)
-  //       {
-  //         var sampleApprox:Int = Std.int(FlxMath.remapToRange(i, 0, group.members.length, remappedShit, remappedShit + 500));
-  //         var left = vis.audioData[sampleApprox] / 32767;
-  //         var animFrame:Int = Std.int(FlxMath.remapToRange(left, -1, 1, 0, 6));
-  //         group.members[i].animation.curAnim.curFrame = animFrame;
-  //       }
-  //     }
-  //   }
-  // }
+  /**
+   * Explicitly define the default levels to draw when the analyzer is not available.
+   * @return Array<Bar>
+   */
+  static function getDefaultLevels():Array<Bar>
+  {
+    var result:Array<Bar> = [];
+
+    for (i in 0...BAR_COUNT)
+    {
+      result.push({value: 0, peak: 0.0});
+    }
+
+    return result;
+  }
 }

source/funkin/audio/visualize/PolygonSpectogram.hx

@@ -4,7 +4,7 @@ import flixel.math.FlxMath;
 import flixel.math.FlxPoint;
 import flixel.sound.FlxSound;
 import flixel.util.FlxColor;
-import funkin.audio.visualize.VisShit;
+import funkin.audio.visualize.VisShit.CurAudioInfo;
 import funkin.graphics.rendering.MeshRender;
 import lime.utils.Int16Array;
 

source/funkin/audio/visualize/PolygonVisGroup.hx

@@ -3,11 +3,12 @@ package funkin.audio.visualize;
 import flixel.group.FlxGroup.FlxTypedGroup;
 import flixel.sound.FlxSound;
 
+@:nullSafety
 class PolygonVisGroup extends FlxTypedGroup<PolygonSpectogram>
 {
-  public var playerVis:PolygonSpectogram;
-  public var opponentVis:PolygonSpectogram;
-  public var instVis:PolygonSpectogram;
+  public var playerVis:Null<PolygonSpectogram>;
+  public var opponentVis:Null<PolygonSpectogram>;
+  public var instVis:Null<PolygonSpectogram>;
 
   public function new()
   {
@@ -99,8 +100,14 @@ class PolygonVisGroup extends FlxTypedGroup<PolygonSpectogram>
 
   public override function destroy():Void
   {
-    playerVis.destroy();
-    opponentVis.destroy();
+    if (playerVis != null)
+    {
+      playerVis.destroy();
+    }
+    if (opponentVis != null)
+    {
+      opponentVis.destroy();
+    }
     super.destroy();
   }
 }

source/funkin/audio/visualize/dsp/Complex.hx

@@ -4,6 +4,7 @@ package funkin.audio.visualize.dsp;
   Complex number representation.
 **/
 @:forward(real, imag) @:notNull @:pure
+@:nullSafety
 abstract Complex({
   final real:Float;
   final imag:Float;

source/funkin/audio/visualize/dsp/FFT.hx

@@ -8,6 +8,7 @@ using funkin.audio.visualize.dsp.Signal;
 /**
   Fast/Finite Fourier Transforms.
 **/
+@:nullSafety
 class FFT
 {
   /**

source/funkin/audio/visualize/dsp/OffsetArray.hx

@@ -6,6 +6,7 @@ package funkin.audio.visualize.dsp;
   Usages include 1-indexed sequences or zero-centered buffers with negative indexing.
 **/
 @:forward(array, offset)
+@:nullSafety
 abstract OffsetArray<T>({
   final array:Array<T>;
   final offset:Int;

source/funkin/audio/visualize/dsp/Signal.hx

@@ -5,12 +5,13 @@ using Lambda;
 /**
   Signal processing miscellaneous utilities.
 **/
+@:nullSafety
 class Signal
 {
   /**
     Returns a smoothed version of the input array using a moving average.
   **/
-  public static function smooth(y:Array<Float>, n:Int):Array<Float>
+  public static function smooth(y:Array<Float>, n:Int):Null<Array<Float>>
   {
     if (n <= 0)
     {

source/funkin/audio/waveform/WaveformData.hx

@@ -243,9 +243,10 @@ class WaveformDataChannel
   }
 
   /**
-   * Retrieve a given minimum point at an index.
+   * @param i Index
+   * @return minimum point at an index.
    */
-  public function minSample(i:Int)
+  public function minSample(i:Int):Int
   {
     var offset = (i * parent.channels + this.channelId) * 2;
     return inline parent.get(offset);

source/funkin/audio/waveform/WaveformDataParser.hx

@@ -1,7 +1,6 @@
 package funkin.audio.waveform;
 
-import funkin.util.TimerUtil;
-
+@:nullSafety
 class WaveformDataParser
 {
   static final INT16_MAX:Int = 32767;
@@ -10,7 +9,7 @@ class WaveformDataParser
   static final INT8_MAX:Int = 127;
   static final INT8_MIN:Int = -128;
 
-  public static function interpretFlxSound(sound:flixel.sound.FlxSound):Null<WaveformData>
+  public static function interpretFlxSound(sound:Null<flixel.sound.FlxSound>):Null<WaveformData>
   {
     if (sound == null) return null;
 
@@ -44,73 +43,58 @@ class WaveformDataParser
 
   public static function interpretAudioBuffer(soundBuffer:lime.media.AudioBuffer):Null<WaveformData>
   {
-    var sampleRate = soundBuffer.sampleRate;
     var channels = soundBuffer.channels;
     var bitsPerSample = soundBuffer.bitsPerSample;
     var samplesPerPoint:Int = 256; // I don't think we need to configure this.
-    var pointsPerSecond:Float = sampleRate / samplesPerPoint; // 172 samples per second for most songs is plenty precise while still being performant..
 
     // TODO: Make this work better on HTML5.
     var soundData:lime.utils.Int16Array = cast soundBuffer.data;
 
-    var soundDataRawLength:Int = soundData.length;
-    var soundDataSampleCount:Int = Std.int(Math.ceil(soundDataRawLength / channels / (bitsPerSample == 16 ? 2 : 1)));
+    var soundDataSampleCount:Int = Std.int(Math.ceil(soundData.length / channels / (bitsPerSample == 16 ? 2 : 1)));
     var outputPointCount:Int = Std.int(Math.ceil(soundDataSampleCount / samplesPerPoint));
 
-    // trace('Interpreting audio buffer:');
-    // trace('  sampleRate: ${sampleRate}');
-    // trace('  channels: ${channels}');
-    // trace('  bitsPerSample: ${bitsPerSample}');
-    // trace('  samplesPerPoint: ${samplesPerPoint}');
-    // trace('  pointsPerSecond: ${pointsPerSecond}');
-    // trace('  soundDataRawLength: ${soundDataRawLength}');
-    // trace('  soundDataSampleCount: ${soundDataSampleCount}');
-    // trace('  soundDataRawLength/4: ${soundDataRawLength / 4}');
-    // trace('  outputPointCount: ${outputPointCount}');
+    // Pre-allocate Vector with exact final size for better performance and memory efficiency
+    var outputDataLength:Int = outputPointCount * channels * 2;
+    var outputData = new haxe.ds.Vector<Int>(outputDataLength);
 
-    var minSampleValue:Int = bitsPerSample == 16 ? INT16_MIN : INT8_MIN;
-    var maxSampleValue:Int = bitsPerSample == 16 ? INT16_MAX : INT8_MAX;
-
-    var outputData:Array<Int> = [];
-
-    var perfStart:Float = TimerUtil.start();
+    // Reusable min/max tracking arrays to avoid allocation in the loop
+    var minValues = new haxe.ds.Vector<Int>(channels);
+    var maxValues = new haxe.ds.Vector<Int>(channels);
 
     for (pointIndex in 0...outputPointCount)
     {
-      // minChannel1, maxChannel1, minChannel2, maxChannel2, ...
-      var values:Array<Int> = [];
+      var rangeStart:Int = pointIndex * samplesPerPoint;
+      var rangeEnd:Int = Std.int(Math.min(rangeStart + samplesPerPoint, soundDataSampleCount));
 
+      // Reset min/max values for this range
       for (i in 0...channels)
       {
-        values.push(bitsPerSample == 16 ? INT16_MAX : INT8_MAX);
-        values.push(bitsPerSample == 16 ? INT16_MIN : INT8_MIN);
+        minValues[i] = bitsPerSample == 16 ? INT16_MAX : INT8_MAX;
+        maxValues[i] = bitsPerSample == 16 ? INT16_MIN : INT8_MIN;
       }
 
-      var rangeStart = pointIndex * samplesPerPoint;
-      var rangeEnd = rangeStart + samplesPerPoint;
-      if (rangeEnd > soundDataSampleCount) rangeEnd = soundDataSampleCount;
-
+      // Process all samples in this range
       for (sampleIndex in rangeStart...rangeEnd)
       {
         for (channelIndex in 0...channels)
         {
-          var sampleIndex:Int = sampleIndex * channels + channelIndex;
-          var sampleValue = soundData[sampleIndex];
+          var sampleValue:Int = soundData[sampleIndex * channels + channelIndex];
 
-          if (sampleValue < values[channelIndex * 2]) values[(channelIndex * 2)] = sampleValue;
-          if (sampleValue > values[channelIndex * 2 + 1]) values[(channelIndex * 2) + 1] = sampleValue;
+          if (sampleValue < minValues[channelIndex]) minValues[channelIndex] = sampleValue;
+          if (sampleValue > maxValues[channelIndex]) maxValues[channelIndex] = sampleValue;
         }
       }
 
-      // We now have the min and max values for the range.
-      for (value in values)
-        outputData.push(value);
+      // Write directly to final positions in output Vector
+      var baseIndex:Int = pointIndex * channels * 2;
+      for (channelIndex in 0...channels)
+      {
+        outputData[baseIndex + channelIndex * 2] = minValues[channelIndex];
+        outputData[baseIndex + channelIndex * 2 + 1] = maxValues[channelIndex];
+      }
     }
 
-    var outputDataLength:Int = Std.int(outputData.length / channels / 2);
-    var result = new WaveformData(null, channels, sampleRate, samplesPerPoint, bitsPerSample, outputPointCount, outputData);
-
-    trace('[WAVEFORM] Interpreted audio buffer in ${TimerUtil.seconds(perfStart)}.');
+    var result = new WaveformData(null, channels, soundBuffer.sampleRate, samplesPerPoint, bitsPerSample, outputPointCount, outputData.toArray());
 
     return result;
   }

source/funkin/data/BaseRegistry.hx

@@ -15,7 +15,9 @@ typedef EntryConstructorFunction = String->Void;
  * @param T The type to construct. Must implement `IRegistryEntry`.
  * @param J The type of the JSON data used when constructing.
  */
+@:nullSafety
 @:generic
+@:autoBuild(funkin.util.macro.DataRegistryMacro.buildRegistry())
 abstract class BaseRegistry<T:(IRegistryEntry<J> & Constructible<EntryConstructorFunction>), J>
 {
   /**
@@ -114,7 +116,7 @@ abstract class BaseRegistry<T:(IRegistryEntry<J> & Constructible<EntryConstructo
     {
       try
       {
-        var entry:T = createEntry(entryId);
+        var entry:Null<T> = createEntry(entryId);
         if (entry != null)
         {
           trace('  Loaded entry data: ${entry}');
@@ -164,7 +166,7 @@ abstract class BaseRegistry<T:(IRegistryEntry<J> & Constructible<EntryConstructo
    * @param id The ID of the entry.
    * @return The class name, or `null` if it does not exist.
    */
-  public function getScriptedEntryClassName(id:String):String
+  public function getScriptedEntryClassName(id:String):Null<String>
   {
     return scriptedEntryIds.get(id);
   }
@@ -189,6 +191,19 @@ abstract class BaseRegistry<T:(IRegistryEntry<J> & Constructible<EntryConstructo
     return entries.get(id);
   }
 
+  /**
+   * A list of all entries included in the base game.
+   * The actual function exists and is auto-generated on each registry at build time.
+   * @return Array<String>
+   */
+  // public function listBaseGameEntryIds():Array<String> {}
+
+  /**
+   * A list of all entries that are not included in the base game.
+   * @return Array<String>
+   */
+  // public function listModdedEntryIds():Array<String> {}
+
   public function toString():String
   {
     return 'Registry(' + registryId + ', ${countEntries()} entries)';
@@ -202,7 +217,7 @@ abstract class BaseRegistry<T:(IRegistryEntry<J> & Constructible<EntryConstructo
   public function fetchEntryVersion(id:String):Null<thx.semver.Version>
   {
     var entryStr:String = loadEntryFile(id).contents;
-    var entryVersion:thx.semver.Version = VersionUtil.getVersionFromJSON(entryStr);
+    var entryVersion:Null<thx.semver.Version> = VersionUtil.getVersionFromJSON(entryStr);
     return entryVersion;
   }
 

source/funkin/data/DataError.hx

@@ -4,6 +4,7 @@ import json2object.Position;
 import json2object.Position.Line;
 import json2object.Error;
 
+@:nullSafety
 class DataError
 {
   public static function printError(error:Error):Void

source/funkin/data/DataParse.hx

@@ -19,6 +19,7 @@ import thx.semver.VersionRule;
  *
  * Functions must be of the signature `(hxjsonast.Json, String) -> T`, where the String is the property name and `T` is the type of the property.
  */
+@:nullSafety
 class DataParse
 {
   /**
@@ -146,7 +147,6 @@ class DataParse
             throw 'Expected Backdrop property $name to be specify a valid "type", but it was "${backdropType}".';
         }
 
-        return null;
       default:
         throw 'Expected property $name to be an object, but it was ${json.value}.';
     }
@@ -310,6 +310,7 @@ class DataParse
         var length:Null<Float> = values[2] == null ? null : Tools.getValue(values[2]);
         var alt:Null<Bool> = values[3] == null ? null : Tools.getValue(values[3]);
 
+        if (time == null || data == null) throw 'Property $name note is missing time and/or data values.';
         return new LegacyNote(time, data, length, alt);
       // return null;
       default:

source/funkin/data/DataWrite.hx

@@ -12,6 +12,7 @@ import haxe.ds.Either;
  *
  * NOTE: Result must include quotation marks if the value is a string! json2object will not add them for you!
  */
+@:nullSafety
 class DataWrite
 {
   /**

source/funkin/data/DefaultRegistryImpl.hx

@@ -0,0 +1,9 @@
+package funkin.data;
+
+/**
+ * An interface which automatically implements essential fields for a class extending `BaseRegistry`.
+ *
+ * @see `funkin.data.BaseRegistry`
+ */
+@:autoBuild(funkin.util.macro.RegistryMacro.buildRegistry())
+interface DefaultRegistryImpl {}

source/funkin/data/IRegistryEntry.hx

@@ -5,6 +5,7 @@ package funkin.data;
  * A `String->Void` constructor is also mandatory, but enforced elsewhere.
  * @param T The JSON data type of the registry entry.
  */
+@:autoBuild(funkin.util.macro.RegistryMacro.buildEntry())
 interface IRegistryEntry<T>
 {
   public final id:String;

source/funkin/data/animation/AnimationData.hx

@@ -1,8 +1,9 @@
 package funkin.data.animation;
 
+@:nullSafety
 class AnimationDataUtil
 {
-  public static function toNamed(data:UnnamedAnimationData, ?name:String = ""):AnimationData
+  public static function toNamed(data:UnnamedAnimationData, name:String = ""):AnimationData
   {
     return {
       name: name,
@@ -17,6 +18,16 @@ class AnimationDataUtil
     };
   }
 
+  /**
+   * @param data
+   * @param name (adds index to name)
+   * @return Array<AnimationData>
+   */
+  public static function toNamedArray(data:Array<UnnamedAnimationData>, name:String = ""):Array<AnimationData>
+  {
+    return data.mapi(function(animItem, ind) return toNamed(animItem, '$name$ind'));
+  }
+
   public static function toUnnamed(data:AnimationData):UnnamedAnimationData
   {
     return {
@@ -30,6 +41,11 @@ class AnimationDataUtil
       frameIndices: data.frameIndices
     };
   }
+
+  public static function toUnnamedArray(data:Array<AnimationData>):Array<UnnamedAnimationData>
+  {
+    return data.map(toUnnamed);
+  }
 }
 
 /**

source/funkin/data/dialogue/conversation/ConversationRegistry.hx

@@ -2,8 +2,11 @@ package funkin.data.dialogue.conversation;
 
 import funkin.play.cutscene.dialogue.Conversation;
 import funkin.play.cutscene.dialogue.ScriptedConversation;
+import funkin.util.tools.ISingleton;
+import funkin.data.DefaultRegistryImpl;
 
-class ConversationRegistry extends BaseRegistry<Conversation, ConversationData>
+@:nullSafety
+class ConversationRegistry extends BaseRegistry<Conversation, ConversationData> implements ISingleton implements DefaultRegistryImpl
 {
   /**
    * The current version string for the dialogue box data format.
@@ -14,74 +17,8 @@ class ConversationRegistry extends BaseRegistry<Conversation, ConversationData>
 
   public static final CONVERSATION_DATA_VERSION_RULE:thx.semver.VersionRule = "1.0.x";
 
-  public static var instance(get, never):ConversationRegistry;
-  static var _instance:Null<ConversationRegistry> = null;
-
-  static function get_instance():ConversationRegistry
-  {
-    if (_instance == null) _instance = new ConversationRegistry();
-    return _instance;
-  }
-
   public function new()
   {
     super('CONVERSATION', 'dialogue/conversations', CONVERSATION_DATA_VERSION_RULE);
   }
-
-  /**
-   * Read, parse, and validate the JSON data and produce the corresponding data object.
-   */
-  public function parseEntryData(id:String):Null<ConversationData>
-  {
-    // JsonParser does not take type parameters,
-    // otherwise this function would be in BaseRegistry.
-    var parser = new json2object.JsonParser<ConversationData>();
-    parser.ignoreUnknownVariables = false;
-
-    switch (loadEntryFile(id))
-    {
-      case {fileName: fileName, contents: contents}:
-        parser.fromJson(contents, fileName);
-      default:
-        return null;
-    }
-
-    if (parser.errors.length > 0)
-    {
-      printErrors(parser.errors, id);
-      return null;
-    }
-    return parser.value;
-  }
-
-  /**
-   * Parse and validate the JSON data and produce the corresponding data object.
-   *
-   * NOTE: Must be implemented on the implementation class.
-   * @param contents The JSON as a string.
-   * @param fileName An optional file name for error reporting.
-   */
-  public function parseEntryDataRaw(contents:String, ?fileName:String):Null<ConversationData>
-  {
-    var parser = new json2object.JsonParser<ConversationData>();
-    parser.ignoreUnknownVariables = false;
-    parser.fromJson(contents, fileName);
-
-    if (parser.errors.length > 0)
-    {
-      printErrors(parser.errors, fileName);
-      return null;
-    }
-    return parser.value;
-  }
-
-  function createScriptedEntry(clsName:String):Conversation
-  {
-    return ScriptedConversation.init(clsName, "unknown");
-  }
-
-  function getScriptedClassNames():Array<String>
-  {
-    return ScriptedConversation.listScriptClasses();
-  }
 }

source/funkin/data/dialogue/dialoguebox/DialogueBoxRegistry.hx

@@ -3,8 +3,11 @@ package funkin.data.dialogue.dialoguebox;
 import funkin.play.cutscene.dialogue.DialogueBox;
 import funkin.data.dialogue.dialoguebox.DialogueBoxData;
 import funkin.play.cutscene.dialogue.ScriptedDialogueBox;
+import funkin.util.tools.ISingleton;
+import funkin.data.DefaultRegistryImpl;
 
-class DialogueBoxRegistry extends BaseRegistry<DialogueBox, DialogueBoxData>
+@:nullSafety
+class DialogueBoxRegistry extends BaseRegistry<DialogueBox, DialogueBoxData> implements ISingleton implements DefaultRegistryImpl
 {
   /**
    * The current version string for the dialogue box data format.
@@ -13,76 +16,10 @@ class DialogueBoxRegistry extends BaseRegistry<DialogueBox, DialogueBoxData>
    */
   public static final DIALOGUEBOX_DATA_VERSION:thx.semver.Version = "1.1.0";
 
-  public static final DIALOGUEBOX_DATA_VERSION_RULE:thx.semver.VersionRule = "1.1.x";
-
-  public static var instance(get, never):DialogueBoxRegistry;
-  static var _instance:Null<DialogueBoxRegistry> = null;
-
-  static function get_instance():DialogueBoxRegistry
-  {
-    if (_instance == null) _instance = new DialogueBoxRegistry();
-    return _instance;
-  }
+  public static final DIALOGUEBOX_DATA_VERSION_RULE:thx.semver.VersionRule = ">=1.0.0 <1.2.0";
 
   public function new()
   {
     super('DIALOGUEBOX', 'dialogue/boxes', DIALOGUEBOX_DATA_VERSION_RULE);
   }
-
-  /**
-   * Read, parse, and validate the JSON data and produce the corresponding data object.
-   */
-  public function parseEntryData(id:String):Null<DialogueBoxData>
-  {
-    // JsonParser does not take type parameters,
-    // otherwise this function would be in BaseRegistry.
-    var parser = new json2object.JsonParser<DialogueBoxData>();
-    parser.ignoreUnknownVariables = false;
-
-    switch (loadEntryFile(id))
-    {
-      case {fileName: fileName, contents: contents}:
-        parser.fromJson(contents, fileName);
-      default:
-        return null;
-    }
-
-    if (parser.errors.length > 0)
-    {
-      printErrors(parser.errors, id);
-      return null;
-    }
-    return parser.value;
-  }
-
-  /**
-   * Parse and validate the JSON data and produce the corresponding data object.
-   *
-   * NOTE: Must be implemented on the implementation class.
-   * @param contents The JSON as a string.
-   * @param fileName An optional file name for error reporting.
-   */
-  public function parseEntryDataRaw(contents:String, ?fileName:String):Null<DialogueBoxData>
-  {
-    var parser = new json2object.JsonParser<DialogueBoxData>();
-    parser.ignoreUnknownVariables = false;
-    parser.fromJson(contents, fileName);
-
-    if (parser.errors.length > 0)
-    {
-      printErrors(parser.errors, fileName);
-      return null;
-    }
-    return parser.value;
-  }
-
-  function createScriptedEntry(clsName:String):DialogueBox
-  {
-    return ScriptedDialogueBox.init(clsName, "unknown");
-  }
-
-  function getScriptedClassNames():Array<String>
-  {
-    return ScriptedDialogueBox.listScriptClasses();
-  }
 }

source/funkin/data/dialogue/speaker/SpeakerRegistry.hx

@@ -1,10 +1,12 @@
 package funkin.data.dialogue.speaker;
 
 import funkin.play.cutscene.dialogue.Speaker;
-import funkin.data.dialogue.speaker.SpeakerData;
 import funkin.play.cutscene.dialogue.ScriptedSpeaker;
+import funkin.util.tools.ISingleton;
+import funkin.data.DefaultRegistryImpl;
 
-class SpeakerRegistry extends BaseRegistry<Speaker, SpeakerData>
+@:nullSafety
+class SpeakerRegistry extends BaseRegistry<Speaker, SpeakerData> implements ISingleton implements DefaultRegistryImpl
 {
   /**
    * The current version string for the speaker data format.
@@ -15,74 +17,8 @@ class SpeakerRegistry extends BaseRegistry<Speaker, SpeakerData>
 
   public static final SPEAKER_DATA_VERSION_RULE:thx.semver.VersionRule = "1.0.x";
 
-  public static var instance(get, never):SpeakerRegistry;
-  static var _instance:Null<SpeakerRegistry> = null;
-
-  static function get_instance():SpeakerRegistry
-  {
-    if (_instance == null) _instance = new SpeakerRegistry();
-    return _instance;
-  }
-
   public function new()
   {
     super('SPEAKER', 'dialogue/speakers', SPEAKER_DATA_VERSION_RULE);
   }
-
-  /**
-   * Read, parse, and validate the JSON data and produce the corresponding data object.
-   */
-  public function parseEntryData(id:String):Null<SpeakerData>
-  {
-    // JsonParser does not take type parameters,
-    // otherwise this function would be in BaseRegistry.
-    var parser = new json2object.JsonParser<SpeakerData>();
-    parser.ignoreUnknownVariables = false;
-
-    switch (loadEntryFile(id))
-    {
-      case {fileName: fileName, contents: contents}:
-        parser.fromJson(contents, fileName);
-      default:
-        return null;
-    }
-
-    if (parser.errors.length > 0)
-    {
-      printErrors(parser.errors, id);
-      return null;
-    }
-    return parser.value;
-  }
-
-  /**
-   * Parse and validate the JSON data and produce the corresponding data object.
-   *
-   * NOTE: Must be implemented on the implementation class.
-   * @param contents The JSON as a string.
-   * @param fileName An optional file name for error reporting.
-   */
-  public function parseEntryDataRaw(contents:String, ?fileName:String):Null<SpeakerData>
-  {
-    var parser = new json2object.JsonParser<SpeakerData>();
-    parser.ignoreUnknownVariables = false;
-    parser.fromJson(contents, fileName);
-
-    if (parser.errors.length > 0)
-    {
-      printErrors(parser.errors, fileName);
-      return null;
-    }
-    return parser.value;
-  }
-
-  function createScriptedEntry(clsName:String):Speaker
-  {
-    return ScriptedSpeaker.init(clsName, "unknown");
-  }
-
-  function getScriptedClassNames():Array<String>
-  {
-    return ScriptedSpeaker.listScriptClasses();
-  }
 }

source/funkin/data/event/SongEventRegistry.hx

@@ -1,7 +1,6 @@
 package funkin.data.event;
 
 import funkin.play.event.SongEvent;
-import funkin.data.event.SongEventSchema;
 import funkin.data.song.SongData.SongEventData;
 import funkin.util.macro.ClassMacro;
 import funkin.play.event.ScriptedSongEvent;
@@ -9,6 +8,7 @@ import funkin.play.event.ScriptedSongEvent;
 /**
  * This class statically handles the parsing of internal and scripted song event handlers.
  */
+@:nullSafety
 class SongEventRegistry
 {
   /**
@@ -88,14 +88,14 @@ class SongEventRegistry
     return eventCache.values();
   }
 
-  public static function getEvent(id:String):SongEvent
+  public static function getEvent(id:String):Null<SongEvent>
   {
     return eventCache.get(id);
   }
 
-  public static function getEventSchema(id:String):SongEventSchema
+  public static function getEventSchema(id:String):Null<SongEventSchema>
   {
-    var event:SongEvent = getEvent(id);
+    var event:Null<SongEvent> = getEvent(id);
     if (event == null) return null;
 
     return event.getEventSchema();
@@ -109,7 +109,7 @@ class SongEventRegistry
   public static function handleEvent(data:SongEventData):Void
   {
     var eventKind:String = data.eventKind;
-    var eventHandler:SongEvent = eventCache.get(eventKind);
+    var eventHandler:Null<SongEvent> = eventCache.get(eventKind);
 
     if (eventHandler != null)
     {

source/funkin/data/event/SongEventSchema.hx

@@ -1,11 +1,5 @@
 package funkin.data.event;
 
-import funkin.play.event.SongEvent;
-import funkin.data.event.SongEventSchema;
-import funkin.data.song.SongData.SongEventData;
-import funkin.util.macro.ClassMacro;
-import funkin.play.event.ScriptedSongEvent;
-
 @:forward(name, title, type, keys, min, max, step, units, defaultValue, iterator)
 abstract SongEventSchema(SongEventSchemaRaw)
 {

source/funkin/data/freeplay/album/AlbumData.hx

@@ -36,6 +36,13 @@ typedef AlbumData =
    */
   public var albumTitleAsset:String;
 
+  /**
+   * Offsets for the album title.
+   */
+  @:optional
+  @:default([0, 0])
+  public var albumTitleOffsets:Null<Array<Float>>;
+
   /**
    * An optional array of animations for the album title.
    */

source/funkin/data/freeplay/album/AlbumRegistry.hx

@@ -3,8 +3,11 @@ package funkin.data.freeplay.album;
 import funkin.ui.freeplay.Album;
 import funkin.data.freeplay.album.AlbumData;
 import funkin.ui.freeplay.ScriptedAlbum;
+import funkin.util.tools.ISingleton;
+import funkin.data.DefaultRegistryImpl;
 
-class AlbumRegistry extends BaseRegistry<Album, AlbumData>
+@:nullSafety
+class AlbumRegistry extends BaseRegistry<Album, AlbumData> implements ISingleton implements DefaultRegistryImpl
 {
   /**
    * The current version string for the album data format.
@@ -15,70 +18,8 @@ class AlbumRegistry extends BaseRegistry<Album, AlbumData>
 
   public static final ALBUM_DATA_VERSION_RULE:thx.semver.VersionRule = '1.0.x';
 
-  public static final instance:AlbumRegistry = new AlbumRegistry();
-
   public function new()
   {
     super('ALBUM', 'ui/freeplay/albums', ALBUM_DATA_VERSION_RULE);
   }
-
-  /**
-   * Read, parse, and validate the JSON data and produce the corresponding data object.
-   * @param id The ID of the entry to load.
-   * @return The parsed data object.
-   */
-  public function parseEntryData(id:String):Null<AlbumData>
-  {
-    // JsonParser does not take type parameters,
-    // otherwise this function would be in BaseRegistry.
-    var parser:json2object.JsonParser<AlbumData> = new json2object.JsonParser<AlbumData>();
-    parser.ignoreUnknownVariables = false;
-
-    switch (loadEntryFile(id))
-    {
-      case {fileName: fileName, contents: contents}:
-        parser.fromJson(contents, fileName);
-      default:
-        return null;
-    }
-
-    if (parser.errors.length > 0)
-    {
-      printErrors(parser.errors, id);
-      return null;
-    }
-    return parser.value;
-  }
-
-  /**
-   * Parse and validate the JSON data and produce the corresponding data object.
-   *
-   * NOTE: Must be implemented on the implementation class.
-   * @param contents The JSON as a string.
-   * @param fileName An optional file name for error reporting.
-   * @return The parsed data object.
-   */
-  public function parseEntryDataRaw(contents:String, ?fileName:String):Null<AlbumData>
-  {
-    var parser:json2object.JsonParser<AlbumData> = new json2object.JsonParser<AlbumData>();
-    parser.ignoreUnknownVariables = false;
-    parser.fromJson(contents, fileName);
-
-    if (parser.errors.length > 0)
-    {
-      printErrors(parser.errors, fileName);
-      return null;
-    }
-    return parser.value;
-  }
-
-  function createScriptedEntry(clsName:String):Album
-  {
-    return ScriptedAlbum.init(clsName, 'unknown');
-  }
-
-  function getScriptedClassNames():Array<String>
-  {
-    return ScriptedAlbum.listScriptClasses();
-  }
 }

source/funkin/data/freeplay/player/CHANGELOG.md

@@ -5,5 +5,10 @@ All notable changes to this project will be documented in this file.
 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.1]
+### Added
+- Added `stickerPack` to specify which sticker pack to use when transitioning into and out of song featuring this character.
+  - If the value isn't present, it will use a default sticker pack instead.
+
 ## [1.0.0]
 Initial release.

source/funkin/data/freeplay/player/PlayerData.hx

@@ -31,6 +31,15 @@ class PlayerData
   @:default(false)
   public var showUnownedChars:Bool = false;
 
+  /**
+   * The default sticker pack to use for songs featuring this playable character.
+   * Can be overridden by specific songs.
+   * @default `default`
+   */
+  @:optional
+  @:default(funkin.util.Constants.DEFAULT_STICKER_PACK)
+  public var stickerPack:String = Constants.DEFAULT_STICKER_PACK;
+
   /**
    * Which freeplay style to use for this character.
    */
@@ -325,12 +334,20 @@ typedef PlayerResultsAnimationData =
    */
   var renderType:String;
 
-  var assetPath:String;
+  @:optional
+  var assetPath:Null<String>;
+
+  @:optional
+  var scriptClass:Null<String>;
 
   @:optional
   @:default([0, 0])
   var offsets:Array<Float>;
 
+  @:optional
+  @:default("both")
+  var filter:String;
+
   @:optional
   @:default(500)
   var zIndex:Int;
@@ -347,6 +364,10 @@ typedef PlayerResultsAnimationData =
   @:default('')
   var startFrameLabel:Null<String>;
 
+  @:optional
+  @:default('')
+  var sound:Null<String>;
+
   @:optional
   @:default(true)
   var looped:Bool;