diff options
| -rw-r--r-- | INSTALL.md | 58 | ||||
| -rw-r--r-- | include/metatile_behavior.h | 8 | ||||
| -rw-r--r-- | src/field_tasks.c | 24 | ||||
| -rw-r--r-- | src/metatile_behavior.c | 8 |
4 files changed, 53 insertions, 45 deletions
diff --git a/INSTALL.md b/INSTALL.md index c2d3f32da..f16384450 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -1,23 +1,22 @@ # Prerequisites -| Linux | macOS | Windows 10 (build 18917+) | Windows 10 (1709+) | Windows Vista, 7, 8, 8.1, and 10 (1507, 1511, 1607, and 1703) -| ----- | ----- | ------------------------- | ------------------ | --------------------------------------------------------- -| none | [Xcode Command Line Tools package][xcode] | [Windows Subsystem for Linux 2][wsl2] | [Windows Subsystem for Linux][wsl] | MSYS2 (see below) +| Linux | macOS | Windows 10 +| - | - | - +| none | [Xcode Command Line Tools Package][xcode] | [Windows Terminal][terminal] and [Windows Subsystem for Linux (WSL)][wsl] -[xcode]: https://developer.apple.com/library/archive/technotes/tn2339/_index.html#//apple_ref/doc/uid/DTS40014588-CH1-DOWNLOADING_COMMAND_LINE_TOOLS_IS_NOT_AVAILABLE_IN_XCODE_FOR_MACOS_10_9__HOW_CAN_I_INSTALL_THEM_ON_MY_MACHINE_ -[wsl2]: https://docs.microsoft.com/windows/wsl/wsl2-install +[xcode]: https://developer.apple.com/library/archive/technotes/tn2339/_index.html +[terminal]: https://docs.microsoft.com/windows/terminal/get-started [wsl]: https://docs.microsoft.com/windows/wsl/install-win10 -The [prerelease version of the Linux subsystem](https://docs.microsoft.com/windows/wsl/install-legacy) available in the 1607 and 1703 releases of Windows 10 is obsolete so consider uninstalling it. +Independently from the specific OS, make sure that the `gcc`, `g++`, `make`, `git`, and `libpng` packages or their equivalents are installed and accessible to the development tools that are used by the project (this means that, for example, on Windows, the packages have to be installed in the WSL environment). The package names and installation methods may vary with each OS. -Make sure that the `build-essential`, `git`, and `libpng-dev` packages are installed. The `build-essential` package includes the `make`, `gcc-core`, and `g++` packages so they do not have to be obtained separately. MSYS2 does not include `libpng-dev` so it must be built from source. +Install the devkitARM toolchain of devkitPro as per [the instructions on their wiki](https://devkitpro.org/wiki/devkitPro_pacman). On Windows, follow the Linux instructions inside WSL as any steps about the Windows installer do not apply. -Install the **devkitARM** toolchain of [devkitPro](https://devkitpro.org/wiki/Getting_Started) and add its environment variables. For Windows versions without the Linux subsystem, the devkitPro [graphical installer](https://github.com/devkitPro/installer/releases) includes a preconfigured MSYS2 environment, thus the steps below are not required. +**Debian-based distro users:** This applies to Debian, Ubuntu, and similar distros, including in WSL. If necessary, install the `libarchive13`, `pkg-config`, and `gdebi-core` packages to be able to install devkitPro. - export DEVKITPRO=/opt/devkitPro - echo "export DEVKITPRO=$DEVKITPRO" >> ~/.bashrc - export DEVKITARM=$DEVKITPRO/devkitARM - echo "export DEVKITARM=$DEVKITARM" >> ~/.bashrc +**Windows 10 users:** WSL 2 is available in the 1903 release (build 18362) and later, therefore existing WSL 1 and [prerelease WSL](https://docs.microsoft.com/windows/wsl/install-legacy) users are recommended to update. Right-click the Start button or press `Win`+`X`, choose Run, and run `ms-settings:about` to determine the Windows version. Also check Windows Update to make sure your installation is up-to-date. + +**Windows 7 and 8.1 users:** pret is no longer focusing on support in pokeemerald for [old versions of Windows](https://support.microsoft.com/help/13853) so consider upgrading to a current release of Windows 10 or try a third-party guide like [this one](https://www.pokecommunity.com/showthread.php?t=425246) instead. # Installation @@ -33,22 +32,27 @@ To set up the repository: cd ../pokeemerald -To build **pokeemerald.gba** and confirm it matches the official ROM image: +To build **pokeemerald.gba** for the first time and confirm it matches the official ROM image: make compare -## Notes +If an OK is returned, then the installation went smoothly. -* If the base tools are not found on macOS in new Terminal sessions after the first successful build, run `echo "if [ -f ~/.bashrc ]; then . ~/.bashrc; fi" >> ~/.bash_profile` once to prevent the issue from occurring again. Verify that the `devkitarm-rules` package is installed as well; if not, install it by running `sudo dkp-pacman -S devkitarm-rules`. +**Windows users:** Consider adding exceptions for the `pokeemerald` and `agbcc` folders in Windows Security using [these instructions](https://support.microsoft.com/help/4028485). This prevents Microsoft Defender from scanning them which might improve performance while building. -* If the repository was previously set up using Cygwin, delete the `.exe` files in the subfolders of the `tools` folder except for `agbcc` and try building again. [Learn the differences between MSYS2 and Cygwin.](https://github.com/msys2/msys2/wiki/How-does-MSYS2-differ-from-Cygwin) -# Guidance +# Start To build **pokeemerald.gba** with your changes: make +**macOS users:** If the base tools are not found in new Terminal sessions after the first successful build, run `echo "if [ -f ~/.bashrc ]; then . ~/.bashrc; fi" >> ~/.bash_profile` once to prevent the issue from occurring again. Verify that the `devkitarm-rules` package is installed as well; if not, install it by running `sudo dkp-pacman -S devkitarm-rules`. + + +# Building guidance + + ## Parallel builds See [the GNU docs](https://www.gnu.org/software/make/manual/html_node/Parallel.html) and [this Stack Exchange thread](https://unix.stackexchange.com/questions/208568) for more information. @@ -59,19 +63,22 @@ To speed up building, run: `nproc` is not available on macOS. The alternative is `sysctl -n hw.ncpu` ([relevant Stack Overflow thread](https://stackoverflow.com/questions/1715580)). -## Building without dependency scanning -If only `.c` or `.s` files were changed, turn off the dependency scanning temporarily. Changes to any other files will be ignored and the build will either fail or not reflect those changes. +## Debug info - make NODEP=1 +To build **pokeemerald.elf** with enhanced debug info: -## Building with devkitARM's C compiler + make DINFO=1 + + +## devkitARM's C compiler This project supports the `arm-none-eabi-gcc` compiler included with devkitARM r52. To build this target, simply run: make modern -## Building with other toolchains + +## Other toolchains To build using a toolchain other than devkitARM, override the `TOOLCHAIN` environment variable with the path to your toolchain, which must contain the subdirectory `bin`. @@ -83,8 +90,9 @@ The following is an example: To compile the `modern` target with this toolchain, the subdirectories `lib`, `include`, and `arm-none-eabi` must also be present. -## Building with debug info -To build **pokeemerald.elf** with enhanced debug info, use the `DINFO` variable. +# Useful additional tools - make DINFO=1 +* [porymap](https://github.com/huderlem/porymap) for viewing and editing maps +* [poryscript](https://github.com/huderlem/poryscript) for scripting ([VS Code extension](https://marketplace.visualstudio.com/items?itemName=karathan.poryscript)) +* [Tilemap Studio](https://github.com/Rangi42/tilemap-studio) for viewing and editing tilemaps diff --git a/include/metatile_behavior.h b/include/metatile_behavior.h index b5dae6de0..d4bd9e683 100644 --- a/include/metatile_behavior.h +++ b/include/metatile_behavior.h @@ -99,10 +99,10 @@ bool8 MetatileBehavior_IsShortGrass(u8); bool8 MetatileBehavior_IsHotSprings(u8); bool8 MetatileBehavior_IsWaterfall(u8); bool8 MetatileBehavior_IsFortreeBridge(u8); -bool8 MetatileBehavior_IsPacifilogVerticalLog1(u8); -bool8 MetatileBehavior_IsPacifilogVerticalLog2(u8); -bool8 MetatileBehavior_IsPacifilogHorizontalLog1(u8); -bool8 MetatileBehavior_IsPacifilogHorizontalLog2(u8); +bool8 MetatileBehavior_IsPacifidlogVerticalLog1(u8); +bool8 MetatileBehavior_IsPacifidlogVerticalLog2(u8); +bool8 MetatileBehavior_IsPacifidlogHorizontalLog1(u8); +bool8 MetatileBehavior_IsPacifidlogHorizontalLog2(u8); bool8 MetatileBehavior_IsPacifidlogLog(u8); bool8 MetatileBehavior_IsTrickHousePuzzleDoor(u8); bool8 MetatileBehavior_IsRegionMap(u8); diff --git a/src/field_tasks.c b/src/field_tasks.c index 91b4558d5..002977a10 100644 --- a/src/field_tasks.c +++ b/src/field_tasks.c @@ -219,13 +219,13 @@ static void DummyPerStepCallback(u8 taskId) static const struct PacifidlogMetatileOffsets *GetPacifidlogBridgeMetatileOffsets(const struct PacifidlogMetatileOffsets *offsets, u16 metatileBehavior) { - if (MetatileBehavior_IsPacifilogVerticalLog1(metatileBehavior)) + if (MetatileBehavior_IsPacifidlogVerticalLog1(metatileBehavior)) return &offsets[0 * 2]; - else if (MetatileBehavior_IsPacifilogVerticalLog2(metatileBehavior)) + else if (MetatileBehavior_IsPacifidlogVerticalLog2(metatileBehavior)) return &offsets[1 * 2]; - else if (MetatileBehavior_IsPacifilogHorizontalLog1(metatileBehavior)) + else if (MetatileBehavior_IsPacifidlogHorizontalLog1(metatileBehavior)) return &offsets[2 * 2]; - else if (MetatileBehavior_IsPacifilogHorizontalLog2(metatileBehavior)) + else if (MetatileBehavior_IsPacifidlogHorizontalLog2(metatileBehavior)) return &offsets[3 * 2]; else return NULL; @@ -265,22 +265,22 @@ static bool32 StandingOnNewPacifidlogBridge(s16 x1, s16 y1, s16 x2, s16 y2) { u16 metatileBehavior = MapGridGetMetatileBehaviorAt(x2, y2); - if (MetatileBehavior_IsPacifilogVerticalLog1(metatileBehavior)) + if (MetatileBehavior_IsPacifidlogVerticalLog1(metatileBehavior)) { if (y1 > y2) return FALSE; } - else if (MetatileBehavior_IsPacifilogVerticalLog2(metatileBehavior)) + else if (MetatileBehavior_IsPacifidlogVerticalLog2(metatileBehavior)) { if (y1 < y2) return FALSE; } - else if (MetatileBehavior_IsPacifilogHorizontalLog1(metatileBehavior)) + else if (MetatileBehavior_IsPacifidlogHorizontalLog1(metatileBehavior)) { if (x1 > x2) return FALSE; } - else if (MetatileBehavior_IsPacifilogHorizontalLog2(metatileBehavior)) + else if (MetatileBehavior_IsPacifidlogHorizontalLog2(metatileBehavior)) { if (x1 < x2) return FALSE; @@ -292,22 +292,22 @@ static bool32 StandingOnSamePacifidlogBridge(s16 x1, s16 y1, s16 x2, s16 y2) { u16 metatileBehavior = MapGridGetMetatileBehaviorAt(x1, y1); - if (MetatileBehavior_IsPacifilogVerticalLog1(metatileBehavior)) + if (MetatileBehavior_IsPacifidlogVerticalLog1(metatileBehavior)) { if (y1 < y2) return FALSE; } - else if (MetatileBehavior_IsPacifilogVerticalLog2(metatileBehavior)) + else if (MetatileBehavior_IsPacifidlogVerticalLog2(metatileBehavior)) { if (y1 > y2) return FALSE; } - else if (MetatileBehavior_IsPacifilogHorizontalLog1(metatileBehavior)) + else if (MetatileBehavior_IsPacifidlogHorizontalLog1(metatileBehavior)) { if (x1 < x2) return FALSE; } - else if (MetatileBehavior_IsPacifilogHorizontalLog2(metatileBehavior)) + else if (MetatileBehavior_IsPacifidlogHorizontalLog2(metatileBehavior)) { if (x1 > x2) return FALSE; diff --git a/src/metatile_behavior.c b/src/metatile_behavior.c index 435ad7233..dde4de329 100644 --- a/src/metatile_behavior.c +++ b/src/metatile_behavior.c @@ -1107,7 +1107,7 @@ bool8 MetatileBehavior_IsFortreeBridge(u8 metatileBehavior) return FALSE; } -bool8 MetatileBehavior_IsPacifilogVerticalLog1(u8 metatileBehavior) +bool8 MetatileBehavior_IsPacifidlogVerticalLog1(u8 metatileBehavior) { if (metatileBehavior == MB_PACIFIDLOG_VERTICAL_LOG_1) return TRUE; @@ -1115,7 +1115,7 @@ bool8 MetatileBehavior_IsPacifilogVerticalLog1(u8 metatileBehavior) return FALSE; } -bool8 MetatileBehavior_IsPacifilogVerticalLog2(u8 metatileBehavior) +bool8 MetatileBehavior_IsPacifidlogVerticalLog2(u8 metatileBehavior) { if (metatileBehavior == MB_PACIFIDLOG_VERTICAL_LOG_2) return TRUE; @@ -1123,7 +1123,7 @@ bool8 MetatileBehavior_IsPacifilogVerticalLog2(u8 metatileBehavior) return FALSE; } -bool8 MetatileBehavior_IsPacifilogHorizontalLog1(u8 metatileBehavior) +bool8 MetatileBehavior_IsPacifidlogHorizontalLog1(u8 metatileBehavior) { if (metatileBehavior == MB_PACIFIDLOG_HORIZONTAL_LOG_1) return TRUE; @@ -1131,7 +1131,7 @@ bool8 MetatileBehavior_IsPacifilogHorizontalLog1(u8 metatileBehavior) return FALSE; } -bool8 MetatileBehavior_IsPacifilogHorizontalLog2(u8 metatileBehavior) +bool8 MetatileBehavior_IsPacifidlogHorizontalLog2(u8 metatileBehavior) { if (metatileBehavior == MB_PACIFIDLOG_HORIZONTAL_LOG_2) return TRUE; |