Skip to content

Commit 878724c

Browse files
hedara90Hedara
hedara90
and
Hedara
authoredDec 25, 2024
Install instructions (rh-hideout#5876)
Co-authored-by: Hedara <hedara90@gmail.com>
1 parent 8cb2f31 commit 878724c

File tree

11 files changed

+288
-534
lines changed

11 files changed

+288
-534
lines changed
 

‎INSTALL.md

+52-534
Large diffs are not rendered by default.

‎docs/install/chromeos/CHROME_OS.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Instructions for ChromeOS
2+
3+
1. Enable the Linux terminal by following the instructions on [this page](https://chromeos.dev/en/productivity/terminal). Be sure to allocate enough space for the Linux install.
4+
2. After the Linux terminal has finished installing, run the following command in the terminal to update and upgrade the Linux terminal:
5+
6+
```console
7+
sudo apt update && apt upgrade
8+
```
9+
3. Then install all dependencies by running the following command:
10+
11+
```console
12+
sudo apt install build-essential binutils-arm-none-eabi gcc-arm-none-eabi libnewlib-arm-none-eabi git libpng-dev python3
13+
```
14+
**NOTE**: The project must be kept in a directory inside the Linux filesystem, for example under `~/Decomps/pokeemerald-expansion`

‎docs/install/linux/ARCH_LINUX.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Arch Linux instructions
2+
## Installing dependencies
3+
Run the following command from the command line:
4+
```console
5+
sudo pacman -S base-devel arm-none-eabi-binutils arm-none-eabi-gcc arm-none-eabi-newlib git libpng python
6+
```

‎docs/install/linux/DEBIAN.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Debian instructions
2+
## Installing dependencies
3+
Open a terminal and run the following command from the command line:
4+
```console
5+
sudo apt install build-essential binutils-arm-none-eabi gcc-arm-none-eabi libnewlib-arm-none-eabi git libpng-dev python3
6+
```

‎docs/install/linux/NIXOS.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# NixOS instructions
2+
Run the following command to start an interactive shell with the necessary packages:
3+
```bash
4+
nix-shell -p pkgsCross.arm-embedded.stdenv.cc git pkg-config libpng
5+
```

‎docs/install/linux/OTHERS.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Instructions for other distributions
2+
1. Try to find the required software in its repositories:
3+
- `gcc`
4+
- `g++`
5+
- `arm-none-eabi-gcc`
6+
- `arm-none-eabi-binutils`
7+
- `arm-none-eabi-newlib`
8+
- `make`
9+
- `git`
10+
- `libpng-dev`
11+
- `python3`

‎docs/install/linux/UBUNTU.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Ubuntu instructions
2+
## Installing dependencies
3+
Open a terminal and run the following command from the command line:
4+
```console
5+
sudo apt install build-essential binutils-arm-none-eabi gcc-arm-none-eabi libnewlib-arm-none-eabi git libpng-dev python3
6+
```

‎docs/install/mac/MAC_OS.md

+93
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
# Instructions for macOS
2+
1. If the Xcode Command Line Tools are not installed, download the tools [here](https://developer.apple.com/xcode/resources/), open your Terminal, and run the following command:
3+
4+
```bash
5+
xcode-select --install
6+
```
7+
8+
2. - If libpng is **not installed**, then go to [Installing libpng (macOS)](#installing-libpng-macos).
9+
- If pkg-config is **not installed**, then go to [Installing pkg-config (macos)](#installing-pkg-config-macos).
10+
- If devkitARM is **not installed**, then go to [Installing devkitARM (macOS)](#installing-devkitarm-macos).
11+
- Otherwise, **open the Terminal** and go to [Choosing where to store pokeemerald-expansion (macOS)](#choosing-where-to-store-pokeemerald-expansion-macos)
12+
13+
### Installing libpng (macOS)
14+
<details>
15+
<summary><i>Note for advanced users...</i></summary>
16+
17+
> 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.
18+
</details>
19+
20+
1. Open the Terminal.
21+
2. If Homebrew is not installed, then install [Homebrew](https://brew.sh/) by following the instructions on the website.
22+
3. Run the following command to install libpng.
23+
24+
```bash
25+
brew install libpng
26+
```
27+
libpng is now installed.
28+
29+
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**.
30+
31+
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).
32+
33+
### Installing pkg-config (macOS)
34+
<details>
35+
<summary><i>Note for advanced users...</i></summary>
36+
37+
> 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.
38+
</details>
39+
40+
1. Open the Terminal.
41+
2. If Homebrew is not installed, then install [Homebrew](https://brew.sh/) by following the instructions on the website.
42+
3. Run the following command to install libpng.
43+
44+
```bash
45+
brew install pkg-config
46+
```
47+
pkg-config is now installed.
48+
49+
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).
50+
51+
### Installing devkitARM (macOS)
52+
1. Download the `devkitpro-pacman-installer.pkg` package from [here](https://github.com/devkitPro/pacman/releases).
53+
2. Open the package to install devkitPro pacman.
54+
3. In the Terminal, run the following commands to install devkitARM:
55+
56+
```bash
57+
sudo dkp-pacman -Sy
58+
sudo dkp-pacman -S gba-dev
59+
sudo dkp-pacman -S devkitarm-rules
60+
```
61+
62+
The command with gba-dev 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.
63+
64+
4. After the tools are installed, devkitARM must now be made accessible from anywhere by the system. To do so, run the following commands:
65+
66+
```bash
67+
export DEVKITPRO=/opt/devkitpro
68+
echo "export DEVKITPRO=$DEVKITPRO" >> ~/.zshrc
69+
export DEVKITARM=$DEVKITPRO/devkitARM
70+
echo "export DEVKITARM=$DEVKITARM" >> ~/.zshrc
71+
72+
echo "if [ -f ~/.zshrc ]; then . ~/.zshrc; fi" >> ~/.zprofile
73+
```
74+
*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.*
75+
<details>
76+
<summary><i>If your terminal is using bash instead of zsh...</i></summary>
77+
78+
```bash
79+
export DEVKITPRO=/opt/devkitpro
80+
echo "export DEVKITPRO=$DEVKITPRO" >> ~/.bashrc
81+
export DEVKITARM=$DEVKITPRO/devkitARM
82+
echo "export DEVKITARM=$DEVKITARM" >> ~/.bashrc
83+
84+
echo "if [ -f ~/.bashrc ]; then . ~/.bashrc; fi" >> ~/.bash_profile
85+
```
86+
</details>
87+
88+
### Installing Python (macOS)
89+
1. Download the latest Python package from [here](https://www.python.org/downloads/).
90+
2. Open the package to install Python.
91+
92+
Python is now installed.
93+

‎docs/install/windows/CYGWIN.md

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# cygwin
2+
Don't, just don't.
3+
Currently doesn't work on current Expansion versions.
4+
This is a bug from upstream pret `pokeemerald`.

‎docs/install/windows/MSYS2.md

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# msys2
2+
Don't, just don't.
3+
Currently doesn't work on current Expansion versions.
4+
This is a bug from upstream pret `pokeemerald`.

‎docs/install/windows/WSL.md

+87
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
# Windows WSL instructions
2+
## Choosing WSL version
3+
If you must store your project on the Windows file system (under /mnt/c/), you should use WSL1.
4+
If you want the best performance and least amount of issues with Windows interfering with compiling the project, use WSL2 and store the project on the Linux file system (under ~/).
5+
## Installing WSL
6+
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).
7+
8+
```powershell
9+
wsl --install -d Ubuntu --enable-wsl1
10+
```
11+
12+
2. Once the process finishes, restart your machine.
13+
14+
### WSL1
15+
3a. Open Windows Powershell **as Administrator** again (after restarting), and run the following command to configure Ubuntu to use WSL1.
16+
17+
```powershell
18+
wsl --set-version Ubuntu 1
19+
```
20+
### WSL2
21+
3a. Open Windows Powershell **as Administrator** again (after restarting), and run the following command to configure Ubuntu to use WSL2.
22+
23+
```powershell
24+
wsl --set-version Ubuntu 2
25+
```
26+
27+
<details>
28+
<summary><i>Note...</i></summary>
29+
30+
> WSL may open automatically after restarting, but you can ignore it for now.
31+
</details>
32+
33+
## Installing dependencies
34+
Some tips before proceeding:
35+
- In WSL, Copy and Paste is either done via
36+
- **right-click** (selection + right click to Copy, right click with no selection to Paste)
37+
- **Ctrl+Shift+C/Ctrl+Shift+V** (enabled by right-clicking the title bar, going to Properties, then checking the checkbox next to "Use Ctrl+Shift+C/V as Copy/Paste").
38+
- Some of the commands that you'll run will ask for your WSL password and/or confirmation to perform the stated action. This is to be expected, just enter your WSL password and/or the yes action when necessary.
39+
40+
1. Open **Ubuntu** (e.g. using Search).
41+
2. WSL/Ubuntu will set up its own installation when it runs for the first time. Once WSL/Ubuntu finishes installing, it will ask for a username and password (to be input in).
42+
<details>
43+
<summary><i>Note...</i></summary>
44+
45+
> When typing in the password, there will be no visible response, but the terminal will still read in input.
46+
</details>
47+
48+
3. Update WSL/Ubuntu before continuing. Do this by running the following command. These commands will likely take a long time to finish:
49+
50+
```bash
51+
sudo apt update && sudo apt upgrade
52+
```
53+
54+
4. Certain packages are required to build pokeemerald Expansion. Install these packages by running the following command:
55+
56+
```bash
57+
sudo apt install build-essential binutils-arm-none-eabi gcc-arm-none-eabi libnewlib-arm-none-eabi git libpng-dev python3
58+
```
59+
60+
## Choosing a location to store pokeemerald Expansion, WSL1
61+
WSL has its own file system that's not natively accessible from Windows, but Windows files *are* accessible from WSL. So you're going to want to store pokeemerald Expansion within Windows.
62+
63+
For example, say you want to store pokeemerald Expansion in **C:\Users\\_\<user>_\Desktop\decomps**. First, ensure that the folder already exists. Then, enter this command to **change directory** to said folder, where *\<user>* is your **Windows** username:
64+
65+
```bash
66+
cd /mnt/c/Users/<user>/Desktop/decomps
67+
```
68+
69+
<details>
70+
<summary><i>Notes...</i></summary>
71+
72+
> Note 1: The Windows C:\ drive is called /mnt/c/ in WSL.
73+
> Note 2: If the path has spaces, then the path must be wrapped with quotations, e.g. `cd "/mnt/c/users/<user>/Desktop/decomp folder"`.
74+
> Note 3: Windows path names are case-insensitive so adhering to capitalization isn't needed
75+
</details>
76+
77+
## Choosing a location to store pokeemerald Expansion, WSL2
78+
WSL has its own file system that's not natively accessible from Windows, but Windows files *are* accessible from WSL. But accessing files on the Windows file system with WSL2 is very slow, so you're going to want to store pokeemerald Expansion within WSL2.
79+
To access the files on the WSL filesystem from Windowsm, you have to open the WSL filesystem as a network attached storage in the file explorer, it should be at the bottom of the left sidebar as "Ubuntu".
80+
81+
Thus you're going to make sure that you're in the WSL filesystem, then create the folder for decomps if it doesn't already exist, then move into that folder.
82+
83+
```bash
84+
cd ~/
85+
mkdir decomps
86+
cd decomps
87+
```

0 commit comments

Comments
 (0)
Please sign in to comment.