upcoming merge (but with 2 failing tests)

.github/ISSUE_TEMPLATE/01_battle_engine_bugs.yaml

@@ -23,16 +23,17 @@ body:
       label: Version
       description: What version of pokeemerald-expansion are you using as a base?
       options:
-        - 1.8.1 (Latest release)
+        - 1.9.0 (Latest release)
         - master (default, unreleased bugfixes)
         - upcoming (Edge)
+        - 1.8.6
+        - 1.8.5
+        - 1.8.4
+        - 1.8.3
+        - 1.8.2
+        - 1.8.1
         - 1.8.0
-        - 1.7.4
-        - 1.7.3
-        - 1.7.2
-        - 1.7.1
-        - 1.7.0
-        - pre-1.7.0
+        - pre-1.8.0
     validations:
       required: true
   - type: input

.github/ISSUE_TEMPLATE/02_battle_ai_issues.yaml

@@ -23,16 +23,17 @@ body:
       label: Version
       description: What version of pokeemerald-expansion are you using as a base?
       options:
-        - 1.8.1 (Latest release)
+        - 1.9.0 (Latest release)
         - master (default, unreleased bugfixes)
         - upcoming (Edge)
+        - 1.8.6
+        - 1.8.5
+        - 1.8.4
+        - 1.8.3
+        - 1.8.2
+        - 1.8.1
         - 1.8.0
-        - 1.7.4
-        - 1.7.3
-        - 1.7.2
-        - 1.7.1
-        - 1.7.0
-        - pre-1.7.0
+        - pre-1.8.0
     validations:
       required: true
   - type: input

.github/ISSUE_TEMPLATE/04_other_errors.yaml

@@ -23,16 +23,17 @@ body:
       label: Version
       description: What version of pokeemerald-expansion are you using as a base?
       options:
-        - 1.8.1 (Latest release)
+        - 1.9.0 (Latest release)
         - master (default, unreleased bugfixes)
         - upcoming (Edge)
+        - 1.8.6
+        - 1.8.5
+        - 1.8.4
+        - 1.8.3
+        - 1.8.2
+        - 1.8.1
         - 1.8.0
-        - 1.7.4
-        - 1.7.3
-        - 1.7.2
-        - 1.7.1
-        - 1.7.0
-        - pre-1.7.0
+        - pre-1.8.0
     validations:
       required: true
   - type: input

.github/workflows/docs.yml

@@ -0,0 +1,48 @@
+name: Docs
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pages: write
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Install latest mdbook
+        run: |
+          tag=$(curl 'https://api.github.com/repos/rust-lang/mdbook/releases/latest' | jq -r '.tag_name')
+          url="https://github.com/rust-lang/mdbook/releases/download/${tag}/mdbook-${tag}-x86_64-unknown-linux-gnu.tar.gz"
+          mkdir mdbook
+          curl -sSL $url | tar -xz --directory=./mdbook
+          echo `pwd`/mdbook >> $GITHUB_PATH
+      - name: Build Book
+        run: |
+          cd docs
+          mdbook build
+      - name: Check if Pages is enabled
+        uses: octokit/[email protected]
+        id: check_pages
+        continue-on-error: true
+        with:
+          route: GET /repos/{repo}/pages
+          repo: ${{ github.repository }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+        if: steps.check_pages.outcome == 'success'
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: 'docs/book'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4
+        if: steps.check_pages.outcome == 'success'

.gitignore

@@ -39,3 +39,4 @@ prefabs.json
 *.sym
 *.js
 src/data/map_group_count.h
+tools/trainerproc/trainerproc

CHANGELOG.md

@@ -1,45 +1,53 @@
 # Pokeemerald-Expansion Changelogs
 
+## 1.9.x
+- **[Version 1.9.0](docs/changelogs/1.9.x/1.9.0.md) - ✨ Feature Release**
+
 ## 1.8.x
-- ### [Version 1.8.1](docs/changelogs/1.8.1.md) - HOTFIX Release 🔥
-- ### [Version 1.8.0](docs/changelogs/1.8.0.md) - Feature Release ✨
+- **[Version 1.8.6](docs/changelogs/1.8.x/1.8.6.md) - 🧹 Bugfix Release**
+- **[Version 1.8.5](docs/changelogs/1.8.x/1.8.5.md) - 🧹 Bugfix Release**
+- **[Version 1.8.4](docs/changelogs/1.8.x/1.8.4.md) - 🧹 Bugfix Release**
+- **[Version 1.8.3](docs/changelogs/1.8.x/1.8.3.md) - 🧹 Bugfix Release**
+- **[Version 1.8.2](docs/changelogs/1.8.x/1.8.2.md) - 🧹 Bugfix Release**
+- **[Version 1.8.1](docs/changelogs/1.8.x/1.8.1.md) - 🔥 HOTFIX Release**
+- **[Version 1.8.0](docs/changelogs/1.8.x/1.8.0.md) - ✨ Feature Release**
 
 ## 1.7.x
-- ### [Version 1.7.4](docs/changelogs/1.7.4.md) - Bugfix Release 🧹
-- ### [Version 1.7.3](docs/changelogs/1.7.3.md) - Bugfix Release 🧹
-- ### [Version 1.7.2](docs/changelogs/1.7.2.md) - Bugfix Release 🧹
-- ### [Version 1.7.1](docs/changelogs/1.7.1.md) - Bugfix Release 🧹
-- ### [Version 1.7.0](docs/changelogs/1.7.0.md) - Feature Release ✨
+- **[Version 1.7.4](docs/changelogs/1.7.x/1.7.4.md) - 🧹 Bugfix Release**
+- **[Version 1.7.3](docs/changelogs/1.7.x/1.7.3.md) - 🧹 Bugfix Release**
+- **[Version 1.7.2](docs/changelogs/1.7.x/1.7.2.md) - 🧹 Bugfix Release**
+- **[Version 1.7.1](docs/changelogs/1.7.x/1.7.1.md) - 🧹 Bugfix Release**
+- **[Version 1.7.0](docs/changelogs/1.7.x/1.7.0.md) - ✨ Feature Release**
 
 ## 1.6.x
-- ### [Version 1.6.2](docs/changelogs/1.6.2.md) - Bugfix Release 🧹
-- ### [Version 1.6.1](docs/changelogs/1.6.1.md) - HOTFIX Release 🔥
-- ### [Version 1.6.0](docs/changelogs/1.6.0.md) - Feature Release ✨
+- **[Version 1.6.2](docs/changelogs/1.6.x/1.6.2.md) - 🧹 Bugfix Release**
+- **[Version 1.6.1](docs/changelogs/1.6.x/1.6.1.md) - 🔥 HOTFIX Release**
+- **[Version 1.6.0](docs/changelogs/1.6.x/1.6.0.md) - ✨ Feature Release**
 
 ## 1.5.x
-- ### [Version 1.5.3](docs/changelogs/1.5.3.md) - HOTFIX Release 🔥
-- ### [Version 1.5.2](docs/changelogs/1.5.2.md) - Bugfix Release 🧹
-- ### [Version 1.5.1](docs/changelogs/1.5.1.md) - Bugfix Release 🧹
-- ### [Version 1.5.0](docs/changelogs/1.5.0.md) - Feature Release ✨
+- **[Version 1.5.3](docs/changelogs/1.5.x/1.5.3.md) - 🔥 HOTFIX Release**
+- **[Version 1.5.2](docs/changelogs/1.5.x/1.5.2.md) - 🧹 Bugfix Release**
+- **[Version 1.5.1](docs/changelogs/1.5.x/1.5.1.md) - 🧹 Bugfix Release**
+- **[Version 1.5.0](docs/changelogs/1.5.x/1.5.0.md) - ✨ Feature Release**
 
 ## 1.4.x
-- ### [Version 1.4.3](docs/changelogs/1.4.3.md) - Bugfix Release 🧹
-- ### [Version 1.4.2](docs/changelogs/1.4.2.md) - Bugfix Release 🧹
-- ### [Version 1.4.1](docs/changelogs/1.4.1.md) - HOTFIX Release 🔥
-- ### [Version 1.4.0](docs/changelogs/1.4.0.md) - Feature Release ✨
+- **[Version 1.4.3](docs/changelogs/1.4.x/1.4.3.md) - 🧹 Bugfix Release**
+- **[Version 1.4.2](docs/changelogs/1.4.x/1.4.2.md) - 🧹 Bugfix Release**
+- **[Version 1.4.1](docs/changelogs/1.4.x/1.4.1.md) - 🔥 HOTFIX Release**
+- **[Version 1.4.0](docs/changelogs/1.4.x/1.4.0.md) - ✨ Feature Release**
 
 ## 1.3.x
-- ### [Version 1.3.0](docs/changelogs/1.3.0.md) - Feature Release ✨
+- **[Version 1.3.0](docs/changelogs/1.3.x/1.3.0.md) - ✨ Feature Release**
 
 ## 1.2.x
-- ### [Version 1.2.0](docs/changelogs/1.2.0.md) - Feature Release ✨
+- **[Version 1.2.0](docs/changelogs/1.2.x/1.2.0.md) - ✨ Feature Release**
 
 ## 1.1.x
-- ### [Version 1.1.1](docs/changelogs/1.1.1.md) - Bugfix Release 🧹
-- ### [Version 1.1.0](docs/changelogs/1.1.0.md) - Feature Release ✨
+- **[Version 1.1.1](docs/changelogs/1.1.x/1.1.1.md) - 🧹 Bugfix Release**
+- **[Version 1.1.0](docs/changelogs/1.1.x/1.1.0.md) - ✨ Feature Release**
 
 ## 1.0.x
-- ### [Version 1.0.0](docs/changelogs/1.0.0.md) - Feature Release ✨
+- **[Version 1.0.0](docs/changelogs/1.0.x/1.0.0.md) - ✨ Feature Release**
 
 ## Pre-1.0.x:
-- ### [Version 0.9.0](docs/changelogs/0.9.0.md) - Retroactive Version 🦕
+- **[Version 0.9.0](docs/changelogs/0.9.x/0.9.0.md) - 🦕 Retroactive Version**

INSTALL.md

@@ -33,27 +33,23 @@ WSL1 is the preferred terminal to build **pokeemerald Expansion**. The following
 - Otherwise, **open WSL** and go to [Choosing where to store pokeemerald Expansion (WSL1)](#Choosing-where-to-store-pokeemerald-expansion-WSL1).
 
 ### Installing WSL1
-1. Open [Windows Powershell **as Administrator**](https://i.imgur.com/QKmVbP9.png), and run the following command (Right Click or Shift+Insert is paste in the Powershell).
+1. Open [Windows Powershell **as Administrator**](https://i.imgur.com/QKmVbP9.png), and run the following commands (Right Click or Shift+Insert is paste in the Powershell).
 
     ```powershell
-    dism.exe /online /enable-feature /featurename:Microsoft-Windows-Subsystem-Linux /all /norestart
+	wsl --install -d Ubuntu --enable-wsl1
     ```
 
 2. Once the process finishes, restart your machine.
 
-3. The next step is to choose and install a Linux distribution from the Microsoft Store. The following instructions will assume Ubuntu as the Linux distribution of choice.
-    <details>
-        <summary><i>Note for advanced users...</i></summary>
-
-    >   You can pick a preferred Linux distribution, but setup instructions may differ. Debian should work with the given instructions, but has not been tested.
-    </details>
+3. Open Windows Powershell **as Administrator** again (after restarting), and run the following command to configure Ubuntu to use WSL1.
 
-4. Open the [Microsoft Store Linux Selection](https://aka.ms/wslstore), click Ubuntu, then click Get, which will install the Ubuntu distribution.
+    ```powershell
+    wsl --set-version Ubuntu 1
+    ```
     <details>
-        <summary><i>Notes...</i></summary>
+        <summary><i>Note...</i></summary>
 
-    >   Note 1: If a dialog pops up asking for you to sign into a Microsoft Account, then just close the dialog.
-    >   Note 2: If the link does not work, then open the Microsoft Store manually, and search for the Ubuntu app (choose the one with no version number).
+    >   WSL may open automatically after restarting, but you can ignore it for now.
     </details>
 
 ### Setting up WSL1
@@ -215,9 +211,9 @@ Note that in msys2, Copy is Ctrl+Insert and Paste is Shift+Insert.
 
 To install Python on msys2, simply run the following commands:
 
-    ```bash
-    pacman -S mingw-w64-x86_64-python3
-    ```
+```bash
+pacman -S mingw-w64-x86_64-python3
+```
 
 Python is now installed.
 
@@ -310,6 +306,7 @@ If this works, then proceed to [Installation](#installation). Otherwise, ask for
     ```
 
 2.  - If libpng is **not installed**, then go to [Installing libpng (macOS)](#installing-libpng-macos).
+    - If pkg-config is **not installed**, then go to [Installing pkg-config (macos)](#installing-pkg-config-macos).
     - If devkitARM is **not installed**, then go to [Installing devkitARM (macOS)](#installing-devkitarm-macos).
     - Otherwise, **open the Terminal** and go to [Choosing where to store pokeemerald Expansion (macOS)](#choosing-where-to-store-pokeemerald-expansion-macos)
 
@@ -329,6 +326,26 @@ If this works, then proceed to [Installation](#installation). Otherwise, ask for
     ```
     libpng is now installed.
 
+    Continue to [Installing pkg-config (macOS)](#installing-pkg-config-macos) if **pkg-config is not installed**. Otherwise, continue to [Installing devkitARM (macOS)](#installing-devkitarm-macos) if **devkitARM is not installed**.
+
+    If both pkg-config and devkitARM are already installed, go to [Choosing where to store pokeemerald Expansion (macOS)](#choosing-where-to-store-pokeemerald-expansion-macos).
+
+### Installing pkg-config (macOS)
+<details>
+    <summary><i>Note for advanced users...</i></summary>
+
+>   This guide installs pkg-config via Homebrew as it is the easiest method, however advanced users can install pkg-config through other means if they so desire.
+</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 pkg-config
+    ```
+    pkg-config is now installed.
+
     Continue to [Installing devkitARM (macOS)](#installing-devkitarm-macos) if **devkitARM is not installed**, otherwise, go to [Choosing where to store pokeemerald Expansion (macOS)](#choosing-where-to-store-pokeemerald-expansion-macos).
 
 ### Installing devkitARM (macOS)
@@ -346,6 +363,18 @@ If this works, then proceed to [Installation](#installation). Otherwise, ask for
 
 4. After the tools are installed, devkitARM must now be made accessible from anywhere by the system. To do so, run the following commands:
 
+    ```bash
+    export DEVKITPRO=/opt/devkitpro
+    echo "export DEVKITPRO=$DEVKITPRO" >> ~/.zshrc
+    export DEVKITARM=$DEVKITPRO/devkitARM
+    echo "export DEVKITARM=$DEVKITARM" >> ~/.zshrc
+
+    echo "if [ -f ~/.zshrc ]; then . ~/.zshrc; fi" >> ~/.zprofile
+    ```
+    *Note: Starting with macOS 10.15, the default Unix shell is now zsh. If you migrated from an older version of macOS, you might still be using bash. You can check my running `echo $0` in the terminal.*
+    <details>
+        <summary><i>If your terminal is using bash instead of zsh...</i></summary>
+
     ```bash
     export DEVKITPRO=/opt/devkitpro
     echo "export DEVKITPRO=$DEVKITPRO" >> ~/.bashrc
@@ -354,6 +383,7 @@ If this works, then proceed to [Installation](#installation). Otherwise, ask for
 
     echo "if [ -f ~/.bashrc ]; then . ~/.bashrc; fi" >> ~/.bash_profile
     ```
+    </details>
 
 ### Installing Python (macOS)
 1. Download the latest Python package from [here](https://www.python.org/downloads/).
@@ -441,6 +471,20 @@ devkitARM is now installed.
 
 Then proceed to [Choosing where to store pokeemerald Expansion (Linux)](#choosing-where-to-store-pokeemerald-expansion-linux).
 
+### NixOS
+Run the following command to start an interactive shell with the necessary packages:
+```bash
+nix-shell -p pkgsCross.arm-embedded.stdenv.cc git pkg-config libpng
+```
+Then proceed to [Choosing where to store pokeemerald Expansion (Linux)](#choosing-where-to-store-pokeemerald-expansion-linux).
+
+### NixOS
+Run the following command to start an interactive shell with the necessary packages:
+```bash
+nix-shell -p pkgsCross.arm-embedded.stdenv.cc git pkg-config libpng
+```
+Then proceed to [Choosing where to store pokeemerald Expansion (Linux)](#choosing-where-to-store-pokeemerald-expansion-linux).
+
 ### Other distributions
 _(Specific instructions for other distributions would be greatly appreciated!)_
 
@@ -558,7 +602,8 @@ Note that this is not necessary for a non-modern (agbcc) build since those are b
 
 <details>
     <summary><i>Deprecated; installing agbcc is optional since 1.7.0</i>.</summary>
-2. Install agbcc into pokeemerald-expansion. The commands to run depend on certain conditions. **You should only follow one of the listed instructions**:
+
+1. Install agbcc into pokeemerald-expansion. The commands to run depend on certain conditions. **You should only follow one of the listed instructions**:
 - If agbcc has **not been built before** in the folder where you chose to store pokeemerald Expansion, run the following commands to build and install it into pokeemerald-expansion:
 
     ```bash
@@ -587,18 +632,20 @@ Note that this is not necessary for a non-modern (agbcc) build since those are b
     <details>
         <summary><i>Note...</i></summary>
 
-        > If building agbcc or pokeemerald results in an error, try deleting the agbcc folder and re-installing agbcc as if it has not been built before.
+    > If building agbcc or pokeemerald results in an error, try deleting the agbcc folder and re-installing agbcc as if it has not been built before.
     </details>
 
-3. Once agbcc is installed, change directory back to the base directory where pokeemerald-expansion and agbcc are stored:
+2. Once agbcc is installed, change directory back to the base directory where pokeemerald-expansion and agbcc are stored:
 
     ```bash
     cd ..
     ```
-
-4. To compile with agbcc:
 
-    ```make agbcc```
+3. To compile with agbcc:
+
+    ```bash
+    make agbcc
+    ```
 
 </details>