Skip to content

Latest commit

 

History

History
90 lines (79 loc) · 4.68 KB

CHANGELOG.md

File metadata and controls

90 lines (79 loc) · 4.68 KB
Raw

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[1.4.1] - 2024-10-04

Changed

  • Fixed an issue where the Hotkey menu couldn't be closed with ESCAPE.
  • Fixed an issue where JSON characters were re-cached everytime the game was hot-reloaded with F5.
  • Cleaned up a lot of the code for charHandler and added comments.

Removed

  • Funker Selector will no longer work on v0.5.0
    • This is due to functions in the code that do not work on v0.5.0.
      • Please use v0.5.1 instead.

[1.4.0] - 2024-09-12

Added

  • v0.5.0 support.
  • You can now have multiple song IDs for Character Variations as an Array.
  • You can now specify a song's variation ID. So you can have character variations for specific song variations.
  • Funker Selector should now work in unison with base game's character select!
    • Example: Selecting Pico (Playable) will now play his respective animations in the Results Screen!
  • Added Pico (Christmas)

Changed

  • Rewritten all the code for Character replacement, the code should look a lot cleaner now.
  • Reformatted all of the code for better readability.
  • Optimized certain parts of CharacterMenu.

[1.3.0] - 2024-08-19

Added

  • You can now set character variations for specific songs within the Funker Selector JSON. See the documentation for more information.
  • Added some more error messages for better error handling.

Changed

  • Changed an error message or two for better clarity.

Fixed

  • Fixed an issue where character IDs with different capitalization than the target character ID were incorrectly recognized as valid, causing the character to not work as intended.

[1.2.2] - 2024-08-12

Changed

  • Changed the class names for the Module and Substate to avoid confusion.

Fixed

  • Fixed a bug where the vocals would reset to default if the player died or restarted the song.
  • Fixed a bug where the Pause Menu and Game Over suffixes would be overridden if Pico or Boyfriend (Pixel) were shown in the Character Menu.

[1.2.1] - 2024-08-11

Added

  • Added a small hotkey menu in the Character Menu, accessible by pressing D.
  • J will now jump to the currently selected character.

Changed

  • Optimized a few spots in the charSelect module and CharacterMenu substate.
  • Refactored vocal replacement. PlayState.instance.voices is now replaced properly instead of the hacky way of setting PlayState.instance.currentChart.characters.player and basically running with it.
  • Use a more memory-efficient method for "Preload Sprites".

Fixed

  • Fixed "Preload Sprites" doing the opposite of what it was supposed to do.
    • In addition, disabling the option will now remove the sprites from memory.
  • Fixed a random Null Object Reference from occuring when "Default" was selected.

[1.2.0] - 2024-08-03

Added

  • A new JSON System for adding Funker Selector characters! Loaded from data/funkerSelector/ in the mod folder.
    • This should allow for more flexibility when adding characters.
    • For documentation on this, please see docs/Funker Selector JSON Character Format.md.
  • You can now change the Opponent and Girlfriend by pressing either Q or E! This will change the current page.
  • Added a count to the UI which shows the current character, and the total amount of characters for the current page.

Changed

  • Gave the entire UI a fresh coat of paint. If the current character is a JSON Character, they will have their sprites displayed, along with a neat little description about them!
    • The UI now uses PhantomMuff by Cracsthor! Allows for text resizing, making the UI less cluttered in general.
    • With this UI overhaul comes some new options related to it:
      • Simplify UI: Simplifies the UI if it's too much.
      • Preload Sprites: Wether to preload the character sprites or not.
  • Changed the way saving works. It now uses Save.instance.modOptions instead of accessing FlxSave directly.
    • Your currently selected character will transfer over.
  • Some minor optimizations here and there, mainly for the Character Selection screen.

Deprecated

  • With the introduction of the new JSON System, charSelectList.txt is now deprecated! This method of loading characters will still be supported for the time being, but I recommend moving your characters to JSON if possible.

[1.1.1] - 2024-07-23

Fixed

  • Fixed vocal replacement for Default variation songs.

Changed

  • "Default" ID now uses the Face icon.

[1.1.0] - 2024-07-22

Added

  • Added the Boyfriend variants and Pico to the default character list.

[1.0.0] - 2024-07-21

Added

  • Pretty much everything.