UltimateTrainingModpack/README.md

# Ultimate Training Modpack Plugin

[![Github all releases](https://img.shields.io/github/downloads/jugeeya/UltimateTrainingModpack/total.svg)](https://GitHub.com/jugeeya/UltimateTrainingModpack/releases/)

A [SaltyNX](https://github.com/shinyquagsire23/SaltyNX) plugin for adding features to the training mode. It interfaces with a fork of [Layoff](https://github.com/crc-32/layoff), a Switch custom overlay, for use as a menu to the features offered in training mode.

Built releases can be found [here](https://github.com/jugeeya/UltimateTrainingModpack/releases/).

- [Features](#features)
- [Build](#build)

<a name="features"/>

# Features
The features in this modpack are configured through the Layoff menu, which can be accessed at any time with by long pressing the Home button on a right Joy-con or Switch Pro controller. 

#### Hitbox Visualization
Currently, hitboxes and grabboxes are supported.


##### Mash Toggles
###### Airdodge
CPUs will mash airdodge on the first frame out of hitstun.

CPUs will also shield quickly if they are hit and remain grounded.

###### Jump
CPUs will mash jump on the first frame out of hitstun.

###### Attack
CPUs will mash an attack on the first frame out of hitstun and when landing. 
Attacks that can be chosen include:
- All aerials, followed by all specials

###### Random
CPUs will mash an aerial or grounded option on the first frame out of hitstun and when landing. 
The aerial options include:
- Airdodge, jump, all aerials, all specials

The grounded options include:
- Jump, jab, all tilts, all smashes, all specials, grab, spotdodge, and rolls

##### Ledge Option
CPUs will perform a random ledge option. 
Specific ledge options that can be chosen include:
- Normal, roll, jump, and attack

CPUs will also perform a defensive option after getting up.

##### Tech Option
CPUs will perform a random tech option. 
Specific tech options that can be chosen include:
- In place, roll, and miss tech

CPUs will also perform a defensive option after getting up.

##### Defensive Option
Choose the defensive option a CPU will perform after teching or getting up from the ledge. 
Specific options include:
    Flash shield, spotdodge, and jab

##### Shield

###### Infinite
CPUs will hold a shield that does not deteriorate over time or by damage.

###### Hold
CPUs will hold a normal shield.

#### Force CPU DI
##### All DI Toggles

##### Specified Direction
CPUs DI in the direction specified, relative to the player's facing position.

##### Random Direction
CPUs DI randomly in or away when the player presses left taunt.

<a name="build"/>

# Build from Source

Requires [DEVKITPRO](https://devkitpro.org/wiki/Getting_Started) in path.

```sh
# building the modpack ELF itself
git clone --recursive https://github.com/jugeeya/UltimateTrainingModpack.git
cd UltimateTrainingModpack/
make
# building the Layoff menu
cd layoff/libnx
pacman -Sy switch-freetype
make
cd ..
make
# make_layeredfs.bat for windows
./make_layeredfs.sh 
```
Update README.md 2019-06-07 01:25:54 +00:00			`# Ultimate Training Modpack Plugin`
Add README 2019-03-26 22:23:43 +00:00
Add downloads badge to README 2019-06-18 19:24:36 +00:00			`[![Github all releases](https://img.shields.io/github/downloads/jugeeya/UltimateTrainingModpack/total.svg)](https://GitHub.com/jugeeya/UltimateTrainingModpack/releases/)`

Update README.md 2019-10-31 07:34:33 +00:00			`A [SaltyNX](https://github.com/shinyquagsire23/SaltyNX) plugin for adding features to the training mode. It interfaces with a fork of [Layoff](https://github.com/crc-32/layoff), a Switch custom overlay, for use as a menu to the features offered in training mode.`
Add README 2019-03-26 22:23:43 +00:00
Update README.md 2019-06-24 21:16:35 +00:00			`Built releases can be found [here](https://github.com/jugeeya/UltimateTrainingModpack/releases/).`
Add README 2019-03-26 22:23:43 +00:00
Update README.md 2019-06-24 21:16:35 +00:00			`- [Features](#features)`
			`- [Build](#build)`
Add README 2019-03-26 22:23:43 +00:00
Update README.md 2019-06-24 21:16:35 +00:00			`<a name="features"/>`
Add README 2019-03-26 22:23:43 +00:00
Update README.md 2019-06-24 21:16:35 +00:00			`# Features`
Update README.md 2019-10-31 07:34:33 +00:00			`The features in this modpack are configured through the Layoff menu, which can be accessed at any time with by long pressing the Home button on a right Joy-con or Switch Pro controller.`
Update README.md 2019-06-24 21:16:35 +00:00
			`#### Hitbox Visualization`
Update README.md 2019-10-31 07:34:33 +00:00			`Currently, hitboxes and grabboxes are supported.`
Update README.md 2019-06-24 21:16:35 +00:00
Update README.md 2019-07-25 15:41:33 +00:00
Update README.md 2019-10-31 07:34:33 +00:00			`##### Mash Toggles`
Update README.md 2019-07-25 15:41:33 +00:00			`###### Airdodge`
Update README.md 2019-06-24 21:16:35 +00:00			`CPUs will mash airdodge on the first frame out of hitstun.`

			`CPUs will also shield quickly if they are hit and remain grounded.`

Update README.md 2019-07-25 15:41:33 +00:00			`###### Jump`
Update README.md 2019-06-24 21:16:35 +00:00			`CPUs will mash jump on the first frame out of hitstun.`

Update README.md 2019-07-25 15:41:33 +00:00			`###### Attack`
Update README.md 2019-06-24 21:16:35 +00:00			`CPUs will mash an attack on the first frame out of hitstun and when landing.`
Update README.md 2019-10-31 07:34:33 +00:00			`Attacks that can be chosen include:`
Update README.md 2019-06-24 21:16:35 +00:00			`- All aerials, followed by all specials`

Update README.md 2019-07-25 15:41:33 +00:00			`###### Random`
Update README.md 2019-06-24 21:16:35 +00:00			`CPUs will mash an aerial or grounded option on the first frame out of hitstun and when landing.`
			`The aerial options include:`
			`- Airdodge, jump, all aerials, all specials`

			`The grounded options include:`
			`- Jump, jab, all tilts, all smashes, all specials, grab, spotdodge, and rolls`

Update README.md 2019-10-31 07:34:33 +00:00			`##### Ledge Option`
Update README.md 2019-06-24 21:16:35 +00:00			`CPUs will perform a random ledge option.`
Update README.md 2019-10-31 07:34:33 +00:00			`Specific ledge options that can be chosen include:`
Update README.md 2019-07-25 15:41:33 +00:00			`- Normal, roll, jump, and attack`

Update README.md 2019-10-31 07:34:33 +00:00			`CPUs will also perform a defensive option after getting up.`
Update README.md 2019-07-25 15:41:33 +00:00
Update README.md 2019-10-31 07:34:33 +00:00			`##### Tech Option`
Update README for random tech options 2019-10-05 08:20:57 +00:00			`CPUs will perform a random tech option.`
Update README.md 2019-10-31 07:34:33 +00:00			`Specific tech options that can be chosen include:`
Update README for random tech options 2019-10-05 08:20:57 +00:00			`- In place, roll, and miss tech`

Update README.md 2019-10-31 07:34:33 +00:00			`CPUs will also perform a defensive option after getting up.`

			`##### Defensive Option`
			`Choose the defensive option a CPU will perform after teching or getting up from the ledge.`
			`Specific options include:`
			`Flash shield, spotdodge, and jab`
Update README for random tech options 2019-10-05 08:20:57 +00:00
Update README.md 2019-07-25 15:41:33 +00:00			`##### Shield`

			`###### Infinite`
			`CPUs will hold a shield that does not deteriorate over time or by damage.`

			`###### Hold`
			`CPUs will hold a normal shield.`
Update README.md 2019-06-24 21:16:35 +00:00
			`#### Force CPU DI`
			`##### All DI Toggles`

			`##### Specified Direction`
Update README.md 2019-10-31 07:34:33 +00:00			`CPUs DI in the direction specified, relative to the player's facing position.`
Update README.md 2019-06-24 21:16:35 +00:00
			`##### Random Direction`
Update README.md 2019-07-25 15:41:33 +00:00			`CPUs DI randomly in or away when the player presses left taunt.`
Update README.md 2019-06-24 21:16:35 +00:00
			`<a name="build"/>`

			`# Build from Source`

			`Requires [DEVKITPRO](https://devkitpro.org/wiki/Getting_Started) in path.`

			```sh
Update README.md 2019-10-31 07:34:33 +00:00			`# building the modpack ELF itself`
Update README.md 2019-07-30 22:43:48 +00:00			`git clone --recursive https://github.com/jugeeya/UltimateTrainingModpack.git`
			`cd UltimateTrainingModpack/`
			`make`
Update README.md 2019-10-31 07:34:33 +00:00			`# building the Layoff menu`
			`cd layoff/libnx`
fix missed parentheses 2019-12-21 20:46:49 +00:00			`pacman -Sy switch-freetype`
Update README.md 2019-10-31 07:34:33 +00:00			`make`
			`cd ..`
			`make`
			`# make_layeredfs.bat for windows`
			`./make_layeredfs.sh`
Add README 2019-03-26 22:23:43 +00:00			```