1
0
Fork 0
mirror of https://github.com/jugeeya/UltimateTrainingModpack.git synced 2024-11-20 00:46:34 +00:00

Quick readme update (#246)

* Correct some mistakes, remove visualizer plugin info

* Add mirroring gif

Co-authored-by: asimon-1 <asimon1@protonmail.com>
This commit is contained in:
asimon-1 2021-08-29 09:12:32 -07:00 committed by GitHub
parent 3fef1a78df
commit 814f0b3129
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

102
README.md
View file

@ -27,7 +27,7 @@ The latest beta release can be found [here](https://github.com/jugeeya/UltimateT
<a name="features"/>
# Features
The features in this modpack are configured through the menu, which can be accessed within training mode by pressing `SPECIAL+UPTAUNT`. Generally they fall into three categories:
The features in this modpack are configured through the menu, which can be accessed within training mode by pressing `SPECIAL+UPTAUNT`. Generally they fall into these categories:
- Enables or disables stage hazards
- Saves and loads the positional state of the player and CPU
@ -45,7 +45,10 @@ Set stage hazards on or off in Training Mode! Use this to practice on tournament
## Save States
At any time in Training Mode, you can press `Grab + Down Taunt` to save the state of training mode. This will save the position, state, and damage of each fighter, which can then be reverted to at any time with `Grab + Up Taunt`. Use this instead of the built-in training mode reset!
At any time in Training Mode, you can press `Grab + Down Taunt` to save the state of training mode. This will save the position, state, and damage of each fighter, which can then be reverted to at any time with `Grab + Up Taunt`. With the mirroring setting,loading the save state will flip the positions, allowing you to practice your skills facing both directions. Use this instead of the built-in training mode reset!
[<img src="https://i.imgur.com/FLy0xiw.gif">](https://i.imgur.com/FLy0xiw.gif)
## Input Delay
Practice with emulated extra input delay, in frames. Use this to practice with online's default delay.
@ -123,53 +126,50 @@ To install the training modpack, download the .zip file from the [latest release
```
SD Card Root
├── atmosphere
│ └── contents
│ └── 01006A800016E000
│ ├── exefs
│ │ ├── main.npdm
│ │ └── subsdk9
│ ├── manual_html
│ │ └── html-document
│ │ └── contents.htdocs
│ │ ├── aerial_delay.svg
│ │ ├── air_dodge_dir.svg
│ │ ├── attack_angle.svg
│ │ ├── check.svg
│ │ ├── defensive_state.svg
│ │ ├── di_state.svg
│ │ ├── falling_aerials.svg
│ │ ├── fast_fall.svg
│ │ ├── fast_fall_delay.svg
│ │ ├── follow_up.svg
│ │ ├── frame_advantage.svg
│ │ ├── full_hop.svg
│ │ ├── input_delay.svg
│ │ ├── ledge_delay.svg
│ │ ├── ledge_state.svg
│ │ ├── mash_in_neutral.svg
│ │ ├── mash_state.svg
│ │ ├── miss_tech_state.svg
│ │ ├── oos_offset.svg
│ │ ├── reaction_time.svg
│ │ ├── save_damage.svg
│ │ ├── save_state_mirroring.svg
│ │ ├── sdi_state.svg
│ │ ├── sdi_strength.svg
│ │ ├── shield_state.svg
│ │ ├── shield_tilt.svg
│ │ ├── stage_hazards.svg
│ │ ├── tech_state.svg
│ │ └── visualization.svg
│ └── romfs
│ └── skyline
│ └── plugins
│ ├── libnn_hid_hook.nro
│ ├── libnro_hook.nro
│ ├── libparam_hook.nro
│ ├── libtraining_modpack.nro
│ └── visualizer.nro
└── colors.json
└── atmosphere
└── contents
└── 01006A800016E000
├── exefs
│ ├── main.npdm
│ └── subsdk9
├── manual_html
│ └── html-document
│ └── contents.htdocs
│ ├── aerial_delay.svg
│ ├── air_dodge_dir.svg
│ ├── attack_angle.svg
│ ├── check.svg
│ ├── defensive_state.svg
│ ├── di_state.svg
│ ├── falling_aerials.svg
│ ├── fast_fall.svg
│ ├── fast_fall_delay.svg
│ ├── follow_up.svg
│ ├── frame_advantage.svg
│ ├── full_hop.svg
│ ├── input_delay.svg
│ ├── ledge_delay.svg
│ ├── ledge_state.svg
│ ├── mash_in_neutral.svg
│ ├── mash_state.svg
│ ├── miss_tech_state.svg
│ ├── oos_offset.svg
│ ├── reaction_time.svg
│ ├── save_damage.svg
│ ├── save_state_mirroring.svg
│ ├── sdi_state.svg
│ ├── sdi_strength.svg
│ ├── shield_state.svg
│ ├── shield_tilt.svg
│ ├── stage_hazards.svg
│ └── tech_state.svg
└── romfs
└── skyline
└── plugins
├── libnn_hid_hook.nro
├── libnro_hook.nro
├── libparam_hook.nro
└── libtraining_modpack.nro
```
To install a beta version of the modpack, follow the same procedure using the [latest beta release](https://github.com/jugeeya/UltimateTrainingModpack/tree/beta) on Github. Beta releases may have additional features and bugfixes, but are subject to change.
@ -179,7 +179,7 @@ To install a beta version of the modpack, follow the same procedure using the [l
# Frequently Asked Questions
* Can my Switch run the Training Modpack?
* Your swithc has to be hackable, which means it needs to be an early enough unit. You can check at https://ismyswitchpatched.com/ .
* Your switch has to be hackable, which means it needs to be an early enough unit. You can check at https://ismyswitchpatched.com/ .
* Is this mod wifi-safe?
* Yes*. Smash online is client sided. What this means is when playing against an opponent, their instance of the game is separate from your instance of the game, and when the server sends over data from the other player, it is replicated on your screen. Desyncs arise from when properties from the other side differ from what your game expects. (For example, Marios Forward Smash dealing 95% instead of its normal amount of damage). Because Training Modpack is only available while using Training Mode, the training modpack is safe to use while using online games. However, you should recognize that mods are not sanctioned by Nintendo and that there is always some ban risk associated with using them. Use this mod and others at your own risk.
* Is this mod compatible with Yuzu or other emulators?
@ -198,10 +198,8 @@ To install a beta version of the modpack, follow the same procedure using the [l
* `atmosphere/contents/01006A800016E000/romfs/libnn_hid_hook.nro`
* `atmosphere/contents/01006A800016E000/romfs/libnro_hook.nro`
* `atmosphere/contents/01006A800016E000/romfs/libtraining_modpack.nro`
* `atmosphere/contents/01006A800016E000/romfs/visualizer.nro`
* Additional static files
* `atmosphere/contents/01006A800016E000/manual_html/html-document/contents.htdocs/*`
* `colors.json`
* `TrainingModpack/*` (which is generated by the modpack)
* Make sure that you only remove the files that you don't want on your SD card anymore (e.g. don't remove skyline if you have other skyline plugins)
* What features are under development?