From bc304a68b9a66e2963f67833f80f10ce82f32e3e Mon Sep 17 00:00:00 2001 From: AppleHair Date: Thu, 25 Jul 2024 12:13:09 +0300 Subject: [PATCH] Fixed README + Changed version number --- LICENSE-CC.md | 4 ++-- README.md | 10 +++++++--- _polymod_meta.json | 2 +- todoList.txt | 4 +--- 4 files changed, 11 insertions(+), 9 deletions(-) diff --git a/LICENSE-CC.md b/LICENSE-CC.md index c439f97..7d63668 100644 --- a/LICENSE-CC.md +++ b/LICENSE-CC.md @@ -1,3 +1,3 @@ -[FNF Unrestricted Difficulties Logo](https://github.com/AppleHair/FNF-UnrestDiffs/blob/main/UD-Logo.gif) © 2024 by [Eytan "AppleHair" Zury](https://github.com/AppleHair) is licensed under Creative Commons Attribution-NonCommercial 4.0 International. To view a copy of this license, visit https://creativecommons.org/licenses/by-nc/4.0/ +[FNF Unrestricted Difficulties Logo](UD-Logo.gif) © 2024 by [Eytan "AppleHair" Zury](https://github.com/AppleHair) is licensed under Creative Commons Attribution-NonCommercial 4.0 International. To view a copy of this license, visit https://creativecommons.org/licenses/by-nc/4.0/ -[FNF Unrestricted Difficulties Icon](https://github.com/AppleHair/FNF-UnrestDiffs/blob/main/_polymod_icon.png) © 2024 by [Eytan "AppleHair" Zury](https://github.com/AppleHair) is licensed under Creative Commons Attribution-NonCommercial 4.0 International. To view a copy of this license, visit https://creativecommons.org/licenses/by-nc/4.0/ \ No newline at end of file +[FNF Unrestricted Difficulties Icon](_polymod_icon.png) © 2024 by [Eytan "AppleHair" Zury](https://github.com/AppleHair) is licensed under Creative Commons Attribution-NonCommercial 4.0 International. To view a copy of this license, visit https://creativecommons.org/licenses/by-nc/4.0/ \ No newline at end of file diff --git a/README.md b/README.md index 8aef012..504626e 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -![UD-Logo](https://github.com/AppleHair/FNF-UnrestDiffs/blob/main/UD-Logo.gif) +![UD-Logo](UD-Logo.gif) # Unrestricted Difficulties @@ -15,11 +15,15 @@ The Unrestricted Difficulties framework is a soft-coded FNF mod, which gives FNF The framework includes the following features: - Makes your custom song variations appear in freeplay (was relevant before 0.4.0, but now it's already implemented in the base game) and story mode (story mode is still relevant). - Adds a variation injection system, which lets you inject your variations into existing songs, without overriding their default metadata files. +- Adds a variation-specific song script system, which lets you create song script for existing songs, which will only be used when a specific variation is selected. This is useful for creating custom cutscenes, custom mechanics and more for specific variations. - Adds a difficulty sorting system, which orders difficulties in freeplay and story mode according to priority numbers. - Support for custom difficulty sprites in the result screen (was relevant before 0.4.0, but now it's already implemented in the base game), which can also be animated (animations are still relevant). -- Adds difficulty display name trimming to the pause menu (and hopefully to the discord RPC too when it gets added to FNF), which will trim a difficulty's variation name from the difficulty's display name if its name starts with the variation name (this doesn't apply to difficulty names that are the same as the variation name). -- Added special attributes to all of the song scripts, which you can set using `scriptSet` on `onCountdownStart` through a module, as opposed to overriding the scripts, to customize the script's default behavior (which includes cutscenes and more song-specific stuff) (to be deprecated in favor of a variation-specific song scripts system in the future). +- Adds difficulty display name system to the pause menu (and hopefully to the discord RPC too when it gets added to FNF), which lets you make the difficulties' display names different from their IDs. This allows different difficulties to have the same display name, while still having different IDs, which makes the menus distinguish between them. If you don't define a display name for a difficulty, the framework will use difficulty display name trimming, which will trim a difficulty's variation name from the difficulty's name when it gets displayed if its name starts with the variation name (this doesn't apply to difficulty names that are the same as the variation name). - Improved story mode menu, with the following key improvements: - Limits the range of difficulties you can choose from and changes the song list according to the songs and difficulties available in each level, as opposed to relying on a constant and displaying only `easy`, `normal` and `hard` (which means you can play base game levels on `erect` and `nightmare` difficulties from the story mode menu using this framework). - Adds custom story mode menu script events (`UD_STORY_ENTER`, `UD_STORY_SCROLL`, `UD_STORY_EXIT`, `UD_STORY_CONFIRM`), which get called on modules. - Lets you inject alternative data to a level for different variations\difficulties available in the level, meaning you can customize how a level looks in the story mode menu (and even add songs under specific requirements) when having specific difficulties selected. + +## Extension: Customizable song scripts + +Adds special attributes to all of the song scripts, which you can set using `scriptSet` on `onCountdownStart` through a module, as opposed to overriding the scripts, to customize the script's default behavior (which includes cutscenes and more song-specific stuff). This was deprecated in favor of variation-specific song scripts, but was kept as an extension for compatibility with mods that use it. The extension download can be found on the [gamebanana page](https://gamebanana.com/mods/512797). \ No newline at end of file diff --git a/_polymod_meta.json b/_polymod_meta.json index 623157e..7455bcd 100644 --- a/_polymod_meta.json +++ b/_polymod_meta.json @@ -8,6 +8,6 @@ "url": "https://github.com/AppleHair" }], "api_version": "0.1.0", - "mod_version": "1.0.4", + "mod_version": "1.1.0", "license": "CC BY-NC 4.0,MIT" } diff --git a/todoList.txt b/todoList.txt index 1874a29..d9528f5 100644 --- a/todoList.txt +++ b/todoList.txt @@ -1,7 +1,5 @@ Future Plans: -Fix part in main README where I wrote about difficulty display name trimming -Replace the explanation about customizable song script in the main README with explanation on variation specific song scripts -REMEMBER TO CHANGE THE VERSION NUMBER AND ADD THE NEW EXTENSION TO THE GAMEBANANA PAGE!!! Add stuff for the next update to the todo list +REMEMBER TO ADD THE NEW EXTENSION TO THE GAMEBANANA PAGE!!! Try to use StringMaps more in the code (low priority) \ No newline at end of file