# Flood +

Flood + is a mod for sm64coopdx intended to expand Agent X's Flood mod and birdekek's Flood Expanded mod. Flood + contains plenty of new modifiers, gamemodes, extensive Romhack Support and more!

## User Information

### Modifiers
- Power-Ups - Collect a certain amount of coins to get a random Power-Up.
- Instakill - Touching the Flood makes you die instantly.
- Pursuit - Spawns a hostile Pursuer that tries to catch all players before they reach the goal.
- PvP - Enables Player interactions.
- Deathcoin - Touching a coin results in an instant death upon interaction.
- Winboost - Everytime someone reaches the flag, the flood speed will increase by 0.25. Please note that the flood speed will always be 1 with this modifier on.
- Speed - Multiplies the player's speed by 2.
- B Button Challenge - Bans the B button from your controller.
- Z Button Challenge - Bans the Z trigger from your controller.
- Coin Rush - The more coins you collect, the faster you are,
- Tripping - When walking, you have the chance to randomly trip.
- Low Gravity - Decreases the player's gravity.
- High Gravity - Increases the player's gravity.
- Flash Flood - The speed of the flood will randomly increase/decrease, from minimal to nearly 2 times faster. Please note that the flood speed will always be 1 with this modifier on.
- BLJ - Allows you to perform a Backwards Long Jump anywhere at any time.
- Capless - You'll never have your cap on, but you can still use cap powers like the Wing, Vanish or Metal Cap.
- Fly - Grants you power to the Wing Cap at all time.
- Slippery Floors - Makes the floor Mario is currently standing on slippery, to make levels harder to traverse!
- Fog - Covers the level in fog, making it harder to see.
- Inverted Controls - Inverts the L Stick, making it harder to move around.
- Hard Floors - Basically the complete opposite of Slippery Floors, and instead makes floors hard (non slippery)!
- Tornadoes - Spawns random tornadoes that try to block your way during the round.
- Firsties - Attempting to perform Wallkicks will now require even more skill and 1 frame precision.
- Special Triple Jump - Allows you to use the hidden Special Triple Jump that Yoshi grants you at the top of the Castle.
- Earthquake - Provokes shaking on the camera.

### Commands

- Open the Flood + Menu - `/flood`

- Start or Reset a round - `/start`

- Start a round in a random level - `/start random`

- Skip a round - `/skip`

- Stop a round - `/stop`

- Enable or Disable a modifier - `/modifiers`

- Change the Flood Speed - `/speed [number]`

- Adjust the Flood's difficulty - `/difficulty [number]`

- Adjust the Round Cooldown - `/round-cooldown [number]`

- Change the Speed Tick Tock Clock objects move - `/ttc-speed [fast, slow, random, stopped]`

- Change the amount of coins needed to get a Power-Up for the Power-Ups modifier - `/coincount [number]`

- Get information about the current version, current settings and level you're playing - `/info`

## Developer Information

### Level Codes

You can find these in `a-levels.lua`. Here's a list of some in vanilla:

```
bob - Bob-Omb Battlefield
wf - Whomp's Fortress
jrb - Jolly Roger Bay
jrb-ship - The Sunken Ship
ccm - Cool, Cool Mountain
ccm-slide - Frosty Slide
bitdw - Bowser In The Dark World
bbh - Big Boo's Haunt
hmc - Deep Underground Cave
cotmc - Cavern Of The Metal Cap
lll - Lethal Lava Land
lll-volcano - Flame-Boiling Volcano
ssl - Shifting Sand Land
ssl-pyramid - The Ancient Pyramid
ddd - Dire, Dire Docks
ddd-sub - Bowser's Submarine Hideout
bitfs - Bowser In The Fire Sea
vcutm - Vanish Cap Under The Moat
sl - Snowman's Land
wdw - Wet-Dry World
wdw-town - Wet-Dry Town
ttm - Tall, Tall Mountain
ttm-slide - Mysterious Mountain Slide
thi-small - The Tiny Island
thi - The Huge Island
ttc - Tick Tock Clock
rr - Rainbow Ride
wmotr - Wing Mario Over The Rainbow
bits - Bowser In The Sky
pss - The Princess' Secret Slide
cg - Castle Grounds
cu - Castle Upstairs
wf2 - Caged Fortress Tricks
jrb2 - Cap'n Ocean Cave
ccm2 - Icey Wallkick Challenge
bbh2 - Boo's Haunted Basement
hmc2 - Cloudy, Haze Maze
hmc3 - Work Elevator
lll2 - Red-Hot Log Rolling
thi2 - Koopa's Island Race
rr2 - Swingin' In The Breeze
rr3 - Tricky Triangles
```

### Scripts

- a-gamemodes.lua - Contains code for Flood +'s gamemodes
- a-levels.lua - Contains all the level data for the position of flags and objects
- a-themes.lua - Handles the custom themes system
- audio.lua - Custom system made for playing audios
- author-colors.lua - Handles the author colors
- a-utils.lua - Contains custom functions
- behaviors.lua - Contains code for the custom behaviors
- cap-display.lua - Handles the cap display
- doors.lua - Handles the autodoors code
- emotes.lua - Handles the emotes code
- enemies.lua - Handles the enemy blacklist system
- flood-colors.lua - Handles the submerged screen color tints for the flood types
- hud-utils.lua - Contains code to supplement hud functions
- kill-inactive.lua - Handles the AFK auto death feature
- leaderboard-hud.lua - Handles the leaderboard hud
- main.lua - Contains most of the actual code for flood and its modifiers
- mb-holiday-events.lua - Handles the Holiday Events for Flood +
- message.lua - Contains code for the Flood + Welcome Message
- minimap.lua - Handles the Minimap HUD
- misc.lua - Contains behavior data and misc functions
- music.lua - Contains the code for Vanilla Custom Sequences
- obj-fixes.lua - Contains some hooks for necessary object bhv modifications
- o-round-fadeout.lua - Handles the round fadeout effects
- o-tips.lua - Contains all the tip messages
- pause-menu.lua - Handles the pause menu
- README.md - The file you are reading right now
- remove-star-spawn-cutscene.lua - Handles the star spawn cutscene removal
- settings-menu.lua - Handles the entire ettings menu
- skybox.lua - Handles custom skyboxes for levels
- spectator.lua - Contains Flood's camera system
- voting.lua - Handles the voting round system
- z-adjustments.lua - Handles tweaks for romhacks
- z-api.lua - Documentation of the entire API for Flood +
- z-death-messages.lua - Handles the death messages
- z-fog.lua - Handles code for the fog modifier

### Folders

- actors - Contains custom models and collisions
- sound - Contains music and sfx
- textures - Contains textures
