Skip to content

Commit 4b2abaa

Browse files
authored
Merge pull request #20 from SeekyCt/dev
Update to v2
2 parents 58621ff + 66f0689 commit 4b2abaa

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

64 files changed

+1955
-579
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,5 @@
22
*.rel
33
.vscode
44
build.*
5+
*.bat
6+
porting

MANUAL.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,14 @@
33
## Opening the Menu
44
The menu can currently be opened at any time the game's pause menu can (although this is probably going to be made less strict in a future version) by pressing `B`.
55

6-
The menu can then be navigated with the D-Pad, `2` to select and `1` to exit.
6+
The menu can then be navigated with the D-Pad, `2` to select, `1` to go back, and `B` to fully close the menu from any section.
77

88
## Map Warping
9-
The `Change Map` option in the menu allows you to warp to any map by its internal name.
9+
The `Change Map` option in the menu allows you to warp to any map with an entrance of your choice by their internal names.
1010

11-
The first 3 letters of the name are the area (such as `he1` for 1-1, `ta3` for 3-3, `mac` for Flipside) and the 2 numbers are the number of the map within that area. These can scrolled through using the D-Pad. Once you've chosen the map you'd like to warp to, press `2`.
11+
The first 3 letters of the name are the area (such as `he1` for 1-1, `ta3` for 3-3, `mac` for Flipside) and the 2 numbers are the number of the map within that area. The entrance column allows you to choose how the room is entered, with the `default` option using the default entrance for the map if it has one, or spawning you at the default coordinates for the map otherwise. These can scrolled through using the D-Pad.
12+
13+
Once you've chosen the map you'd like to warp to and the entrance you'd like to use, press `2`.
1214

1315
A full list of map names can be found [here](https://docs.google.com/document/d/10w4CS5oNBOHHYtM9OrNUYM7GIqNxIaR-b_Sr8FSG7Pk/edit).
1416

@@ -23,6 +25,10 @@ The Map & Door Name Display shows the current map name (without the underscore s
2325
### Position
2426
The Position Display shows your current co-ordinates in the top left of the screen.
2527

28+
The `Position Update Delay` option allows you to change the amount of frames between each time the coordinates are read and the display is updated.
29+
30+
The `Position Decimal Places` option allows you to set how many decimal places the coordinates are displayed to.
31+
2632
## Logging Options
2733
The `Edit Logging Options` option in the menu allows you to enable and disable various things being printed to an on-screen console or OSReport (for Dolphin). The list can be navigated with the D-Pad and `2` can be pressed to switch between Enabled and Disabled.
2834

@@ -49,3 +55,6 @@ The `Manage Saved Settings` option in the menu allows you to save your settings
4955

5056
## Return to Title Screen
5157
The `Return to Title Screen` option allows you to return to the main menu without needing to game over or reboot.
58+
59+
## Exception Handler
60+
When the game crashes or sets of an OSPanic, a custom exception handler will be displayed on screen showing debugging information. Unlike regular crashes, the power button can still be used to turn off the game as normal when the exception handler runs. This is currently not supported in the Korean version.

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,5 +28,6 @@ To compile this yourself, you'll need the following:
2828
Once that's set up you can use `make rgX` to build region `rg` ('eu', 'us', 'jp' or 'kr') revision `X` (0-1 for eu & jp, 0-2 for us, 0 for kr) or just `make` to build for all regions and revisions.
2929

3030
## Credits
31-
* JohnP55 for help and suggestions creating the map change teleport effect.
3231
* This mod was made using the [SPM Rel Loader](https://github.com/SeekyCt/spm-rel-loader), which is based on the TTYD rel loader by PistonMiner, Zephiles, Jdaster64 and JasperRLZ.
32+
* JohnP55 for help and suggestions creating the map change teleport effect.
33+
* TheLordScruffy for the dolphin detection method.

0 commit comments

Comments
 (0)