CHEATERex/README.md
$4Y$ f342aa550a Update README.md
Add loads of features you said, it will be fun you said
2020-11-21 16:01:59 -05:00

114 lines
4 KiB
Markdown

# CHEATERex
Fork of [sm64pc/sm64ex](https://github.com/sm64pc/sm64ex) with additional patches built-in.
To be used as a template for modders, hackers and cheaters.
**Only supports US - JP and EU in development**
-JP and EU can be tested with `DEBUG=1`
**no upload of any copyrighted asset**.
Run `./extract_assets.py --clean && make clean` or `make distclean` to remove ROM-originated content.
*Read this in other languages: [Español](README_es_ES.md)
-Please feel free to translate this into any other languages
## Additional Cheats
* Instant Death/Level Exit L Trigger + R Trigger + Z Trigger + A Button + B Button
* CHAOS Mode
* Time Stop
- Just press Y to stop time
- Can be reserved by CAP cheat or level transition
* No Hold Heavy
* Swim Anywhere
* Walk on Hazards (Lava/Quicksand)
* Yellow Coin Magnet
* Drain JRB?
* FLYER
* No Bounds
- "Disable OOB Walls" by Arceveti and anonim
* All Jumps Triple
* Hover Mode
- B button = Up
- A button = Down
- Hold L Trigger for speed boost
- Hold R Trigger to stop and rotate
- Press Z Trigger to exit
- CANNOT access pause screen while hovering
* Moon Gravity
* Run Speed Modifier
-Slow x.75
-Slower x.5
-Fast x2
-Faster ~x3
* No Death Barrier
* All Jumps Higher
* Speed Display, ported by ferris the crab(io12)
* T Pose Float?
* Jukebox song selector (WIP)
* Quick Ending
- while Enabled, if player has 120 stars, warp directly to End Cutscene
* Hurt Mario = L Trigger + A Button
- Burn
- Shock
- Set Health to One HP
* Cannon Anywhere = L Trigger + C Up Button
- spawns a cannon on player to trigger firing
*note: if used deep underwater, player will be sent to surface
* AutoWallKick
- while enabled, player will automatically wallkick after hitting wall
- Hold A to increase height
*note: Bonks will occur if wallkick is not possible
* Get Shell v2 = L Trigger + R Trigger
- now spawns underwater shells when in water
* Get Bomomb = L Trigger + B Button
* Spamba v2 (Spawns common0 actors)= L Trigger + Z Trigger
* Swift Swim v3
- max speed submerged doubled when holding A Button, now with bubbles
* JAGSTAX's Cap cheats (now controlled by the D Pad)
- REMOVE cap and DISABLE Cap Music added
* GateGuy's port of Kaze Emanuar's BLJ Anywhere
* Play as cheats (WIP), much thanks to ferris the crab(io12)
- Black Bobomb
- Bobomb Buddy
- Goomba
- Amp
- chuckya
- FlyGuy
## New features
* X, Y, and D PAD added (check `sm64.h` for defines)
* 60 FPS by Emil
* Angry Penguin by GateGuy
* Captian Toad Castle Stars by Keanine
* Leave Ending Screen by GateGuy
* 50 Coin 1UP by Keanine
* Open Castle v1.1 by Keanine
* Time Trials by GateGuy and PeachyPeach
* Stay In Level After Star (Cheat Version) by GateGuy
* Menu C button support by engima907
* Bugfixes by JAGSTAX
* DynOS by PeachyPeach
-Exit to Main Menu by Adya
* JP Red Coin Sound Option by Evanbowl
* 4x Extended Level Bounds by anonymous_moose and Lazthedude
* And of course, CHEATERv11 by $4Y$, me
## How to add cheats/mods
* Use `src/game/mario_cheats.c` for code
- each of the `actions` files has a single line function
- Use with `mario_cheats.h` to add new functionality
* Use `src/game/cheats_menu.h` for in game options
- add `TEXT_OPT_<NAME>` to `optsCheatsStr`
- if using a list, you need to make an array for `TEXT_OPT`
as well as one for the strings (see file for example)
* Use `include/text_cheats_strings.h.in` to tell the game what to print
- ie `#define TEXT_OPT_HEY _("Hey")`
- should be done for both JP and US
- JP only uses capital letters
- In game buttons examples `_("[A]")` or `_("[C]<")` no L though
* Use `src/game/options_menu.c` to add to `static struct Option optCheats`
* If adding new files, the `Makefile` will most likely need to be edited
- External Data aka `build/res/base.zip` is handled partly in both the `Makefile` and `Makefile.split`
* [tutorial](https://youtu.be/VIB2qKiR8fI)
# feel free to ask questions, request pulls, open issues