Skip to content

Commit

Permalink
Ok that's it I think
Browse files Browse the repository at this point in the history
  • Loading branch information
AppleHair committed Jun 25, 2024
1 parent 39dc8b5 commit 6098123
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 11 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,17 @@ The Unrestricted Difficulties framework is a soft-coded FNF mod, which gives FNF
## Features

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 (still relevant).
- 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 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 (still relevant).
- 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).
- 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 in certain conditions) when having specific difficulties selected.
- Added special attributes to some 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 per-variation song scripts system in the future).
- 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.
- 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).

## Usage as dependency for other mods

Previously, I had a section on gamebanana that explained how to bundle this framework with your mod, but now I want to suggest the exact opposite: **DON'T BUNDLE THIS FRAMEWORK WITH YOUR MOD AT ALL!!**. Instead, you should tell your users to download this framework separately, and then download your mod. This way, your mod will be more future-proof, and you won't have to worry about updating this framework in your mod's download every time I update this framework. If you want to make sure your mod won't load when this framework isn't installed or just make sure this framework loads before your mod does, you can add it as a dependency to your mod's metadata and use polymod's [dependency behavior](https://polymod.io/docs/dependencies/).
6 changes: 4 additions & 2 deletions _polymod_meta.json
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
{
"title": "Unrestricted Difficulties",
"description": "This module hackes the planned story menu difficulty behavior back into the game, works around freeplay difficulty restrictions, lets you inject custom variations to existing songs without collisions between mods, lets you add custom difficulty sprites for the result screen and implements the rating sorting on freeplay, which opens the door for much more flexability in difficulty modding for the base game.",
"homepage": "https://github.com/AppleHair/FNF-UnrestDiffs",
"description": "A soft-coded FNF mod, which gives FNF modders more control over difficulties and variations.",
"contributors": [{
"name": "AppleHair",
"role": "Developer"
"role": "Developer",
"url": "https://github.com/AppleHair"
}],
"api_version": "0.1.0",
"mod_version": "1.0.0",
Expand Down
6 changes: 1 addition & 5 deletions todoList.txt
Original file line number Diff line number Diff line change
@@ -1,11 +1,7 @@
Re-write mod descriptions and README
Write some basic instructions for specific features

Future Plans:

Finish comments on story-diffs
Add the ability to make variation specific song scripts
Add a simplified roses script that just changes the red fade beat if the variation is "erect"
Add a simplified roses variation-specific script that just changes the red fade beat if the variation is "erect"
Move the customizable song scripts into a seperate mod
Add instructions for new features
Add the ability to make variation specific level scripts (low priority)

0 comments on commit 6098123

Please sign in to comment.