diff options
author | PikalaxALT <pikalaxalt@gmail.com> | 2022-03-13 16:04:56 -0400 |
---|---|---|
committer | PikalaxALT <pikalaxalt@gmail.com> | 2022-03-13 16:04:56 -0400 |
commit | ccd694f665ff93e869eb31e1418ba0bb00cba07d (patch) | |
tree | da5b8195f8a8bd5d36016c88fab4848cd21b8878 /docs | |
parent | b7a624077caceaccb9159140c5d6cd4db8c3a792 (diff) |
Sync INSTALL.md with Emerald
Diffstat (limited to 'docs')
-rw-r--r-- | docs/bugs_and_glitches.md | 26 | ||||
-rw-r--r-- | docs/legacy_WSL1_INSTALL.md | 41 |
2 files changed, 67 insertions, 0 deletions
diff --git a/docs/bugs_and_glitches.md b/docs/bugs_and_glitches.md new file mode 100644 index 000000000..ed3f74318 --- /dev/null +++ b/docs/bugs_and_glitches.md @@ -0,0 +1,26 @@ + +# Bugs and Glitches + +These are known bugs and glitches in the original Pokémon FireRed game: code that clearly does not work as intended, or that only works in limited circumstances but has the possibility to fail or crash. Defining the `BUGFIX` and `UBFIX` preprocessor variables will fix some of these automatically. `UBFIX` will already be defined for MODERN builds. + +Fixes are written in the `diff` format. If you've used Git before, this should look familiar: + +```diff + this is some code +-delete red - lines ++add green + lines +``` + +## Contents + +<!--- TODO: Migrate from the wiki ---> +- [Bug 1](#bug-1) + + +## Bug 1 + +A brief description of the bug and how to reproduce it in the vanilla game + +**Fix:** + +Code to edit, in which routines, or data to edit, using the above mentioned diff syntax. diff --git a/docs/legacy_WSL1_INSTALL.md b/docs/legacy_WSL1_INSTALL.md new file mode 100644 index 000000000..b9840d1c8 --- /dev/null +++ b/docs/legacy_WSL1_INSTALL.md @@ -0,0 +1,41 @@ +### Setting up WSL1 (Legacy Portion) + +1. Certain packages are required to build pokeemerald. Install these packages by running the following command: + + ```bash + sudo apt install build-essential git libpng-dev gdebi-core + ``` + > Note: If the above command does not work, try the above command but replacing `apt` with `apt-get`. + +2. Once the packages have finished installing, download the devkitPro pacman package [here](https://github.com/devkitPro/pacman/releases). The file to download is `devkitpro-pacman.amd64.deb`. + +3. WSL has its own file system that's not accessible from Windows, but Windows files *are* accessible from WSL. To install the devkitPro package, you'll need to change to the **current working directory** where the package file was saved. + + For example, if the package file was saved to **C:\Users\\_\<user>_\Downloads** (the Downloads location for most users), enter this command, where *\<user>* is your **Windows** username: + + ```bash + cd /mnt/c/Users/<user>/Downloads + ``` + + > Note 1: The Windows C:\ drive is called /mnt/c/ in WSL. + > Note 2: If the path has spaces, then the path must be wrapped with quotations, e.g. `cd "/mnt/c/users/<user>/Downloads folder"`. + > Note 3: Windows path names are case-insensitive so adhering to capitalization isn't needed + +4. Once the directory has been changed to the folder containing the devkitPro pacman package, run the following commands to install devkitARM. + + ```bash + sudo gdebi devkitpro-pacman.amd64.deb + sudo dkp-pacman -Sy + sudo dkp-pacman -S gba-dev + ``` + + The last command will ask for the selection of packages to install. Just press Enter to install all of them, followed by entering Y to proceed with the installation. + + > Note: `devkitpro-pacman.amd64.deb` is the expected filename of the devkitPro package downloaded (for the first command). If the downloaded package filename differs, then use that filename instead. + +5. Run the following command to set devkitPro related environment variables (alternatively, close and re-open WSL): + ```bash + source /etc/profile.d/devkit-env.sh + ``` + +Proceed to [Choosing where to store pokeemerald (WSL1) of the current INSTALL.md](/INSTALL.md#choosing-where-to-store-pokeemerald-WSL1). |