diff options
| -rw-r--r-- | INSTALL.md | 138 | ||||
| -rw-r--r-- | README.md | 33 |
2 files changed, 108 insertions, 63 deletions
@@ -1,100 +1,142 @@ -The source files are assembled into a rom using [**rgbds**](https://github.com/rednex/rgbds). -These instructions explain how to set up the tools required to build. +# Instructions -If you run into trouble, ask on irc ([**freenode#pret**](https://kiwiirc.com/client/irc.freenode.net/?#pret)). +These instructions explain how to set up the tools required to build **pokegold**, including [**rgbds**](https://github.com/rednex/rgbds), which assembles the source files into a ROM. +Currently building requires that you provide a base ROM for both versions. You can find the sha1 for each version in [README.md](README.md) to confirm you have the right one. -# NOTICE +You will need to rename the Gold ROM to **baserom-gold.gbc** and the Silver ROM to **baserom-silver.gbc** in order to build either version. -Currently building requires that you provide a base ROM for both versions. You can find the md5 for each version in [README.md](README.md) to confirm you have the right one. +If you run into trouble, ask for help on IRC or Discord (see [README.md](README.md)). -You will need to rename the Gold ROM to **baserom-gold.gbc** and the Silver ROM to **baserom-silver.gbc** in order to build either version. +## Windows 10 +Download and install [**Windows Subsystem for Linux**](https://docs.microsoft.com/en-us/windows/wsl/install-win10). Then open the **WSL terminal**. -# Linux +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 pokegold within Windows. You'll have to change the **current working directory** every time you open WSL. -Python 2.7 is required. +For example, if you want to store pokegold in **C:\Users\\*\<user>*\Desktop**, enter this command: ```bash -sudo apt-get install make gcc bison git python +cd /mnt/c/Users/<user>/Desktop +``` -git clone https://github.com/rednex/rgbds -cd rgbds -sudo make install -cd .. +(The Windows `C:\` drive is called `/mnt/c/` in WSL. Replace *\<user>* in the example path with your username.) -git clone --recursive https://github.com/pret/pokegold -cd pokegold -``` +If successful, follow [the regular Linux instructions](#linux) below for whatever distribution you installed for WSL. -To build **pokegold.gbc**: +Otherwise, continue reading below for [the regular Windows instructions](#windows). -```bash -make gold -``` +## Windows -To build **pokesilver.gbc**: +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 the "**Select Packages**" step, choose to install the following, all of which are in the "**Devel**" category: + +- `make` +- `git` +- `gcc-core` + +Double click on the text that says "**Skip**" next to each package to select the most recent version to install. + +Then download [**rgbds**](https://github.com/rednex/rgbds/releases/): the latest **win64.zip** or **win32.zip** release. Extract it and put all the `exe` and `dll` files individually in **C:\cygwin64\usr\local\bin**. + +**Note: If you already have an older rgbds, you will need to update to 0.3.10.** Ignore this if you have never installed rgbds before. If a version newer than 0.3.10 does not work, try downloading 0.3.10. + +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 pokegold there, you'll have to change the **current working directory** every time you open Cygwin. + +For example, if you want to store pokegold in **C:\Users\\*\<user>*\Desktop**: ```bash -make silver +cd /cygdrive/c/Users/<user>/Desktop ``` -To build both ROMs: +(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 **pokegold**](#build-pokegold). + +## macOS + +Install [**Homebrew**](https://brew.sh/). Follow the official instructions. + +Open **Terminal** and enter the following commands. + +To install **rgbds**: ```bash -make +brew install rgbds ``` +Now you're ready to [build **pokegold**](#build-pokegold). -# Mac +## Linux -In **Terminal**, run: +Open **Terminal** and enter the following commands, depending on which distro you're using. -```bash -xcode-select --install +### Debian or Ubuntu -git clone https://github.com/rednex/rgbds -cd rgbds -sudo make install -cd .. +To install the software required for **pokegold**: -git clone --recursive https://github.com/pret/pokegold -cd pokegold +```bash +sudo apt-get install make gcc git ``` -To build **pokegold.gbc**: +To install **rgbds**: ```bash -make gold +sudo apt-get install pkg-config flex bison libpng-dev +git clone -b v0.3.10 --depth=1 https://github.com/rednex/rgbds +sudo make -C rgbds CFLAGS=-O2 install ``` -To build **pokesilver.gbc**: +### OpenSUSE + +To install the software required for **pokegold**: ```bash -make silver +sudo zypper install make gcc git ``` -To build both ROMs: +To install **rgbds**: ```bash -make +sudo zypper install pkg-config flex bison libpng16-devel +git clone -b v0.3.10 --depth=1 https://github.com/rednex/rgbds +sudo make -C rgbds CFLAGS=-O2 install ``` +### Other distros -# Windows +If your distro is not listed here, try to find the required software in its repositories: -To build on Windows, install [**Cygwin**](http://cygwin.com/install.html) with the default settings. +- `make` +- `gcc` (or `clang`) +- `git` +- `rgbds` -In the installer, select the following packages: `make` `git` `python` +If `rgbds` is not available, you'll also need these: -Then get the most recent version of [**rgbds**](https://github.com/rednex/rgbds/releases/). -Extract the archive and put `rgbasm.exe`, `rgblink.exe` and `rgbfix.exe` in `C:\cygwin64\usr\local\bin`. +- `pkg-config` +- `flex` +- `bison` +- `libpng` (and the development headers) -In the **Cygwin terminal**: +To install **rgbds**: ```bash +git clone -b v0.3.10 --depth=1 https://github.com/rednex/rgbds +sudo make -C rgbds CFLAGS=-O2 install +``` -git clone --recursive https://github.com/pret/pokegold +Now you're ready to [build **pokegold**](#build-pokegold). + +## Build pokegold + +To download the **pokegold** source files: + +```bash +git clone https://github.com/pret/pokegold cd pokegold ``` @@ -114,4 +156,4 @@ To build both ROMs: ```bash make -``` +```
\ No newline at end of file @@ -2,25 +2,28 @@ This is a disassembly of Pokémon Gold and Pokémon Silver. -It builds the following roms: +It builds the following ROMs: -* Pokemon - Gold Version (USA, Europe).gbc `md5:a6924ce1f9ad2228e1c6580779b23878` -* Pokemon - Silver Version (USA, Europe).gbc `md5:2ac166169354e84d0e2d7cf4cb40b312` +- Pokemon - Gold Version (UE) [C][!].gbc `sha1: d8b8a3600a465308c9953dfa04f0081c05bdcb94` +- Pokemon - Silver Version (UE) [C][!].gbc `sha1: 49b163f7e57702bc939d642a18f591de55d92dae` -To set up the repository, see [**INSTALL.md**](INSTALL.md). +To set up the repository, see [INSTALL.md](INSTALL.md). ## See also -* Disassembly of [**Pokémon Red/Blue**][pokered] -* Disassembly of [**Pokémon Yellow**][pokeyellow] -* Disassembly of [**Pokémon Crystal**][pokecrystal] -* Disassembly of [**Pokémon Pinball**][pokepinball] -* Disassembly of [**Pokémon TCG**][poketcg] -* Disassembly of [**Pokémon Ruby**][pokeruby] -* Disassembly of [**Pokémon Fire Red**][pokefirered] -* Disassembly of [**Pokémon Emerald**][pokeemerald] -* Discord: [**pret**][Discord] -* irc: **irc.freenode.net** [**#pret**][irc] +- **Discord:** [pret][discord] +- **IRC:** [freenode#pret][irc] + +Other disassembly projects: + +- [**Pokémon Red/Blue**][pokered] +- [**Pokémon Yellow**][pokeyellow] +- [**Pokémon Crystal**][pokecrystal] +- [**Pokémon Pinball**][pokepinball] +- [**Pokémon TCG**][poketcg] +- [**Pokémon Ruby**][pokeruby] +- [**Pokémon Fire Red**][pokefirered] +- [**Pokémon Emerald**][pokeemerald] [pokered]: https://github.com/pret/pokered [pokeyellow]: https://github.com/pret/pokeyellow @@ -30,5 +33,5 @@ To set up the repository, see [**INSTALL.md**](INSTALL.md). [pokeruby]: https://github.com/pret/pokeruby [pokefirered]: https://github.com/pret/pokefirered [pokeemerald]: https://github.com/pret/pokeemerald -[Discord]: https://discord.gg/d5dubZ3 +[discord]: https://discord.gg/d5dubZ3 [irc]: https://kiwiirc.com/client/irc.freenode.net/?#pret |