Starship/include/mods.h
Alejandro Asenjo Nitti 0251769d16
General docs (#269)
* fox_display.c DOCS

* PRINTF

* actor->destroy boolean

* corneria docs

* Boss->unk_04C to Boss->animFrame

* aCoGrangaWalkingAnim

* more corneria docs

* Spawner

* Spawner code refined

* Spawner description

* Actor Spawn guard

* Molar Rock (name by @inspectredc)

* more docs

* actor docs

* initial disassembly config for lodgenet

* correct vram addresses for lodgenet

* Actor Docs

* More actor docs

* more actor docs

* correction

* correction

* more actor docs

* Preliminary work for Effect documentation

* Change Init for Setup

* fox_play cleanup and defake

* fox_zo function names

* fox_so function renaming

* more object docs

* venom 1 actors

* actor docs

* some fox_bo docs

* some fox_fo corrections

* fox_ma obj->this

* fox_ma renamings

* fox_ma docs

* fox_ti Actors

* revert permuter settings to ido

* some renames on fox_andross.c

* fox_sy actors

* object names

* corrections

* some effect comments

* fix AudioTable struct and data to avoid UB

* uintptr_t in audio

* audio load changes

* event id enum usage in fox_sy

* clear padding in sPlaylists

* HUD_FoBase_ExplodeCs

* HUD
2024-08-12 11:58:54 -03:00

93 lines
2.1 KiB
C

#ifndef MODS_H
#define MODS_H
/**
* Quick Boot:
* Define this variable to a game state to boot into that
* state. Two presets (map and main menu) are provided.
* For the full list of game states, see sf64thread.h.
*/
// #define MODS_BOOT_STATE 3 // main menu
// #define MODS_BOOT_STATE 4 // map
/**
* Level Select:
* Use the D-Pad to select a level. Press L to start in
* an advanced level phase (warp zone or Andross fight).
* Useful for debugging and speedrunning training.
*/
#define MODS_LEVEL_SELECT 0
/**
* Sound Effects Jukebox:
* Ability to play sound effects inside the expert sound menu
* Use L to switch between jukebox and soundtrack
* Use D-PAD to move the cursor
* Use C buttons to edit values
*/
#define MODS_SFX_JUKEBOX 0
/**
* Auto debugger:
* Crash debugger appears without needing to enter code.
*/
#define MODS_AUTO_DEBUGGER 0
/**
* FPS Counter:
* Hold Z + R and press L to toggle FPS Display
*/
#define MODS_FPS_COUNTER 0
/**
* RAM modifier:
* Hold Z + R and press C> to cycle modes
*
* Cheats:
* Use D-Pad up and down to select a cheat
* Use D-Pad left and right to set its value
* Press L to set the value or twice to lock it
*
* Object Ram Editor:
* Watch up to seven addresses from the player and object arrays
* Use D-Pad to move the cursor and change values
* Press L to edit the highlighted value
*/
#define MODS_RAM_MOD 0
/**
* Spawner:
* Spawn Scenery, Actors, Bosses, Sprites, Items, Effects or even Event Actors.
*
* Controls:
* D-Pad left and right to set the object Id.
* C-Right to change between spawn modes.
* Analog stick sets the spawn position.
* L-Trigger to spawn the object.
* D-Pad UP to kill all objects.
* D-Pad DOWN to freeze/unfreeze the ship speed.
* WARNING: Spawning an object that's not loaded in memory will likely result in a crash.
*/
#define MODS_SPAWNER 0
/* ************************* */
#if MODS_LEVEL_SELECT == 1
void Map_LevelSelect(void);
#endif
#if MODS_FPS_COUNTER == 1
static void Play_RenderFps(void);
#endif
#if MODS_RAM_MOD == 1
void RamMod_Update(void);
#endif
#if MODS_SPAWNER == 1
void Spawner(void);
#endif
#endif