forked from Ax461/pokeblack
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
139 additions
and
26 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,49 +1,162 @@ | ||
# Linux | ||
# Instructions | ||
|
||
sudo apt-get install make git gcc | ||
These instructions explain how to set up the tools required to build **pokeblack**, including [**rgbds**](https://github.com/gbdev/rgbds), which assembles the source files into a ROM. | ||
|
||
sudo apt-get install byacc flex pkg-config libpng-dev | ||
git clone https://github.com/rednex/rgbds | ||
cd rgbds | ||
sudo make install | ||
cd .. | ||
If you run into trouble, ask for help on IRC or Discord (see [README.md](README.md)). | ||
|
||
git clone https://github.com/Ax461/pokeblack | ||
cd pokeblack | ||
|
||
make | ||
## Windows 10 | ||
|
||
Download and install [**Windows Subsystem for Linux**](https://docs.microsoft.com/en-us/windows/wsl/install-win10). Then open the **WSL terminal**. | ||
|
||
# Mac | ||
Update WSL's software before continuing. If you chose Debian, Ubuntu, or another distribution that uses `apt-get`, then enter this command: | ||
|
||
Get [**Homebrew**](http://brew.sh/). | ||
```bash | ||
apt-get update && apt-get upgrade | ||
``` | ||
|
||
Then in **Terminal**, run: | ||
WSL has its own file system that's not accessible from Windows, but Windows files *are* accessible from WSL. So you're going to want to install pokeblack within Windows. You'll have to change the **current working directory** every time you open WSL. | ||
|
||
xcode-select --install | ||
brew install rgbds | ||
For example, if you want to store pokeblack in **C:\Users\\*\<user>*\Desktop**, enter this command: | ||
|
||
git clone https://github.com/Ax461/pokeblack | ||
cd pokeblack | ||
```bash | ||
cd /mnt/c/Users/<user>/Desktop | ||
``` | ||
|
||
make | ||
(The Windows `C:\` drive is called `/mnt/c/` in WSL. Replace *\<user>* in the example path with your username.) | ||
|
||
If this works, then follow [the instructions for **Linux**](#linux) below for whatever distribution you installed for WSL. | ||
|
||
# Windows | ||
Otherwise, continue reading below for [the older Windows instructions](#windows). | ||
|
||
|
||
## Windows | ||
|
||
Download [**Cygwin**](http://cygwin.com/install.html): **setup-x86_64.exe** for 64-bit Windows, **setup-x86.exe** for 32-bit. | ||
|
||
Run setup and leave the default settings. At "Select Packages", choose to install the following: | ||
Run setup and leave the default settings. At the "**Select Packages**" step, choose to install the following, all of which are in the "**Devel**" category: | ||
|
||
- `make` | ||
- `git` | ||
- `gcc-core` | ||
|
||
Then download [**rgbds**](https://github.com/rednex/rgbds/releases/): the latest **win64.tar.gz** or **win32.tar.gz** release. Extract it and put all the `exe` and `dll` files individually in **C:\cygwin64\usr\local\bin**. | ||
Double click on the text that says "**Skip**" next to each package to select the most recent version to install. | ||
|
||
Then follow the [**rgbds** install instructions](https://rgbds.gbdev.io/install/windows) for Windows with Cygwin to install **rgbds 0.5.1**. | ||
|
||
**Note:** If you already have an older rgbds, you will need to update to 0.5.1. Ignore this if you have never installed rgbds before. If a version newer than 0.5.1 does not work, try downloading 0.5.1. | ||
|
||
Now open the **Cygwin terminal** and enter the following commands. | ||
|
||
Cygwin has its own file system that's within Windows, at **C:\cygwin64\home\\*\<user>***. If you don't want to store pokeblack there, you'll have to change the **current working directory** every time you open Cygwin. | ||
|
||
For example, if you want to store pokeblack in **C:\Users\\*\<user>*\Desktop**: | ||
|
||
```bash | ||
cd /cygdrive/c/Users/<user>/Desktop | ||
``` | ||
|
||
(The Windows `C:\` drive is called `/cygdrive/c/` in Cygwin. Replace *\<user>* in the example path with your username.) | ||
|
||
Now you're ready to [build **pokeblack**](#build-pokeblack). | ||
|
||
|
||
## macOS | ||
|
||
Install [**Homebrew**](https://brew.sh/). Follow the official instructions. | ||
|
||
Open **Terminal** and prepare to enter commands. | ||
|
||
Then follow the [**rgbds** instructions](https://rgbds.gbdev.io/install/macos) for macOS to install **rgbds 0.5.1**. | ||
|
||
Now you're ready to [build **pokeblack**](#build-pokeblack). | ||
|
||
|
||
## Linux | ||
|
||
Open **Terminal** and enter the following commands, depending on which distro you're using. | ||
|
||
### Debian or Ubuntu | ||
|
||
To install the software required for **pokeblack**: | ||
|
||
```bash | ||
sudo apt-get install make gcc git | ||
``` | ||
|
||
Then follow the [**rgbds** instructions](https://rgbds.gbdev.io/install/source) to build **rgbds 0.5.1** from source. | ||
|
||
### OpenSUSE | ||
|
||
To install the software required for **pokeblack**: | ||
|
||
```bash | ||
sudo zypper install make gcc git | ||
``` | ||
|
||
Then follow the [**rgbds** instructions](https://rgbds.gbdev.io/install/source) to build **rgbds 0.5.1** from source. | ||
|
||
### Arch Linux | ||
|
||
To install the software required for **pokeblack**: | ||
|
||
```bash | ||
sudo pacman -S make gcc git | ||
``` | ||
|
||
Then follow the [**rgbds** instructions](https://rgbds.gbdev.io/install/arch) for Arch Linux to install **rgbds 0.5.1**. | ||
|
||
If you want to compile and install **rgbds** yourself instead, then follow the [**rgbds** instructions](https://rgbds.gbdev.io/install/source) to build **rgbds 0.5.1** from source. | ||
|
||
### Termux | ||
|
||
To install the software required for **pokeblack**: | ||
|
||
```bash | ||
sudo apt install make clang git sed | ||
``` | ||
|
||
To install **rgbds**: | ||
|
||
```bash | ||
sudo apt install rgbds | ||
``` | ||
|
||
If you want to compile and install **rgbds** yourself instead, then follow the [**rgbds** instructions](https://rgbds.gbdev.io/install/source) to build **rgbds 0.5.1** from source. | ||
|
||
### Other distros | ||
|
||
If your distro is not listed here, try to find the required software in its repositories: | ||
|
||
- `make` | ||
- `gcc` (or `clang`) | ||
- `git` | ||
- `rgbds` | ||
|
||
If `rgbds` is not available, you'll need to follow the [**rgbds** instructions](https://rgbds.gbdev.io/install/source) to build **rgbds 0.5.1** from source. | ||
|
||
Now you're ready to [build **pokeblack**](#build-pokeblack). | ||
|
||
|
||
## Build pokeblack | ||
|
||
To download the **pokeblack** source files: | ||
|
||
```bash | ||
git clone https://github.com/Ax461/pokeblack | ||
cd pokeblack | ||
``` | ||
|
||
To build **pokeblack.gbc** and **pokeblue.gbc**: | ||
|
||
```bash | ||
make | ||
``` | ||
|
||
In the **Cygwin terminal**, enter these commands: | ||
### Build with a local rgbds version | ||
|
||
git clone https://github.com/Ax461/pokeblack | ||
cd pokeblack | ||
If you have different projects that require different versions of `rgbds`, it might not be convenient to install rgbds 0.5.1 globally. Instead, you can put its files in a directory within pokeblack, such as `pokeblack/rgbds-0.5.1/`. Then specify it when you run `make`: | ||
|
||
make | ||
```bash | ||
make RGBDS=rgbds-0.5.1/ | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters