From 943c38767bf7e007ec51864aa0d0f3315f8b9e2d Mon Sep 17 00:00:00 2001 From: Abnormal <86753001+AbnormalPoof@users.noreply.github.com> Date: Tue, 11 Feb 2025 23:07:21 -0600 Subject: [PATCH 01/34] Contributor's guide Co-authored-by: Hundrec Co-authored-by: Abnormal <86753001+AbnormalPoof@users.noreply.github.com> --- docs/CONTRIBUTING.md | 244 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 244 insertions(+) create mode 100644 docs/CONTRIBUTING.md diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md new file mode 100644 index 000000000..b25cbb190 --- /dev/null +++ b/docs/CONTRIBUTING.md @@ -0,0 +1,244 @@ +# 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. + +# 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.5.3) +- 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^_ | +| 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 | +| Adjusted Difficulty Ratings | https://github.com/FunkinCrew/Funkin/issues/2781#issuecomment-2172053144 | +| Countdown after Unpausing | https://github.com/FunkinCrew/Funkin/issues/2721#issuecomment-2159330106 | +| 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. + +**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! + +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. + +## 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 look like a 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). + +Here are some guidelines for writing comments in your code: +- Leave comments only when you believe a piece of code warrants explanation. +- 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 Comments +#### DO NOT: +```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 whole 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(); + } +``` + +#### DO: +```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(); + } +``` + +## 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. + +# Closing +Thank you for reading the Contributing Guide. +We look forward to seeing your contributions to the game! From c6ef9b17a2288f0af82841c299e7aeb6247e0f4a Mon Sep 17 00:00:00 2001 From: Hundrec Date: Fri, 7 Feb 2025 22:52:07 -0700 Subject: [PATCH 02/34] Add more console outputs to Troubleshooting Guide Includes a line about warnings and deprecated functions, as well as a line about the hxcpp prompt. --- docs/TROUBLESHOOTING.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/docs/TROUBLESHOOTING.md b/docs/TROUBLESHOOTING.md index 54ba396c4..fd2bee464 100644 --- a/docs/TROUBLESHOOTING.md +++ b/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,7 +23,7 @@ - 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**. From 36fd05b1f95c4baab7be2464b2e2086978841d22 Mon Sep 17 00:00:00 2001 From: Hundrec Date: Thu, 13 Feb 2025 16:44:36 -0700 Subject: [PATCH 03/34] Link CONTRIBUTING.md in README --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9239d266c..6c12bfd08 100644 --- a/README.md +++ b/README.md @@ -11,11 +11,11 @@ This game was made with love to Newgrounds and its community. Extra love to Tom **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. +To learn how to install the necessary dependencies and compile the game from source, please follow our [Compiling Guide](/docs/COMPILING.md). # 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)! +Check out our [Contributing Guide](/docs/CONTRIBUTING.md) to learn how you can actively contribute to the development of Friday Night Funkin'! # Modding From e3eddc892d61048261402c96e7bdb1b0ec292960 Mon Sep 17 00:00:00 2001 From: Hundrec Date: Thu, 13 Feb 2025 16:50:11 -0700 Subject: [PATCH 04/34] Contributing Guide in Minor Bug Template --- .github/ISSUE_TEMPLATE/bug.yml | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index 5210f50bf..24c822805 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -3,14 +3,18 @@ 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](/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 read the pinned [Issues Guide](https://github.com/FunkinCrew/Funkin/issues/4050) + - label: I have read the [Contributing Guide](/docs/CONTRIBUTING.md) - label: I have checked the Issues/Discussions pages to see if my issue has already been reported - - label: I have properly named my issue + - label: I have properly titled my issue - type: dropdown attributes: From dd215687d4a084b4c7e87da07ecfbcace0d17dd0 Mon Sep 17 00:00:00 2001 From: Hundrec Date: Thu, 13 Feb 2025 16:50:34 -0700 Subject: [PATCH 05/34] quote --- .github/ISSUE_TEMPLATE/bug.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index 24c822805..e49af3755 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -5,7 +5,7 @@ title: "Bug Report: " body: - type: markdown attributes: - value: "# PLEASE READ THE [CONTRIBUTING GUIDE](/docs/CONTRIBUTING.md) BEFORE OPENING ISSUES! + value: "# PLEASE READ THE [CONTRIBUTING GUIDE](/docs/CONTRIBUTING.md) BEFORE OPENING ISSUES!" - type: checkboxes attributes: From 7b9e375feabca2dabaf0a53a82786e05484da200 Mon Sep 17 00:00:00 2001 From: Hundrec Date: Thu, 13 Feb 2025 16:58:34 -0700 Subject: [PATCH 06/34] Fix Contributing link --- .github/ISSUE_TEMPLATE/bug.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index e49af3755..1399c316a 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -5,14 +5,14 @@ title: "Bug Report: " body: - type: markdown attributes: - value: "# PLEASE READ THE [CONTRIBUTING GUIDE](/docs/CONTRIBUTING.md) BEFORE OPENING ISSUES!" + 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 read the [Contributing Guide](/docs/CONTRIBUTING.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 From d11027fb08b96198f9bd0035f6c9fbc746956dc0 Mon Sep 17 00:00:00 2001 From: Hundrec Date: Thu, 13 Feb 2025 17:07:12 -0700 Subject: [PATCH 07/34] A lil spacing --- .github/ISSUE_TEMPLATE/bug.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index 1399c316a..0d9df9617 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -6,7 +6,6 @@ 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 @@ -49,6 +48,7 @@ body: placeholder: ex. 0.5.3 validations: required: true + - type: markdown attributes: From 0bc0ab4eec144addb1a343c08d59e031c65e6ab3 Mon Sep 17 00:00:00 2001 From: Hundrec Date: Thu, 13 Feb 2025 17:10:05 -0700 Subject: [PATCH 08/34] Revert spacing --- .github/ISSUE_TEMPLATE/bug.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index 0d9df9617..f6f5c3250 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -6,6 +6,7 @@ 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 @@ -48,7 +49,6 @@ body: placeholder: ex. 0.5.3 validations: required: true - - type: markdown attributes: From f8f533ad370e7d01187be8580f0f1cd0cf6b8b6d Mon Sep 17 00:00:00 2001 From: Hundrec Date: Thu, 13 Feb 2025 17:10:59 -0700 Subject: [PATCH 09/34] Charting Template --- .github/ISSUE_TEMPLATE/charting.yml | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/charting.yml b/.github/ISSUE_TEMPLATE/charting.yml index 3c1e689ce..e86b73c12 100644 --- a/.github/ISSUE_TEMPLATE/charting.yml +++ b/.github/ISSUE_TEMPLATE/charting.yml @@ -3,14 +3,18 @@ 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 read the pinned [Issues Guide](https://github.com/FunkinCrew/Funkin/issues/4050) + - 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 named my issue + - label: I have properly titled my issue - type: dropdown attributes: From a9d0c1cb88c9fa356160df3faa7f014017355360 Mon Sep 17 00:00:00 2001 From: Hundrec Date: Thu, 13 Feb 2025 17:13:46 -0700 Subject: [PATCH 10/34] Compiling Help Template --- .github/ISSUE_TEMPLATE/compiling.yml | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/compiling.yml b/.github/ISSUE_TEMPLATE/compiling.yml index c9e364c3e..6dd9e4cf9 100644 --- a/.github/ISSUE_TEMPLATE/compiling.yml +++ b/.github/ISSUE_TEMPLATE/compiling.yml @@ -3,15 +3,19 @@ description: Report an issue with compiling the game. labels: ["type: compilation help", "status: pending triage"] 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 read the pinned [Issues Guide](https://github.com/FunkinCrew/Funkin/issues/4050) - 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 named my issue + - label: I have properly titled my issue - type: dropdown attributes: From bda5d90bbcc23fbaa639c1fd8c37563ee45cfeda Mon Sep 17 00:00:00 2001 From: Hundrec Date: Thu, 13 Feb 2025 17:14:29 -0700 Subject: [PATCH 11/34] Crash Template --- .github/ISSUE_TEMPLATE/crash.yml | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/crash.yml b/.github/ISSUE_TEMPLATE/crash.yml index 4f4928997..f315fcc2c 100644 --- a/.github/ISSUE_TEMPLATE/crash.yml +++ b/.github/ISSUE_TEMPLATE/crash.yml @@ -3,14 +3,18 @@ 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 read the pinned [Issues Guide](https://github.com/FunkinCrew/Funkin/issues/4050) + - 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 named my issue + - label: I have properly titled my issue - type: dropdown attributes: From ba78ded457f0bbfefe0109c9a013eaf499ec42ae Mon Sep 17 00:00:00 2001 From: Hundrec Date: Thu, 13 Feb 2025 17:15:56 -0700 Subject: [PATCH 12/34] Enhancement Template --- .github/ISSUE_TEMPLATE/enhancement.yml | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/enhancement.yml b/.github/ISSUE_TEMPLATE/enhancement.yml index 108279534..ac0e758c8 100644 --- a/.github/ISSUE_TEMPLATE/enhancement.yml +++ b/.github/ISSUE_TEMPLATE/enhancement.yml @@ -3,14 +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 read the pinned [Issues Guide](https://github.com/FunkinCrew/Funkin/issues/4050) + - 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 named my enhancement + - label: I have properly titled my enhancement - type: textarea attributes: From 8126cca29bdd74a4a36236585c80f833f35a2e2d Mon Sep 17 00:00:00 2001 From: Hundrec Date: Thu, 13 Feb 2025 17:17:49 -0700 Subject: [PATCH 13/34] PR Template --- .github/pull_request_template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 8e8a45e19..197a0e629 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,4 +1,4 @@ - + ## Does this PR close any issues? If so, link them below. ## Briefly describe the issue(s) fixed. From 07b6d8f86f5ec70964309b7d08beb29e12d53946 Mon Sep 17 00:00:00 2001 From: Hundrec Date: Thu, 13 Feb 2025 17:25:18 -0700 Subject: [PATCH 14/34] adjust link in PR Template --- .github/pull_request_template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 197a0e629..15e94daa5 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,4 +1,4 @@ - + ## Does this PR close any issues? If so, link them below. ## Briefly describe the issue(s) fixed. From 7e820f94974746d63252a1e41852a76ce19990f9 Mon Sep 17 00:00:00 2001 From: MidyGamy Date: Thu, 30 Jan 2025 23:43:52 -0400 Subject: [PATCH 15/34] Added missing debug hotkeys --- docs/Funkin' Debug Hotkeys.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/Funkin' Debug Hotkeys.md b/docs/Funkin' Debug Hotkeys.md index 416c89714..1202698ac 100644 --- a/docs/Funkin' Debug Hotkeys.md +++ b/docs/Funkin' Debug Hotkeys.md @@ -29,3 +29,9 @@ Most of this functionality is only available on debug builds of the game! ## **Main Menu** - `~`: ***DEBUG***: Opens a menu to access the Chart Editor and other work-in-progress editors. Rebindable in the options menu. - `CTRL-ALT-SHIFT-W`: ***ALL ACCESS***: Unlocks all songs in Freeplay. Only available on debug builds. +- `CTRL-ALT-SHIFT-M`: ***NO MORE ACCESS***: Locks back songs in Freeplay (those unloked by default aren't locked. 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***: Froce the character select screen to play Pico being unlocked. Only available on debug builds. +- `Ctrl-Alt-Shift-N`: ***Character Not seen***: Mark all characters as not seen and make BF glow again as there is a character to unlock. Only available on debug builds. +- `Ctrl-Alt-Shift-E`: ***Dump save data***: Self explainatory. Only available on debug builds. +- `Ctrl-Alt-Shift-L`: ***Force crash***: Force crash and create a log dump. Only available on debug builds. From f5efc1661164714554c29c663a6af93c073af7b8 Mon Sep 17 00:00:00 2001 From: MidyGamy Date: Fri, 31 Jan 2025 10:57:06 -0400 Subject: [PATCH 16/34] Rewording missing Funkin' Debug Hotkeys.md (thx Hundrec) --- docs/Funkin' Debug Hotkeys.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/Funkin' Debug Hotkeys.md b/docs/Funkin' Debug Hotkeys.md index 1202698ac..e45e7fe40 100644 --- a/docs/Funkin' Debug Hotkeys.md +++ b/docs/Funkin' Debug Hotkeys.md @@ -29,9 +29,9 @@ Most of this functionality is only available on debug builds of the game! ## **Main Menu** - `~`: ***DEBUG***: Opens a menu to access the Chart Editor and other work-in-progress editors. Rebindable in the options menu. - `CTRL-ALT-SHIFT-W`: ***ALL ACCESS***: Unlocks all songs in Freeplay. Only available on debug builds. -- `CTRL-ALT-SHIFT-M`: ***NO MORE ACCESS***: Locks back songs in Freeplay (those unloked by default aren't locked. 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***: Froce the character select screen to play Pico being unlocked. Only available on debug builds. -- `Ctrl-Alt-Shift-N`: ***Character Not seen***: Mark all characters as not seen and make BF glow again as there is a character to unlock. Only available on debug builds. -- `Ctrl-Alt-Shift-E`: ***Dump save data***: Self explainatory. Only available on debug builds. -- `Ctrl-Alt-Shift-L`: ***Force crash***: Force crash and create a log dump. 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***: Export a JSON file of your current save data. Only available on debug builds. +- `CTRL-ALT-SHIFT-L`: ***FORCE CRASH***: Immediately crash the game with a detailed crash log and a stack trace. Only available on debug builds. From 33f943a672fb1cb78b90ca3109c2e5a667dcd245 Mon Sep 17 00:00:00 2001 From: MidyGamy Date: Sat, 1 Feb 2025 12:35:31 -0400 Subject: [PATCH 17/34] More dump save info + force crash now accurate --- docs/Funkin' Debug Hotkeys.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/Funkin' Debug Hotkeys.md b/docs/Funkin' Debug Hotkeys.md index e45e7fe40..cf85c6c59 100644 --- a/docs/Funkin' Debug Hotkeys.md +++ b/docs/Funkin' Debug Hotkeys.md @@ -7,6 +7,8 @@ Most of this functionality is only available on debug builds of the game! - `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** @@ -33,5 +35,4 @@ Most of this functionality is only available on debug builds of the game! - `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***: Export a JSON file of your current save data. Only available on debug builds. -- `CTRL-ALT-SHIFT-L`: ***FORCE CRASH***: Immediately crash the game with a detailed crash log and a stack trace. 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. \ No newline at end of file From 894d0743c9baa3b608d9b39c10820d9b731cb350 Mon Sep 17 00:00:00 2001 From: Hundrec Date: Sun, 16 Feb 2025 18:55:39 -0700 Subject: [PATCH 18/34] Table of Contents for CONTRIBUTING.md --- docs/CONTRIBUTING.md | 53 +++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 52 insertions(+), 1 deletion(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index b25cbb190..2a7904a72 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -1,6 +1,50 @@ # 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. +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 +
+Contents + +[Part 1: Etiquette](https://github.com/FunkinCrew/Funkin/blob/main/docs/CONTRIBUTING.md#part-1-etiquette) + +
+Part 2: Issues + +* [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) + +
+ +
+ +Part 3: Pull Requests + +* [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) + +
+ +[Closing](https://github.com/FunkinCrew/Funkin/blob/main/docs/CONTRIBUTING.md#closing) + +
+ # Part 1: Etiquette - Be respectful to one another. We're here to help each other out! @@ -192,7 +236,9 @@ Here are some guidelines for writing comments in your code: ## 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] @@ -229,16 +275,21 @@ Make sure your changes are easy to understand and formatted consistently to maxi ## 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. # Closing Thank you for reading the Contributing Guide. + We look forward to seeing your contributions to the game! From bd3acc319cab1ec12b70a3bcdb21757f727e5cb9 Mon Sep 17 00:00:00 2001 From: Hundrec Date: Sat, 22 Feb 2025 13:38:08 -0700 Subject: [PATCH 19/34] Remove issue reopening action --- .github/workflows/label-issue.yml | 22 ---------------------- 1 file changed, 22 deletions(-) delete mode 100644 .github/workflows/label-issue.yml diff --git a/.github/workflows/label-issue.yml b/.github/workflows/label-issue.yml deleted file mode 100644 index 7430f161c..000000000 --- a/.github/workflows/label-issue.yml +++ /dev/null @@ -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. From 6c9c3e418a047df43e14a0f94a008e569ccd6dbc Mon Sep 17 00:00:00 2001 From: Hundrec Date: Sun, 9 Mar 2025 21:52:51 -0600 Subject: [PATCH 20/34] Add more rejected features to Contributing Guide --- docs/CONTRIBUTING.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 2a7904a72..13e2e3543 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -71,13 +71,21 @@ Here's a list of commonly suggested features and the reasons why they won't be a | 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 | | 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 | +| Fresh (Chill Mix) as Title Screen Music | https://github.com/FunkinCrew/Funkin/pull/4282#issuecomment-2709334718 | | Adjusted Difficulty Ratings | https://github.com/FunkinCrew/Funkin/issues/2781#issuecomment-2172053144 | -| Countdown after Unpausing | https://github.com/FunkinCrew/Funkin/issues/2721#issuecomment-2159330106 | +| Difficulty Ratings above 20 | https://github.com/FunkinCrew/Funkin/issues/3075#issuecomment-2368984497 | +| Ability to Reset a Song's Score | https://github.com/FunkinCrew/Funkin/issues/3916#issuecomment-2525408261 | +| 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 | +| 4:3 Aspect Ratio for Week 6 | https://github.com/FunkinCrew/Funkin/issues/3840#issuecomment-2689158438 | +| "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 | +| Lua Support | https://github.com/FunkinCrew/Funkin/issues/2643#issuecomment-2143718093 | + ## Issue Types Choose the issue template that best suits your needs! From df353a1ee8a6c79fd825dee7b99b2fe47b8d475d Mon Sep 17 00:00:00 2001 From: Hyper_ Date: Wed, 25 Sep 2024 22:16:21 -0300 Subject: [PATCH 21/34] docs: Some Linux troubleshooting --- docs/COMPILING.md | 4 +++- docs/TROUBLESHOOTING.md | 19 +++++++++++++++++++ 2 files changed, 22 insertions(+), 1 deletion(-) diff --git a/docs/COMPILING.md b/docs/COMPILING.md index 6df1232b1..f193b7830 100644 --- a/docs/COMPILING.md +++ b/docs/COMPILING.md @@ -13,7 +13,7 @@ - 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 +7. Run `haxelib run lime setup` to set up Lime 8. 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: @@ -21,6 +21,8 @@ - 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/) + - Note: Funkin's fork currently doesn't come with the necessary binaries so you'll have to rebuild Lime. See [Troubleshooting](TROUBLESHOOTING.md#lime-related-issues). + - One of Funkin's dependencies uses libVLC, which requires you to install some packages to be able to compile: `sudo apt install libvlc-dev libvlccore-dev libvlccore9` - HTML5: Compiles without any extra setup 9. If you are targeting for native, you may need to run `lime rebuild ` and `lime rebuild -debug` 10. `lime test ` to build and launch the game for your platform (for example, `lime test windows`) diff --git a/docs/TROUBLESHOOTING.md b/docs/TROUBLESHOOTING.md index fd2bee464..e85ef3138 100644 --- a/docs/TROUBLESHOOTING.md +++ b/docs/TROUBLESHOOTING.md @@ -29,3 +29,22 @@ - 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 `source/funkin/Conductor.hx:538: Done mapping time changes: [SongTimeChange(0ms,102bpm)]` line appears + - 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. This file is provided with Lime's Haxelib releases, but not via Git. Please copy it from Lime's latest Haxelib release into either .haxelib/lime/git/ndll/ or .haxelib/lime/git/ndll/, as appropriate for your system. Advanced users may run "lime rebuild cpp" instead.` + - Usually specific to Linux. Running the commands below should fix it. + ``` + cd .haxelib/lime/git + git submodule init + git submodule sync + git submodule update + cd ../../.. + # Note: The packages here might have different names 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 + ``` + - For other platforms you can download pre-built binaries from [Funkin's Lime](https://github.com/FunkinCrew/lime/tree/dev-funkin/ndll). From 9708e20dd4406d0b034c7d1e38ee25b3dd9bc30d Mon Sep 17 00:00:00 2001 From: Hyper_ <40342021+NotHyper-474@users.noreply.github.com> Date: Thu, 13 Feb 2025 21:25:23 -0300 Subject: [PATCH 22/34] Minor adjustments Some reformatting and shortening --- docs/TROUBLESHOOTING.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/TROUBLESHOOTING.md b/docs/TROUBLESHOOTING.md index e85ef3138..b17ee72b1 100644 --- a/docs/TROUBLESHOOTING.md +++ b/docs/TROUBLESHOOTING.md @@ -31,11 +31,11 @@ - 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 `source/funkin/Conductor.hx:538: Done mapping time changes: [SongTimeChange(0ms,102bpm)]` line appears - - 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. +- 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. This file is provided with Lime's Haxelib releases, but not via Git. Please copy it from Lime's latest Haxelib release into either .haxelib/lime/git/ndll/ or .haxelib/lime/git/ndll/, as appropriate for your system. Advanced users may run "lime rebuild cpp" instead.` +- `Uncaught exception - Could not find lime.ndll.` ... `Advanced users may run "lime rebuild cpp" instead.` - Usually specific to Linux. Running the commands below should fix it. ``` cd .haxelib/lime/git @@ -43,8 +43,8 @@ git submodule sync git submodule update cd ../../.. - # Note: The packages here might have different names depending on your distro + # 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 ``` - - For other platforms you can download pre-built binaries from [Funkin's Lime](https://github.com/FunkinCrew/lime/tree/dev-funkin/ndll). + For Windows or MacOS you can download pre-built binaries from [Funkin's Lime](https://github.com/FunkinCrew/lime/tree/dev-funkin/ndll). From 6e44484a1adaea0b8323a7c1c33343272fc892d8 Mon Sep 17 00:00:00 2001 From: Hundrec Date: Tue, 11 Mar 2025 08:15:31 -0600 Subject: [PATCH 23/34] Changelog overhaul for 0.5.3, 0.5.2, 0.5.1 Plus added line breaks to match Keep A Changelog's format --- CHANGELOG.md | 331 +++++++++++++++++++++++++++++++++++---------------- 1 file changed, 226 insertions(+), 105 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index ee9ff9e94..63b3b2461 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,80 +6,92 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [0.5.3] - 2024-10-18 This patch resolves a critical issue which could cause user's save data to become corrupted. It is recommended that users switch to this version immediately and avoid using version 0.5.2. + ### Fixed + - Fixed a critical issue in which the Stage Editor theme value could not be parsed by older versions of the game, resulting in all save data being destroyed. - Added a check which prevents save data from being loaded if it is corrupted rather than overriding it. - `optionsStageEditor.theme` in the save data converted from an Enum to a String to fix save data compatibility issues. - In the future, Enum values should not be used in order to prevent incompatibilities caused by introducing new types to the save data that older versions cannot parse. -- `optionsChartEditor.theme` in the save data converted from an Enum to a String to fix save data compatibility issues. - `optionsChartEditor.chartEditorLiveInputStyle` in the save data converted from an Enum to a String to fix save data compatibility issues. - Fixed an issue where some publicly distributed builds of the game were debug builds instead of release builds. ## [0.5.2] - 2024-10-11 + ### Added + - Added InverseDotsShader that emulates flash selections ([097dbf5](https://github.com/FunkinCrew/Funkin/commit/097dbf5bb4346d431d8ca9f0ec4bc5b5e6f4523f)) - by @ninjamuffin99 -- Added a new reworked Stage Editor ([27a0b44](https://github.com/FunkinCrew/Funkin/pull/3482/commits/27a0b4426f86f04362f97e16e2eff580c9402f34)) - by @JustKolosaki in [#3482](https://github.com/FunkinCrew/Funkin/pull/3482) -- Added the `color` attribute to stage prop JSON data to allow them to be tinted without code. ([27a0b44](https://github.com/FunkinCrew/Funkin/pull/3482/commits/27a0b4426f86f04362f97e16e2eff580c9402f34)) - by @JustKolosaki -- Added the `angle` attribute to stage prop JSON data to allow them to be rotated without code. ([27a0b44](https://github.com/FunkinCrew/Funkin/pull/3482/commits/27a0b4426f86f04362f97e16e2eff580c9402f34)) - by @JustKolosaki -- Added the `blend` attribute to the stage prop JSON data to allow blend modes to be applied without code. ([27a0b44](https://github.com/FunkinCrew/Funkin/pull/3482/commits/27a0b4426f86f04362f97e16e2eff580c9402f34)) - by @JustKolosaki +- Added a new reworked Stage Editor ([27a0b44](https://github.com/FunkinCrew/Funkin/pull/3482/commits/27a0b4426f86f04362f97e16e2eff580c9402f34)) - by @KoloInDaCrib in [#3482](https://github.com/FunkinCrew/Funkin/pull/3482) +- Added the `color` attribute to stage prop JSON data to allow them to be tinted without code ([27a0b44](https://github.com/FunkinCrew/Funkin/pull/3482/commits/27a0b4426f86f04362f97e16e2eff580c9402f34)) - by @KoloInDaCrib in [#3482](https://github.com/FunkinCrew/Funkin/pull/3482) +- Added the `angle` attribute to stage prop JSON data to allow them to be rotated without code ([27a0b44](https://github.com/FunkinCrew/Funkin/pull/3482/commits/27a0b4426f86f04362f97e16e2eff580c9402f34)) - by @KoloInDaCrib in [#3482](https://github.com/FunkinCrew/Funkin/pull/3482) +- Added the `blend` attribute to the stage prop JSON data to allow blend modes to be applied without code ([27a0b44](https://github.com/FunkinCrew/Funkin/pull/3482/commits/27a0b4426f86f04362f97e16e2eff580c9402f34)) - by @KoloInDaCrib in [#3482](https://github.com/FunkinCrew/Funkin/pull/3482) + ### Changed -- (docs) Delete Modding.md since we have a separate modding documentation ([a42240e](https://github.com/FunkinCrew/Funkin/commit/a42240e6a595d33034f2c887bf38a350d1fa0f15)) - by @AbnormalPoof in [#3651](https://github.com/FunkinCrew/Funkin/pull/3651) -- (docs) Create a git cliff template for easier changelog stuff ([91b4544](https://github.com/FunkinCrew/Funkin/commit/91b4544f7ebc51485e3e28c3d716ba6ee69ad885)) - by @ninjamuffin99 in [#3652](https://github.com/FunkinCrew/Funkin/pull/3652) -- (docs) Add additional `variation` input parameter to `Save.hasBeatenSong()` to allow usage of the function by inputting a variation id ([4fa9a0d](https://github.com/FunkinCrew/Funkin/commit/4fa9a0daaa67e0977460b147bd1f74a118e3e2a5)) - by @ninjamuffin99 -- (docs) Added modding docs link in readme ([4b54118](https://github.com/FunkinCrew/Funkin/commit/4b54118731e26118111e06558ae4853c577fe4bb)) - by @Cartridge-Man in [#3082](https://github.com/FunkinCrew/Funkin/pull/3082) -- (docs) Fix some misspellings and grammar in code documentation ([2175bea](https://github.com/FunkinCrew/Funkin/commit/2175beaa651e009332202985be4b7eb4ed36e5a4)) - by @Hundrec in [#3477](https://github.com/FunkinCrew/Funkin/pull/3477) -- (docs) Improvements to Github Issues templates ([399869c](https://github.com/FunkinCrew/Funkin/commit/399869cdccc9c5ac27cecfbcdc33c3d7eb4b348c)) - by @Hundrec in [#3458](https://github.com/FunkinCrew/Funkin/pull/3458) + +- (docs) Added link to modding docs in README ([4b54118](https://github.com/FunkinCrew/Funkin/commit/4b54118731e26118111e06558ae4853c577fe4bb)) - by @Cartridge-Man in [#3082](https://github.com/FunkinCrew/Funkin/pull/3082) +- (docs) Deleted Modding.md since we have a separate modding documentation ([a42240e](https://github.com/FunkinCrew/Funkin/commit/a42240e6a595d33034f2c887bf38a350d1fa0f15)) - by @AbnormalPoof in [#3651](https://github.com/FunkinCrew/Funkin/pull/3651) +- (docs) Fixed some misspellings and grammar in code documentation ([2175bea](https://github.com/FunkinCrew/Funkin/commit/2175beaa651e009332202985be4b7eb4ed36e5a4)) - by @Hundrec in [#3477](https://github.com/FunkinCrew/Funkin/pull/3477) +- (docs) Improvements to GitHub Issue templates ([399869c](https://github.com/FunkinCrew/Funkin/commit/399869cdccc9c5ac27cecfbcdc33c3d7eb4b348c)) - by @Hundrec in [#3458](https://github.com/FunkinCrew/Funkin/pull/3458) +- (docs) Created a git cliff template for easier changelog stuff ([91b4544](https://github.com/FunkinCrew/Funkin/commit/91b4544f7ebc51485e3e28c3d716ba6ee69ad885)) - by @ninjamuffin99 in [#3652](https://github.com/FunkinCrew/Funkin/pull/3652) +- (docs) Added additional `variation` input parameter to `Save.hasBeatenSong()` to allow usage of the function by inputting a variation id ([4fa9a0d](https://github.com/FunkinCrew/Funkin/commit/4fa9a0daaa67e0977460b147bd1f74a118e3e2a5)) - by @ninjamuffin99 in [#3506](https://github.com/FunkinCrew/Funkin/pull/3506) + ### Fixed -- Fix the user song offsets being applied incorrectly, causing stuttering or skipping ([410cfe9](https://github.com/FunkinCrew/Funkin/commit/410cfe972d6df9de4d4d128375cf8380c4f06d92)) - by @JustKolosaki in [#3546](https://github.com/FunkinCrew/Funkin/pull/3546) in [#3506](https://github.com/FunkinCrew/Funkin/pull/3506) -- Fixed issues with variation / difficulty loading for Freeplay Menu which caused some songs to disappear ([c0314c8](https://github.com/FunkinCrew/Funkin/commit/c0314c85ecd5116641aff3de8e9153f7fe48e79c)) - by @ninjamuffin99 -- Pico's songs now display properly on the Freeplay Menu ([1d2bd61](https://github.com/FunkinCrew/Funkin/commit/1d2bd61119e5f418df7f11d7ef2a0fdedee17d3d)) - by @ninjamuffin99 in [#3506](https://github.com/FunkinCrew/Funkin/pull/3506) -- Exiting the chart editor doesn't crash the game anymore ([f52472a](https://github.com/FunkinCrew/Funkin/commit/f52472a4767388b22cfbab0f5f7860f6e6762856)) - by @EliteMasterEric and @ianharrigan in [#3519](https://github.com/FunkinCrew/Funkin/pull/3519) -- Disable flickering when attempting to select FPS in the options menu ([b2647fe](https://github.com/FunkinCrew/Funkin/commit/b2647fe09f5281ce7074b26d47bc1524764168ee)) - by @lemz1 in [#3629](https://github.com/FunkinCrew/Funkin/pull/3629) -- Anti-alias / smooth the volume sound tray ([e66290c](https://github.com/FunkinCrew/Funkin/commit/e66290c55f7141402223644f06ec8a69edeee089)) - by @Kn1ghtNight in [#2853](https://github.com/FunkinCrew/Funkin/pull/2853) -- Don't restart the FreeplayState song preview when changing the difficulty within the same variation ([903b3fc](https://github.com/FunkinCrew/Funkin/commit/903b3fc59905a70802618a1cd67407722ea956ed)) - by @JustKolosaki in [#3587](https://github.com/FunkinCrew/Funkin/pull/3587) -- Character Select cursor moves properly at lower framerates ([ab5bda3](https://github.com/FunkinCrew/Funkin/commit/ab5bda3ee573a6e03595ec6941e6de38df851889)) - by @ninjamuffin99 in [#3507](https://github.com/FunkinCrew/Funkin/pull/3507) -- Stop allowing F1 to create more than one help dialog window in the Charting Editor ([777978f](https://github.com/FunkinCrew/Funkin/commit/777978f5a544e1b7c89b47dcc365f734eb6d0df1)) - by @amyspark-ng in [#3552](https://github.com/FunkinCrew/Funkin/pull/3552) -- Main menu music doesn't cut out when switching states anymore. ([711e0a6](https://github.com/FunkinCrew/Funkin/commit/711e0a6b7547eb04113e9318dab900f01ad576a5)) - by @EliteMasterEric in [#3530](https://github.com/FunkinCrew/Funkin/pull/3530) -- The dialog now shows up on the animation debugger view ([1fde59f](https://github.com/FunkinCrew/Funkin/commit/1fde59f999eac94eb10fc22094885de2f5310705)) - by @EliteMasterEric in [#3530](https://github.com/FunkinCrew/Funkin/pull/3530) -- Center preloader 'fnf' and 'dsp' text so it doesn't clip anymore ([165ad60](https://github.com/FunkinCrew/Funkin/commit/165ad6015539a295e9eefdaef291c312e9566b26)) - by @Burgerballs in [#3567](https://github.com/FunkinCrew/Funkin/pull/3567) -- `Song.getFirstValidVariation()` now properly takes into account multiple variations/difficulty input ([d2e2987](https://github.com/FunkinCrew/Funkin/commit/d2e29879fe2acc6febfe0f335f655b741d630c34)) - by @ninjamuffin99 in [#3506](https://github.com/FunkinCrew/Funkin/pull/3506) + +- Input offsets no longer cause songs to stutter or skip ([410cfe9](https://github.com/FunkinCrew/Funkin/commit/410cfe972d6df9de4d4d128375cf8380c4f06d92)) - by @KoloInDaCrib in [#3546](https://github.com/FunkinCrew/Funkin/pull/3546) +- Exiting the Input Offset menu no longer crashes the game ([39b1a42](https://github.com/FunkinCrew/Funkin/commit/39b1a42cfeafe2b7be8b66e2fe529e853d9ae197)) - by @lemz1 in [#3493](https://github.com/FunkinCrew/Funkin/pull/3493) +- Pico's songs now display properly in the Freeplay Menu ([1d2bd61](https://github.com/FunkinCrew/Funkin/commit/1d2bd61119e5f418df7f11d7ef2a0fdedee17d3d)) - by @ninjamuffin99 in [#3506](https://github.com/FunkinCrew/Funkin/pull/3506) +- Fixed issues with variation/difficulty loading for Freeplay Menu which caused some songs to disappear ([c0314c8](https://github.com/FunkinCrew/Funkin/commit/c0314c85ecd5116641aff3de8e9153f7fe48e79c)) - by @ninjamuffin99 in [#3506](https://github.com/FunkinCrew/Funkin/pull/3506) +- `Song.getFirstValidVariation()` now properly takes into account multiple variation/difficulty inputs ([d2e2987](https://github.com/FunkinCrew/Funkin/commit/d2e29879fe2acc6febfe0f335f655b741d630c34)) - by @ninjamuffin99 in [#3506](https://github.com/FunkinCrew/Funkin/pull/3506) +- Song previews no longer restart when changing difficulties within the same variation ([903b3fc](https://github.com/FunkinCrew/Funkin/commit/903b3fc59905a70802618a1cd67407722ea956ed)) - by @KoloInDaCrib in [#3587](https://github.com/FunkinCrew/Funkin/pull/3587) +- Main menu music no longer cuts out when switching states ([711e0a6](https://github.com/FunkinCrew/Funkin/commit/711e0a6b7547eb04113e9318dab900f01ad576a5)) - by @EliteMasterEric in [#3530](https://github.com/FunkinCrew/Funkin/pull/3530) +- Centered preloader 'fnf' and 'dsp' text so they don't clip anymore ([165ad60](https://github.com/FunkinCrew/Funkin/commit/165ad6015539a295e9eefdaef291c312e9566b26)) - by @Burgerballs in [#3567](https://github.com/FunkinCrew/Funkin/pull/3567) +- FPS setting in options menu no longer flickers when selected ([b2647fe](https://github.com/FunkinCrew/Funkin/commit/b2647fe09f5281ce7074b26d47bc1524764168ee)) - by @lemz1 in [#3629](https://github.com/FunkinCrew/Funkin/pull/3629) +- Volume sound tray is now anti-aliased/smoothed ([e66290c](https://github.com/FunkinCrew/Funkin/commit/e66290c55f7141402223644f06ec8a69edeee089)) - by @Kn1ghtNight in [#2853](https://github.com/FunkinCrew/Funkin/pull/2853) +- Fixed looping animations for modded StrumlineNote sprites ([bc546e8](https://github.com/FunkinCrew/Funkin/commit/bc546e86aa77ffc795b3f079de5f590289a9c583)) - by @DaWaterMalone in [#3577](https://github.com/FunkinCrew/Funkin/pull/3577) +- Stopped allowing inputs after selecting a character in Character Select ([dbf66ac](https://github.com/FunkinCrew/Funkin/commit/dbf66ac250137262866d75f7c1387645b35d88d0)) - by @ACrazyTown in [#3398](https://github.com/FunkinCrew/Funkin/pull/3398) +- Player and girlfriend no longer disappear or overlap themselves in Character Select ([9324359](https://github.com/FunkinCrew/Funkin/commit/9324359d2fce6a7097077d169a0efcd80e6fefa1)) - by @gamerbross in [#3457](https://github.com/FunkinCrew/Funkin/pull/3457) +- Player no longer enters twice after entering Character Select or when spamming buttons ([30a9887](https://github.com/FunkinCrew/Funkin/commit/30a98871367b494c85934cd3fcfa91eeb774a7d5)) - by @gamerbross in [#3457](https://github.com/FunkinCrew/Funkin/pull/3457) +- Wrong girlfriend no longer appears in Character Select ([9324359](https://github.com/FunkinCrew/Funkin/commit/9324359d2fce6a7097077d169a0efcd80e6fefa1)) - by @gamerbross in [#3457](https://github.com/FunkinCrew/Funkin/pull/3457) +- Cursor now updates properly when moving and selecting in Character Select ([9324359](https://github.com/FunkinCrew/Funkin/commit/9324359d2fce6a7097077d169a0efcd80e6fefa1)) - by @gamerbross in [#3457](https://github.com/FunkinCrew/Funkin/pull/3457) +- Cursor now moves properly at lower framerates in Character Select ([ab5bda3](https://github.com/FunkinCrew/Funkin/commit/ab5bda3ee573a6e03595ec6941e6de38df851889)) - by @ninjamuffin99 in [#3507](https://github.com/FunkinCrew/Funkin/pull/3507) +- Exiting the Chart Editor no longer crashes the game ([f52472a](https://github.com/FunkinCrew/Funkin/commit/f52472a4767388b22cfbab0f5f7860f6e6762856)) - by @EliteMasterEric and @ianharrigan in [#3519](https://github.com/FunkinCrew/Funkin/pull/3519) +- Properly format the millisecond counter in the Chart Editor playbar ([f1b6e6c](https://github.com/FunkinCrew/Funkin/commit/f1b6e6c4e42455e0c2900d738ebc24893f2479a0)) - by @afreetoplaynoob in [#3537](https://github.com/FunkinCrew/Funkin/pull/3537) +- Pressing F1 multiple times no longer creates more than one help window in the Chart Editor ([777978f](https://github.com/FunkinCrew/Funkin/commit/777978f5a544e1b7c89b47dcc365f734eb6d0df1)) - by @amyspark-ng in [#3552](https://github.com/FunkinCrew/Funkin/pull/3552) +- The dialog box now shows up in the Animation Editor ([1fde59f](https://github.com/FunkinCrew/Funkin/commit/1fde59f999eac94eb10fc22094885de2f5310705)) - by @EliteMasterEric in [#3530](https://github.com/FunkinCrew/Funkin/pull/3530) - (debug) No more fullscreening when typing "F" in the flixel debugger console ([29b6763](https://github.com/FunkinCrew/Funkin/commit/29b6763290df05d42039806f3d142740568c80f0)) - by @ninjamuffin99 -- Fix crash in LatencyState when exiting / cleaning up state data ([39b1a42](https://github.com/FunkinCrew/Funkin/commit/39b1a42cfeafe2b7be8b66e2fe529e853d9ae197)) - by @lemz1 in [#3493](https://github.com/FunkinCrew/Funkin/pull/3493) -- Add additional classes to Polymod blacklist for security ([b0b73c8](https://github.com/FunkinCrew/Funkin/commit/b0b73c83994f33118c6a69550da9ec8ec1c07adc)) - by @EliteMasterEric in [#3558](https://github.com/FunkinCrew/Funkin/pull/3558) -- Stop allowing inputs after selecting a character ([dbf66ac](https://github.com/FunkinCrew/Funkin/commit/dbf66ac250137262866d75f7c1387645b35d88d0)) - by @ACrazyTown in [#3398](https://github.com/FunkinCrew/Funkin/pull/3398) -- Fix conflict with modded StrumlineNote sprite looping animation ([bc546e8](https://github.com/FunkinCrew/Funkin/commit/bc546e86aa77ffc795b3f079de5f590289a9c583)) - by @DaWaterMalone in [#3577](https://github.com/FunkinCrew/Funkin/pull/3577) -- Properly format the millisecond counter in the chart editor playbar ([f1b6e6c](https://github.com/FunkinCrew/Funkin/commit/f1b6e6c4e42455e0c2900d738ebc24893f2479a0)) - by @afreetoplaynoob in [#3537](https://github.com/FunkinCrew/Funkin/pull/3537) -- Fixed an issue where the player and girlfriend would disappear or overlap themselves in Character Select ([community fix by @gamerbross](https://github.com/FunkinCrew/Funkin/pull/3457)) -- Fixed an issue where the game would show the wrong girlfriend in Character Select ([community fix by @gamerbross](https://github.com/FunkinCrew/Funkin/pull/3457)) -- Fixed an issue where the cursor wouldn't update properly in Character Select ([community fix by @gamerbross](https://github.com/FunkinCrew/Funkin/pull/3457)) -- Fixed an issue where the player would display double after entering character select or when spamming buttons ([community fix by @gamerbross](https://github.com/FunkinCrew/Funkin/pull/3457)) +- Added additional classes to Polymod blacklist for security ([b0b73c8](https://github.com/FunkinCrew/Funkin/commit/b0b73c83994f33118c6a69550da9ec8ec1c07adc)) - by @EliteMasterEric in [#3558](https://github.com/FunkinCrew/Funkin/pull/3558) ## New Contributors for 0.5.2 -* @JustKolosaki made their first contribution in [#3482](https://github.com/FunkinCrew/Funkin/pull/3482) + * @Kn1ghtNight made their first contribution in [#2853](https://github.com/FunkinCrew/Funkin/pull/2853) -* @DaWaterMalone made their first contribution in [#3577](https://github.com/FunkinCrew/Funkin/pull/3577) -* @amyspark-ng made their first contribution in [#3552](https://github.com/FunkinCrew/Funkin/pull/3552) * @Cartridge-Man made their first contribution in [#3082](https://github.com/FunkinCrew/Funkin/pull/3082) +* @KoloInDaCrib made their first contribution in [#3482](https://github.com/FunkinCrew/Funkin/pull/3482) * @afreetoplaynoob made their first contribution in [#3537](https://github.com/FunkinCrew/Funkin/pull/3537) +* @amyspark-ng made their first contribution in [#3552](https://github.com/FunkinCrew/Funkin/pull/3552) +* @DaWaterMalone made their first contribution in [#3577](https://github.com/FunkinCrew/Funkin/pull/3577) ## [0.5.1] - 2024-09-30 + ### Added + - Readded the Merch button to the main menu. - Click it to check out our Makeship campaign! - Added Discord Rich Presence support. People can now see what song you are playing from Discord! - We'll get mod support working for this eventually. - Added an FPS limit option to the Preferences menu. - You can now change how high the game tries to push your frame rate, from as little as 30 to as high as 300. -- Added support for the Tracy instrumenation-based profiling tool in development environments. Enable it with the `-DFEATURE_DEBUG_TRACY` compilation flag. +- Added support for the Tracy instrumentation-based profiling tool in development environments. Enable it with the `-DFEATURE_DEBUG_TRACY` compilation flag. - For the people who aren't nerds, this is a tool for tracking down performance issues! - Playable Character data now defines an asset location for an Animate Atlas to display Girlfriend. - This includes the option to display a visualizer, if configured correctly. - Separated the Perfect and Perfect (Gold) animations in the Playable Character data. - Base game just uses the same animation for both, but modders can split the animations up on their custom characters now. -- Added a bunch of Flash project files from the Weekend 1 and Playable Pico updates to the `Funkin.art` repository. +- Added a bunch of Flash project files from the Weekend 1 and Playable Pico updates to the `funkin.art` repository. - Added the `flipX` and `flipY` parameters to props in the Stage data. ([community feature by AbnormalPoof](https://github.com/FunkinCrew/Funkin/pull/3474)) + ### Changed + - The game's mod API version check is now more dynamic. - The update accepts mods with API version `0.5.0` as well as `0.5.1`. - Pico is no longer unlocked for all players automatically. @@ -89,64 +101,69 @@ This patch resolves a critical issue which could cause user's save data to becom - The game now complains if you create a song variation with symbols in the name. - Switched the force crash keybind from Ctrl-Shift-L to Ctrl-Alt-Shift-L. - Added some additional functions to `funkin.Assets` after `openfl.utils.Assets` had to get blacklisted from scripts. + ### Fixed -- Fixed an issue where DadBattle (Pico Mix) was not properly credited to `TeraVex (ft. Saruky)`. -- Fixed an issue where DadBattle (Pico Mix) was missing charts on the Normal and Easy difficulty. -- Fixed an issue where Spookeez (Pico Mix) was not properly credited to `Six Impala (ft. Saster)`. -- Fixed an issue where the "Shit!" judgement would display with anti-aliasing in Week 6. -- Fixed an issue where Pico Erect could be played with different instrumentals. -- Fixed an issue where Pico would not play his shooting animations in Stress. -- Fixed an issue where Freeplay would display no custom songs when switching characters. -- Fixed an issue where Freeplay would sometimes display the wrong text on the capsules. -- Fixed an issue where duplicate difficulties from custom variations wouldn't display properly in Freeplay. -- Fixed an issue where custom note styles would sometimes just use default values rather than using the fallback note style. -- Fixed an issue where custom note styles would randomly fail to fetch information about their fallback note style. -- Fixed an issue where the Screenshots and Chart Editor binds displayed in the controls menu on Web builds (where they are disabled). -- Fixed an issue where the Stage Editor bind displayed in the controls menu even when the feature was disabled. -- Fixed an issue where the Freeplay Character Select keybind displayed weird in the keybinds menu. -- Fixed an issue where setting the input offset or visual offset too high would cause the song to skip. -- Fixed an issue where video cutscenes would not scale their volume properly. -- Fixed an issue where Cocoa Erect (Erect difficulty) had a tap note stacked on top of a hold note, -- Fixed an issue where the game would stutter when playing on the Week 5 Remix stage. -- Fixed an issue where the save data version number wouldn't get written to save data properly. -- Fixed an issue where the example mod could not be loaded. -- Fixed an issue where a script error would display when entering Blazin'. -- Fixed an issue where pressing F5 to force reload a song would sometimes cause the game to crash. -- Fixed an issue where animations on Animate Atlas characters would throw a bunch of warnings in the console. -- Fixed an issue where characters with high offsets would shift over after the player dies or restarts. -- Fixed an issue where Pico wouldn't play out his full burp animation in South (Pico Mix). -- Fixed an issue where Results screen audio could continue into Freeplay or even gameplay. -- Fixed an issue where some audio tracks would get destroyed even if they were flagged as persistent. -- Fixed an issue where the audio track would stay muted if you missed a note just before Pico burps. -- Fixed an issue where the curtains in Week 1 would display in front of larger characters. -- Fixed an issue where Boyfriend wouldn't play his death animation properly on Week 2's Remix stage. -- Fixed an issue in Freeplay where the clear % would not display after switching characters. -- Fixed an issue in Freeplay where character remixes would display the base song's highscore. -- Fixed an issue where Pico would become locked every time the game starts, and you would have to watch the unlock animation each game boot. + +- DadBattle (Pico Mix) is now properly credited to `TeraVex (ft. Saruky)`. +- DadBattle (Pico Mix) now has charts for Normal and Easy difficulties. +- Spookeez (Pico Mix) is now properly credited to `Six Impala (ft. Saster)`. +- The "Shit!" judgement no longer displays with anti-aliasing in Week 6. +- Pico Erect can no longer be played with different instrumentals. +- Pico now plays his shooting animations in Stress. +- Freeplay now displays custom songs when switching characters. +- Freeplay no longer displays the wrong text on capsules. +- Duplicate difficulties from custom variations now display properly in Freeplay. +- Custom note styles no longer sometimes use default values rather than the fallback note style +- Custom note styles no longer randomly fail to fetch information about their fallback note style. +- Screenshots and Chart Editor binds no longer display in the controls menu on Web builds (where they are disabled). +- Stage Editor bind no longer displays in the controls menu even when the feature is disabled. +- Freeplay Character Select keybind no longer displays strangely in the controls menu. +- Setting the input offset or visual offset to high values no longer causes the song to skip. +- Video cutscenes now scale their volume properly. +- The game no longer stutters when playing on the Week 5 Remix stage. +- The save data version number is now written to the save data properly. +- The example mod can now be loaded. +- Entering Blazin' no longer displays a script error. +- Pressing F5 to force reload a song no longer occasionally causes the game to crash. +- Animations on Animate Atlas characters no longer throw a bunch of warnings in the console. +- Characters with high offsets no longer shift over after the player dies or restarts. +- The audio track now unmutes if you miss a note just before Pico burps. +- Pico now plays out his full burp animation in South (Pico Mix). +- Removed a tap note stacked on top of a hold note in Cocoa Erect (Erect difficulty). +- Results screen audio no longer continues into Freeplay or gameplay. +- Audio tracks no longer get destroyed if they are flagged as persistent. +- The curtains in Week 1 no longer display in front of larger characters. +- Boyfriend now plays his death animation properly on the Week 2 Remix stage. +- The clear % now displays in Freeplay after switching characters. +- Character remixes no longer display the base song's highscore in Freeplay. +- Pico is no longer locked every time the game starts, and you no longer have to watch the unlock animation each game boot. - The animation should now play only once per save file. -- Fixed an issue where Spirit's trail in Week 6 would not display correctly. -- Fixed an issue where the Input Offsets menu would crash when entering it before playing a song on web builds. -- Fixed an issue where the Results screen would spam the percentage tick noise instead of playing when the value changes. -- Fixed an issue where parts of the Chart Editor could not be interacted with. ([community fix by Kade-github](https://github.com/FunkinCrew/Funkin/pull/3337)) -- Fixed an issue where classic FocusCamera song events could cause the camera to snap in place. ([community fix by nebulazorua](https://github.com/FunkinCrew/Funkin/pull/2331)) -- Fixed an issue where achieving the same rank on a song (but a different clear %) would override your clear %, even if it was lower. ([community fix by lemz1](https://github.com/FunkinCrew/Funkin/pull/3019)) -- Fixed an issue where the FPS counter would display even if Debug Display was turned off. ([community fix by Lethrial](https://github.com/FunkinCrew/Funkin/pull/3356)) -- Fixed an issue where selecting the area to the left of the Chart Editor would select some of the player's notes ([community fix by NotHyper-474](https://github.com/FunkinCrew/Funkin/pull/3093)) -- Fixed an issue where pixel icons in the Chart Editor would not display correctly. ([community fix by Techniktil](https://github.com/FunkinCrew/Funkin/pull/3339)) -- Fixed an issue where `Stage.addCharacter` would not properly assign the `characterType`. ([community fix by Kade-github](https://github.com/FunkinCrew/Funkin/pull/3357)) -- Fixed an issue where players could interact with Character Select during the unlock sequence, causing a crash. ([community fix by ActualMandM](https://github.com/FunkinCrew/Funkin/pull/3355)) -- Fixed an issue where hold notes in Week 6 were not scaled/positioned correctly. ([community fix by dombomb64](https://github.com/FunkinCrew/Funkin/pull/3351)) -- Fixed an issue where audio offets would not interact with the Chart Editor properly. ([community fix by Kade-github](https://github.com/FunkinCrew/Funkin/pull/3384)) -- Fixed an issue where fetching Modules during the `onDestroy` event would fail at random. ([community fix by cyn0x8](https://github.com/FunkinCrew/Funkin/pull/3131)) -- Fixed an issue where `onSubStateOpenEnd` and `onSubStateCloseEnd` script events would not always get called. ([community fix by lemz1](https://github.com/FunkinCrew/Funkin/pull/3138)) +- Spirit's trail in Week 6 now displays correctly. +- The Input Offsets menu no longer crashes when entering it before playing a song on web builds. +- The Results screen now plays the percentage tick sound when the value changes instead of spamming the sound. +- The Chart Editor can now be interacted with properly. ([community fix by Kade-github](https://github.com/FunkinCrew/Funkin/pull/3337)) +- Classic FocusCamera song events no longer cause the camera to snap in place. ([community fix by nebulazorua](https://github.com/FunkinCrew/Funkin/pull/2331)) +- Achieving the same rank on a song with a lower clear % no longer overwrites your clear %. ([community fix by lemz1](https://github.com/FunkinCrew/Funkin/pull/3019)) +- The FPS counter no longer displays if Debug Display is turned off. ([community fix by Lethrial](https://github.com/FunkinCrew/Funkin/pull/3356)) +- Selecting the area to the left of the Chart Editor no longer selects some of the player's notes. ([community fix by NotHyper-474](https://github.com/FunkinCrew/Funkin/pull/3093)) +- Pixel icons now display correctly in the Chart Editor. ([community fix by Techniktil](https://github.com/FunkinCrew/Funkin/pull/3339)) +- `Stage.addCharacter` now properly assigns the `characterType`. ([community fix by Kade-github](https://github.com/FunkinCrew/Funkin/pull/3357)) +- Players can no longer crash the game by interacting with Character Select during the unlock sequence. ([community fix by ActualMandM](https://github.com/FunkinCrew/Funkin/pull/3355)) +- Pixel hold note trails in Week 6 are now scaled/positioned correctly. ([community fix by dombomb64](https://github.com/FunkinCrew/Funkin/pull/3351)) +- Audio offsets now interact with the Chart Editor properly. ([community fix by Kade-github](https://github.com/FunkinCrew/Funkin/pull/3384)) +- Fetching Modules during the `onDestroy` event no longer fails at random. ([community fix by cyn0x8](https://github.com/FunkinCrew/Funkin/pull/3131)) +- `onSubStateOpenEnd` and `onSubStateCloseEnd` script events are now called consistently. ([community fix by lemz1](https://github.com/FunkinCrew/Funkin/pull/3138)) ## New Contributors for 0.5.1 -* @Lethrial made their first contribution in [#3356](https://github.com/FunkinCrew/Funkin/pull/3356) + * @dombomb64 made their first contribution in [#3351](https://github.com/FunkinCrew/Funkin/pull/3351) +* @Lethrial made their first contribution in [#3356](https://github.com/FunkinCrew/Funkin/pull/3356) ## [0.5.0] - 2024-09-12 + ### Added + - Added a new Character Select screen to switch between playable characters in Freeplay - Modding isn't 100% there but we're working on it! - Added Pico as a playable character! Unlock him by completing Weekend 1 (if you haven't already done that) @@ -182,7 +199,9 @@ This patch resolves a critical issue which could cause user's save data to becom - Implemented support for scripted Note Kinds. You can use HScript define a different note style to display for these notes as well as custom behavior. (community feature by lemz1) - Implemented support for Numeric and Selector options in the Options menu. ([community feature by FlooferLand](https://github.com/FunkinCrew/Funkin/pull/2942)) - Implemented new animations for Tankman and Pico. + ## Changed + - Girlfriend and Nene now perform previously unused animations when you achieve a large combo, or drop a large combo. - The pixel character icons in the Freeplay menu now display an animation! - Altered how Week 6 displays sprites to make things look more retro. @@ -202,7 +221,9 @@ This patch resolves a critical issue which could cause user's save data to becom - Animation offsets no longer directly modify the `x` and `y` position of props, which makes props work better with tweens ([community fix by Sword352](https://github.com/FunkinCrew/Funkin/pull/2310)) - The YEAH! events in Tutorial now use chart events rather than being hard-coded ([community fix by anysad](https://github.com/FunkinCrew/Funkin/pull/3007)) - The player's Score now displays commas in it (community fix by loggo) + ## Fixed + - Fixed an issue where songs with no notes would crash on the Results screen. - Fixed an issue where the old icon easter egg would not work properly on pixel levels. - Fixed an issue where you could play notes during the Thorns cutscene. @@ -225,21 +246,26 @@ This patch resolves a critical issue which could cause user's save data to becom - Fixed an issue in Story Mode where a song that isn't valid for the current variation could be selected ([community fix by AppleHair](https://github.com/FunkinCrew/Funkin/pull/3037)) ## New Contributors for 0.5.0 + +* @Sword352 made their first contribution in [#2310](https://github.com/FunkinCrew/Funkin/pull/2310) +* @cyn0x8 made their first contribution in [#2494](https://github.com/FunkinCrew/Funkin/pull/2494) +* @KarimAkra made their first contribution in [#2713](https://github.com/FunkinCrew/Funkin/pull/2713) +* @AppleHair made their first contribution in [#2742](https://github.com/FunkinCrew/Funkin/pull/2742) +* @JVNpixels made their first contribution in [#2873](https://github.com/FunkinCrew/Funkin/pull/2873) * @Flooferland made their first contribution in [#2942](https://github.com/FunkinCrew/Funkin/pull/2942) * @anysad made their first contribution in [#3007](https://github.com/FunkinCrew/Funkin/pull/3007) -* @Sword352 made their first contribution in [#2310](https://github.com/FunkinCrew/Funkin/pull/2310) -* @KarimAkra made their first contribution in [#2713](https://github.com/FunkinCrew/Funkin/pull/2713) -* @JVNpixels made their first contribution in [#2873](https://github.com/FunkinCrew/Funkin/pull/2873) -* @AppleHair made their first contribution in [#2742](https://github.com/FunkinCrew/Funkin/pull/2742) * @7oltan made their first contribution in [#3035](https://github.com/FunkinCrew/Funkin/pull/3035) -* @cyn0x8 made their first contribution in [#2494](https://github.com/FunkinCrew/Funkin/pull/2494) ## [0.4.1] - 2024-06-12 + ### Added + - Pressing ESCAPE on the title screen on desktop now exits the game, allowing you to exit the game while in fullscreen on desktop - Freeplay menu controls (favoriting and switching categories) are now rebindable from the Options menu, and now have default binds on controllers. + ### Changed + - Highscores and ranks are now saved separately, which fixes the issue where people would overwrite their saves with higher scores, which would remove their rank if they had a lower one. - A-Bot speaker now reacts to the user's volume preference on desktop ([thanks to M7theguy for the issue report/suggestion](https://github.com/FunkinCrew/Funkin/issues/2744)!) @@ -251,7 +277,9 @@ which would remove their rank if they had a lower one. - Re-enabled custom camera events in Roses (Erect/Nightmare) - Tweaked the chart for Lit Up (Hard) - Corrected the difficulty ratings for M.I.L.F (Easy/Normal/Hard) + ### Fixed + - Fixed an issue in the controls menu where some control binds would overlap their names - Fixed crash when attempting to exit the gameover screen when also attempting to retry the song ([thanks DMMaster636 for the PR!](https://github.com/FunkinCrew/Funkin/pull/2709)) - Fix botplay sustain release bug ([thanks Hundrec!](https://github.com/FunkinCrew/Funkin/pull/2683)) @@ -265,12 +293,15 @@ which would remove their rank if they had a lower one. - Fixed the black "temp" graphic on freeplay from being incorrectly sized / masked, now it's identical to the dad freeplay graphic ## New Contributors for 0.4.1 -* @DMMaster636 made their first contribution in [#2709](https://github.com/FunkinCrew/Funkin/pull/2709) + * @Hundrec made their first contribution in [#2683](https://github.com/FunkinCrew/Funkin/pull/2683) +* @DMMaster636 made their first contribution in [#2709](https://github.com/FunkinCrew/Funkin/pull/2709) ## [0.4.0] - 2024-06-06 + ### Added + - 2 new Erect remixes, Eggnog and Satin Panties. Check them out from the Freeplay menu! - Major visual improvements to the Results screen, with additional animations and audio based on your performance. - Major visual improvements to the Freeplay screen, with song difficulty ratings and player rank displays. @@ -278,7 +309,9 @@ which would remove their rank if they had a lower one. - Added a Charter field to the chart format, to allow for crediting the creator of a level's chart. - You can see who charted a song from the Pause menu. - Added a new Scroll Speed chart event to change the note speed mid-song ([thanks Burgerballs!](https://github.com/FunkinCrew/Funkin/pull/2409)) + ### Changed + - Tweaked the charts for several songs: - Tutorial (increased the note speed slightly) - Spookeez @@ -298,7 +331,9 @@ which would remove their rank if they had a lower one. - Health icons now support a Winning frame without requiring a spritesheet, simply include a third frame in the icon file. ([thanks gamerbross!](https://github.com/FunkinCrew/Funkin/pull/2593)) - Remember that for more complex behaviors such as animations or transitions, you should use an XML file to define each frame. - Improved the Event Toolbox in the Chart Editor; dropdowns are now bigger, include search field, and display elements in alphabetical order rather than a random order. + ### Fixed + - Fixed an issue where Nene's visualizer would not play on Desktop builds - Fixed a bug where the game would silently fail to load saves on HTML5 - Fixed some bugs with the props on the Story Menu not bopping properly @@ -322,20 +357,25 @@ which would remove their rank if they had a lower one. - Additional bug fixes and optimizations. ## New Contributors for 0.4.0 -* @Keoiki made their first contribution in [#2581](https://github.com/FunkinCrew/Funkin/pull/2581) -* @richTrash21 made their first contribution in [#2493](https://github.com/FunkinCrew/Funkin/pull/2493) -* @sector-a made their first contribution in [#2585](https://github.com/FunkinCrew/Funkin/pull/2585) -* @MaybeMaru made their first contribution in [#2488](https://github.com/FunkinCrew/Funkin/pull/2488) -* @Ethan-makes-music made their first contribution in [#2624](https://github.com/FunkinCrew/Funkin/pull/2624) + * @Noobz4Life made their first contribution in [#2472](https://github.com/FunkinCrew/Funkin/pull/2472) -* @NotHyper-474 made their first contribution in [#2629](https://github.com/FunkinCrew/Funkin/pull/2629) +* @MaybeMaru made their first contribution in [#2488](https://github.com/FunkinCrew/Funkin/pull/2488) +* @richTrash21 made their first contribution in [#2493](https://github.com/FunkinCrew/Funkin/pull/2493) +* @Keoiki made their first contribution in [#2581](https://github.com/FunkinCrew/Funkin/pull/2581) +* @sector-a made their first contribution in [#2585](https://github.com/FunkinCrew/Funkin/pull/2585) * @PurSnake made their first contribution in [#2610](https://github.com/FunkinCrew/Funkin/pull/2610) +* @Ethan-makes-music made their first contribution in [#2624](https://github.com/FunkinCrew/Funkin/pull/2624) +* @NotHyper-474 made their first contribution in [#2629](https://github.com/FunkinCrew/Funkin/pull/2629) ## [0.3.3] - 2024-05-14 + ### Changed + - Cleaned up some code in `PlayAnimationSongEvent.hx` ([thanks Burgerballs!](https://github.com/FunkinCrew/Funkin/pull/2308)) + ### Fixed + - Fixes to the Loading bar on HTML5 ([thanks lemz1!](https://github.com/FunkinCrew/Funkin/pull/2499)) - Don't allow any more inputs when exiting freeplay ([thanks gamerbross!](https://github.com/FunkinCrew/Funkin/pull/2470)) - Fixed using mouse wheel to scroll on freeplay ([thanks JugieNoob!](https://github.com/FunkinCrew/Funkin/pull/2466)) @@ -353,18 +393,21 @@ which would remove their rank if they had a lower one. - Fix a crash on Freeplay found on AMD graphics cards ## New Contributors for 0.3.3 -* @Burgerballs made their first contribution in [#2308](https://github.com/FunkinCrew/Funkin/pull/2308) -* @lemz1 made their first contribution in [#2499](https://github.com/FunkinCrew/Funkin/pull/2499) -* @gamerbross made their first contribution in [#2470](https://github.com/FunkinCrew/Funkin/pull/2470) -* @JugieNoob made their first contribution in [#2466](https://github.com/FunkinCrew/Funkin/pull/2466) -* @MadBear422 made their first contribution in [#2370](https://github.com/FunkinCrew/Funkin/pull/2370) -* @ImCodist made their first contribution in [#2309](https://github.com/FunkinCrew/Funkin/pull/2309) + * @TheGaloXx made their first contribution in [#2300](https://github.com/FunkinCrew/Funkin/pull/2300) +* @Burgerballs made their first contribution in [#2308](https://github.com/FunkinCrew/Funkin/pull/2308) +* @ImCodist made their first contribution in [#2309](https://github.com/FunkinCrew/Funkin/pull/2309) * @nebulazorua made their first contribution in [#2323](https://github.com/FunkinCrew/Funkin/pull/2323) +* @MadBear422 made their first contribution in [#2370](https://github.com/FunkinCrew/Funkin/pull/2370) +* @JugieNoob made their first contribution in [#2466](https://github.com/FunkinCrew/Funkin/pull/2466) +* @gamerbross made their first contribution in [#2470](https://github.com/FunkinCrew/Funkin/pull/2470) +* @lemz1 made their first contribution in [#2499](https://github.com/FunkinCrew/Funkin/pull/2499) ## [0.3.2] - 2024-05-03 + ### Added + - Added `,` and `.` keybinds to the Chart Editor. These place Focus Camera events at the playhead, for the opponent and player respectively. - Implemented a blacklist to prevent mods from calling system functions. - Added a couple utility functions to call useful stuff that got blacklisted. @@ -372,11 +415,15 @@ which would remove their rank if they had a lower one. - Added the current loaded modlist to crash logs. - Added the `visible` attribute to Level JSON data. - Enabled ZIP file system support for Polymod (make sure the metadata is in the root of the ZIP). + ### Changed + - Songs in the mod folders will display in Freeplay without any extra scripting. - Story levels in the mod folders will display in Story without any extra scripting. - All audio should sound better in HTML5, less muddy + ### Fixed + - Fixed a typo in the credits folder (`Custcene` -> `Cutscene`) - Fixed an issue where health icon transition animations would loop and never finish properly. - Fixed an issue where video cutscenes flagged as mid-song would crash the game when they finish. @@ -385,18 +432,24 @@ which would remove their rank if they had a lower one. - Fixed an issue where the preloader would spam the logs when it was complete and waiting for user input. - Should definitely have the fix for freeplay where it stops taking control of the main menu below it - Changed the code for the story menu difficulties so that "normal" doesn't overlap the arrows after leaving Weekend 1 + ### Removed + - Removed some unused `.txt` files in the `assets/data` folder. ## [0.3.1] - 2024-05-01 + ### Changed + - Ensure the Git commit hash always displays in the log files. - Added whether the local Git repo was modified to the log files. - Removed "PROTOTYPE" text on release builds only (it still shows on debug builds). - Added additional credits and special thanks. - Updated peepo in creds to peepo173 + ### Fixed + - Fix a crash when retrieving system specs while handing a crash. - Fix a crash triggered when pausing before the song started. - Fix a crash triggered when dying before the song started. @@ -407,7 +460,9 @@ which would remove their rank if they had a lower one. ## [0.3.0] - 2024-04-30 + ### Added + - New Story Level: Weekend 1, starting Pico, Darnell, and Nene. - Beat the level in Story Mode to unlock the songs for Freeplay! - 12 new Erect remixes, featuring Kawai Sprite, Saruky, Kohta Takahashi, and Saster @@ -421,7 +476,9 @@ which would remove their rank if they had a lower one. - New song events system allows for simple customization of camera behavior. - Mods can implement custom song events via HScript, and new built-in song events will come in the future. - New credits menu to list all the dozens of people who contributed. + ### Changed + - Completely refactored the game's input system for higher reliability and accuracy. - Reworked note rendering to massively reduce lag on larger charts. - Reworks to scoring and health gain. @@ -436,35 +493,49 @@ which would remove their rank if they had a lower one. - Fully refactored the game's chart file format for extensibility and readability. - You can migrate old charts using the Import FNF Legacy option in the chart editor. - Various visual tweaks and improvements. + ### Fixed + - 17 quadrillion bugs across hundreds of PRs. ## [0.2.8] - 2021-04-18 (note, this one is iffy cuz we slacked wit it lol!) + ### Added + - TANKMAN! 3 NEW SONGS BY KAWAISPRITE (UGH, GUNS, STRESS)! Charting help by MtH! - Monster added into week 2, FINALLY (Charting help by MtH and ChaoticGamer!) - Can now change song difficulty mid-game. - Shows some song info on pause screen. - Cute little icons onto freeplay menu - Offset files for easier modification of characters + ### Changed + - ASSET LOADING OVERHAUL, WAY FASTER LOAD TIMES ON WEB!!! (THANKS TO GEOKURELI WOKE KING) - Made difficulty selector on freeplay menu more apparent + ### Fixed + - That one random note on Bopeebo ## [0.2.7.1] - 2021-02-14 + ### Added + - Easter eggs - readme's in desktop versions of the game + ### Changed + - New icons, old one was placeholder since October woops! - Made the transitions between the story mode levels more seamless. - Offset of the Newgrounds logo on boot screen. - Made the changelog txt so it can be opened easier by normal people who don't have a markdown reader (most normal people); + ### Fixed + - Fixed crashes on Week 6 story mode dialogue if spam too fast ([Thanks to Lotusotho for the Pull Request!](https://github.com/FunkinCrew/Funkin/pull/357)) - Should show intro credits on desktop versions of the game more consistently - Layering on Week 4 songs with GF and the LIMO LOL HOW TF I MISS THIS @@ -474,21 +545,29 @@ which would remove their rank if they had a lower one. ## [0.2.7] - 2021-02-02 + ### Added + - PIXEL DAY UPDATE LOL 1 WEEK LATER - 3 New songs by Kawaisprite! - COOL CUTSCENES - WEEK 6 YOYOYOYOY - Swaggy pixel art by Moawling! + ### Changed + - Made it so you lose sliiiightly more health when you miss a note. - Removed the default HaxeFlixel pause screen when the game window loses focus, can get screenshots of the game easier hehehe + ### Fixed + - Idle animation bug with BF christmas and BF hair blow sprites ([Thanks to Injourn for the Pull Request!](https://github.com/FunkinCrew/Funkin/pull/237)) ## [0.2.6] - 2021-01-20 + ### Added + - 3 NEW CHRISTMAS SONGS. 2 BY KAWAISPRITE, 1 BY BASSETFILMS!!!!! BF WITH DRIP! SANTA HANGIN OUT! - Enemy icons change when they you are winning a lot ([Thanks to pahaze for the Pull Request!](https://github.com/FunkinCrew/Funkin/pull/138)) - Holding CTRL in charting editor places notes on both sides @@ -496,11 +575,17 @@ which would remove their rank if they had a lower one. - Other charting editor workflow improvements - More hair physics - Heads appear at top of chart editor to help show which side ur charting for + ### Changed + - Tweaked code relating to inputs, hopefully making notes that are close together more fair to hit + ### Removed + - Removed APE + ### Fixed + - Maybe fixed double notes / jump notes. Need to tweak it for balance, but should open things up for cooler charts in the future. - Old Verison popup screen weirdness ([Thanks to gedehari for the Pull Request!](https://github.com/FunkinCrew/Funkin/pull/155)) - Song no longer loops when finishing the song. ([Thanks Injourn for the Pull Request!](https://github.com/FunkinCrew/Funkin/pull/132)) @@ -509,7 +594,9 @@ which would remove their rank if they had a lower one. ## [0.2.5] - 2020-12-27 + ### Added + - MOMMY GF, 3 NEW ASS SONGS BY KAWAISPRITE, NEW ART BY PHANTOMARCADE,WOOOOOOAH!!!! - Different icons depending on which character you are against, art by EVILSK8R!! - Autosave to chart editor @@ -517,31 +604,45 @@ which would remove their rank if they had a lower one. - Swap button in note editor - a new boot text or two - automatic check for when you're on an old version of the game! + ### Changed + - Made Spookeez on Normal easier. - Mouse is now visible in note editor + ### Fixed + - Crash when playing Week 3 and then playing a non-week 3 song - When pausing music at the start, it doesn't continue the song anyways. ([shoutouts gedehari for the Pull Request!](https://github.com/FunkinCrew/Funkin/pull/48)) - IDK i think backing out of song menu should play main menu songs again hehe ([shoutouts gedehari for the Pull Request!](https://github.com/FunkinCrew/Funkin/pull/48)) ## [0.2.4] - 2020-12-11 + ### Added + - 3 NEW SONGS BY KAWAISPRITE. Pico, Philly, and Blammed. - NEW CHARACTER, PICO. Based off the classic Flash game "Pico's School" by Tom Fulp - NEW LEVEL WOW! PHILLY BABEEEE + ### Changed + - Made it less punishing to ATTEMPT to hit a note and miss, rather than let it pass you + ### Fixed + - Song desync of you paused and unpaused frequently ([shoutouts SonicBlam](https://github.com/FunkinCrew/Funkin/issues/37)) - Animation offsets when GF is scared ## [0.2.3] - 2020-12-04 + ### Added + - More intro texts + ### Fixed + - Exploit where you could potentially give yourself a high score via the debug menu - Issue/bug where you could spam the confirm button on the story menu ([shoutouts lotusotho for the CODE contribution/pull request!](https://github.com/FunkinCrew/Funkin/pull/19)) - Glitch where if you never would lose health if you missed a note on a fast song (shoutouts [MrDulfin](https://github.com/FunkinCrew/Funkin/issues/10), [HotSauceBurritos](https://github.com/FunkinCrew/Funkin/issues/13) and [LobsterMango](https://lobstermango.newgrounds.com)) @@ -549,15 +650,21 @@ which would remove their rank if they had a lower one. ## [0.2.2] - 2020-11-20 + ### Added + - Music playing on the freeplay menu. - UI sounds on freeplay menu - Score now shows mid-song. - Menu on pause screen! Can resume, and restart song, or go back to main menu. - New music made for pause menu! + ### Changed + - Moved all the intro texts to its own txt file instead of being hardcoded, this allows for much easier customization. File is in the data folder, called "introText.txt", follow the format in there and you're probably good to go! + ### Fixed + - Fixed soft lock when pausing on song finish ([shoutouts gedehari](https://github.com/FunkinCrew/Funkin/issues/15)) - Think I fixed issue that led to in-game scores being off by 2 ([shoutouts Mike](https://github.com/FunkinCrew/Funkin/issues/4)) - Should have fixed the 1 frame note appearance thing. ([shoutouts Mike](https://github.com/FunkinCrew/Funkin/issues/6)) @@ -567,36 +674,50 @@ which would remove their rank if they had a lower one. ## [0.2.1.2] - 2020-11-06 + ### Fixed + - Story mode scores not properly resetting, leading to VERY inflated highscores on the leaderboards. This also requires me to clear the scores that are on the leaderboard right now, sorry! - Difficulty on storymode and in freeplay scores - Hard mode difficulty on campaign levels have been fixed ## [0.2.1.1] - 2020-11-06 + ### Fixed + - Week 2 not unlocking properly ## [0.2.1] - 2020-11-06 + ### Added + - Scores to the freeplay menu - A few new intro boot messages. - Lightning effect in Spooky stages - Campaign scores, can now compete on scoreboards for campaign! - Can now change difficulties in Freeplay mode + ### Changed + - Balanced out Normal mode for the harder songs(DadBattle and Spookeez, not South yet). Should be much easier all around. - Put tutorial in it's own 'week', so that if you want to play week 1, you don't have to play the tutorial. + ### Fixed + - One of the charting bits on South and Spookeez during the intro. ## [0.2.0] - 2020-11-01 + ### Added + - Uhh Newgrounds release lolol I always lose track of shit. ## [0.1.0] - 2020-10-05 + ### Added + - Uh, everything. This the game's initial gamejam release. We put it out From 56033b3288ba9dc3868a5d897fb313c8a2acc5ff Mon Sep 17 00:00:00 2001 From: Hundrec Date: Tue, 11 Mar 2025 09:30:36 -0600 Subject: [PATCH 24/34] Changelog overhaul for 0.4.1, 0.4.0, 0.3.3, 0.3.2, 0.3.1, 0.3.0 --- CHANGELOG.md | 226 +++++++++++++++++++++++++-------------------------- 1 file changed, 113 insertions(+), 113 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 63b3b2461..13ef473a4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -49,13 +49,13 @@ This patch resolves a critical issue which could cause user's save data to becom - Volume sound tray is now anti-aliased/smoothed ([e66290c](https://github.com/FunkinCrew/Funkin/commit/e66290c55f7141402223644f06ec8a69edeee089)) - by @Kn1ghtNight in [#2853](https://github.com/FunkinCrew/Funkin/pull/2853) - Fixed looping animations for modded StrumlineNote sprites ([bc546e8](https://github.com/FunkinCrew/Funkin/commit/bc546e86aa77ffc795b3f079de5f590289a9c583)) - by @DaWaterMalone in [#3577](https://github.com/FunkinCrew/Funkin/pull/3577) - Stopped allowing inputs after selecting a character in Character Select ([dbf66ac](https://github.com/FunkinCrew/Funkin/commit/dbf66ac250137262866d75f7c1387645b35d88d0)) - by @ACrazyTown in [#3398](https://github.com/FunkinCrew/Funkin/pull/3398) -- Player and girlfriend no longer disappear or overlap themselves in Character Select ([9324359](https://github.com/FunkinCrew/Funkin/commit/9324359d2fce6a7097077d169a0efcd80e6fefa1)) - by @gamerbross in [#3457](https://github.com/FunkinCrew/Funkin/pull/3457) -- Player no longer enters twice after entering Character Select or when spamming buttons ([30a9887](https://github.com/FunkinCrew/Funkin/commit/30a98871367b494c85934cd3fcfa91eeb774a7d5)) - by @gamerbross in [#3457](https://github.com/FunkinCrew/Funkin/pull/3457) -- Wrong girlfriend no longer appears in Character Select ([9324359](https://github.com/FunkinCrew/Funkin/commit/9324359d2fce6a7097077d169a0efcd80e6fefa1)) - by @gamerbross in [#3457](https://github.com/FunkinCrew/Funkin/pull/3457) +- The player and girlfriend no longer disappear or overlap themselves in Character Select ([9324359](https://github.com/FunkinCrew/Funkin/commit/9324359d2fce6a7097077d169a0efcd80e6fefa1)) - by @gamerbross in [#3457](https://github.com/FunkinCrew/Funkin/pull/3457) +- The player no longer enters twice after entering Character Select or when spamming buttons ([30a9887](https://github.com/FunkinCrew/Funkin/commit/30a98871367b494c85934cd3fcfa91eeb774a7d5)) - by @gamerbross in [#3457](https://github.com/FunkinCrew/Funkin/pull/3457) +- The wrong girlfriend no longer appears in Character Select ([9324359](https://github.com/FunkinCrew/Funkin/commit/9324359d2fce6a7097077d169a0efcd80e6fefa1)) - by @gamerbross in [#3457](https://github.com/FunkinCrew/Funkin/pull/3457) - Cursor now updates properly when moving and selecting in Character Select ([9324359](https://github.com/FunkinCrew/Funkin/commit/9324359d2fce6a7097077d169a0efcd80e6fefa1)) - by @gamerbross in [#3457](https://github.com/FunkinCrew/Funkin/pull/3457) - Cursor now moves properly at lower framerates in Character Select ([ab5bda3](https://github.com/FunkinCrew/Funkin/commit/ab5bda3ee573a6e03595ec6941e6de38df851889)) - by @ninjamuffin99 in [#3507](https://github.com/FunkinCrew/Funkin/pull/3507) - Exiting the Chart Editor no longer crashes the game ([f52472a](https://github.com/FunkinCrew/Funkin/commit/f52472a4767388b22cfbab0f5f7860f6e6762856)) - by @EliteMasterEric and @ianharrigan in [#3519](https://github.com/FunkinCrew/Funkin/pull/3519) -- Properly format the millisecond counter in the Chart Editor playbar ([f1b6e6c](https://github.com/FunkinCrew/Funkin/commit/f1b6e6c4e42455e0c2900d738ebc24893f2479a0)) - by @afreetoplaynoob in [#3537](https://github.com/FunkinCrew/Funkin/pull/3537) +- The millisecond counter in the Chart Editor playbar is now properly formatted ([f1b6e6c](https://github.com/FunkinCrew/Funkin/commit/f1b6e6c4e42455e0c2900d738ebc24893f2479a0)) - by @afreetoplaynoob in [#3537](https://github.com/FunkinCrew/Funkin/pull/3537) - Pressing F1 multiple times no longer creates more than one help window in the Chart Editor ([777978f](https://github.com/FunkinCrew/Funkin/commit/777978f5a544e1b7c89b47dcc365f734eb6d0df1)) - by @amyspark-ng in [#3552](https://github.com/FunkinCrew/Funkin/pull/3552) - The dialog box now shows up in the Animation Editor ([1fde59f](https://github.com/FunkinCrew/Funkin/commit/1fde59f999eac94eb10fc22094885de2f5310705)) - by @EliteMasterEric in [#3530](https://github.com/FunkinCrew/Funkin/pull/3530) - (debug) No more fullscreening when typing "F" in the flixel debugger console ([29b6763](https://github.com/FunkinCrew/Funkin/commit/29b6763290df05d42039806f3d142740568c80f0)) - by @ninjamuffin99 @@ -104,53 +104,53 @@ This patch resolves a critical issue which could cause user's save data to becom ### Fixed -- DadBattle (Pico Mix) is now properly credited to `TeraVex (ft. Saruky)`. -- DadBattle (Pico Mix) now has charts for Normal and Easy difficulties. -- Spookeez (Pico Mix) is now properly credited to `Six Impala (ft. Saster)`. -- The "Shit!" judgement no longer displays with anti-aliasing in Week 6. -- Pico Erect can no longer be played with different instrumentals. -- Pico now plays his shooting animations in Stress. -- Freeplay now displays custom songs when switching characters. +- Pico is no longer locked every time the game starts, and you no longer have to watch the unlock animation each game boot. + - The animation should now play only once per save file. +- The clear % now displays in Freeplay after switching characters. +- Character remixes no longer display the base song's highscore in Freeplay. - Freeplay no longer displays the wrong text on capsules. +- Freeplay now displays custom songs when switching characters. - Duplicate difficulties from custom variations now display properly in Freeplay. -- Custom note styles no longer sometimes use default values rather than the fallback note style +- DadBattle (Pico Mix) now has charts for Normal and Easy difficulties. +- DadBattle (Pico Mix) is now properly credited to `TeraVex (ft. Saruky)`. +- Spookeez (Pico Mix) is now properly credited to `Six Impala (ft. Saster)`. +- The audio track now unmutes if you miss a note just before Pico burps. +- Pico now plays out his full burp animation in South (Pico Mix). +- Removed a tap note stacked on top of a hold note in Cocoa Erect (Erect difficulty). +- Pico Erect can no longer be played with different instrumentals. +- The curtains in Week 1 no longer display in front of larger characters. +- Boyfriend now plays his death animation properly on the Week 2 Remix stage. +- The game no longer stutters when playing on the Week 5 Remix stage. +- The "Shit!" judgement no longer displays with anti-aliasing in Week 6. +- Spirit's trail in Week 6 now displays correctly. +- Pico now plays his shooting animations in Stress. +- Characters with high offsets no longer shift over after the player dies or restarts. +- Custom note styles no longer sometimes use default values rather than the fallback note style. - Custom note styles no longer randomly fail to fetch information about their fallback note style. - Screenshots and Chart Editor binds no longer display in the controls menu on Web builds (where they are disabled). - Stage Editor bind no longer displays in the controls menu even when the feature is disabled. - Freeplay Character Select keybind no longer displays strangely in the controls menu. -- Setting the input offset or visual offset to high values no longer causes the song to skip. +- Audio tracks no longer get destroyed if they are flagged as persistent. - Video cutscenes now scale their volume properly. -- The game no longer stutters when playing on the Week 5 Remix stage. +- Results screen audio no longer continues into Freeplay or gameplay. +- The Results screen now plays the percentage tick sound when the value changes instead of spamming the sound. - The save data version number is now written to the save data properly. - The example mod can now be loaded. -- Entering Blazin' no longer displays a script error. - Pressing F5 to force reload a song no longer occasionally causes the game to crash. - Animations on Animate Atlas characters no longer throw a bunch of warnings in the console. -- Characters with high offsets no longer shift over after the player dies or restarts. -- The audio track now unmutes if you miss a note just before Pico burps. -- Pico now plays out his full burp animation in South (Pico Mix). -- Removed a tap note stacked on top of a hold note in Cocoa Erect (Erect difficulty). -- Results screen audio no longer continues into Freeplay or gameplay. -- Audio tracks no longer get destroyed if they are flagged as persistent. -- The curtains in Week 1 no longer display in front of larger characters. -- Boyfriend now plays his death animation properly on the Week 2 Remix stage. -- The clear % now displays in Freeplay after switching characters. -- Character remixes no longer display the base song's highscore in Freeplay. -- Pico is no longer locked every time the game starts, and you no longer have to watch the unlock animation each game boot. - - The animation should now play only once per save file. -- Spirit's trail in Week 6 now displays correctly. +- Entering Blazin' no longer displays a script error. - The Input Offsets menu no longer crashes when entering it before playing a song on web builds. -- The Results screen now plays the percentage tick sound when the value changes instead of spamming the sound. -- The Chart Editor can now be interacted with properly. ([community fix by Kade-github](https://github.com/FunkinCrew/Funkin/pull/3337)) +- Setting the input offset or visual offset to high values no longer causes the song to skip. - Classic FocusCamera song events no longer cause the camera to snap in place. ([community fix by nebulazorua](https://github.com/FunkinCrew/Funkin/pull/2331)) +- Pixel hold note trails in Week 6 are now scaled/positioned correctly. ([community fix by dombomb64](https://github.com/FunkinCrew/Funkin/pull/3351)) - Achieving the same rank on a song with a lower clear % no longer overwrites your clear %. ([community fix by lemz1](https://github.com/FunkinCrew/Funkin/pull/3019)) - The FPS counter no longer displays if Debug Display is turned off. ([community fix by Lethrial](https://github.com/FunkinCrew/Funkin/pull/3356)) +- The Chart Editor can now be interacted with properly. ([community fix by Kade-github](https://github.com/FunkinCrew/Funkin/pull/3337)) - Selecting the area to the left of the Chart Editor no longer selects some of the player's notes. ([community fix by NotHyper-474](https://github.com/FunkinCrew/Funkin/pull/3093)) - Pixel icons now display correctly in the Chart Editor. ([community fix by Techniktil](https://github.com/FunkinCrew/Funkin/pull/3339)) -- `Stage.addCharacter` now properly assigns the `characterType`. ([community fix by Kade-github](https://github.com/FunkinCrew/Funkin/pull/3357)) -- Players can no longer crash the game by interacting with Character Select during the unlock sequence. ([community fix by ActualMandM](https://github.com/FunkinCrew/Funkin/pull/3355)) -- Pixel hold note trails in Week 6 are now scaled/positioned correctly. ([community fix by dombomb64](https://github.com/FunkinCrew/Funkin/pull/3351)) - Audio offsets now interact with the Chart Editor properly. ([community fix by Kade-github](https://github.com/FunkinCrew/Funkin/pull/3384)) +- Players can no longer crash the game by interacting with Character Select during the unlock sequence. ([community fix by ActualMandM](https://github.com/FunkinCrew/Funkin/pull/3355)) +- `Stage.addCharacter` now properly assigns the `characterType`. ([community fix by Kade-github](https://github.com/FunkinCrew/Funkin/pull/3357)) - Fetching Modules during the `onDestroy` event no longer fails at random. ([community fix by cyn0x8](https://github.com/FunkinCrew/Funkin/pull/3131)) - `onSubStateOpenEnd` and `onSubStateCloseEnd` script events are now called consistently. ([community fix by lemz1](https://github.com/FunkinCrew/Funkin/pull/3138)) @@ -180,7 +180,7 @@ This patch resolves a critical issue which could cause user's save data to becom - Eggnog (Pico Mix) - Ugh (Pico Mix) - Guns (Pico Mix) -- Added 1 new Boyfriend remix! Access it by completing Weekend 1 as Pico and then selecting Boyfriend from in the Character Select screen +- Added 1 new Boyfriend remix! Access it by completing Weekend 1 as Pico and then selecting Boyfriend in the Character Select screen - Darnell (BF Mix) - Added 2 new Erect remixes! Access them by switching difficulty on the song - Cocoa Erect @@ -194,7 +194,7 @@ This patch resolves a critical issue which could cause user's save data to becom - Week 4 Erect Stage - Week 5 Erect Stage - Weekend 1 Erect Stage -- Implemented alternate animations and music for Pico in the results screen. +- Implemented alternate animations and music for Pico in the Results screen. - These display on Pico remixes, as well as when playing Weekend 1. - Implemented support for scripted Note Kinds. You can use HScript define a different note style to display for these notes as well as custom behavior. (community feature by lemz1) - Implemented support for Numeric and Selector options in the Options menu. ([community feature by FlooferLand](https://github.com/FunkinCrew/Funkin/pull/2942)) @@ -208,42 +208,42 @@ This patch resolves a critical issue which could cause user's save data to becom - Character offsets are now independent of the character's scale. - This should resolve issues with offsets when porting characters from older mods. - Pixel character offsets have been modified to compensate. +- Reworked the JSON merging system in Polymod; you can now include JSONPatch files under `_merge` in your mod folder to add, modify, or remove values in a JSON without replacing it entirely! +- The `danceEvery` property of characters and stage props can now use values with a precision of `0.25`, to play their idle animation up to four times per beat. +- Characters now respect the `danceEvery` property ([community fix by gamerbross](https://github.com/FunkinCrew/Funkin/pull/2925)) - Note style data can now specify custom combo count graphics, judgement graphics, countdown graphics, and countdown audio. ([community feature by anysad](https://github.com/FunkinCrew/Funkin/pull/3020)) - These were previously using hardcoded values based on whether the stage was `school` or `schoolEvil`. -- The `danceEvery` property of characters and stage props can now use values with a precision of `0.25`, to play their idle animation up to four times per beat. -- Reworked the JSON merging system in Polymod; you can now include JSONPatch files under `_merge` in your mod folder to add, modify, or remove values in a JSON without replacing it entirely! -- Cutscenes now automatically pause when tabbing out ([community fix by AbnormalPoof](https://github.com/FunkinCrew/Funkin/pull/2903)) -- Characters will now respect the `danceEvery` property ([community fix by gamerbross](https://github.com/FunkinCrew/Funkin/pull/2925)) -- The F5 function now reloads the current song's chart data from disc ([community feature by gamerbross](https://github.com/FunkinCrew/Funkin/pull/2990)) -- Refactored the compilation guide and added common troubleshooting steps ([community fix by Hundrec](https://github.com/FunkinCrew/Funkin/pull/2813)) -- Made several layout improvements and fixes to the Animation Offsets editor in the Debug menu ([community fix by gamerbross](https://github.com/FunkinCrew/Funkin/pull/2820)) -- Fixed a bug where the Back sound would be not played when leaving the Story menu and Options menu ([community fix by AppleHair](https://github.com/FunkinCrew/Funkin/pull/2986)) -- Animation offsets no longer directly modify the `x` and `y` position of props, which makes props work better with tweens ([community fix by Sword352](https://github.com/FunkinCrew/Funkin/pull/2310)) - The YEAH! events in Tutorial now use chart events rather than being hard-coded ([community fix by anysad](https://github.com/FunkinCrew/Funkin/pull/3007)) +- Cutscenes now automatically pause when tabbing out ([community fix by AbnormalPoof](https://github.com/FunkinCrew/Funkin/pull/2903)) +- The F5 function now reloads the current song's chart data from disk ([community feature by gamerbross](https://github.com/FunkinCrew/Funkin/pull/2990)) +- Made several layout improvements and fixes to the Animation Offsets editor in the Debug menu ([community fix by gamerbross](https://github.com/FunkinCrew/Funkin/pull/2820)) +- Animation offsets no longer directly modify the `x` and `y` position of props, which makes props work better with tweens ([community fix by Sword352](https://github.com/FunkinCrew/Funkin/pull/2310)) +- Fixed a bug where the Back sound would be not played when leaving the Story menu and Options menu ([community fix by AppleHair](https://github.com/FunkinCrew/Funkin/pull/2986)) - The player's Score now displays commas in it (community fix by loggo) +- Refactored the compilation guide and added common troubleshooting steps ([community fix by Hundrec](https://github.com/FunkinCrew/Funkin/pull/2813)) ## Fixed -- Fixed an issue where songs with no notes would crash on the Results screen. -- Fixed an issue where the old icon easter egg would not work properly on pixel levels. -- Fixed an issue where you could play notes during the Thorns cutscene. -- Fixed an issue where the Heart icon when favoriting a song in Freeplay would be malformed. -- Fixed an issue where Pico's death animation displays a faint blue background ([community fix by doggogit](https://github.com/FunkinCrew/funkin.assets/pull/1)) -- Fixed an issue where mod songs would not play a preview in the Freeplay menu ([community fix by KarimAkra](https://github.com/FunkinCrew/Funkin/pull/2724)) -- Fixed an issue where the Memory Usage counter could overflow and display a negative number ([community fix by KarimAkra](https://github.com/FunkinCrew/Funkin/pull/2713)) -- Fixed an issue where pressing the Chart Editor keybind while playtesting a chart would reset the chart editor ([community fix by gamerbross](https://github.com/FunkinCrew/Funkin/pull/2739)) -- Fixed a crash bug when pressing F5 after seeing the sticker transition ([community fix by gamerbross](https://github.com/FunkinCrew/Funkin/pull/2863)) -- Fixed an issue where the Story Mode menu couldn't be scrolled with a mouse ([community fix by JVNpixels](https://github.com/FunkinCrew/Funkin/pull/2873)) -- Fixed an issue causing the song to majorly desync sometimes ([community fix by Burgerballs](https://github.com/FunkinCrew/Funkin/pull/3058)) -- Fixed an issue where the Freeplay song preview would not respect the instrumental ID specified in the song metadata ([community fix by AppleHair](https://github.com/FunkinCrew/Funkin/pull/2742)) -- Fixed an issue where Tankman's icon wouldn't display in the Chart Editor ([community fix by Hundrec](https://github.com/FunkinCrew/Funkin/pull/2912)) -- Fixed an issue where pausing the game during a camera zoom would zoom the pause menu. ([community fix by gamerbross](https://github.com/FunkinCrew/Funkin/pull/2567)) -- Fixed an issue where certain UI elements would not flash at a consistent rate ([community fix by cyn0x8](https://github.com/FunkinCrew/Funkin/pull/2494)) -- Fixed an issue where the game would not use the placeholder health icon as a fallback ([community fix by gamerbross](https://github.com/FunkinCrew/Funkin/pull/3005)) -- Fixed an issue where the chart editor could get stuck creating a hold note when using Live Inputs ([community fix by gamerbross](https://github.com/FunkinCrew/Funkin/pull/2992)) -- Fixed an issue where character graphics could not be placed in week folders ([community fix by 7oltan](https://github.com/FunkinCrew/Funkin/pull/3035)) -- Fixed a crash issue when a Freeplay song has no `Normal` difficulty ([community fix by AppleHair](https://github.com/FunkinCrew/Funkin/pull/3036) and [gamerbross](https://github.com/FunkinCrew/Funkin/pull/2712)) -- Fixed an issue in Story Mode where a song that isn't valid for the current variation could be selected ([community fix by AppleHair](https://github.com/FunkinCrew/Funkin/pull/3037)) +- Songs with no notes no longer crash on the Results screen. +- Note inputs are no longer accepted during the Thorns cutscene. +- The old icon easter egg now works properly on pixel levels. +- The Heart icon is no longer malformed when favoriting a song in Freeplay. +- Freeplay songs with no `Normal` difficulty no longer crash the game ([community fix by AppleHair](https://github.com/FunkinCrew/Funkin/pull/3036) and [gamerbross](https://github.com/FunkinCrew/Funkin/pull/2712)) +- Songs that aren't valid for the current variation can no longer be selected ([community fix by AppleHair](https://github.com/FunkinCrew/Funkin/pull/3037)) +- The Freeplay song preview now respects the instrumental ID specified in the song metadata ([community fix by AppleHair](https://github.com/FunkinCrew/Funkin/pull/2742)) +- Modded songs now play previews in the Freeplay menu ([community fix by KarimAkra](https://github.com/FunkinCrew/Funkin/pull/2724)) +- The Story Mode menu can now be scrolled using the mouse wheel ([community fix by JVNpixels](https://github.com/FunkinCrew/Funkin/pull/2873)) +- Pressing F5 after seeing the sticker transition no longer crashes the game ([community fix by gamerbross](https://github.com/FunkinCrew/Funkin/pull/2863)) +- Pausing the game during a camera zoom no longer zooms the pause menu as well ([community fix by gamerbross](https://github.com/FunkinCrew/Funkin/pull/2567)) +- The song no longer majorly desyncs at times ([community fix by Burgerballs](https://github.com/FunkinCrew/Funkin/pull/3058)) +- Pico's death animation no longer displays a faint blue background ([community fix by doggogit](https://github.com/FunkinCrew/funkin.assets/pull/1)) +- The game now uses the placeholder health icon as a fallback ([community fix by gamerbross](https://github.com/FunkinCrew/Funkin/pull/3005)) +- Pressing the Chart Editor keybind while playtesting a chart no longer resets the Chart Editor ([community fix by gamerbross](https://github.com/FunkinCrew/Funkin/pull/2739)) +- The Chart Editor no longer gets stuck creating a hold note when using Live Inputs ([community fix by gamerbross](https://github.com/FunkinCrew/Funkin/pull/2992)) +- Tankman's icon now displays in the Chart Editor ([community fix by Hundrec](https://github.com/FunkinCrew/Funkin/pull/2912)) +- The Memory Usage counter no longer overflows and displays a negative number ([community fix by KarimAkra](https://github.com/FunkinCrew/Funkin/pull/2713)) +- Certain UI elements now flash at a consistent rate ([community fix by cyn0x8](https://github.com/FunkinCrew/Funkin/pull/2494)) +- Character graphics can now be placed in week folders ([community fix by 7oltan](https://github.com/FunkinCrew/Funkin/pull/3035)) ## New Contributors for 0.5.0 @@ -270,7 +270,7 @@ This patch resolves a critical issue which could cause user's save data to becom which would remove their rank if they had a lower one. - A-Bot speaker now reacts to the user's volume preference on desktop ([thanks to M7theguy for the issue report/suggestion](https://github.com/FunkinCrew/Funkin/issues/2744)!) - On Freeplay, heart icons are shifted to the right when you favorite a song that has no rank on it. -- Only play `scrollMenu` sound effect when there's a real change on the freeplay menu ([thanks gamerbross for the PR!](https://github.com/FunkinCrew/Funkin/pull/2741)) +- Only play `scrollMenu` sound effect when there's a real change on the Freeplay menu ([thanks gamerbross for the PR!](https://github.com/FunkinCrew/Funkin/pull/2741)) - Gave antialiasing to the edge of the dad graphic on Freeplay - Rearranged some controls in the controls menu - Made several chart revisions @@ -280,17 +280,17 @@ which would remove their rank if they had a lower one. ### Fixed -- Fixed an issue in the controls menu where some control binds would overlap their names -- Fixed crash when attempting to exit the gameover screen when also attempting to retry the song ([thanks DMMaster636 for the PR!](https://github.com/FunkinCrew/Funkin/pull/2709)) -- Fix botplay sustain release bug ([thanks Hundrec!](https://github.com/FunkinCrew/Funkin/pull/2683)) -- Fix for the camera not pausing during a gameplay pause ([thanks gamerbross!](https://github.com/FunkinCrew/Funkin/pull/2684)) -- Fixed issue where Pico's gameplay sprite would unintentionally appear on the gameover screen when dying on 2hot from an explosion -- Freeplay previews properly fade volume during the BF idle animation -- Fixed bug where DadBattle incorrectly appeared as DadBattle Erect when returning to freeplay on Hard -- Fixed 2hot not appearing under the "#" category in Freeplay menu -- Fixed a bug where the Chart Editor would crash when attempting to select an event with the Event toolbox open -- Improved offsets for Pico and Tankman opponents so they don't slide around as much. -- Fixed the black "temp" graphic on freeplay from being incorrectly sized / masked, now it's identical to the dad freeplay graphic +- Control binds in the controls menu no longer overlap their names +- Attempting to exit the gameover screen and retry the song at the same time no longer crashes the game ([thanks DMMaster636 for the PR!](https://github.com/FunkinCrew/Funkin/pull/2709)) +- Botplay mode now handles the player's animations properly during hold notes ([thanks Hundrec!](https://github.com/FunkinCrew/Funkin/pull/2683)) +- Camera movement now pauses when the game is paused ([thanks Matriculaso!](https://github.com/FunkinCrew/Funkin/pull/2684)) +- Pico's gameplay sprite no longer appears on the gameover screen when dying from an explosion in 2hot +- Freeplay previews now properly fade in volume during the BF idle animation +- DadBattle no longer incorrectly appears as DadBattle Erect when returning to Freeplay on Hard +- 2hot now appears under the "#" category in Freeplay menu +- The Chart Editor no longer crashes when selecting an event with the Event toolbox open +- Improved offsets for Pico and Tankman opponents so they don't slide around as much +- The black "temp" graphic in Freeplay is now correctly sized/masked, now it's identical to the Dad Freeplay graphic ## New Contributors for 0.4.1 @@ -334,26 +334,26 @@ which would remove their rank if they had a lower one. ### Fixed -- Fixed an issue where Nene's visualizer would not play on Desktop builds -- Fixed a bug where the game would silently fail to load saves on HTML5 -- Fixed some bugs with the props on the Story Menu not bopping properly -- Additional fixes to the Loading bar on HTML5 ([thanks lemz1!](https://github.com/FunkinCrew/Funkin/pull/2553)) +- Nene's visualizer now plays on Desktop builds +- The game no longer silently fails to load saves on HTML5 +- Props on the Story Menu now bop properly +- Additional fixes for the loading bar on HTML5 ([thanks lemz1!](https://github.com/FunkinCrew/Funkin/pull/2553)) - Fixed several bugs with the TitleState, including missing music when returning from the Main Menu ([thanks gamerbross!](https://github.com/FunkinCrew/Funkin/pull/2539)) -- Fixed a camera bug in the Main Menu ([thanks richTrash21!](https://github.com/FunkinCrew/Funkin/pull/2576)) -- Fixed a bug where changing difficulties in Story mode wouldn't update the score ([thanks sector-a!](https://github.com/FunkinCrew/Funkin/pull/2585)) +- The Main Menu camera now properly follows the selected item ([thanks richTrash21!](https://github.com/FunkinCrew/Funkin/pull/2576)) +- Changing difficulties in Story Mode now updates the score text ([thanks sector-a!](https://github.com/FunkinCrew/Funkin/pull/2585)) - Fixed a crash in Freeplay caused by a level referencing an invalid song ([thanks gamerbross!](https://github.com/FunkinCrew/Funkin/pull/2457)) -- Fixed a bug where pressing the volume keys would stop the Toy commercial ([thanks gamerbross!](https://github.com/FunkinCrew/Funkin/pull/2540)) -- Fixed a bug where the Chart Editor Playtest would crash when losing ([thanks gamerbross!](https://github.com/FunkinCrew/Funkin/pull/2518)) -- Fixed a bug where hold notes would display improperly in the Chart Editor when downscroll was enabled for gameplay ([thanks gamerbross!](https://github.com/FunkinCrew/Funkin/pull/2565)) -- Fixed a bug where hold notes would be positioned wrong on downscroll ([thanks MaybeMaru!](https://github.com/FunkinCrew/Funkin/pull/2488)) +- Pressing the volume keys no longer stops the Toy commercial ([thanks gamerbross!](https://github.com/FunkinCrew/Funkin/pull/2540)) +- Playtesting in the Chart Editor no longer crashes when losing ([thanks gamerbross!](https://github.com/FunkinCrew/Funkin/pull/2518)) +- Hold notes now display properly in the Chart Editor when downscroll is enabled for gameplay ([thanks gamerbross!](https://github.com/FunkinCrew/Funkin/pull/2565)) +- Hold notes are now positioned correctly with downscroll enabled ([thanks MaybeMaru!](https://github.com/FunkinCrew/Funkin/pull/2488)) - Removed a large number of unused imports to optimize builds ([thanks Ethan-makes-music!](https://github.com/FunkinCrew/Funkin/pull/2624)) - Improved debug logging for unscripted stages ([thanks gamerbross!](https://github.com/FunkinCrew/Funkin/pull/2603)) - Fixed a crash on Linux caused by an old version of hxCodec ([thanks Noobz4Life!](https://github.com/FunkinCrew/Funkin/pull/2472)) - Optimized animation handling for characters ([thanks richTrash21!](https://github.com/FunkinCrew/Funkin/pull/2493)) +- The Chart Editor no longer uses an incorrect instrumental on imported Legacy songs ([thanks gamerbross!](https://github.com/FunkinCrew/Funkin/pull/2604)) +- Opening the game from the command line no longer crashes the preloader ([thanks NotHyper-474!](https://github.com/FunkinCrew/Funkin/pull/2629)) +- Characters no longer use the wrong scale value sometimes ([thanks PurSnake!](https://github.com/FunkinCrew/Funkin/pull/2610)) - Made improvements to compiling documentation (thanks gedehari!) -- Fixed an issue where the Chart Editor would use an incorrect instrumental on imported Legacy songs ([thanks gamerbross!](https://github.com/FunkinCrew/Funkin/pull/2604)) -- Fixed a bug where opening the game from the command line would crash the preloader ([thanks NotHyper-474!](https://github.com/FunkinCrew/Funkin/pull/2629)) -- Fixed a bug where characters would sometimes use the wrong scale value ([thanks PurSnake!](https://github.com/FunkinCrew/Funkin/pull/2610)) - Additional bug fixes and optimizations. ## New Contributors for 0.4.0 @@ -376,21 +376,21 @@ which would remove their rank if they had a lower one. ### Fixed -- Fixes to the Loading bar on HTML5 ([thanks lemz1!](https://github.com/FunkinCrew/Funkin/pull/2499)) -- Don't allow any more inputs when exiting freeplay ([thanks gamerbross!](https://github.com/FunkinCrew/Funkin/pull/2470)) -- Fixed using mouse wheel to scroll on freeplay ([thanks JugieNoob!](https://github.com/FunkinCrew/Funkin/pull/2466)) -- Fixed the resets of the health icons, score, and notes when re-entering gameplay from gameover ([thanks ImCodist!](https://github.com/FunkinCrew/Funkin/pull/2390)) -- Fixed the chart editor character selector's hitbox width ([thanks MadBear422!](https://github.com/FunkinCrew/Funkin/pull/2370)) +- Fixes for the Loading bar on HTML5 ([thanks lemz1!](https://github.com/FunkinCrew/Funkin/pull/2499)) +- Don't allow inputs when exiting Freeplay ([thanks gamerbross!](https://github.com/FunkinCrew/Funkin/pull/2470)) +- Fixed mouse wheel scrolling in Freeplay ([thanks JugieNoob!](https://github.com/FunkinCrew/Funkin/pull/2466)) +- Health icons, score, and notes now reset properly when re-entering gameplay from gameover ([thanks ImCodist!](https://github.com/FunkinCrew/Funkin/pull/2390)) +- Fixed the character selector's hitbox width in the Chart Editor ([thanks MadBear422!](https://github.com/FunkinCrew/Funkin/pull/2370)) - Fixed camera stutter once a wipe transition to the Main Menu completes ([thanks ImCodist!](https://github.com/FunkinCrew/Funkin/pull/2315)) -- Fixed an issue where hold note would be invisible for a single frame ([thanks ImCodist!](https://github.com/FunkinCrew/Funkin/pull/2309)) -- Fix tween accumulation on title screen when pressing Y multiple times ([thanks TheGaloXx!](https://github.com/FunkinCrew/Funkin/pull/2300)) -- Fix a crash when querying FlxG.state in the crash handler -- Fix for a game over easter egg so you don't accidentally exit it when viewing -- Fix an issue where the Freeplay menu never displays 100% clear -- Fix an issue where Weekend 1 Pico attempted to retrieve a missing asset. -- Fix an issue where duplicate keybinds would be stored, potentially causing a crash +- Hold notes no longer become invisible for a single frame ([thanks ImCodist!](https://github.com/FunkinCrew/Funkin/pull/2309)) +- Tweens no longer accumulate on the Title screen when pressing Y multiple times ([thanks TheGaloXx!](https://github.com/FunkinCrew/Funkin/pull/2300)) +- Fixed a crash when querying FlxG.state in the crash handler +- Fixed a game over easter egg so you don't accidentally exit it when viewing +- The Freeplay menu can now display 100% clear +- Weekend 1 Pico no longer attempts to retrieve a missing asset +- Fixed an issue where duplicate keybinds would be stored, potentially causing a crash - Chart debug key now properly returns you to the previous chart editor session if you were playtesting a chart ([thanks nebulazorua!](https://github.com/FunkinCrew/Funkin/pull/2323)) -- Fix a crash on Freeplay found on AMD graphics cards +- Fixed a crash on Freeplay found on AMD graphics cards ## New Contributors for 0.3.3 @@ -430,7 +430,7 @@ which would remove their rank if they had a lower one. - Fixed an issue where some substate lifecycle events were not being dispatched. - Fixed a crash when trying to load into the Animation Offsets menu with an invalid character. - Fixed an issue where the preloader would spam the logs when it was complete and waiting for user input. -- Should definitely have the fix for freeplay where it stops taking control of the main menu below it +- Should definitely have the fix for Freeplay where it stops taking control of the main menu below it - Changed the code for the story menu difficulties so that "normal" doesn't overlap the arrows after leaving Weekend 1 ### Removed @@ -446,17 +446,17 @@ which would remove their rank if they had a lower one. - Added whether the local Git repo was modified to the log files. - Removed "PROTOTYPE" text on release builds only (it still shows on debug builds). - Added additional credits and special thanks. -- Updated peepo in creds to peepo173 +- Updated peepo in creds to peepo173. ### Fixed -- Fix a crash when retrieving system specs while handing a crash. -- Fix a crash triggered when pausing before the song started. -- Fix a crash triggered when dying before the song started. -- Fix a crash triggered when unloading certain graphics. -- Pico game over confirm plays correctly -- When exiting from a song into freeplay, main menu no longer takes inputs unintentionally (aka issues with merch links opening up when selecting songs) -- Fix for arrow keys causing web browser page scroll +- Fixed a crash when retrieving system specs while handing a crash. +- Fixed a crash triggered when pausing before the song starts. +- Fixed a crash triggered when dying before the song starts. +- Fixed a crash triggered when unloading certain graphics. +- Pico game over confirm now plays correctly. +- When exiting from a song into Freeplay, main menu no longer takes inputs unintentionally (aka issues with merch links opening up when selecting songs). +- Arrow keys no longer cause the web browser page to scroll. ## [0.3.0] - 2024-04-30 @@ -465,10 +465,10 @@ which would remove their rank if they had a lower one. - New Story Level: Weekend 1, starting Pico, Darnell, and Nene. - Beat the level in Story Mode to unlock the songs for Freeplay! -- 12 new Erect remixes, featuring Kawai Sprite, Saruky, Kohta Takahashi, and Saster +- 12 new Erect remixes, featuring Kawai Sprite, Saruky, Kohta Takahashi, and Saster. - Unlocked instantly in Freeplay - New visually enhanced Freeplay menu. - - Sorting, favorites, and more. + - Sorting, favorites, and more - New Results screen upon completing any song or story level. - New refactored Chart Editor prototype (accessible via `~` in the main menu or `7` in the Play State, rebindable). (VERY EARLY PROTOTYPE. EXPECT BUGS AND CRASHES) - Implemented a new scripting system using HScript (an interpreted language with Haxe-like syntax) for incredible flexibility. From bb8d3ae3dcb88bd9309c0f9a1b36a087694f46d7 Mon Sep 17 00:00:00 2001 From: Hundrec Date: Tue, 11 Mar 2025 09:52:36 -0600 Subject: [PATCH 25/34] Combine those lines Thanks Hyper! --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 13ef473a4..69f79e09b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -11,7 +11,7 @@ This patch resolves a critical issue which could cause user's save data to becom - Fixed a critical issue in which the Stage Editor theme value could not be parsed by older versions of the game, resulting in all save data being destroyed. - Added a check which prevents save data from being loaded if it is corrupted rather than overriding it. -- `optionsStageEditor.theme` in the save data converted from an Enum to a String to fix save data compatibility issues. +- `optionsStageEditor.theme` and `optionsChartEditor.theme` in the save data converted from an Enum to a String to fix save data compatibility issues. - In the future, Enum values should not be used in order to prevent incompatibilities caused by introducing new types to the save data that older versions cannot parse. - `optionsChartEditor.chartEditorLiveInputStyle` in the save data converted from an Enum to a String to fix save data compatibility issues. - Fixed an issue where some publicly distributed builds of the game were debug builds instead of release builds. From 7d80e6657bd01313f1d09d518298866d43c3cfd4 Mon Sep 17 00:00:00 2001 From: Hundrec Date: Tue, 11 Mar 2025 16:15:44 -0600 Subject: [PATCH 26/34] A few more rewordings --- CHANGELOG.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 69f79e09b..201b8081c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -425,13 +425,13 @@ which would remove their rank if they had a lower one. ### Fixed - Fixed a typo in the credits folder (`Custcene` -> `Cutscene`) -- Fixed an issue where health icon transition animations would loop and never finish properly. -- Fixed an issue where video cutscenes flagged as mid-song would crash the game when they finish. -- Fixed an issue where some substate lifecycle events were not being dispatched. -- Fixed a crash when trying to load into the Animation Offsets menu with an invalid character. -- Fixed an issue where the preloader would spam the logs when it was complete and waiting for user input. -- Should definitely have the fix for Freeplay where it stops taking control of the main menu below it -- Changed the code for the story menu difficulties so that "normal" doesn't overlap the arrows after leaving Weekend 1 +- Health icon transition animations now finish properly instead of looping forever. +- Video cutscenes flagged as mid-song no longer crash the game when they finish. +- Substate lifecycle events are now dispatched consistently. +- Trying to load into the Animation Offsets menu with an invalid character no longer crashes the game. +- The preloader no longer spams the logs when it is complete and waiting for user input. +- Should definitely have the fix for Freeplay where it stops taking control of the main menu below it. +- Changed the code for the Story Mode menu difficulties so that "normal" doesn't overlap the arrows after leaving Weekend 1 ### Removed From cef0cbf9d480bc6c0e655b3c111887616df2fe67 Mon Sep 17 00:00:00 2001 From: Hundrec Date: Wed, 12 Mar 2025 01:14:39 -0600 Subject: [PATCH 27/34] Remove docs entries in Changelog + add punctuation --- CHANGELOG.md | 300 ++++++++++++++++++++++++++------------------------- 1 file changed, 155 insertions(+), 145 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 201b8081c..f33ea2bf6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,62 +4,55 @@ All notable changes 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). + + ## [0.5.3] - 2024-10-18 -This patch resolves a critical issue which could cause user's save data to become corrupted. It is recommended that users switch to this version immediately and avoid using version 0.5.2. +This patch resolves a critical issue that could cause user's save data to become corrupted. It is recommended that users switch to this version immediately and avoid using version 0.5.2. ### Fixed - Fixed a critical issue in which the Stage Editor theme value could not be parsed by older versions of the game, resulting in all save data being destroyed. - - Added a check which prevents save data from being loaded if it is corrupted rather than overriding it. -- `optionsStageEditor.theme` and `optionsChartEditor.theme` in the save data converted from an Enum to a String to fix save data compatibility issues. + - Added a check that prevents save data from being loaded if it is corrupted rather than overwriting it. +- Converted `optionsStageEditor.theme`, `optionsChartEditor.theme`, and `optionsChartEditor.chartEditorLiveInputStyle` in the save data from an Enum to a String to fix save data compatibility issues. - In the future, Enum values should not be used in order to prevent incompatibilities caused by introducing new types to the save data that older versions cannot parse. -- `optionsChartEditor.chartEditorLiveInputStyle` in the save data converted from an Enum to a String to fix save data compatibility issues. -- Fixed an issue where some publicly distributed builds of the game were debug builds instead of release builds. + + ## [0.5.2] - 2024-10-11 ### Added -- Added InverseDotsShader that emulates flash selections ([097dbf5](https://github.com/FunkinCrew/Funkin/commit/097dbf5bb4346d431d8ca9f0ec4bc5b5e6f4523f)) - by @ninjamuffin99 -- Added a new reworked Stage Editor ([27a0b44](https://github.com/FunkinCrew/Funkin/pull/3482/commits/27a0b4426f86f04362f97e16e2eff580c9402f34)) - by @KoloInDaCrib in [#3482](https://github.com/FunkinCrew/Funkin/pull/3482) -- Added the `color` attribute to stage prop JSON data to allow them to be tinted without code ([27a0b44](https://github.com/FunkinCrew/Funkin/pull/3482/commits/27a0b4426f86f04362f97e16e2eff580c9402f34)) - by @KoloInDaCrib in [#3482](https://github.com/FunkinCrew/Funkin/pull/3482) -- Added the `angle` attribute to stage prop JSON data to allow them to be rotated without code ([27a0b44](https://github.com/FunkinCrew/Funkin/pull/3482/commits/27a0b4426f86f04362f97e16e2eff580c9402f34)) - by @KoloInDaCrib in [#3482](https://github.com/FunkinCrew/Funkin/pull/3482) -- Added the `blend` attribute to the stage prop JSON data to allow blend modes to be applied without code ([27a0b44](https://github.com/FunkinCrew/Funkin/pull/3482/commits/27a0b4426f86f04362f97e16e2eff580c9402f34)) - by @KoloInDaCrib in [#3482](https://github.com/FunkinCrew/Funkin/pull/3482) - -### Changed - -- (docs) Added link to modding docs in README ([4b54118](https://github.com/FunkinCrew/Funkin/commit/4b54118731e26118111e06558ae4853c577fe4bb)) - by @Cartridge-Man in [#3082](https://github.com/FunkinCrew/Funkin/pull/3082) -- (docs) Deleted Modding.md since we have a separate modding documentation ([a42240e](https://github.com/FunkinCrew/Funkin/commit/a42240e6a595d33034f2c887bf38a350d1fa0f15)) - by @AbnormalPoof in [#3651](https://github.com/FunkinCrew/Funkin/pull/3651) -- (docs) Fixed some misspellings and grammar in code documentation ([2175bea](https://github.com/FunkinCrew/Funkin/commit/2175beaa651e009332202985be4b7eb4ed36e5a4)) - by @Hundrec in [#3477](https://github.com/FunkinCrew/Funkin/pull/3477) -- (docs) Improvements to GitHub Issue templates ([399869c](https://github.com/FunkinCrew/Funkin/commit/399869cdccc9c5ac27cecfbcdc33c3d7eb4b348c)) - by @Hundrec in [#3458](https://github.com/FunkinCrew/Funkin/pull/3458) -- (docs) Created a git cliff template for easier changelog stuff ([91b4544](https://github.com/FunkinCrew/Funkin/commit/91b4544f7ebc51485e3e28c3d716ba6ee69ad885)) - by @ninjamuffin99 in [#3652](https://github.com/FunkinCrew/Funkin/pull/3652) -- (docs) Added additional `variation` input parameter to `Save.hasBeatenSong()` to allow usage of the function by inputting a variation id ([4fa9a0d](https://github.com/FunkinCrew/Funkin/commit/4fa9a0daaa67e0977460b147bd1f74a118e3e2a5)) - by @ninjamuffin99 in [#3506](https://github.com/FunkinCrew/Funkin/pull/3506) +- Added InverseDotsShader that emulates flash selections. ([097dbf5](https://github.com/FunkinCrew/Funkin/commit/097dbf5bb4346d431d8ca9f0ec4bc5b5e6f4523f)) - by @ninjamuffin99 +- Added a new reworked Stage Editor. ([27a0b44](https://github.com/FunkinCrew/Funkin/pull/3482/commits/27a0b4426f86f04362f97e16e2eff580c9402f34)) - by @KoloInDaCrib in [#3482](https://github.com/FunkinCrew/Funkin/pull/3482) +- Added the `color` attribute to stage prop JSON data to allow them to be tinted without code. ([27a0b44](https://github.com/FunkinCrew/Funkin/pull/3482/commits/27a0b4426f86f04362f97e16e2eff580c9402f34)) - by @KoloInDaCrib in [#3482](https://github.com/FunkinCrew/Funkin/pull/3482) +- Added the `angle` attribute to stage prop JSON data to allow them to be rotated without code. ([27a0b44](https://github.com/FunkinCrew/Funkin/pull/3482/commits/27a0b4426f86f04362f97e16e2eff580c9402f34)) - by @KoloInDaCrib in [#3482](https://github.com/FunkinCrew/Funkin/pull/3482) +- Added the `blend` attribute to the stage prop JSON data to allow blend modes to be applied without code. ([27a0b44](https://github.com/FunkinCrew/Funkin/pull/3482/commits/27a0b4426f86f04362f97e16e2eff580c9402f34)) - by @KoloInDaCrib in [#3482](https://github.com/FunkinCrew/Funkin/pull/3482) ### Fixed -- Input offsets no longer cause songs to stutter or skip ([410cfe9](https://github.com/FunkinCrew/Funkin/commit/410cfe972d6df9de4d4d128375cf8380c4f06d92)) - by @KoloInDaCrib in [#3546](https://github.com/FunkinCrew/Funkin/pull/3546) -- Exiting the Input Offset menu no longer crashes the game ([39b1a42](https://github.com/FunkinCrew/Funkin/commit/39b1a42cfeafe2b7be8b66e2fe529e853d9ae197)) - by @lemz1 in [#3493](https://github.com/FunkinCrew/Funkin/pull/3493) -- Pico's songs now display properly in the Freeplay Menu ([1d2bd61](https://github.com/FunkinCrew/Funkin/commit/1d2bd61119e5f418df7f11d7ef2a0fdedee17d3d)) - by @ninjamuffin99 in [#3506](https://github.com/FunkinCrew/Funkin/pull/3506) -- Fixed issues with variation/difficulty loading for Freeplay Menu which caused some songs to disappear ([c0314c8](https://github.com/FunkinCrew/Funkin/commit/c0314c85ecd5116641aff3de8e9153f7fe48e79c)) - by @ninjamuffin99 in [#3506](https://github.com/FunkinCrew/Funkin/pull/3506) -- `Song.getFirstValidVariation()` now properly takes into account multiple variation/difficulty inputs ([d2e2987](https://github.com/FunkinCrew/Funkin/commit/d2e29879fe2acc6febfe0f335f655b741d630c34)) - by @ninjamuffin99 in [#3506](https://github.com/FunkinCrew/Funkin/pull/3506) -- Song previews no longer restart when changing difficulties within the same variation ([903b3fc](https://github.com/FunkinCrew/Funkin/commit/903b3fc59905a70802618a1cd67407722ea956ed)) - by @KoloInDaCrib in [#3587](https://github.com/FunkinCrew/Funkin/pull/3587) -- Main menu music no longer cuts out when switching states ([711e0a6](https://github.com/FunkinCrew/Funkin/commit/711e0a6b7547eb04113e9318dab900f01ad576a5)) - by @EliteMasterEric in [#3530](https://github.com/FunkinCrew/Funkin/pull/3530) -- Centered preloader 'fnf' and 'dsp' text so they don't clip anymore ([165ad60](https://github.com/FunkinCrew/Funkin/commit/165ad6015539a295e9eefdaef291c312e9566b26)) - by @Burgerballs in [#3567](https://github.com/FunkinCrew/Funkin/pull/3567) -- FPS setting in options menu no longer flickers when selected ([b2647fe](https://github.com/FunkinCrew/Funkin/commit/b2647fe09f5281ce7074b26d47bc1524764168ee)) - by @lemz1 in [#3629](https://github.com/FunkinCrew/Funkin/pull/3629) -- Volume sound tray is now anti-aliased/smoothed ([e66290c](https://github.com/FunkinCrew/Funkin/commit/e66290c55f7141402223644f06ec8a69edeee089)) - by @Kn1ghtNight in [#2853](https://github.com/FunkinCrew/Funkin/pull/2853) -- Fixed looping animations for modded StrumlineNote sprites ([bc546e8](https://github.com/FunkinCrew/Funkin/commit/bc546e86aa77ffc795b3f079de5f590289a9c583)) - by @DaWaterMalone in [#3577](https://github.com/FunkinCrew/Funkin/pull/3577) -- Stopped allowing inputs after selecting a character in Character Select ([dbf66ac](https://github.com/FunkinCrew/Funkin/commit/dbf66ac250137262866d75f7c1387645b35d88d0)) - by @ACrazyTown in [#3398](https://github.com/FunkinCrew/Funkin/pull/3398) -- The player and girlfriend no longer disappear or overlap themselves in Character Select ([9324359](https://github.com/FunkinCrew/Funkin/commit/9324359d2fce6a7097077d169a0efcd80e6fefa1)) - by @gamerbross in [#3457](https://github.com/FunkinCrew/Funkin/pull/3457) -- The player no longer enters twice after entering Character Select or when spamming buttons ([30a9887](https://github.com/FunkinCrew/Funkin/commit/30a98871367b494c85934cd3fcfa91eeb774a7d5)) - by @gamerbross in [#3457](https://github.com/FunkinCrew/Funkin/pull/3457) -- The wrong girlfriend no longer appears in Character Select ([9324359](https://github.com/FunkinCrew/Funkin/commit/9324359d2fce6a7097077d169a0efcd80e6fefa1)) - by @gamerbross in [#3457](https://github.com/FunkinCrew/Funkin/pull/3457) -- Cursor now updates properly when moving and selecting in Character Select ([9324359](https://github.com/FunkinCrew/Funkin/commit/9324359d2fce6a7097077d169a0efcd80e6fefa1)) - by @gamerbross in [#3457](https://github.com/FunkinCrew/Funkin/pull/3457) -- Cursor now moves properly at lower framerates in Character Select ([ab5bda3](https://github.com/FunkinCrew/Funkin/commit/ab5bda3ee573a6e03595ec6941e6de38df851889)) - by @ninjamuffin99 in [#3507](https://github.com/FunkinCrew/Funkin/pull/3507) -- Exiting the Chart Editor no longer crashes the game ([f52472a](https://github.com/FunkinCrew/Funkin/commit/f52472a4767388b22cfbab0f5f7860f6e6762856)) - by @EliteMasterEric and @ianharrigan in [#3519](https://github.com/FunkinCrew/Funkin/pull/3519) -- The millisecond counter in the Chart Editor playbar is now properly formatted ([f1b6e6c](https://github.com/FunkinCrew/Funkin/commit/f1b6e6c4e42455e0c2900d738ebc24893f2479a0)) - by @afreetoplaynoob in [#3537](https://github.com/FunkinCrew/Funkin/pull/3537) -- Pressing F1 multiple times no longer creates more than one help window in the Chart Editor ([777978f](https://github.com/FunkinCrew/Funkin/commit/777978f5a544e1b7c89b47dcc365f734eb6d0df1)) - by @amyspark-ng in [#3552](https://github.com/FunkinCrew/Funkin/pull/3552) -- The dialog box now shows up in the Animation Editor ([1fde59f](https://github.com/FunkinCrew/Funkin/commit/1fde59f999eac94eb10fc22094885de2f5310705)) - by @EliteMasterEric in [#3530](https://github.com/FunkinCrew/Funkin/pull/3530) -- (debug) No more fullscreening when typing "F" in the flixel debugger console ([29b6763](https://github.com/FunkinCrew/Funkin/commit/29b6763290df05d42039806f3d142740568c80f0)) - by @ninjamuffin99 -- Added additional classes to Polymod blacklist for security ([b0b73c8](https://github.com/FunkinCrew/Funkin/commit/b0b73c83994f33118c6a69550da9ec8ec1c07adc)) - by @EliteMasterEric in [#3558](https://github.com/FunkinCrew/Funkin/pull/3558) +- Input offsets no longer cause songs to stutter or skip. ([410cfe9](https://github.com/FunkinCrew/Funkin/commit/410cfe972d6df9de4d4d128375cf8380c4f06d92)) - by @KoloInDaCrib in [#3546](https://github.com/FunkinCrew/Funkin/pull/3546) +- Exiting the Input Offset menu no longer crashes the game. ([39b1a42](https://github.com/FunkinCrew/Funkin/commit/39b1a42cfeafe2b7be8b66e2fe529e853d9ae197)) - by @lemz1 in [#3493](https://github.com/FunkinCrew/Funkin/pull/3493) +- Pico's songs now display properly in the Freeplay Menu. ([1d2bd61](https://github.com/FunkinCrew/Funkin/commit/1d2bd61119e5f418df7f11d7ef2a0fdedee17d3d)) - by @ninjamuffin99 in [#3506](https://github.com/FunkinCrew/Funkin/pull/3506) +- Fixed issues with variation/difficulty loading for Freeplay Menu which caused some songs to disappear. ([c0314c8](https://github.com/FunkinCrew/Funkin/commit/c0314c85ecd5116641aff3de8e9153f7fe48e79c)) - by @ninjamuffin99 in [#3506](https://github.com/FunkinCrew/Funkin/pull/3506) +- `Song.getFirstValidVariation()` now properly takes into account multiple variation/difficulty inputs. ([d2e2987](https://github.com/FunkinCrew/Funkin/commit/d2e29879fe2acc6febfe0f335f655b741d630c34)) - by @ninjamuffin99 in [#3506](https://github.com/FunkinCrew/Funkin/pull/3506) +- Song previews no longer restart when changing difficulties within the same variation. ([903b3fc](https://github.com/FunkinCrew/Funkin/commit/903b3fc59905a70802618a1cd67407722ea956ed)) - by @KoloInDaCrib in [#3587](https://github.com/FunkinCrew/Funkin/pull/3587) +- Main menu music no longer cuts out when switching states. ([711e0a6](https://github.com/FunkinCrew/Funkin/commit/711e0a6b7547eb04113e9318dab900f01ad576a5)) - by @EliteMasterEric in [#3530](https://github.com/FunkinCrew/Funkin/pull/3530) +- Centered preloader 'fnf' and 'dsp' text so they don't clip anymore. ([165ad60](https://github.com/FunkinCrew/Funkin/commit/165ad6015539a295e9eefdaef291c312e9566b26)) - by @Burgerballs in [#3567](https://github.com/FunkinCrew/Funkin/pull/3567) +- FPS setting in options menu no longer flickers when selected. ([b2647fe](https://github.com/FunkinCrew/Funkin/commit/b2647fe09f5281ce7074b26d47bc1524764168ee)) - by @lemz1 in [#3629](https://github.com/FunkinCrew/Funkin/pull/3629) +- Volume sound tray is now anti-aliased/smoothed. ([e66290c](https://github.com/FunkinCrew/Funkin/commit/e66290c55f7141402223644f06ec8a69edeee089)) - by @Kn1ghtNight in [#2853](https://github.com/FunkinCrew/Funkin/pull/2853) +- Fixed looping animations for modded StrumlineNote sprites. ([bc546e8](https://github.com/FunkinCrew/Funkin/commit/bc546e86aa77ffc795b3f079de5f590289a9c583)) - by @DaWaterMalone in [#3577](https://github.com/FunkinCrew/Funkin/pull/3577) +- Stopped allowing inputs after selecting a character in Character Select. ([dbf66ac](https://github.com/FunkinCrew/Funkin/commit/dbf66ac250137262866d75f7c1387645b35d88d0)) - by @ACrazyTown in [#3398](https://github.com/FunkinCrew/Funkin/pull/3398) +- The player and girlfriend no longer disappear or overlap themselves in Character Select. ([9324359](https://github.com/FunkinCrew/Funkin/commit/9324359d2fce6a7097077d169a0efcd80e6fefa1)) - by @gamerbross in [#3457](https://github.com/FunkinCrew/Funkin/pull/3457) +- The player no longer enters twice after entering Character Select or when spamming buttons. ([30a9887](https://github.com/FunkinCrew/Funkin/commit/30a98871367b494c85934cd3fcfa91eeb774a7d5)) - by @gamerbross in [#3457](https://github.com/FunkinCrew/Funkin/pull/3457) +- The wrong girlfriend no longer appears in Character Select. ([9324359](https://github.com/FunkinCrew/Funkin/commit/9324359d2fce6a7097077d169a0efcd80e6fefa1)) - by @gamerbross in [#3457](https://github.com/FunkinCrew/Funkin/pull/3457) +- Cursor now updates properly when moving and selecting in Character Select. ([9324359](https://github.com/FunkinCrew/Funkin/commit/9324359d2fce6a7097077d169a0efcd80e6fefa1)) - by @gamerbross in [#3457](https://github.com/FunkinCrew/Funkin/pull/3457) +- Cursor now moves properly at lower framerates in Character Select. ([ab5bda3](https://github.com/FunkinCrew/Funkin/commit/ab5bda3ee573a6e03595ec6941e6de38df851889)) - by @ninjamuffin99 in [#3507](https://github.com/FunkinCrew/Funkin/pull/3507) +- Exiting the Chart Editor no longer crashes the game. ([f52472a](https://github.com/FunkinCrew/Funkin/commit/f52472a4767388b22cfbab0f5f7860f6e6762856)) - by @EliteMasterEric and @ianharrigan in [#3519](https://github.com/FunkinCrew/Funkin/pull/3519) +- The millisecond counter in the Chart Editor playbar is now properly formatted. ([f1b6e6c](https://github.com/FunkinCrew/Funkin/commit/f1b6e6c4e42455e0c2900d738ebc24893f2479a0)) - by @afreetoplaynoob in [#3537](https://github.com/FunkinCrew/Funkin/pull/3537) +- Pressing F1 multiple times no longer creates more than one help window in the Chart Editor. ([777978f](https://github.com/FunkinCrew/Funkin/commit/777978f5a544e1b7c89b47dcc365f734eb6d0df1)) - by @amyspark-ng in [#3552](https://github.com/FunkinCrew/Funkin/pull/3552) +- The dialog box now shows up in the Animation Editor. ([1fde59f](https://github.com/FunkinCrew/Funkin/commit/1fde59f999eac94eb10fc22094885de2f5310705)) - by @EliteMasterEric in [#3530](https://github.com/FunkinCrew/Funkin/pull/3530) +- (debug) No more fullscreening when typing "F" in the flixel debugger console. ([29b6763](https://github.com/FunkinCrew/Funkin/commit/29b6763290df05d42039806f3d142740568c80f0)) - by @ninjamuffin99 +- Added additional classes to Polymod blacklist for security. ([b0b73c8](https://github.com/FunkinCrew/Funkin/commit/b0b73c83994f33118c6a69550da9ec8ec1c07adc)) - by @EliteMasterEric in [#3558](https://github.com/FunkinCrew/Funkin/pull/3558) ## New Contributors for 0.5.2 @@ -71,6 +64,7 @@ This patch resolves a critical issue which could cause user's save data to becom * @DaWaterMalone made their first contribution in [#3577](https://github.com/FunkinCrew/Funkin/pull/3577) + ## [0.5.1] - 2024-09-30 ### Added @@ -92,19 +86,18 @@ This patch resolves a critical issue which could cause user's save data to becom ### Changed -- The game's mod API version check is now more dynamic. - - The update accepts mods with API version `0.5.0` as well as `0.5.1`. - Pico is no longer unlocked for all players automatically. - You need to beat Weekend 1 in Story Mode in order to unlock him in Character Select. +- The game's mod API version check is now more dynamic. + - The update accepts mods with API version `0.5.0` as well as `0.5.1`. - Removed some of the more spammy `trace()` calls to improve debugging a bit. -- Improved some of the compilation and modding documentation. -- The game now complains if you create a song variation with symbols in the name. +- The game now complains if you create a song variation with symbols in its name. - Switched the force crash keybind from Ctrl-Shift-L to Ctrl-Alt-Shift-L. - Added some additional functions to `funkin.Assets` after `openfl.utils.Assets` had to get blacklisted from scripts. ### Fixed -- Pico is no longer locked every time the game starts, and you no longer have to watch the unlock animation each game boot. +- Pico is no longer locked every time the game starts, so you no longer have to watch the unlock animation each game boot. - The animation should now play only once per save file. - The clear % now displays in Freeplay after switching characters. - Character remixes no longer display the base song's highscore in Freeplay. @@ -160,15 +153,16 @@ This patch resolves a critical issue which could cause user's save data to becom * @Lethrial made their first contribution in [#3356](https://github.com/FunkinCrew/Funkin/pull/3356) + ## [0.5.0] - 2024-09-12 ### Added -- Added a new Character Select screen to switch between playable characters in Freeplay +- Added a new Character Select screen to switch between playable characters in Freeplay. - Modding isn't 100% there but we're working on it! -- Added Pico as a playable character! Unlock him by completing Weekend 1 (if you haven't already done that) - - The songs from Weekend 1 have moved; you must now switch to Pico via Character Select screen in Freeplay to access them -- Added 11 new Pico remixes! Access them by selecting Pico from in the Character Select screen +- Added Pico as a playable character! Unlock him by completing Weekend 1 (if you haven't already done that). + - The songs from Weekend 1 have moved; you must now switch to Pico via Character Select screen in Freeplay to access them. +- Added 11 new Pico remixes! Access them by selecting Pico in the Character Select screen. - Bopeebo (Pico Mix) - Fresh (Pico Mix) - DadBattle (Pico Mix) @@ -180,14 +174,14 @@ This patch resolves a critical issue which could cause user's save data to becom - Eggnog (Pico Mix) - Ugh (Pico Mix) - Guns (Pico Mix) -- Added 1 new Boyfriend remix! Access it by completing Weekend 1 as Pico and then selecting Boyfriend in the Character Select screen +- Added 1 new Boyfriend remix! Access it by completing Weekend 1 as Pico and then selecting Boyfriend in the Character Select screen. - Darnell (BF Mix) -- Added 2 new Erect remixes! Access them by switching difficulty on the song +- Added 2 new Erect remixes! Access them by switching difficulties on the songs. - Cocoa Erect - Ugh Erect -- Implemented support for a new Instrumental Selector in Freeplay - - Beating a Pico remix lets you use that instrumental when playing as Boyfriend -- Added the first batch of Erect Stages! These graphical overhauls of the original stages will be used when playing Erect remixes and Pico remixes +- Implemented support for a new Instrumental Selector in Freeplay. + - Beating a Pico remix lets you use that instrumental when playing as Boyfriend. +- Added the first batch of Erect Stages! These graphical overhauls of the original stages will be used when playing Erect remixes and Pico remixes: - Week 1 Erect Stage - Week 2 Erect Stage - Week 3 Erect Stage @@ -210,17 +204,16 @@ This patch resolves a critical issue which could cause user's save data to becom - Pixel character offsets have been modified to compensate. - Reworked the JSON merging system in Polymod; you can now include JSONPatch files under `_merge` in your mod folder to add, modify, or remove values in a JSON without replacing it entirely! - The `danceEvery` property of characters and stage props can now use values with a precision of `0.25`, to play their idle animation up to four times per beat. -- Characters now respect the `danceEvery` property ([community fix by gamerbross](https://github.com/FunkinCrew/Funkin/pull/2925)) +- Characters now respect the `danceEvery` property. ([community fix by gamerbross](https://github.com/FunkinCrew/Funkin/pull/2925)) - Note style data can now specify custom combo count graphics, judgement graphics, countdown graphics, and countdown audio. ([community feature by anysad](https://github.com/FunkinCrew/Funkin/pull/3020)) - These were previously using hardcoded values based on whether the stage was `school` or `schoolEvil`. -- The YEAH! events in Tutorial now use chart events rather than being hard-coded ([community fix by anysad](https://github.com/FunkinCrew/Funkin/pull/3007)) -- Cutscenes now automatically pause when tabbing out ([community fix by AbnormalPoof](https://github.com/FunkinCrew/Funkin/pull/2903)) -- The F5 function now reloads the current song's chart data from disk ([community feature by gamerbross](https://github.com/FunkinCrew/Funkin/pull/2990)) -- Made several layout improvements and fixes to the Animation Offsets editor in the Debug menu ([community fix by gamerbross](https://github.com/FunkinCrew/Funkin/pull/2820)) -- Animation offsets no longer directly modify the `x` and `y` position of props, which makes props work better with tweens ([community fix by Sword352](https://github.com/FunkinCrew/Funkin/pull/2310)) -- Fixed a bug where the Back sound would be not played when leaving the Story menu and Options menu ([community fix by AppleHair](https://github.com/FunkinCrew/Funkin/pull/2986)) -- The player's Score now displays commas in it (community fix by loggo) -- Refactored the compilation guide and added common troubleshooting steps ([community fix by Hundrec](https://github.com/FunkinCrew/Funkin/pull/2813)) +- The YEAH! events in Tutorial now use chart events rather than being hard-coded. ([community fix by anysad](https://github.com/FunkinCrew/Funkin/pull/3007)) +- Cutscenes now automatically pause when tabbing out. ([community fix by AbnormalPoof](https://github.com/FunkinCrew/Funkin/pull/2903)) +- The F5 function now reloads the current song's chart data from disk. ([community feature by gamerbross](https://github.com/FunkinCrew/Funkin/pull/2990)) +- Made several layout improvements and fixes to the Animation Offsets editor in the Debug menu. ([community fix by gamerbross](https://github.com/FunkinCrew/Funkin/pull/2820)) +- Animation offsets no longer directly modify the `x` and `y` position of props, making props work better with tweens. ([community fix by Sword352](https://github.com/FunkinCrew/Funkin/pull/2310)) +- Fixed a bug where the Back sound would be not played when leaving the Story menu and Options menu. ([community fix by AppleHair](https://github.com/FunkinCrew/Funkin/pull/2986)) +- The player's Score now displays commas in it. (community fix by loggo) ## Fixed @@ -228,22 +221,22 @@ This patch resolves a critical issue which could cause user's save data to becom - Note inputs are no longer accepted during the Thorns cutscene. - The old icon easter egg now works properly on pixel levels. - The Heart icon is no longer malformed when favoriting a song in Freeplay. -- Freeplay songs with no `Normal` difficulty no longer crash the game ([community fix by AppleHair](https://github.com/FunkinCrew/Funkin/pull/3036) and [gamerbross](https://github.com/FunkinCrew/Funkin/pull/2712)) -- Songs that aren't valid for the current variation can no longer be selected ([community fix by AppleHair](https://github.com/FunkinCrew/Funkin/pull/3037)) -- The Freeplay song preview now respects the instrumental ID specified in the song metadata ([community fix by AppleHair](https://github.com/FunkinCrew/Funkin/pull/2742)) -- Modded songs now play previews in the Freeplay menu ([community fix by KarimAkra](https://github.com/FunkinCrew/Funkin/pull/2724)) -- The Story Mode menu can now be scrolled using the mouse wheel ([community fix by JVNpixels](https://github.com/FunkinCrew/Funkin/pull/2873)) -- Pressing F5 after seeing the sticker transition no longer crashes the game ([community fix by gamerbross](https://github.com/FunkinCrew/Funkin/pull/2863)) -- Pausing the game during a camera zoom no longer zooms the pause menu as well ([community fix by gamerbross](https://github.com/FunkinCrew/Funkin/pull/2567)) -- The song no longer majorly desyncs at times ([community fix by Burgerballs](https://github.com/FunkinCrew/Funkin/pull/3058)) -- Pico's death animation no longer displays a faint blue background ([community fix by doggogit](https://github.com/FunkinCrew/funkin.assets/pull/1)) -- The game now uses the placeholder health icon as a fallback ([community fix by gamerbross](https://github.com/FunkinCrew/Funkin/pull/3005)) -- Pressing the Chart Editor keybind while playtesting a chart no longer resets the Chart Editor ([community fix by gamerbross](https://github.com/FunkinCrew/Funkin/pull/2739)) -- The Chart Editor no longer gets stuck creating a hold note when using Live Inputs ([community fix by gamerbross](https://github.com/FunkinCrew/Funkin/pull/2992)) -- Tankman's icon now displays in the Chart Editor ([community fix by Hundrec](https://github.com/FunkinCrew/Funkin/pull/2912)) -- The Memory Usage counter no longer overflows and displays a negative number ([community fix by KarimAkra](https://github.com/FunkinCrew/Funkin/pull/2713)) -- Certain UI elements now flash at a consistent rate ([community fix by cyn0x8](https://github.com/FunkinCrew/Funkin/pull/2494)) -- Character graphics can now be placed in week folders ([community fix by 7oltan](https://github.com/FunkinCrew/Funkin/pull/3035)) +- Freeplay songs with no `Normal` difficulty no longer crash the game. ([community fix by AppleHair](https://github.com/FunkinCrew/Funkin/pull/3036) and [gamerbross](https://github.com/FunkinCrew/Funkin/pull/2712)) +- Songs that aren't valid for the current variation can no longer be selected. ([community fix by AppleHair](https://github.com/FunkinCrew/Funkin/pull/3037)) +- The Freeplay song preview now respects the instrumental ID specified in the song metadata. ([community fix by AppleHair](https://github.com/FunkinCrew/Funkin/pull/2742)) +- Modded songs now play previews in the Freeplay menu. ([community fix by KarimAkra](https://github.com/FunkinCrew/Funkin/pull/2724)) +- The Story Mode menu can now be scrolled using the mouse wheel. ([community fix by JVNpixels](https://github.com/FunkinCrew/Funkin/pull/2873)) +- Pressing F5 after seeing the sticker transition no longer crashes the game. ([community fix by gamerbross](https://github.com/FunkinCrew/Funkin/pull/2863)) +- Pausing the game during a camera zoom no longer zooms the pause menu as well. ([community fix by gamerbross](https://github.com/FunkinCrew/Funkin/pull/2567)) +- The song no longer majorly desyncs at times. ([community fix by Burgerballs](https://github.com/FunkinCrew/Funkin/pull/3058)) +- Pico's death animation no longer displays a faint blue background. ([community fix by doggogit](https://github.com/FunkinCrew/funkin.assets/pull/1)) +- The game now uses the placeholder health icon as a fallback. ([community fix by gamerbross](https://github.com/FunkinCrew/Funkin/pull/3005)) +- Pressing the Chart Editor keybind while playtesting a chart no longer resets the Chart Editor. ([community fix by gamerbross](https://github.com/FunkinCrew/Funkin/pull/2739)) +- The Chart Editor no longer gets stuck creating a hold note when using Live Inputs. ([community fix by gamerbross](https://github.com/FunkinCrew/Funkin/pull/2992)) +- Tankman's icon now displays in the Chart Editor. ([community fix by Hundrec](https://github.com/FunkinCrew/Funkin/pull/2912)) +- The Memory Usage counter no longer overflows and displays a negative number. ([community fix by KarimAkra](https://github.com/FunkinCrew/Funkin/pull/2713)) +- Certain UI elements now flash at a consistent rate. ([community fix by cyn0x8](https://github.com/FunkinCrew/Funkin/pull/2494)) +- Character graphics can now be placed in week folders. ([community fix by 7oltan](https://github.com/FunkinCrew/Funkin/pull/3035)) ## New Contributors for 0.5.0 @@ -257,40 +250,40 @@ This patch resolves a critical issue which could cause user's save data to becom * @7oltan made their first contribution in [#3035](https://github.com/FunkinCrew/Funkin/pull/3035) + ## [0.4.1] - 2024-06-12 ### Added -- Pressing ESCAPE on the title screen on desktop now exits the game, allowing you to exit the game while in fullscreen on desktop +- Pressing ESCAPE on the title screen on desktop now exits the game, allowing you to exit the game while in fullscreen on desktop. - Freeplay menu controls (favoriting and switching categories) are now rebindable from the Options menu, and now have default binds on controllers. ### Changed -- Highscores and ranks are now saved separately, which fixes the issue where people would overwrite their saves with higher scores, -which would remove their rank if they had a lower one. -- A-Bot speaker now reacts to the user's volume preference on desktop ([thanks to M7theguy for the issue report/suggestion](https://github.com/FunkinCrew/Funkin/issues/2744)!) -- On Freeplay, heart icons are shifted to the right when you favorite a song that has no rank on it. -- Only play `scrollMenu` sound effect when there's a real change on the Freeplay menu ([thanks gamerbross for the PR!](https://github.com/FunkinCrew/Funkin/pull/2741)) -- Gave antialiasing to the edge of the dad graphic on Freeplay -- Rearranged some controls in the controls menu -- Made several chart revisions +- Highscores and ranks are now saved separately, fixing an issue where lower ranks would overwrite higher ranks if the player achieved a new highscore. +- A-Bot speaker now reacts to the user's volume preference on desktop. ([thanks to M7theguy for the issue report/suggestion](https://github.com/FunkinCrew/Funkin/issues/2744)!) +- Freeplay heart icons are now shifted to the right when favoriting a song with no rank. +- The `scrollMenu` sound effect now only plays when there's a real change on the Freeplay menu. ([thanks gamerbross for the PR!](https://github.com/FunkinCrew/Funkin/pull/2741)) +- Applied anti-aliasing to the edge of the Freeplay Dad graphic. +- Rearranged some controls in the controls menu. +- Made several chart revisions: - Re-enabled custom camera events in Roses (Erect/Nightmare) - - Tweaked the chart for Lit Up (Hard) - - Corrected the difficulty ratings for M.I.L.F (Easy/Normal/Hard) + - Tweaked chart for Lit Up (Hard) + - Corrected difficulty ratings for M.I.L.F (Easy/Normal/Hard) ### Fixed -- Control binds in the controls menu no longer overlap their names -- Attempting to exit the gameover screen and retry the song at the same time no longer crashes the game ([thanks DMMaster636 for the PR!](https://github.com/FunkinCrew/Funkin/pull/2709)) -- Botplay mode now handles the player's animations properly during hold notes ([thanks Hundrec!](https://github.com/FunkinCrew/Funkin/pull/2683)) -- Camera movement now pauses when the game is paused ([thanks Matriculaso!](https://github.com/FunkinCrew/Funkin/pull/2684)) -- Pico's gameplay sprite no longer appears on the gameover screen when dying from an explosion in 2hot -- Freeplay previews now properly fade in volume during the BF idle animation -- DadBattle no longer incorrectly appears as DadBattle Erect when returning to Freeplay on Hard -- 2hot now appears under the "#" category in Freeplay menu -- The Chart Editor no longer crashes when selecting an event with the Event toolbox open -- Improved offsets for Pico and Tankman opponents so they don't slide around as much -- The black "temp" graphic in Freeplay is now correctly sized/masked, now it's identical to the Dad Freeplay graphic +- Control binds in the controls menu no longer overlap their names. +- Attempting to exit the gameover screen and retry the song at the same time no longer crashes the game. ([thanks DMMaster636 for the PR!](https://github.com/FunkinCrew/Funkin/pull/2709)) +- Botplay mode now handles the player's animations properly during hold notes. ([thanks Hundrec!](https://github.com/FunkinCrew/Funkin/pull/2683)) +- Camera movement now pauses when the game is paused. ([thanks Matriculaso!](https://github.com/FunkinCrew/Funkin/pull/2684)) +- Pico's gameplay sprite no longer appears on the gameover screen when dying from an explosion in 2hot. +- Freeplay previews now properly fade in volume during the BF idle animation. +- DadBattle no longer incorrectly appears as DadBattle Erect when returning to Freeplay on Hard. +- 2hot now appears under the "#" category in Freeplay menu. +- The Chart Editor no longer crashes when selecting an event with the Event toolbox open. +- Improved offsets for Pico and Tankman opponents so they don't slide around as much. +- The black "temp" graphic in Freeplay is now correctly sized/masked, now it's identical to the Dad Freeplay graphic. ## New Contributors for 0.4.1 @@ -298,6 +291,7 @@ which would remove their rank if they had a lower one. * @DMMaster636 made their first contribution in [#2709](https://github.com/FunkinCrew/Funkin/pull/2709) + ## [0.4.0] - 2024-06-06 ### Added @@ -308,11 +302,11 @@ which would remove their rank if they had a lower one. - Freeplay now plays a preview of songs when you hover over them. - Added a Charter field to the chart format, to allow for crediting the creator of a level's chart. - You can see who charted a song from the Pause menu. -- Added a new Scroll Speed chart event to change the note speed mid-song ([thanks Burgerballs!](https://github.com/FunkinCrew/Funkin/pull/2409)) +- Added a new Scroll Speed chart event to change the note speed mid-song. ([thanks Burgerballs!](https://github.com/FunkinCrew/Funkin/pull/2409)) ### Changed -- Tweaked the charts for several songs: +- Tweaked charts for several songs: - Tutorial (increased the note speed slightly) - Spookeez - Monster @@ -334,26 +328,25 @@ which would remove their rank if they had a lower one. ### Fixed -- Nene's visualizer now plays on Desktop builds -- The game no longer silently fails to load saves on HTML5 -- Props on the Story Menu now bop properly -- Additional fixes for the loading bar on HTML5 ([thanks lemz1!](https://github.com/FunkinCrew/Funkin/pull/2553)) -- Fixed several bugs with the TitleState, including missing music when returning from the Main Menu ([thanks gamerbross!](https://github.com/FunkinCrew/Funkin/pull/2539)) -- The Main Menu camera now properly follows the selected item ([thanks richTrash21!](https://github.com/FunkinCrew/Funkin/pull/2576)) -- Changing difficulties in Story Mode now updates the score text ([thanks sector-a!](https://github.com/FunkinCrew/Funkin/pull/2585)) -- Fixed a crash in Freeplay caused by a level referencing an invalid song ([thanks gamerbross!](https://github.com/FunkinCrew/Funkin/pull/2457)) -- Pressing the volume keys no longer stops the Toy commercial ([thanks gamerbross!](https://github.com/FunkinCrew/Funkin/pull/2540)) -- Playtesting in the Chart Editor no longer crashes when losing ([thanks gamerbross!](https://github.com/FunkinCrew/Funkin/pull/2518)) -- Hold notes now display properly in the Chart Editor when downscroll is enabled for gameplay ([thanks gamerbross!](https://github.com/FunkinCrew/Funkin/pull/2565)) -- Hold notes are now positioned correctly with downscroll enabled ([thanks MaybeMaru!](https://github.com/FunkinCrew/Funkin/pull/2488)) -- Removed a large number of unused imports to optimize builds ([thanks Ethan-makes-music!](https://github.com/FunkinCrew/Funkin/pull/2624)) -- Improved debug logging for unscripted stages ([thanks gamerbross!](https://github.com/FunkinCrew/Funkin/pull/2603)) -- Fixed a crash on Linux caused by an old version of hxCodec ([thanks Noobz4Life!](https://github.com/FunkinCrew/Funkin/pull/2472)) -- Optimized animation handling for characters ([thanks richTrash21!](https://github.com/FunkinCrew/Funkin/pull/2493)) -- The Chart Editor no longer uses an incorrect instrumental on imported Legacy songs ([thanks gamerbross!](https://github.com/FunkinCrew/Funkin/pull/2604)) -- Opening the game from the command line no longer crashes the preloader ([thanks NotHyper-474!](https://github.com/FunkinCrew/Funkin/pull/2629)) -- Characters no longer use the wrong scale value sometimes ([thanks PurSnake!](https://github.com/FunkinCrew/Funkin/pull/2610)) -- Made improvements to compiling documentation (thanks gedehari!) +- Nene's visualizer now plays on Desktop builds. +- The game no longer silently fails to load saves on HTML5. +- Props on the Story Menu now bop properly. +- Additional fixes for the loading bar on HTML5. ([thanks lemz1!](https://github.com/FunkinCrew/Funkin/pull/2553)) +- Fixed several bugs with the TitleState, including missing music when returning from the Main Menu. ([thanks gamerbross!](https://github.com/FunkinCrew/Funkin/pull/2539)) +- The Main Menu camera now properly follows the selected item. ([thanks richTrash21!](https://github.com/FunkinCrew/Funkin/pull/2576)) +- Changing difficulties in Story Mode now updates the score text. ([thanks sector-a!](https://github.com/FunkinCrew/Funkin/pull/2585)) +- Fixed a crash in Freeplay caused by a level referencing an invalid song. ([thanks gamerbross!](https://github.com/FunkinCrew/Funkin/pull/2457)) +- Pressing the volume keys no longer stops the Toy commercial. ([thanks gamerbross!](https://github.com/FunkinCrew/Funkin/pull/2540)) +- Playtesting in the Chart Editor no longer crashes when losing. ([thanks gamerbross!](https://github.com/FunkinCrew/Funkin/pull/2518)) +- Hold notes now display properly in the Chart Editor when downscroll is enabled for gameplay. ([thanks gamerbross!](https://github.com/FunkinCrew/Funkin/pull/2565)) +- Hold notes are now positioned correctly with downscroll enabled. ([thanks MaybeMaru!](https://github.com/FunkinCrew/Funkin/pull/2488)) +- Removed a large number of unused imports to optimize builds. ([thanks Ethan-makes-music!](https://github.com/FunkinCrew/Funkin/pull/2624)) +- Improved debug logging for unscripted stages. ([thanks gamerbross!](https://github.com/FunkinCrew/Funkin/pull/2603)) +- Fixed a crash on Linux caused by an old version of hxCodec. ([thanks Noobz4Life!](https://github.com/FunkinCrew/Funkin/pull/2472)) +- Optimized animation handling for characters. ([thanks richTrash21!](https://github.com/FunkinCrew/Funkin/pull/2493)) +- The Chart Editor no longer uses an incorrect instrumental on imported Legacy songs. ([thanks gamerbross!](https://github.com/FunkinCrew/Funkin/pull/2604)) +- Opening the game from the command line no longer crashes the preloader. ([thanks NotHyper-474!](https://github.com/FunkinCrew/Funkin/pull/2629)) +- Characters no longer use the wrong scale value sometimes. ([thanks PurSnake!](https://github.com/FunkinCrew/Funkin/pull/2610)) - Additional bug fixes and optimizations. ## New Contributors for 0.4.0 @@ -368,29 +361,30 @@ which would remove their rank if they had a lower one. * @NotHyper-474 made their first contribution in [#2629](https://github.com/FunkinCrew/Funkin/pull/2629) + ## [0.3.3] - 2024-05-14 ### Changed -- Cleaned up some code in `PlayAnimationSongEvent.hx` ([thanks Burgerballs!](https://github.com/FunkinCrew/Funkin/pull/2308)) +- Cleaned up some code in `PlayAnimationSongEvent.hx`. ([thanks Burgerballs!](https://github.com/FunkinCrew/Funkin/pull/2308)) ### Fixed -- Fixes for the Loading bar on HTML5 ([thanks lemz1!](https://github.com/FunkinCrew/Funkin/pull/2499)) -- Don't allow inputs when exiting Freeplay ([thanks gamerbross!](https://github.com/FunkinCrew/Funkin/pull/2470)) -- Fixed mouse wheel scrolling in Freeplay ([thanks JugieNoob!](https://github.com/FunkinCrew/Funkin/pull/2466)) -- Health icons, score, and notes now reset properly when re-entering gameplay from gameover ([thanks ImCodist!](https://github.com/FunkinCrew/Funkin/pull/2390)) -- Fixed the character selector's hitbox width in the Chart Editor ([thanks MadBear422!](https://github.com/FunkinCrew/Funkin/pull/2370)) -- Fixed camera stutter once a wipe transition to the Main Menu completes ([thanks ImCodist!](https://github.com/FunkinCrew/Funkin/pull/2315)) -- Hold notes no longer become invisible for a single frame ([thanks ImCodist!](https://github.com/FunkinCrew/Funkin/pull/2309)) -- Tweens no longer accumulate on the Title screen when pressing Y multiple times ([thanks TheGaloXx!](https://github.com/FunkinCrew/Funkin/pull/2300)) -- Fixed a crash when querying FlxG.state in the crash handler -- Fixed a game over easter egg so you don't accidentally exit it when viewing -- The Freeplay menu can now display 100% clear -- Weekend 1 Pico no longer attempts to retrieve a missing asset -- Fixed an issue where duplicate keybinds would be stored, potentially causing a crash -- Chart debug key now properly returns you to the previous chart editor session if you were playtesting a chart ([thanks nebulazorua!](https://github.com/FunkinCrew/Funkin/pull/2323)) -- Fixed a crash on Freeplay found on AMD graphics cards +- Fixes for the Loading bar on HTML5. ([thanks lemz1!](https://github.com/FunkinCrew/Funkin/pull/2499)) +- Don't allow inputs when exiting Freeplay. ([thanks gamerbross!](https://github.com/FunkinCrew/Funkin/pull/2470)) +- Fixed mouse wheel scrolling in Freeplay. ([thanks JugieNoob!](https://github.com/FunkinCrew/Funkin/pull/2466)) +- Health icons, score, and notes now reset properly when re-entering gameplay from gameover. ([thanks ImCodist!](https://github.com/FunkinCrew/Funkin/pull/2390)) +- Fixed the character selector's hitbox width in the Chart Editor. ([thanks MadBear422!](https://github.com/FunkinCrew/Funkin/pull/2370)) +- Fixed camera stutter once a wipe transition to the Main Menu completes. ([thanks ImCodist!](https://github.com/FunkinCrew/Funkin/pull/2315)) +- Hold notes no longer become invisible for a single frame. ([thanks ImCodist!](https://github.com/FunkinCrew/Funkin/pull/2309)) +- Tweens no longer accumulate on the Title screen when pressing Y multiple times. ([thanks TheGaloXx!](https://github.com/FunkinCrew/Funkin/pull/2300)) +- Fixed a crash when querying FlxG.state in the crash handler. +- Fixed a game over easter egg so you don't accidentally exit it when viewing. +- The Freeplay menu can now display 100% clear. +- Weekend 1 Pico no longer attempts to retrieve a missing asset. +- Fixed an issue where duplicate keybinds would be stored, potentially causing a crash. +- Chart debug key now properly returns you to the previous chart editor session if you were playtesting a chart. ([thanks nebulazorua!](https://github.com/FunkinCrew/Funkin/pull/2323)) +- Fixed a crash on Freeplay found on AMD graphics cards. ## New Contributors for 0.3.3 @@ -404,6 +398,7 @@ which would remove their rank if they had a lower one. * @lemz1 made their first contribution in [#2499](https://github.com/FunkinCrew/Funkin/pull/2499) + ## [0.3.2] - 2024-05-03 ### Added @@ -412,7 +407,7 @@ which would remove their rank if they had a lower one. - Implemented a blacklist to prevent mods from calling system functions. - Added a couple utility functions to call useful stuff that got blacklisted. - Added an `onSongLoad` script event which allows for mutation of notes and events. -- Added the current loaded modlist to crash logs. +- Added the currently loaded modlist to crash logs. - Added the `visible` attribute to Level JSON data. - Enabled ZIP file system support for Polymod (make sure the metadata is in the root of the ZIP). @@ -420,7 +415,7 @@ which would remove their rank if they had a lower one. - Songs in the mod folders will display in Freeplay without any extra scripting. - Story levels in the mod folders will display in Story without any extra scripting. -- All audio should sound better in HTML5, less muddy +- All audio should sound better in HTML5, less muddy. ### Fixed @@ -431,13 +426,14 @@ which would remove their rank if they had a lower one. - Trying to load into the Animation Offsets menu with an invalid character no longer crashes the game. - The preloader no longer spams the logs when it is complete and waiting for user input. - Should definitely have the fix for Freeplay where it stops taking control of the main menu below it. -- Changed the code for the Story Mode menu difficulties so that "normal" doesn't overlap the arrows after leaving Weekend 1 +- Changed the code for the Story Mode menu difficulties so that "normal" doesn't overlap the arrows after leaving Weekend 1. ### Removed - Removed some unused `.txt` files in the `assets/data` folder. + ## [0.3.1] - 2024-05-01 ### Changed @@ -459,11 +455,12 @@ which would remove their rank if they had a lower one. - Arrow keys no longer cause the web browser page to scroll. + ## [0.3.0] - 2024-04-30 ### Added -- New Story Level: Weekend 1, starting Pico, Darnell, and Nene. +- New Story Level: Weekend 1, starring Pico, Darnell, and Nene. - Beat the level in Story Mode to unlock the songs for Freeplay! - 12 new Erect remixes, featuring Kawai Sprite, Saruky, Kohta Takahashi, and Saster. - Unlocked instantly in Freeplay @@ -499,6 +496,7 @@ which would remove their rank if they had a lower one. - 17 quadrillion bugs across hundreds of PRs. + ## [0.2.8] - 2021-04-18 (note, this one is iffy cuz we slacked wit it lol!) ### Added @@ -520,6 +518,7 @@ which would remove their rank if they had a lower one. - That one random note on Bopeebo + ## [0.2.7.1] - 2021-02-14 ### Added @@ -544,6 +543,7 @@ which would remove their rank if they had a lower one. - Antialiasing on the skyscraper lights + ## [0.2.7] - 2021-02-02 ### Added @@ -564,6 +564,7 @@ which would remove their rank if they had a lower one. - Idle animation bug with BF christmas and BF hair blow sprites ([Thanks to Injourn for the Pull Request!](https://github.com/FunkinCrew/Funkin/pull/237)) + ## [0.2.6] - 2021-01-20 ### Added @@ -593,6 +594,7 @@ which would remove their rank if they had a lower one. - Boyfriend animations on hold notes, and pressing on repeating notes should behave differently + ## [0.2.5] - 2020-12-27 ### Added @@ -617,6 +619,7 @@ which would remove their rank if they had a lower one. - IDK i think backing out of song menu should play main menu songs again hehe ([shoutouts gedehari for the Pull Request!](https://github.com/FunkinCrew/Funkin/pull/48)) + ## [0.2.4] - 2020-12-11 ### Added @@ -635,6 +638,7 @@ which would remove their rank if they had a lower one. - Animation offsets when GF is scared + ## [0.2.3] - 2020-12-04 ### Added @@ -649,6 +653,7 @@ which would remove their rank if they had a lower one. - Fixed tiny note bleed over thingies (shoutouts [lotusotho](https://github.com/FunkinCrew/Funkin/pull/24)) + ## [0.2.2] - 2020-11-20 ### Added @@ -673,6 +678,7 @@ which would remove their rank if they had a lower one. - Animation issue where GF would freak out on the title screen if you returned to it([shoutouts MultiXIII](https://github.com/FunkinCrew/Funkin/issues/12)). + ## [0.2.1.2] - 2020-11-06 ### Fixed @@ -682,6 +688,7 @@ which would remove their rank if they had a lower one. - Hard mode difficulty on campaign levels have been fixed + ## [0.2.1.1] - 2020-11-06 ### Fixed @@ -689,6 +696,7 @@ which would remove their rank if they had a lower one. - Week 2 not unlocking properly + ## [0.2.1] - 2020-11-06 ### Added @@ -709,6 +717,7 @@ which would remove their rank if they had a lower one. - One of the charting bits on South and Spookeez during the intro. + ## [0.2.0] - 2020-11-01 ### Added @@ -716,6 +725,7 @@ which would remove their rank if they had a lower one. - Uhh Newgrounds release lolol I always lose track of shit. + ## [0.1.0] - 2020-10-05 ### Added From 4383fcf32c280a1c0ee7b9c80d255611d497cabc Mon Sep 17 00:00:00 2001 From: Hundrec Date: Fri, 14 Mar 2025 00:14:03 -0600 Subject: [PATCH 28/34] Correctly list all new contributors since Weekend 1 Gives those contributors their credit! Lists all first-time GitHub contributors, even if their change isn't listed as an entry in the Changelog. Quadruple-checked for good measure. --- CHANGELOG.md | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index f33ea2bf6..5754bc43a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -58,7 +58,6 @@ This patch resolves a critical issue that could cause user's save data to become * @Kn1ghtNight made their first contribution in [#2853](https://github.com/FunkinCrew/Funkin/pull/2853) * @Cartridge-Man made their first contribution in [#3082](https://github.com/FunkinCrew/Funkin/pull/3082) -* @KoloInDaCrib made their first contribution in [#3482](https://github.com/FunkinCrew/Funkin/pull/3482) * @afreetoplaynoob made their first contribution in [#3537](https://github.com/FunkinCrew/Funkin/pull/3537) * @amyspark-ng made their first contribution in [#3552](https://github.com/FunkinCrew/Funkin/pull/3552) * @DaWaterMalone made their first contribution in [#3577](https://github.com/FunkinCrew/Funkin/pull/3577) @@ -140,7 +139,7 @@ This patch resolves a critical issue that could cause user's save data to become - The FPS counter no longer displays if Debug Display is turned off. ([community fix by Lethrial](https://github.com/FunkinCrew/Funkin/pull/3356)) - The Chart Editor can now be interacted with properly. ([community fix by Kade-github](https://github.com/FunkinCrew/Funkin/pull/3337)) - Selecting the area to the left of the Chart Editor no longer selects some of the player's notes. ([community fix by NotHyper-474](https://github.com/FunkinCrew/Funkin/pull/3093)) -- Pixel icons now display correctly in the Chart Editor. ([community fix by Techniktil](https://github.com/FunkinCrew/Funkin/pull/3339)) +- Pixel icons now display correctly in the Chart Editor. ([community fix by TechnikTil](https://github.com/FunkinCrew/Funkin/pull/3339)) - Audio offsets now interact with the Chart Editor properly. ([community fix by Kade-github](https://github.com/FunkinCrew/Funkin/pull/3384)) - Players can no longer crash the game by interacting with Character Select during the unlock sequence. ([community fix by ActualMandM](https://github.com/FunkinCrew/Funkin/pull/3355)) - `Stage.addCharacter` now properly assigns the `characterType`. ([community fix by Kade-github](https://github.com/FunkinCrew/Funkin/pull/3357)) @@ -151,6 +150,7 @@ This patch resolves a critical issue that could cause user's save data to become * @dombomb64 made their first contribution in [#3351](https://github.com/FunkinCrew/Funkin/pull/3351) * @Lethrial made their first contribution in [#3356](https://github.com/FunkinCrew/Funkin/pull/3356) +* @KoloInDaCrib made their first contribution in [#3371](https://github.com/FunkinCrew/Funkin/pull/3371) @@ -243,9 +243,11 @@ This patch resolves a critical issue that could cause user's save data to become * @Sword352 made their first contribution in [#2310](https://github.com/FunkinCrew/Funkin/pull/2310) * @cyn0x8 made their first contribution in [#2494](https://github.com/FunkinCrew/Funkin/pull/2494) * @KarimAkra made their first contribution in [#2713](https://github.com/FunkinCrew/Funkin/pull/2713) +* @tposejank made their first contribution in [#2717](https://github.com/FunkinCrew/Funkin/pull/2717) * @AppleHair made their first contribution in [#2742](https://github.com/FunkinCrew/Funkin/pull/2742) * @JVNpixels made their first contribution in [#2873](https://github.com/FunkinCrew/Funkin/pull/2873) * @Flooferland made their first contribution in [#2942](https://github.com/FunkinCrew/Funkin/pull/2942) +* @Punkinator7 made their first contribution in [#2962](https://github.com/FunkinCrew/Funkin/pull/2962) * @anysad made their first contribution in [#3007](https://github.com/FunkinCrew/Funkin/pull/3007) * @7oltan made their first contribution in [#3035](https://github.com/FunkinCrew/Funkin/pull/3035) @@ -287,8 +289,9 @@ This patch resolves a critical issue that could cause user's save data to become ## New Contributors for 0.4.1 -* @Hundrec made their first contribution in [#2683](https://github.com/FunkinCrew/Funkin/pull/2683) +* @Hundrec made their first contribution in [#2661](https://github.com/FunkinCrew/Funkin/pull/2661) * @DMMaster636 made their first contribution in [#2709](https://github.com/FunkinCrew/Funkin/pull/2709) +* @eltociear made their first contribution in [#2730](https://github.com/FunkinCrew/Funkin/pull/2730) @@ -353,12 +356,17 @@ This patch resolves a critical issue that could cause user's save data to become * @Noobz4Life made their first contribution in [#2472](https://github.com/FunkinCrew/Funkin/pull/2472) * @MaybeMaru made their first contribution in [#2488](https://github.com/FunkinCrew/Funkin/pull/2488) +* @NotHyper-474 made their first contribution in [#2490](https://github.com/FunkinCrew/Funkin/pull/2490) * @richTrash21 made their first contribution in [#2493](https://github.com/FunkinCrew/Funkin/pull/2493) +* @TechnikTil made their first contribution in [#2508](https://github.com/FunkinCrew/Funkin/pull/2508) +* @SanicBTW made their first contribution in [#2544](https://github.com/FunkinCrew/Funkin/pull/2544) +* @EnterTheVoid-x86 made their first contribution in [#2573](https://github.com/FunkinCrew/Funkin/pull/2573) * @Keoiki made their first contribution in [#2581](https://github.com/FunkinCrew/Funkin/pull/2581) * @sector-a made their first contribution in [#2585](https://github.com/FunkinCrew/Funkin/pull/2585) * @PurSnake made their first contribution in [#2610](https://github.com/FunkinCrew/Funkin/pull/2610) * @Ethan-makes-music made their first contribution in [#2624](https://github.com/FunkinCrew/Funkin/pull/2624) -* @NotHyper-474 made their first contribution in [#2629](https://github.com/FunkinCrew/Funkin/pull/2629) +* @An-enderman made their first contribution in [#2662](https://github.com/FunkinCrew/Funkin/pull/2662) +* @moondroidcoder made their first contribution in [#2701](https://github.com/FunkinCrew/Funkin/pull/2701) @@ -388,6 +396,7 @@ This patch resolves a critical issue that could cause user's save data to become ## New Contributors for 0.3.3 +* @Chubercik made their first contribution in [#2297](https://github.com/FunkinCrew/Funkin/pull/2297) * @TheGaloXx made their first contribution in [#2300](https://github.com/FunkinCrew/Funkin/pull/2300) * @Burgerballs made their first contribution in [#2308](https://github.com/FunkinCrew/Funkin/pull/2308) * @ImCodist made their first contribution in [#2309](https://github.com/FunkinCrew/Funkin/pull/2309) From 055c4d9b752f9c6a9d9b806f01ce21b95afbe811 Mon Sep 17 00:00:00 2001 From: Lasercar Date: Sun, 23 Feb 2025 16:52:24 +1000 Subject: [PATCH 29/34] Add remaining debug keys --- docs/Funkin' Debug Hotkeys.md | 23 ++++++++++++++++++----- 1 file changed, 18 insertions(+), 5 deletions(-) diff --git a/docs/Funkin' Debug Hotkeys.md b/docs/Funkin' Debug Hotkeys.md index cf85c6c59..0f92170bb 100644 --- a/docs/Funkin' Debug Hotkeys.md +++ b/docs/Funkin' Debug Hotkeys.md @@ -3,6 +3,7 @@ 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! @@ -11,6 +12,9 @@ Most of this functionality is only available on debug builds of the game! - `CTRL-SHIFT-L`: ***FORCE CRASH***: Immediately crash the game with a detailed crash log and a stack trace. +## Loading State +- `SPACE`: Trace callbacks. + ## **Play State** - `H`: ***HIDE UI***: Makes the user interface invisible. Works in Pause Menu, great for screenshots. - `1`: ***END SONG***: Immediately ends the song and moves to Results Screen on Freeplay, or next song on Story Mode. @@ -19,20 +23,29 @@ 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 ON SONG***: Redirect to the chart editor playing the current song. +- `STAGE Hotkey`: ***OPEN STAGE EDITOR ON STAGE***: Open the stage editor overlaying the current state. ## **Freeplay State** -- `F` (Freeplay Menu) - Move to Favorites -- `Q` (Freeplay Menu) - Back one category -- `E` (Freeplay Menu) - Forward one category +- `CTRL-HOLD`: When a song preview is played it will instead play the preview for the first variation available for that song. +- `SHIFT-HOLD`: ***BOTPLAY***: Will enable botplay when a song is started. +- `P`: ***SWITCH TO PICO/BF***: Switch to Pico or BF (reopens Freeplay as the other character). +- `T`: ***TEST RANK***: Test rank the tutorial (/random if the character has no variation for it) with Perfect Gold. +- `CTRL+LEFT`/`RIGHT`/`UP`/`DOWN+SHIFT/ALT`: ***OFFSET BF DJ IN CARTOON STATE***: Offset the BF DJ in the cartoon state by 1 pixel in that direction. `SHIFT` to move 10 pixels, `ALT` to move 0.1 pixels. +- `CTRL+C`: ***SET/UNSET DJ CARTOON***: Set the Freeplay DJ's state to cartoon, or change it back to idle. ## **Title State** -- `Y` - WOAH +- `ESCAPE`: ***QUIT***: Quit the game. +- `D`: COOL +- `UI LEFT`/`UI RIGHT Hotkey`: 2COOL +- `Y`: WOAH ## **Main Menu** +- `SHIFT-HOLD`: ***OPEN FREEPLAY WITH PICO***: Entering freeplay will set the target character to Pico. - `~`: ***DEBUG***: Opens a menu to access the Chart Editor and other work-in-progress editors. Rebindable in the options menu. - `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. \ No newline at end of file +- `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. From b74df06f48400bdb3c23dd27ad69a24b92cfe625 Mon Sep 17 00:00:00 2001 From: Hundrec Date: Fri, 14 Mar 2025 21:09:01 -0600 Subject: [PATCH 30/34] Reword some debug hotkeys --- docs/Funkin' Debug Hotkeys.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/Funkin' Debug Hotkeys.md b/docs/Funkin' Debug Hotkeys.md index 0f92170bb..9c10f060c 100644 --- a/docs/Funkin' Debug Hotkeys.md +++ b/docs/Funkin' Debug Hotkeys.md @@ -23,16 +23,16 @@ 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 ON SONG***: Redirect to the chart editor playing the current song. -- `STAGE Hotkey`: ***OPEN STAGE EDITOR ON STAGE***: Open the stage editor overlaying the current state. +- `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** -- `CTRL-HOLD`: When a song preview is played it will instead play the preview for the first variation available for that song. -- `SHIFT-HOLD`: ***BOTPLAY***: Will enable botplay when a song is started. - `P`: ***SWITCH TO PICO/BF***: Switch to Pico or BF (reopens Freeplay as the other character). -- `T`: ***TEST RANK***: Test rank the tutorial (/random if the character has no variation for it) with Perfect Gold. -- `CTRL+LEFT`/`RIGHT`/`UP`/`DOWN+SHIFT/ALT`: ***OFFSET BF DJ IN CARTOON STATE***: Offset the BF DJ in the cartoon state by 1 pixel in that direction. `SHIFT` to move 10 pixels, `ALT` to move 0.1 pixels. -- `CTRL+C`: ***SET/UNSET DJ CARTOON***: Set the Freeplay DJ's state to cartoon, or change it back to idle. +- `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. +- `CTRL-LEFT`/`RIGHT`/`UP`/`DOWN`: ***OFFSET BF DJ IN CARTOON STATE***: While BF DJ's TV animation is playing, offset the DJ by 1 pixel in the opposite direction. `SHIFT` to move 10 pixels, `ALT` to move 0.1 pixels. +- `CTRL-C`: ***TRIGGER DJ CARTOON***: Play the Freeplay DJ's cartoon animation. Press again to return to its regular animation. ## **Title State** - `ESCAPE`: ***QUIT***: Quit the game. @@ -41,8 +41,8 @@ Most of this functionality is only available on debug builds of the game! - `Y`: WOAH ## **Main Menu** -- `SHIFT-HOLD`: ***OPEN FREEPLAY WITH PICO***: Entering freeplay will set the target character to Pico. - `~`: ***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. From 871709bb7d63963ba5855cd269ef99520c04684c Mon Sep 17 00:00:00 2001 From: Abnormal <86753001+AbnormalPoof@users.noreply.github.com> Date: Wed, 19 Mar 2025 19:43:42 -0500 Subject: [PATCH 31/34] Some additions to the Contributor's Guide Co-authored-by: Hundrec Co-authored-by: Abnormal <86753001+AbnormalPoof@users.noreply.github.com> --- docs/CONTRIBUTING.md | 238 +++++++++++++++++++++++++++++++------------ 1 file changed, 175 insertions(+), 63 deletions(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 13e2e3543..8cf9174af 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -1,6 +1,6 @@ # Contributing Welcome to the Contributing Guide! -You can contribute to the Funkin' repository by opening issues or pull requests. +You can contribute to the Funkin' repository by opening issues or pull requests. This guide will cover best practices for each type of contribution. @@ -11,7 +11,7 @@ This guide will cover best practices for each type of contribution. [Part 1: Etiquette](https://github.com/FunkinCrew/Funkin/blob/main/docs/CONTRIBUTING.md#part-1-etiquette)
-Part 2: Issues +Part 2: Issues * [Requirements](https://github.com/FunkinCrew/Funkin/blob/main/docs/CONTRIBUTING.md#requirements) @@ -24,8 +24,8 @@ This guide will cover best practices for each type of contribution.
- -Part 3: Pull Requests + +Part 3: Pull Requests * [Choosing a base branch](https://github.com/FunkinCrew/Funkin/blob/main/docs/CONTRIBUTING.md#choosing-a-base-branch) @@ -39,6 +39,8 @@ This guide will cover best practices for each type of contribution. * [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) +
[Closing](https://github.com/FunkinCrew/Funkin/blob/main/docs/CONTRIBUTING.md#closing) @@ -54,7 +56,7 @@ This guide will cover best practices for each type of contribution. # 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). +This section provides guidelines to follow when [opening an issue](https://github.com/FunkinCrew/Funkin/issues). ## Requirements Make sure you're playing: @@ -84,7 +86,7 @@ Here's a list of commonly suggested features and the reasons why they won't be a | "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 | +| Lua Support | https://github.com/FunkinCrew/Funkin/issues/2643#issuecomment-2143718093 | ## Issue Types @@ -122,6 +124,9 @@ Also only report one issue or enhancement at a time! If you have multiple bug re 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 @@ -133,6 +138,7 @@ When creating a branch in your fork, base your branch on either the `main` or `d > [!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) @@ -165,85 +171,173 @@ This process reapplies your changes on top of the updated branch and cleanly res > 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). +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. +- 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 Comments +### 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 +/** + * 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 { - // 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 whole 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(); + 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 +/** + * 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) { - 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(); + 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. +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. @@ -297,6 +391,24 @@ If you simultaneously modify files from both repositories, then open two separat 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 **adding/removing notes** or **adjusting the placement of song events**. + +This involves modifying one or several of the `funkin.assets` repository's `.json` chart files, found in the `preload/data/songs/` directory. + +These PRs should only be opened in the `funkin.assets` repository. + +> [!CAUTION] +> **No Major Recharts!** Any PR that makes major chart modifications will be rejected. +> Keep your PRs to small tweaks and fixes. + +Here are some guidelines for opening a Charting PR: +- **Explain the issue.** Which song, variation, difficulty, and section/timestamp is the problem in? Help us understand with screenshots and videos. +- **Show your changes.** How does the chart look with your changes? Provide screenshots and videos here as well. +- **Minimize the diff.** If your changes are very small (e.g. a few notes), do not re-export the chart using the Chart Editor. Instead, manually edit the `.json` chart files to help GitHub display your changes cleanly. + +If your PR is accepted, you will be credited as a GitHub contributor (but not as a charter in the Pause Menu). + # Closing Thank you for reading the Contributing Guide. From 439be3cb2657e7feee4b9b11664aac1246f6d0b0 Mon Sep 17 00:00:00 2001 From: Hundrec Date: Mon, 17 Mar 2025 19:32:41 -0600 Subject: [PATCH 32/34] Update templates and docs to 0.6.0 --- .github/ISSUE_TEMPLATE/bug.yml | 2 +- .github/ISSUE_TEMPLATE/charting.yml | 2 +- .github/ISSUE_TEMPLATE/compiling.yml | 2 +- .github/ISSUE_TEMPLATE/crash.yml | 2 +- docs/CONTRIBUTING.md | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index f6f5c3250..919d6335c 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -46,7 +46,7 @@ body: 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 + placeholder: ex. 0.6.0 validations: required: true diff --git a/.github/ISSUE_TEMPLATE/charting.yml b/.github/ISSUE_TEMPLATE/charting.yml index e86b73c12..aadb897f5 100644 --- a/.github/ISSUE_TEMPLATE/charting.yml +++ b/.github/ISSUE_TEMPLATE/charting.yml @@ -46,7 +46,7 @@ body: 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 + placeholder: ex. 0.6.0 validations: required: true diff --git a/.github/ISSUE_TEMPLATE/compiling.yml b/.github/ISSUE_TEMPLATE/compiling.yml index 6dd9e4cf9..1d049870c 100644 --- a/.github/ISSUE_TEMPLATE/compiling.yml +++ b/.github/ISSUE_TEMPLATE/compiling.yml @@ -34,7 +34,7 @@ body: 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 + placeholder: ex. 0.6.0 validations: required: true diff --git a/.github/ISSUE_TEMPLATE/crash.yml b/.github/ISSUE_TEMPLATE/crash.yml index f315fcc2c..01eeeeeb1 100644 --- a/.github/ISSUE_TEMPLATE/crash.yml +++ b/.github/ISSUE_TEMPLATE/crash.yml @@ -46,7 +46,7 @@ body: 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 + placeholder: ex. 0.6.0 validations: required: true diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 8cf9174af..aa4587967 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -60,7 +60,7 @@ This section provides guidelines to follow when [opening an issue](https://githu ## Requirements Make sure you're playing: -- the latest version of the game (currently v0.5.3) +- the latest version of the game (currently v0.6.0) - without any mods - on [Newgrounds](https://www.newgrounds.com/portal/view/770371) or downloaded from [itch.io](https://ninja-muffin24.itch.io/funkin) From 3ccd1b04da5e7c91d85e1ceb46bc7d52d9722558 Mon Sep 17 00:00:00 2001 From: Hundrec Date: Mon, 31 Mar 2025 14:27:04 -0600 Subject: [PATCH 33/34] Bump repo versions to 0.6.1 --- .github/ISSUE_TEMPLATE/bug.yml | 2 +- .github/ISSUE_TEMPLATE/charting.yml | 2 +- .github/ISSUE_TEMPLATE/compiling.yml | 2 +- .github/ISSUE_TEMPLATE/crash.yml | 2 +- docs/CONTRIBUTING.md | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index 919d6335c..73713df76 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -46,7 +46,7 @@ body: 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.6.0 + placeholder: ex. 0.6.1 validations: required: true diff --git a/.github/ISSUE_TEMPLATE/charting.yml b/.github/ISSUE_TEMPLATE/charting.yml index aadb897f5..aca027bd8 100644 --- a/.github/ISSUE_TEMPLATE/charting.yml +++ b/.github/ISSUE_TEMPLATE/charting.yml @@ -46,7 +46,7 @@ body: 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.6.0 + placeholder: ex. 0.6.1 validations: required: true diff --git a/.github/ISSUE_TEMPLATE/compiling.yml b/.github/ISSUE_TEMPLATE/compiling.yml index 1d049870c..fb5d8f16f 100644 --- a/.github/ISSUE_TEMPLATE/compiling.yml +++ b/.github/ISSUE_TEMPLATE/compiling.yml @@ -34,7 +34,7 @@ body: 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.6.0 + placeholder: ex. 0.6.1 validations: required: true diff --git a/.github/ISSUE_TEMPLATE/crash.yml b/.github/ISSUE_TEMPLATE/crash.yml index 01eeeeeb1..c6135c649 100644 --- a/.github/ISSUE_TEMPLATE/crash.yml +++ b/.github/ISSUE_TEMPLATE/crash.yml @@ -46,7 +46,7 @@ body: 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.6.0 + placeholder: ex. 0.6.1 validations: required: true diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index aa4587967..f87ea574a 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -60,7 +60,7 @@ This section provides guidelines to follow when [opening an issue](https://githu ## Requirements Make sure you're playing: -- the latest version of the game (currently v0.6.0) +- the latest version of the game (currently v0.6.1) - without any mods - on [Newgrounds](https://www.newgrounds.com/portal/view/770371) or downloaded from [itch.io](https://ninja-muffin24.itch.io/funkin) From 3c6466bec7ca4fa006215a2cd3387ff9d8d70ac3 Mon Sep 17 00:00:00 2001 From: Hundrec Date: Mon, 31 Mar 2025 19:18:34 -0600 Subject: [PATCH 34/34] Bump repo versions to 0.6.2 --- .github/ISSUE_TEMPLATE/bug.yml | 2 +- .github/ISSUE_TEMPLATE/charting.yml | 2 +- .github/ISSUE_TEMPLATE/compiling.yml | 2 +- .github/ISSUE_TEMPLATE/crash.yml | 2 +- docs/CONTRIBUTING.md | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index 73713df76..1c82abc2a 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -46,7 +46,7 @@ body: 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.6.1 + placeholder: ex. 0.6.2 validations: required: true diff --git a/.github/ISSUE_TEMPLATE/charting.yml b/.github/ISSUE_TEMPLATE/charting.yml index aca027bd8..810a3778d 100644 --- a/.github/ISSUE_TEMPLATE/charting.yml +++ b/.github/ISSUE_TEMPLATE/charting.yml @@ -46,7 +46,7 @@ body: 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.6.1 + placeholder: ex. 0.6.2 validations: required: true diff --git a/.github/ISSUE_TEMPLATE/compiling.yml b/.github/ISSUE_TEMPLATE/compiling.yml index fb5d8f16f..a3370e3c5 100644 --- a/.github/ISSUE_TEMPLATE/compiling.yml +++ b/.github/ISSUE_TEMPLATE/compiling.yml @@ -34,7 +34,7 @@ body: 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.6.1 + placeholder: ex. 0.6.2 validations: required: true diff --git a/.github/ISSUE_TEMPLATE/crash.yml b/.github/ISSUE_TEMPLATE/crash.yml index c6135c649..04fea1d13 100644 --- a/.github/ISSUE_TEMPLATE/crash.yml +++ b/.github/ISSUE_TEMPLATE/crash.yml @@ -46,7 +46,7 @@ body: 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.6.1 + placeholder: ex. 0.6.2 validations: required: true diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index f87ea574a..6459b98ca 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -60,7 +60,7 @@ This section provides guidelines to follow when [opening an issue](https://githu ## Requirements Make sure you're playing: -- the latest version of the game (currently v0.6.1) +- the latest version of the game (currently v0.6.2) - without any mods - on [Newgrounds](https://www.newgrounds.com/portal/view/770371) or downloaded from [itch.io](https://ninja-muffin24.itch.io/funkin)