Merge pull request #216 from Reonu/develop/refactor__config_doc

Config documentation

Fixes #191
This commit is contained in:
thecozies
2021-12-21 05:04:26 -06:00
committed by GitHub
2 changed files with 7 additions and 7 deletions

View File

@@ -15,7 +15,7 @@
// Save number of lives to the save file (Does nothing if DISABLE_LIVES is enabled)
#define SAVE_NUM_LIVES
// The number of lives Mario starts with after a game over or starting the game for the first time.
// The number of lives Mario starts with after a game over or starting the game for the first time (must be lower than 127)
#define DEFAULT_NUM_LIVES 4
// This can be 0..127
@@ -62,7 +62,7 @@
// Prevents infinite death loops by always restoring Mario's health when he's warped to any kind of warp while dead.
#define PREVENT_DEATH_LOOP
// The level that the game starts in after file select
// The level that the game starts in after file select. The levelscript needs to have a MARIO_POS command for this to work.
#define START_LEVEL LEVEL_CASTLE_GROUNDS
@@ -71,3 +71,6 @@
#ifdef DISABLE_LIVES
#undef SAVE_NUM_LIVES
#endif // DISABLE_LIVES
#ifndef START_LEVEL
#define START_LEVEL LEVEL_CASTLE_GROUNDS
#endif

View File

@@ -12,13 +12,10 @@
// Decides whether you can exit course while moving (has no effect if you disable exit course)
#define EXIT_COURSE_WHILE_MOVING
// Decides which level "exit course" takes you to (has no effect if you disable exit course)
// Decides which level, area and warp ID the "exit course" option takes you to (has no effect if you disable exit course)
// Ensure that the warp exists, or else the game will crash.
#define EXIT_COURSE_LEVEL LEVEL_CASTLE
// Decides the area node "exit course" takes you to (has no effect if you disable exit course)
#define EXIT_COURSE_AREA 0x01
// Decides the warp node "exit course" takes you to (has no effect if you disable exit course)
#define EXIT_COURSE_NODE 0x1F
// -- Compatibility safeguards. Don't mess with these unless you know what you're doing. --