iidx30-32, sdvx6: Revamp 'Patches' section, add a warning advising to keep spice2x updated

This commit is contained in:
Akitake 2024-11-06 12:38:51 +01:00
parent ca60276cad
commit 9ca68732a1
6 changed files with 32 additions and 55 deletions

View File

@ -84,6 +84,10 @@
--- ---
### Installing Spice2x ### Installing Spice2x
!!! info ""
If you already have Spice2x installed, make sure it is up to date!
!!! tip "" !!! tip ""
- Head over to [spice2x.github.io](https://spice2x.github.io) and download the latest release. - Head over to [spice2x.github.io](https://spice2x.github.io) and download the latest release.

View File

@ -107,6 +107,10 @@
--- ---
### Installing Spice2x ### Installing Spice2x
!!! info ""
If you already have Spice2x installed, make sure it is up to date!
!!! tip "" !!! tip ""
- Head over to [spice2x.github.io](https://spice2x.github.io) and download the latest release. - Head over to [spice2x.github.io](https://spice2x.github.io) and download the latest release.
@ -178,23 +182,15 @@
#### Patches #### Patches
!!! info "First go through the [Spice2x Patching](../../extras/patchsp2x.md) page to import patches." !!! info "Go through the [Spice2x Patching](../../extras/patchsp2x.md) page to import patches."
!!! danger "If not using ASIO, you NEED to patch `Force Audio Output Mode` to `WASAPI` otherwise the game won't boot." !!! tip ""
??? tip "Other patches that may be useful to you" Ever since EPOLIS final (2024-08-26), patches have a description built-in to them.
Note: As a general rule of thumb, the fewer patches the better. If you're unsure what something does, don't enable or change it. To view it, hover-over the `(?)` or `(!)` to the left of each patch's name.
| Patch | Recommendation | Description | !!! danger "To prevent issues, avoid patching things you don't need or understand."
|-----------------------------------------------|---------------- |-------------|
| Force TDJ Mode | Either | Starts the game in TDJ (010) mode when using a LDJ (012) `.dll` file. Use this instead of forcing 120Hz using other patches. |
| Standard/Menu Timer Freeze | Either | Freezes the timer in all non-premium environments. |
| Premium Free Timer Freeze | Either | Freezes the timer in Premium Free mode. |
| Cursor Lock | Either | In song select, always returns to the previously selected song. |
| CS-style Song Start Delay | Either | At the start of a song, holding Start will pause it until you release it. |
| Increase Game Volume | Either | Ignores in-game settings and keeps the volume at a maximum, helpful for `TDJ` which tends to be quiet. |
| Hide all bottom text | Either | Hides text at the bottom of the screen such as `Credits` or `Paseli`. |
#### API #### API

View File

@ -86,4 +86,4 @@
!!! tip "" !!! tip ""
When using this patch, you must set your audio device's sample rate to 48000 Hz. See [audio](setup.md#audio) for more details When using this patch, you must set your audio device's sample rate to 48000 Hz. See [audio](setup.md#audio) for more details.

View File

@ -107,6 +107,10 @@
--- ---
### Installing Spice2x ### Installing Spice2x
!!! info ""
If you already have Spice2x installed, make sure it is up to date!
!!! tip "" !!! tip ""
- Head over to [spice2x.github.io](https://spice2x.github.io) and download the latest release. - Head over to [spice2x.github.io](https://spice2x.github.io) and download the latest release.
@ -178,23 +182,15 @@
#### Patches #### Patches
!!! info "First go through the [Spice2x Patching](../../extras/patchsp2x.md) page to import patches." !!! info "Go through the [Spice2x Patching](../../extras/patchsp2x.md) page to import patches."
!!! danger "If not using ASIO, you NEED to patch `Force Audio Output Mode` to `WASAPI` otherwise the game won't boot." !!! tip ""
??? tip "Other patches that may be useful to you" Ever since EPOLIS final (2024-08-26), patches have a description built-in to them.
Note: As a general rule of thumb, the fewer patches the better. If you're unsure what something does, don't enable or change it. To view it, hover-over the `(?)` or `(!)` to the left of each patch's name.
| Patch | Recommendation | Description | !!! danger "To prevent issues, avoid patching things you don't need or understand."
|-----------------------------------------------|---------------- |-------------|
| Force TDJ Mode | Either | Starts the game in TDJ (010) mode when using a LDJ (012) `.dll` file. Use this instead of forcing 120Hz using other patches. |
| Standard/Menu Timer Freeze | Either | Freezes the timer in all non-premium environments. |
| Premium Free Timer Freeze | Either | Freezes the timer in Premium Free mode. |
| Cursor Lock | Either | In song select, always returns to the previously selected song. |
| CS-style Song Start Delay | Either | At the start of a song, holding Start will pause it until you release it. |
| Increase Game Volume | Either | Ignores in-game settings and keeps the volume at a maximum, helpful for `TDJ` which tends to be quiet. |
| Hide all bottom text | Either | Hides text at the bottom of the screen such as `Credits` or `Paseli`. |
#### API #### API

View File

@ -86,4 +86,4 @@
!!! tip "" !!! tip ""
When using this patch, you must set your audio device's sample rate to 48000 Hz. See [audio](setup.md#audio) for more details When using this patch, you must set your audio device's sample rate to 48000 Hz. See [audio](setup.md#audio) for more details.

View File

@ -66,6 +66,10 @@
--- ---
### Installing Spice2x ### Installing Spice2x
!!! info ""
If you already have Spice2x installed, make sure it is up to date!
!!! tip "" !!! tip ""
- Head over to [spice2x.github.io](https://spice2x.github.io) and download the latest release. - Head over to [spice2x.github.io](https://spice2x.github.io) and download the latest release.
@ -144,36 +148,13 @@
!!! info "Go through the [Spice2x Patching](../../extras/patchsp2x.md) page to import patches." !!! info "Go through the [Spice2x Patching](../../extras/patchsp2x.md) page to import patches."
!!! danger "If you don't absolutely need a patch or you're unsure what it does, leave it alone! Regardless of recommendations below." !!! tip ""
??? tip "General patches" Ever since the 2024-09-10 update, patches have a description built-in to them.
| Patch | Recommendation | Description | To view it, hover-over the `(?)` or `(!)` to the left of each patch's name.
|-----------------------------------------------|---------------- |-------------|
| Disable power change | Either | Prevents the game from changing Windows power settings. |
| Disable monitor change | Either | Prevents the game from changing Windows monitor settings. |
| Force BIO2 (KFC) IO in Valkyrie mode | OFF | Only useful for real cabs or Valkyrie at 60hz. |
| Shared mode WASAPI | Either | **For non-Valkyrie setups**. Runs the game with non-exclusive WASAPI audio, allowing you to hear audio from other sources **at the cost of audio latency**. |
| Shared mode WASAPI Valkyrie | Either | **For Valkyrie setups**. Same as above. |
| ASIO 2 Channels Mode | OFF | **For ASIO audio only**. Uses 2 channels instead of 8, useful for some audio cards. |
| Unlock All Songs | OFF | **This might get you banned from remote servers.**<br> If using Asphyxia, **you should unlock Songs using the WebUI instead**. |
| Unlock All Difficulties | OFF | **This might get you banned from remote servers.**<br> If using Asphyxia, **you should unlock Difficulties using the WebUI instead**. |
| Uncensor album jackets (for K region only) | OFF | **Only useful for Korean region**. The game is already "uncensored" otherwise. |
| Hide all bottom text | Either | Hides text at the bottom of the screen such as `Credits` or `Paseli`. |
| Disable subscreen in Valkyrie mode | Either | Disables the subscreen entirely. Note that this option is also available in the Options tab (`-sdvxnosub`).
| Timer freeze | Either | Freezes the timer in all non-premium environments.
| Premium timer freeze | Either | Freezes the timer in premium environments.
| Hide premium guide banner | Either | Hides the premium guide banner at the bottom of the screen during play.
| Premium Time Length | Any | Defines how long your premium time will be. If you've frozen premium time this is just vanity.
| Valkyrie Mode 60hz | OFF | Allows 60hz monitor users to use Valkyrie-exclusive features. To be used in conjunction with the Force BIO2 patch and `G` spec in `ea3-config.xml`.
| Fake Region | Japan | Unlocks region specific content regardless of the chosen region in `ea3-config.xml`. Japan unlocks the most content and is therefore recommended.
??? tip "If your monitor supports 120hz or more" !!! danger "To prevent issues, avoid patching things you don't need or understand."
| Patch | Recommendation |
|-----------------------------------------------|---------------------------|
| Game FPS Target | 120 FPS **(NOT higher)** |
| Note FPS Target | 120 FPS **(NOT higher)** |
#### API #### API