Merge branch 'master' of https://github.com/pret/pokefirered

Author: Deokishisu

.github/calcrom/calcrom.pl

@@ -68,6 +68,7 @@
 }
 
 my @sorted = sort { $a->[1] <=> $b->[1] } @pairs;
+(my $elffname = $ARGV[0]) =~ s/\.map/.elf/;
 
 # Note that the grep filters out all branch labels. It also requires a minimum
 # line length of 5, to filter out a ton of generated symbols (like AcCn). No
@@ -78,16 +79,17 @@
 #
 # You'd expect this to take a while, because of uniq. It runs in under a second,
 # though. Uniq is pretty fast!
-my $base_cmd = "nm pokefirered.elf | awk '{print \$3}' | grep '^[^_].\\{4\\}' | uniq";
+my $base_cmd = "nm $elffname | awk '{print \$3}' | grep '^[^_].\\{4\\}' | uniq";
 
-# This looks for Unknown_, Unknown_, or sub_, followed by just numbers. Note that
+# This looks for Unknown_, Unknown_, or sub_, followed by an address. Note that
 # it matches even if stuff precedes the unknown, like sUnknown/gUnknown.
-my $undoc_cmd = "grep '[Uu]nknown_[0-9a-fA-F]*\\|sub_[0-9a-fA-F]*'";
+my $undoc_regex = "'[Uu]nknown_[0-9a-fA-F]\\{5,7\\}\\|sub_[0-9a-fA-F]\\{5,7\\}'";
 
 # This looks for every symbol with an address at the end of it. Some things are
 # given a name based on their type / location, but still have an unknown purpose.
 # For example, FooMap_EventScript_FFFFFFF.
-my $partial_doc_cmd = "grep '_[0-38][0-9a-fA-F]\\{5,6\\}'";
+# The above may be double counted here, and will need to be filtered out.
+my $partial_doc_regex = "'_[0-28][0-9a-fA-F]\\{5,7\\}'";
 
 my $count_cmd = "wc -l";
 
@@ -104,15 +106,15 @@
 
 my $undocumented_as_string;
 (run (
-    command => "$base_cmd | $undoc_cmd | $count_cmd",
+    command => "$base_cmd | grep $undoc_regex | $count_cmd",
     buffer => \$undocumented_as_string,
     timeout => 60
 ))
     or die "ERROR: Error while filtering for undocumented symbols: $?";
 
 my $partial_documented_as_string;
 (run (
-    command => "$base_cmd | $partial_doc_cmd | $count_cmd",
+    command => "$base_cmd | grep $partial_doc_regex | grep -v $undoc_regex | $count_cmd",
     buffer => \$partial_documented_as_string,
     timeout => 60
 ))
@@ -121,16 +123,19 @@
 # Performing addition on a string converts it to a number. Any string that fails
 # to convert to a number becomes 0. So if our converted number is 0, but our string
 # is nonzero, then the conversion was an error.
+$undocumented_as_string =~ s/^\s+|\s+$//g;
 my $undocumented = $undocumented_as_string + 0;
-(($undocumented != 0) and ($undocumented_as_string ne "0"))
+(($undocumented != 0) or (($undocumented == 0) and ($undocumented_as_string eq "0")))
     or die "ERROR: Cannot convert string to num: '$undocumented_as_string'";
 
+$partial_documented_as_string =~ s/^\s+|\s+$//g;
 my $partial_documented = $partial_documented_as_string + 0;
-(($partial_documented != 0) and ($partial_documented_as_string ne "0"))
-	or die "ERROR: Cannot convert string to num: '$partial_documented_as_string'";
+(($partial_documented != 0) or (($partial_documented == 0) and ($partial_documented_as_string eq "0")))
+    or die "ERROR: Cannot convert string to num: '$partial_documented_as_string'";
 
+$total_syms_as_string =~ s/^\s+|\s+$//g;
 my $total_syms = $total_syms_as_string + 0;
-(($total_syms != 0) and ($total_syms_as_string ne "0"))
+(($total_syms != 0) or (($total_syms == 0) and ($total_syms_as_string eq "0")))
     or die "ERROR: Cannot convert string to num: '$total_syms_as_string'";
 
 ($total_syms != 0)
@@ -140,9 +145,6 @@
 my $srcPct = sprintf("%.4f", 100 * $src / $total);
 my $asmPct = sprintf("%.4f", 100 * $asm / $total);
 
-# partial_documented is double-counting the unknown_* and sub_* symbols.
-$partial_documented = $partial_documented - $undocumented;
-
 my $documented = $total_syms - ($undocumented + $partial_documented);
 my $docPct = sprintf("%.4f", 100 * $documented / $total_syms);
 my $partialPct = sprintf("%.4f", 100 * $partial_documented / $total_syms);

.github/workflows/build.yml

@@ -73,14 +73,6 @@ jobs:
         run: |
           make -j${nproc} all
 
-      - name: Webhook
-        if: ${{ github.event_name == 'push' && github.repository_owner == 'pret' }}
-        env:
-          CALCROM_DISCORD_WEBHOOK_USERNAME: OK
-          CALCROM_DISCORD_WEBHOOK_AVATAR_URL: https://i.imgur.com/38BQHdd.png
-          CALCROM_DISCORD_WEBHOOK_URL: ${{ secrets.CALCROM_DISCORD_WEBHOOK_URL }}
-        run: sh .github/calcrom/webhook.sh pokefirered
-
       - name: Move symfiles
         if: ${{ github.event_name == 'push' }}
         run: |

.gitignore

@@ -22,7 +22,6 @@
 *.id1
 *.id2
 *.latfont
-*.ld
 *.lz
 *.map
 *.nam
@@ -46,14 +45,18 @@ ld_script_sapphire.txt
 sound/**/*.bin
 sound/songs/midi/*.s
 src/data/items.h
+src/data/region_map/region_map_entries.h
+src/data/region_map/region_map_entry_strings.h
+src/data/region_map/porymap_config.json
 tags
 tools/agbcc
 tools/binutils
 types_*.taghl
 !.github/calcrom/calcrom.pl
 !sound/programmable_wave_samples/*.pcm
 _Deparsed_XSubs.pm
-porymap.project.cfg
+porymap.*.cfg
+prefabs.json
 .vscode/*.*
 *.ss1
 *.ss2

INSTALL.md

@@ -9,7 +9,7 @@ If you run into trouble, ask for help on Discord or IRC (see [README.md](README.
 
 ## Windows
 Windows has instructions for building with three possible terminals, providing 3 different options in case the user stumbles upon unexpected errors.
-- [Windows 10 (WSL1)](#windows-10-wsl1) (**Fastest, highly recommended**, Windows 10 only)
+- [Windows 10/11 (WSL1)](#windows-1011-wsl1) (**Fastest, highly recommended**, Windows 10 and 11 only)
 - [Windows (msys2)](#windows-msys2) (Second fastest)
 - [Windows (Cygwin)](#windows-cygwin) (Slowest)
 
@@ -26,7 +26,7 @@ All of the Windows instructions assume that the default drive is C:\\. If this d
 
 **A note of caution**: As Windows 7 is officially unsupported by Microsoft and Windows 8 has very little usage, some maintainers are unwilling to maintain the Windows 7/8 instructions. Thus, these instructions may break in the future with fixes taking longer than fixes to the Windows 10 instructions.
 
-## Windows 10 (WSL1)
+## Windows 10/11 (WSL1)
 WSL1 is the preferred terminal to build **pokefirered**. The following instructions will explain how to install WSL1 (referred to interchangeably as WSL).
 - If WSL (Debian or Ubuntu) is **not installed**, then go to [Installing WSL1](#Installing-WSL1).
 - Otherwise, if WSL is installed, but it **hasn't previously been set up for another decompilation project**, then go to [Setting up WSL1](#Setting-up-WSL1).
@@ -125,19 +125,52 @@ Otherwise, ask for help on Discord or IRC (see [README.md](README.md)), or conti
 
 Note that in msys2, Copy is Ctrl+Insert and Paste is Shift+Insert.
 
-1. Open msys2 at C:\devkitPro\msys2\mingw64.exe or run `C:\devkitPro\msys2\msys2_shell.bat -mingw64`.
+1. Open msys2 at C:\devkitPro\msys2\msys2_shell.bat.
 
 2. Certain packages are required to build pokefirered. Install these by running the following command:
 
     ```bash
-    pacman -S make zlib-devel git mingw-w64-x86_64-gcc mingw-w64-x86_64-libpng
+    pacman -S make gcc zlib-devel git
     ```
     <details>
         <summary><i>Note...</i></summary>
 
    >   This command will ask for confirmation, just enter the yes action when prompted.
     </details>
 
+3. Download [libpng](https://sourceforge.net/projects/libpng/files/libpng16/1.6.37/libpng-1.6.37.tar.xz/download).
+
+4. Change directory to where libpng was downloaded. By default, msys2 will start in the current user's profile folder, located at **C:\Users\\&#8288;_\<user>_**, where *\<user>* is your Windows username. In most cases, libpng should be saved within a subfolder of the profile folder. For example, if libpng was saved to **C:\Users\\_\<user>_\Downloads** (the Downloads location for most users), enter this command:
+
+    ```bash
+    cd Downloads
+    ```
+
+    <details>
+        <summary><i>Notes...</i></summary>
+
+    >   Note 1: While not shown, msys uses forward slashes `/` instead of backwards slashes `\` as the directory separator.  
+    >   Note 2: If the path has spaces, then the path must be wrapped with quotations, e.g. `cd "Downloads/My Downloads"`.  
+    >   Note 3: Windows path names are case-insensitive so adhering to capitalization isn’t needed.   
+    >   Note 4: If libpng was saved elsewhere, you will need to specify the full path to where libpng was downloaded, e.g. `cd c:/devkitpro/msys2` if it was saved there.
+    </details>
+
+5. Run the following commands to uncompress and install libpng.
+
+    ```bash
+    tar xf libpng-1.6.37.tar.xz
+    cd libpng-1.6.37
+    ./configure --prefix=/usr
+    make check
+    make install
+    ```
+
+6. Then finally, run the following command to change back to the user profile folder.
+
+    ```bash
+    cd
+    ```
+
 ### Choosing where to store pokefirered (msys2)
 At this point, you can choose a folder to store pokefirered into. If you're okay with storing pokefirered in the user profile folder, then proceed to [Installation](#installation). Otherwise, you'll need to account for where pokefirered is stored when changing directory to the pokefirered folder.
 
@@ -236,13 +269,19 @@ If this works, then proceed to [Installation](#installation). Otherwise, ask for
 
 >   This guide installs libpng via Homebrew as it is the easiest method, however advanced users can install libpng through other means if they so desire.
 </details>
+<details>
+    <summary><i><strong>Note for Apple Silicon (M1) Mac users...</strong></i></summary>
+
+>   Currently, Homebrew and libng must be installed via Rosetta on Apple Silicon Macs. Before continuing, create a [Terminal shell profile with Rosetta](https://www.astroworldcreations.com/blog/apple-silicon-and-legacy-command-line-software). Be sure to run the commands corresponding to Apple Silicon (M1).
+</details>
 
 1. Open the Terminal.
 2. If Homebrew is not installed, then install [Homebrew](https://brew.sh/) by following the instructions on the website.
 3. Run the following command to install libpng.
 
     ```bash
-    brew install libpng
+    brew install libpng # Intel Macs
+    /usr/local/bin/brew install libpng # Apple Silicon (M1) Macs
     ```
    libpng is now installed.
 
@@ -265,11 +304,14 @@ If this works, then proceed to [Installation](#installation). Otherwise, ask for
 
     ```bash
     export DEVKITPRO=/opt/devkitpro
-    echo "export DEVKITPRO=$DEVKITPRO" >> ~/.bashrc
+    echo "export DEVKITPRO=$DEVKITPRO" >> ~/.bashrc # Intel Macs
+    echo "export DEVKITPRO=$DEVKITPRO" >> ~/.zshrc # Apple Silicon (M1) Macs
     export DEVKITARM=$DEVKITPRO/devkitARM
-    echo "export DEVKITARM=$DEVKITARM" >> ~/.bashrc
+    echo "export DEVKITARM=$DEVKITARM" >> ~/.bashrc # Intel Macs
+    echo "export DEVKITARM=$DEVKITARM" >> ~/.zshrc # Apple Silicon (M1) Macs
 
-    echo "if [ -f ~/.bashrc ]; then . ~/.bashrc; fi" >> ~/.bash_profile
+    echo "if [ -f ~/.bashrc ]; then . ~/.bashrc; fi" >> ~/.bash_profile # Intel Macs
+    echo "if [ -f ~/.zshrc ]; then . ~/.zshrc; fi" >> ~/.zprofile # Apple Silicon (M1) Macs
     ```
 
 ### Choosing where to store pokefirered (macOS)
@@ -404,21 +446,16 @@ If you aren't in the pokefirered directory already, then **change directory** to
 ```bash
 cd pokefirered
 ```
-To build **pokefirered.gba** for the first time and confirm it matches the official ROM image (Note: to speed up builds, see [Parallel builds](#parallel-builds)):
+To build **pokefirered.gba** (Note: to speed up builds, see [Parallel builds](#parallel-builds)):
 ```bash
-make compare
+make
 ```
-If an OK is returned, then the installation went smoothly.
+If it has built successfully you will have the output file **pokefirered.gba** in your project folder.
 <details>
 <summary>Note for Windows...</summary>
 > If you switched terminals since the last build (e.g. from msys2 to WSL1), you must run `make clean-tools` once before any subsequent `make` commands.
 </details>
 
-To build **pokefirered.gba** with your changes:
-```bash
-make
-```
-
 ## Build pokeleafgreen and REV1
 Pokemon FireRed and LeafGreen were both released together. As such, this project is capable of building both ROMs. To do so, simply run
 ```bash
@@ -449,11 +486,20 @@ Replace `<output of nproc>` with the number that the `nproc` command returned.
 
 `nproc` is not available on macOS. The alternative is `sysctl -n hw.ncpu` ([relevant Stack Overflow thread](https://stackoverflow.com/questions/1715580)).
 
-## Debug info
+## Compare ROM to the original
 
-To build **pokefirered.elf** with enhanced debug info:
+For contributing, or if you'd simply like to verify that your ROM is identical to the original game, run:
+```bash
+make compare  # or compare_leafgreen, compare_firered_rev1, compare_leafgreen_rev1
+```
+If it matches, you will see the following at the end of the output:
+```bash
+pokefirered.gba: OK
+```
+If there are any changes from the original game, you will instead see:
 ```bash
-make DINFO=1
+pokefirered.gba: FAILED
+shasum: WARNING: 1 computed checksum did NOT match
 ```
 
 ## devkitARM's C compiler
@@ -548,4 +594,4 @@ To compile the `modern` target with this toolchain, the subdirectories `lib`, `i
 
 * [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
+* [Tilemap Studio](https://github.com/Rangi42/tilemap-studio) for viewing and editing tilemaps

Makefile

@@ -81,6 +81,7 @@ ASM_SUBDIR = asm
 DATA_ASM_SUBDIR = data
 SONG_SUBDIR = sound/songs
 MID_SUBDIR = sound/songs/midi
+SAMPLE_SUBDIR = sound/direct_sound_samples
 CRY_SUBDIR = sound/direct_sound_samples/cries
 
 C_BUILDDIR = $(OBJ_DIR)/$(C_SUBDIR)
@@ -194,7 +195,7 @@ compare:
 	@$(MAKE) COMPARE=1
 
 mostlyclean: tidy
-	$(RM) sound/direct_sound_samples/*.bin
+	rm -f $(SAMPLE_SUBDIR)/*.bin
 	rm -f $(CRY_SUBDIR)/*.bin
 	$(RM) $(SONG_OBJS) $(MID_SUBDIR)/*.s
 	find . \( -iname '*.1bpp' -o -iname '*.4bpp' -o -iname '*.8bpp' -o -iname '*.gbapal' -o -iname '*.lz' -o -iname '*.latfont' -o -iname '*.hwjpnfont' -o -iname '*.fwjpnfont' \) -exec rm {} +
@@ -247,7 +248,7 @@ $(C_BUILDDIR)/isagbprn.o: CC1 := tools/agbcc/bin/old_agbcc$(EXE)
 $(C_BUILDDIR)/isagbprn.o: CFLAGS := -mthumb-interwork
 
 $(C_BUILDDIR)/trainer_tower.o: CFLAGS += -ffreestanding
-$(C_BUILDDIR)/flying.o: CFLAGS += -ffreestanding
+$(C_BUILDDIR)/battle_anim_flying.o: CFLAGS += -ffreestanding
 
 $(C_BUILDDIR)/librfu_intr.o: CC1 := tools/agbcc/bin/agbcc_arm$(EXE)
 $(C_BUILDDIR)/librfu_intr.o: CFLAGS := -O2 -mthumb-interwork -quiet
@@ -326,19 +327,15 @@ $(OBJ_DIR)/sym_ewram.ld: sym_ewram.txt
 	$(RAMSCRGEN) ewram_data $< ENGLISH > $@
 
 ifeq ($(MODERN),0)
-LD_SCRIPT := ld_script.txt
+LD_SCRIPT := ld_script.ld
 LD_SCRIPT_DEPS := $(OBJ_DIR)/sym_bss.ld $(OBJ_DIR)/sym_common.ld $(OBJ_DIR)/sym_ewram.ld
 else
-LD_SCRIPT := ld_script_modern.txt
+LD_SCRIPT := ld_script_modern.ld
 LD_SCRIPT_DEPS :=
 endif
 
-$(OBJ_DIR)/ld_script.ld: $(LD_SCRIPT) $(LD_SCRIPT_DEPS)
-	cd $(OBJ_DIR) && sed -f ../../ld_script.sed ../../$< | sed "s#tools/#../../tools/#g" > ld_script.ld
-
-$(ELF): $(OBJ_DIR)/ld_script.ld $(OBJS)
-	@echo "cd $(OBJ_DIR) && $(LD) $(LDFLAGS) -T ld_script.ld -o ../../$@ <objects> <lib>"
-	@cd $(OBJ_DIR) && $(LD) $(LDFLAGS) -T ld_script.ld -o ../../$@ $(OBJS_REL) $(LIB)
+$(ELF): $(LD_SCRIPT) $(LD_SCRIPT_DEPS) $(OBJS)
+	@cd $(OBJ_DIR) && $(LD) $(LDFLAGS) -T ../../$< -o ../../$@ $(OBJS_REL) $(LIB)
 	$(FIX) $@ -t"$(TITLE)" -c$(GAME_CODE) -m$(MAKER_CODE) -r$(GAME_REVISION) --silent
 
 $(ROM): $(ELF)

README.md

@@ -11,21 +11,7 @@ This is the repository for the Pokémon FireRed and LeafGreen+ hack, based on [p
 
 ## See also
 
-Other pret disassembly and/or decompilation projects:
-* [**Pokémon Red and Blue**](https://github.com/pret/pokered)
-* [**Pokémon Gold and Silver (Space World '97 demo)**](https://github.com/pret/pokegold-spaceworld)
-* [**Pokémon Yellow**](https://github.com/pret/pokeyellow)
-* [**Pokémon Trading Card Game**](https://github.com/pret/poketcg)
-* [**Pokémon Pinball**](https://github.com/pret/pokepinball)
-* [**Pokémon Stadium**](https://github.com/pret/pokestadium)
-* [**Pokémon Gold and Silver**](https://github.com/pret/pokegold)
-* [**Pokémon Crystal**](https://github.com/pret/pokecrystal)
-* [**Pokémon Ruby and Sapphire**](https://github.com/pret/pokeruby)
-* [**Pokémon FireRed and LeafGreen**](https://github.com/pret/pokefirered)
-* [**Pokémon Pinball: Ruby & Sapphire**](https://github.com/pret/pokepinballrs)
-* [**Pokémon Emerald**](https://github.com/pret/pokeemerald)
-* [**Pokémon Mystery Dungeon: Red Rescue Team**](https://github.com/pret/pmd-red)
-
+For other pret projects, see [pret.github.io](https://pret.github.io/).
 
 ## Discord server for pret
 

asm/macros.inc

@@ -1,7 +1,6 @@
 	.include "asm/macros/asm.inc"
 	.include "asm/macros/function.inc"
 	.include "asm/macros/movement.inc"
-	.include "asm/macros/pokemon_data.inc"
 	.include "asm/macros/ec.inc"
 	.include "asm/macros/map.inc"
 	.include "asm/macros/m4a.inc"