From 8c58151b819cd4e0e3ac1e560280fbad9a46fbd2 Mon Sep 17 00:00:00 2001 From: akanyan Date: Mon, 10 Feb 2025 03:36:17 +0000 Subject: [PATCH] docs: add READMEs to all mods --- CHANGELOG.md | 38 +++++++++++++++++++ Enhancements/AttractVideoPlayer/README.md | 9 +++++ Enhancements/BetterGiveUp/README.md | 6 +++ Enhancements/DisableGP/README.md | 23 +++++++++++ Enhancements/DisableTimers/README.md | 3 ++ Enhancements/InfiniteStory/README.md | 3 ++ Enhancements/Pause/README.md | 3 ++ Enhancements/SkipNotices/README.md | 3 ++ Extras/Blacklist/README.md | 8 ++++ Extras/MoreProfileOptions/README.md | 23 +++++++++++ Extras/PlatinumTiming/README.md | 3 ++ Extras/SelectBGM/README.md | 14 +++++++ Extras/SkipCutscenes/README.md | 32 ++++++++++++++++ Extras/SortByInternalDifficulty/README.md | 3 ++ Extras/TestMenuConfig/README.md | 3 ++ Fixes/DisableEncryption/README.md | 5 +++ Fixes/DisableMaintenance/README.md | 3 ++ Fixes/ExclusiveAudio/README.md | 16 ++++++++ Fixes/FrameRate/README.md | 21 ++++++++++ Fixes/LoadBoost/README.md | 5 +++ Fixes/TestMenuScaling/README.md | 3 ++ Unlockers/UnlockAllMusic/README.md | 0 .../UnlockAndSetJewelBoostNine/README.md | 0 Unlockers/UnlockGameEvents/README.md | 9 +++++ Unlockers/UnlockMasterDifficulty/README.md | 0 Unlockers/UnlockMemoryChapters/README.md | 0 26 files changed, 236 insertions(+) create mode 100644 CHANGELOG.md create mode 100644 Enhancements/AttractVideoPlayer/README.md create mode 100644 Enhancements/BetterGiveUp/README.md create mode 100644 Enhancements/DisableGP/README.md create mode 100644 Enhancements/DisableTimers/README.md create mode 100644 Enhancements/InfiniteStory/README.md create mode 100644 Enhancements/Pause/README.md create mode 100644 Enhancements/SkipNotices/README.md create mode 100644 Extras/Blacklist/README.md create mode 100644 Extras/MoreProfileOptions/README.md create mode 100644 Extras/PlatinumTiming/README.md create mode 100644 Extras/SelectBGM/README.md create mode 100644 Extras/SkipCutscenes/README.md create mode 100644 Extras/SortByInternalDifficulty/README.md create mode 100644 Extras/TestMenuConfig/README.md create mode 100644 Fixes/DisableEncryption/README.md create mode 100644 Fixes/DisableMaintenance/README.md create mode 100644 Fixes/ExclusiveAudio/README.md create mode 100644 Fixes/FrameRate/README.md create mode 100644 Fixes/LoadBoost/README.md create mode 100644 Fixes/TestMenuScaling/README.md create mode 100644 Unlockers/UnlockAllMusic/README.md create mode 100644 Unlockers/UnlockAndSetJewelBoostNine/README.md create mode 100644 Unlockers/UnlockGameEvents/README.md create mode 100644 Unlockers/UnlockMasterDifficulty/README.md create mode 100644 Unlockers/UnlockMemoryChapters/README.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..4238c5d --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,38 @@ +## 3.4.0 + +* Added README files to all patches +* Added to [Rainycolor Watercolor](https://rainy.patafour.zip/package/7EVENDAYSHOLIDAYS/Mu3Mods/) + +## 3.3.1 + +* SkipCutscenes: fixed the pre-music ritual skip removing card info from the bottom of the screen + +## 3.3.0 + +* UnlockGameEvents: fixed/reworked monthly mission events. + * If the server is properly configured, and there is only one valid active mission, then that mission is chosen. + * Otherwise, all missions are unlocked and will iterate from latest to oldest. + * A mission is considered complete once you unlock all rewards and enter a loop (typically 25,000mp). + * Note that Artemis enables all missions by default. If multiple monthly missions are active, the vanilla game chooses the first one. This is why your mission events may have been stuck on [bright memory's oldest mission](https://wikiwiki.jp/gameongeki/%E3%83%9E%E3%83%B3%E3%82%B9%E3%83%AA%E3%83%BC%E3%83%9F%E3%83%83%E3%82%B7%E3%83%A7%E3%83%B3%EF%BC%882022%E5%B9%B43%E6%9C%88%EF%BC%89). + * If you want to enable a specific mission, make sure only that mission is active at the present time in `ongeki_static_events` (`where type=13`). +* Fixed various edgecase issues. + +## 3.2.0 + +* ExclusiveAudio: added to `fixes`. + * Allows for sample rates other than 48KHz (in exclusive mode). + * Adds an option to use 2-channel audio instead of 6-channel. + +## 3.1.0 + +* AttractVideoPlayer: left red button can now be used to skip attract video. +* SkipCutscenes: added a skip for the continue prompt. * Can be enabled in the mod test menu or `[Sequence] AutoContinue=1`. +* SkipCutscenes: fixed being able to skip after the play was restarted after the player had died. +* BetterGiveUp: removed the "continue?" popup that briefly showed up after giving up. +* BetterGiveUp: yeet. + +## 3.0.1 + +* SkipCutscenes: fixed the post-game skip not working when FC/AB/FB was not achieved. + +For older changelogs, see [the releases page](https://gitea.tendokyu.moe/akanyan/mu3-mods/releases) \ No newline at end of file diff --git a/Enhancements/AttractVideoPlayer/README.md b/Enhancements/AttractVideoPlayer/README.md new file mode 100644 index 0000000..30b8920 --- /dev/null +++ b/Enhancements/AttractVideoPlayer/README.md @@ -0,0 +1,9 @@ +## AttractVideoPlayer + +Grants control over attract mode's video player. + +* L1: Skip +* L2: Previous video +* L3: Next video + +The selected video persists between sessions. \ No newline at end of file diff --git a/Enhancements/BetterGiveUp/README.md b/Enhancements/BetterGiveUp/README.md new file mode 100644 index 0000000..9211919 --- /dev/null +++ b/Enhancements/BetterGiveUp/README.md @@ -0,0 +1,6 @@ +## BetterGiveUp + +* Red menu: return to song select +* Yellow menu: restart + +You have to hold down the button briefly (to prevent misclicks). \ No newline at end of file diff --git a/Enhancements/DisableGP/README.md b/Enhancements/DisableGP/README.md new file mode 100644 index 0000000..55b1f4c --- /dev/null +++ b/Enhancements/DisableGP/README.md @@ -0,0 +1,23 @@ +## DisableGP + +Patches out credits and GP checks. +Freezes GP at a fixed value. This value still affects money income (default is 999). + +```ini +[Extra] +GP=999 +``` + +Reorganizes the footer UI by default. Credits and GP are removed, and the network icons are moved to the left corner. This can be reverted with TestMenuConfig or in mu3.ini: + +```ini +[Extra] +HideCredits=1 +HideGP=1 +``` + +There is also an option to hide the game version (bottom-right corner): +```ini +[Extra] +HideVersion=0 +``` \ No newline at end of file diff --git a/Enhancements/DisableTimers/README.md b/Enhancements/DisableTimers/README.md new file mode 100644 index 0000000..6515ba1 --- /dev/null +++ b/Enhancements/DisableTimers/README.md @@ -0,0 +1,3 @@ +## DisableTimers + +Disables all timers. \ No newline at end of file diff --git a/Enhancements/InfiniteStory/README.md b/Enhancements/InfiniteStory/README.md new file mode 100644 index 0000000..5d21749 --- /dev/null +++ b/Enhancements/InfiniteStory/README.md @@ -0,0 +1,3 @@ +## InfiniteStory + +Lifts the *one story per credit* limit. \ No newline at end of file diff --git a/Enhancements/Pause/README.md b/Enhancements/Pause/README.md new file mode 100644 index 0000000..bb2844f --- /dev/null +++ b/Enhancements/Pause/README.md @@ -0,0 +1,3 @@ +## Pause + +Adds a pause button (FN2, service button). Has an internal 5-second cooldown. \ No newline at end of file diff --git a/Enhancements/SkipNotices/README.md b/Enhancements/SkipNotices/README.md new file mode 100644 index 0000000..59d1e3b --- /dev/null +++ b/Enhancements/SkipNotices/README.md @@ -0,0 +1,3 @@ +## SkipNotices + +Skips the safety warning screen and event notices. \ No newline at end of file diff --git a/Extras/Blacklist/README.md b/Extras/Blacklist/README.md new file mode 100644 index 0000000..8bccb17 --- /dev/null +++ b/Extras/Blacklist/README.md @@ -0,0 +1,8 @@ +## Blacklist + +Blocks score uploads on custom charts. The default ID range is 10,000-19,999 (the range used by NyagekiFumenProject/NAGEKI-NET) but you can adjust it in mu3.ini: +```ini +[Extra] +BlacklistMin = 10000 +BlacklistMax = 19999 +``` \ No newline at end of file diff --git a/Extras/MoreProfileOptions/README.md b/Extras/MoreProfileOptions/README.md new file mode 100644 index 0000000..c050d6d --- /dev/null +++ b/Extras/MoreProfileOptions/README.md @@ -0,0 +1,23 @@ +## MoreProfileOptions + +### Track skip + +SSS+, Personal Best, Full Bell, AA (900k) + +PB and FB fall back to AA for Score- display. + +### Rating + +This rating calculation is client-side and purely cosmetic but the profile option is stored on the server so it can persist between sessions (i.e. Emmy will know you are using this mod, but won't know your naive rating value). + +#### TYPE-A: Default +[(OldBest30+NewBest15+Recent10)÷55](https://silentblue.remywiki.com/ONGEKI:Rating#Profile_rating) + +#### TYPE-B: Naive +Best45÷45 + +#### TYPE-C: Reachable +Like TYPE-A but "Recent10" is always the best eligible score times 10 + +#### TYPE-D: Recent +Recent10÷10 \ No newline at end of file diff --git a/Extras/PlatinumTiming/README.md b/Extras/PlatinumTiming/README.md new file mode 100644 index 0000000..8fd18ef --- /dev/null +++ b/Extras/PlatinumTiming/README.md @@ -0,0 +1,3 @@ +## PlatinumTiming + +Displays early/late critical break counts (next to the regular early/late counts, in fainter colors). \ No newline at end of file diff --git a/Extras/SelectBGM/README.md b/Extras/SelectBGM/README.md new file mode 100644 index 0000000..cfd39f4 --- /dev/null +++ b/Extras/SelectBGM/README.md @@ -0,0 +1,14 @@ +## SelectBGM + +Use TestMenuConfig or add this entry to mu3.ini: +```ini +[Extra] +; 1 - original +; 2 - SUMMER +; 3 - R.E.D. +; 4 - bright +; 5 - END CHAPTER +; 6 - Act.3 +; 0 - random +BGM = 6 +``` \ No newline at end of file diff --git a/Extras/SkipCutscenes/README.md b/Extras/SkipCutscenes/README.md new file mode 100644 index 0000000..7a93b8a --- /dev/null +++ b/Extras/SkipCutscenes/README.md @@ -0,0 +1,32 @@ +## SkipCutscenes + +### Daily bonus skip + +Press the red menu button to instantly stamp the item and move on. + +### Pre-battle ritual skip + +Press the red menu button once the stage is loaded (after the boss sprite has been replaced with the boss chibi) to start the battle instantly. + +This can be done automatically with a toggle from TestMenuOptions, or the following entry in mu3.ini:``` +[Sequence] +QuickStart=1 +``` + +### Post-battle fanfare skip + +Press the red menu button during the lamp animation (ALL BREAK) or later to skip to the result screen. + +### Post-score item giveaway + +Currently not implemented, but you can speed this section up if you explicitly get rid of rewards: + +* Remove UnlockGameEvents +* Disable all missions in Artemis like this: +```sql +update ongeki_static_events +set startDate = "2022-01-01 00:00:00", endDate = "2022-01-01 00:00:00" +where type = 13; +``` +* Choose an event without ranking or silver jewels +* Use collab cards (they don't receive affection) \ No newline at end of file diff --git a/Extras/SortByInternalDifficulty/README.md b/Extras/SortByInternalDifficulty/README.md new file mode 100644 index 0000000..f55d91c --- /dev/null +++ b/Extras/SortByInternalDifficulty/README.md @@ -0,0 +1,3 @@ +## SortByInternalDifficulty + +Adds options to group and sort by internal difficulty level (譜面定数). \ No newline at end of file diff --git a/Extras/TestMenuConfig/README.md b/Extras/TestMenuConfig/README.md new file mode 100644 index 0000000..7401706 --- /dev/null +++ b/Extras/TestMenuConfig/README.md @@ -0,0 +1,3 @@ +## TestMenuConfig + +Adds a test menu page with additional options, mostly related to other mu3-mods. \ No newline at end of file diff --git a/Fixes/DisableEncryption/README.md b/Fixes/DisableEncryption/README.md new file mode 100644 index 0000000..c585218 --- /dev/null +++ b/Fixes/DisableEncryption/README.md @@ -0,0 +1,5 @@ +## DisableEncryption + +Disables network encryption and is necessary for local network support. + +Your assembly may already come with this patch baked in (even if it's marketed as as "clean"). \ No newline at end of file diff --git a/Fixes/DisableMaintenance/README.md b/Fixes/DisableMaintenance/README.md new file mode 100644 index 0000000..138494b --- /dev/null +++ b/Fixes/DisableMaintenance/README.md @@ -0,0 +1,3 @@ +## DisableMaintenance + +Disables daily maintenance/forced logout. \ No newline at end of file diff --git a/Fixes/ExclusiveAudio/README.md b/Fixes/ExclusiveAudio/README.md new file mode 100644 index 0000000..6bf0f2e --- /dev/null +++ b/Fixes/ExclusiveAudio/README.md @@ -0,0 +1,16 @@ +## ExclusiveAudio + +Allows for arbitrary sample rates in exclusive mode. +Adds an option to use 2-channel exclusive audio (instead of 6-channel). + +This is a relatively experimental patch. In my experience, it improves latency but also causes bass overload. + +To use this, open TestMenuConfig or edit `mu3.ini`: +``` +[Sound] +; 0 - Shared +; 1 - 5.1 Exclusive +; 2 - 2.0 Exclusive +ExclusiveAudio = 2 +SampleRate = 48000 +``` \ No newline at end of file diff --git a/Fixes/FrameRate/README.md b/Fixes/FrameRate/README.md new file mode 100644 index 0000000..a28e492 --- /dev/null +++ b/Fixes/FrameRate/README.md @@ -0,0 +1,21 @@ +## FrameRate + +This patch can unlock the framerate or lock it to an arbitary value, and fixes the game on HFR monitors and multi-monitor setups. + +### Framerate settingValues can be edited with TestMenuConfig or directly in mu3.ini. Example: +```ini +[Video] +Framerate=60 +VSync=0 +``` + +Set `Framerate=0` to unlock the framerate (**not recommended**). + +`VSync=1` (**also not recommended**) overrides `Framerate`. + +For authentic experience, keep it at 60. Although there are no technical obstacles to running the game at HFR, there is a note smoothing/snapping algorithm (refer to `MU3.Notes.NotesManager.progressFrameAndFrameReal()`) that expects the game to run at 60fps, and ties the game's speed to the framerate. The aforemenetioned snapping is disabled when the framerate is set to anything other than 60. + +### High refresh rate fix +Normally, the game runs with a framerate lock corresponding to the refresh rate of your primary monitor. You may want to run the game on a secondary monitor, and their refresh rates may differ. + +This means an unmodded setup with a 120Hz primary monitor and a secondary 60Hz Ongeki monitor will run the game at double speed, even though the user intended to run at the "proper" framerate. \ No newline at end of file diff --git a/Fixes/LoadBoost/README.md b/Fixes/LoadBoost/README.md new file mode 100644 index 0000000..d892e1f --- /dev/null +++ b/Fixes/LoadBoost/README.md @@ -0,0 +1,5 @@ +## LoadBoost + +Significantly improves boot time by caching a lot of data that normally gets recalculated every boot. + +You may need to delete cache (`data_cache.bin`, `data_fumen_analysis_cache.bin` if you made changes to existing game files, especially charts). \ No newline at end of file diff --git a/Fixes/TestMenuScaling/README.md b/Fixes/TestMenuScaling/README.md new file mode 100644 index 0000000..d9b57cd --- /dev/null +++ b/Fixes/TestMenuScaling/README.md @@ -0,0 +1,3 @@ +## TestMenuScaling + +Fixes test mode (including the boot sequence) on resolutions other than 1080x1920. \ No newline at end of file diff --git a/Unlockers/UnlockAllMusic/README.md b/Unlockers/UnlockAllMusic/README.md new file mode 100644 index 0000000..e69de29 diff --git a/Unlockers/UnlockAndSetJewelBoostNine/README.md b/Unlockers/UnlockAndSetJewelBoostNine/README.md new file mode 100644 index 0000000..e69de29 diff --git a/Unlockers/UnlockGameEvents/README.md b/Unlockers/UnlockGameEvents/README.md new file mode 100644 index 0000000..c2afb8d --- /dev/null +++ b/Unlockers/UnlockGameEvents/README.md @@ -0,0 +1,9 @@ +## UnlockGameEvents + +Note about mission events: + +* If the server is properly configured, and there is only one valid active mission, then that mission is chosen. +* Otherwise, all missions are unlocked and will iterate from latest to oldest. + * A mission is considered complete once you unlock all rewards and enter a loop (typically 25,000mp). +* Note that Artemis enables all missions by default. If multiple monthly missions are active, the vanilla game chooses the first one. This is why your mission events may have been stuck on [bright memory's oldest mission](https://wikiwiki.jp/gameongeki/%E3%83%9E%E3%83%B3%E3%82%B9%E3%83%AA%E3%83%BC%E3%83%9F%E3%83%83%E3%82%B7%E3%83%A7%E3%83%B3%EF%BC%882022%E5%B9%B43%E6%9C%88%EF%BC%89). + * If you want to enable a specific mission, make sure only that mission is active at the present time in `ongeki_static_events` (`where type=13`). \ No newline at end of file diff --git a/Unlockers/UnlockMasterDifficulty/README.md b/Unlockers/UnlockMasterDifficulty/README.md new file mode 100644 index 0000000..e69de29 diff --git a/Unlockers/UnlockMemoryChapters/README.md b/Unlockers/UnlockMemoryChapters/README.md new file mode 100644 index 0000000..e69de29