Update README and INSTALL markdown files

This commit is contained in:
pikalaxalt 2016-06-17 14:27:47 -04:00
parent 1a1f911eb4
commit 13ff559c04
3 changed files with 93 additions and 443 deletions

View File

@ -1,89 +1,120 @@
The source files are assembled into a rom using [**rgbds**](https://github.com/bentley/rgbds).
These instructions explain how to set up the tools required to build.
If you run into trouble, ask on irc ([**freenode#pret**](https://kiwiirc.com/client/irc.freenode.net/?#pret)).
# NOTICE
Currently the repository requires prebuilt copies of Pokémon Gold and Pokémon Silver. You can find their MD5sums in README.md. Due to legal issues, we are unable to provide direct links to these ROMs, but a quick Google search should point you in the right direction.
You will need to rename the GOLD ROM to **baserom-gold.gbc** and the SILVER ROM to **baserom-silver.gbc** in order to build the respective version of the game.
# Linux
Note that this requires python2.7 for the moment.
Python 2.7 is required.
sudo apt-get install make gcc bison git python python-setuptools
```bash
sudo apt-get install make gcc bison git python
git clone git://github.com/bentley/rgbds.git
cd rgbds
sudo make install
cd ..
git clone https://github.com/bentley/rgbds
cd rgbds
sudo make install
cd ..
git clone --recursive git://github.com/kanzure/pokecrystal.git
cd pokecrystal
git clone --recursive https://github.com/pikalaxalt/pokegold
cd pokegold
```
To build **pokecrystal.gbc**:
To build **pokegold.gbc**:
make
```bash
make gold
```
To build **pokesilver.gbc**:
```bash
make silver
```
To build both ROMs:
```bash
make
```
# OS X
# Mac
On 10.8 or earlier, download and install **Command Line Tools for Xcode**.
In **Terminal**, run:
On 10.9 or later:
```bash
xcode-select --install
xcode-select --install
git clone https://github.com/bentley/rgbds
cd rgbds
sudo make install
cd ..
In the shell, run:
git clone --recursive https://github.com/pikalaxalt/pokegold
cd pokegold
```
git clone git://github.com/bentley/rgbds.git
cd rgbds
sudo make install
cd ..
To build **pokegold.gbc**:
git clone --recursive git://github.com/kanzure/pokecrystal.git
cd pokecrystal
```bash
make gold
```
To build **pokecrystal.gbc**:
To build **pokesilver.gbc**:
make
```bash
make silver
```
To build both ROMs:
```bash
make
```
# Windows
To build on Windows, use [**Cygwin**](http://cygwin.com/install.html) (32-bit).
To build on Windows, install [**Cygwin**](http://cygwin.com/install.html) with the default settings.
In the installer, select the following packages: `make` `git` `python` `python-setuptools` `gcc` `libsasl2` `ca-certificates`
In the installer, select the following packages: `make` `git` `python` `gettext`
Then get the most recent version of [**rgbds**](https://github.com/bentley/rgbds/releases/).
Put `rgbasm.exe`, `rgblink.exe` and `rgbfix.exe` in `C:\cygwin\usr\local\bin`.
Extract the archive and put `rgbasm.exe`, `rgblink.exe` and `rgbfix.exe` in `C:\cygwin64\usr\local\bin`.
In the **Cygwin terminal**:
git clone --recursive git://github.com/kanzure/pokecrystal.git
cd pokecrystal
```bash
To build:
make
# Vagrant
The simplest way to get pokecrystal to compile is to use Vagrant and
VirtualBox. Follow these steps:
* [Download and install Vagrant](http://www.vagrantup.com/downloads.html)
* Follow the instructions to [download and install VirtualBox](http://docs-v1.vagrantup.com/v1/docs/getting-started/)
* Run these commands:
```
vagrant box add pokecrystal http://diyhpl.us/~bryan/irc/pokecrystal/pokecrystal.box
mkdir vagrantbox
cd vagrantbox
vagrant init pokecrystal
vagrant up
vagrant ssh -c "cd /vagrant && git clone --recursive git://github.com/kanzure/pokecrystal.git"
vagrant ssh
git clone --recursive https://github.com/pikalaxalt/pokegold
cd pokegold
```
Running "vagrant ssh" will give you a shell to type commands into for compiling
the source code. Then the "virtualbox" directory on the host appears as a shared
folder inside of the guest virtual machine at "/vagrant".
To build **pokegold.gbc**:
To build the project, run these commands in the guest (that is, inside "vagrant
ssh"):
```bash
make gold
```
cd /vagrant/pokecrystal
make
To build **pokesilver.gbc**:
```bash
make silver
```
To build both ROMs:
```bash
make
```
## notes
- If `gettext` no longer exists, grab `libsasl2-3` `ca-certificates`.

View File

@ -1,21 +1,22 @@
# Pokémon Gold
# Pokémon Gold and Silver
This is a disassembly of Pokémon Gold and (eventually) Pokémon Silver.
This is a disassembly of Pokémon Gold and Pokémon Silver.
It builds the following roms:
* Pokemon - Gold Version (USA, Europe).gbc `md5:a6924ce1f9ad2228e1c6580779b23878`
* Pokemon - Silver Version (USA, Europe).gbc `md5:2ac166169354e84d0e2d7cf4cb40b312` (eventually)
* Pokemon - Silver Version (USA, Europe).gbc `md5:2ac166169354e84d0e2d7cf4cb40b312`
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]
* irc: **irc.freenode.net** [**#pret**][irc]
[pokered]: https://github.com/iimarckus/pokered
[pokeyellow]: https://github.com/iimarckus/pokeyellow
[pokecrystal]: https://github.com/kanzure/pokecrystal
[irc]: https://kiwiirc.com/client/irc.freenode.net/?#pret

View File

@ -1,382 +0,0 @@
INCLUDE "constants.asm"
SECTION "bank1", DATA, BANK[$1]
dr $4000, $8000, 1
SECTION "bank2", DATA, BANK[$2]
dr $8000, $c000, 1
SECTION "bank3", DATA, BANK[$3]
dr $c000, $10000, 1
SECTION "bank4", DATA, BANK[$4]
dr $10000, $14000, 1
SECTION "bank5", DATA, BANK[$5]
dr $14000, $18000, 1
SECTION "bank6", DATA, BANK[$6]
dr $18000, $1c000, 1
SECTION "bank7", DATA, BANK[$7]
dr $1c000, $20000, 1
SECTION "bank8", DATA, BANK[$8]
dr $20000, $24000, 1
SECTION "bank9", DATA, BANK[$9]
dr $24000, $28000, 1
SECTION "banka", DATA, BANK[$a]
dr $28000, $2c000, 1
SECTION "bankb", DATA, BANK[$b]
dr $2c000, $30000, 1
SECTION "bankc", DATA, BANK[$c]
dr $30000, $34000, 1
SECTION "bankd", DATA, BANK[$d]
dr $34000, $38000, 1
SECTION "banke", DATA, BANK[$e]
dr $38000, $3c000, 1
SECTION "bankf", DATA, BANK[$f]
dr $3c000, $40000, 1
SECTION "bank10", DATA, BANK[$10]
dr $40000, $44000, 1
SECTION "bank11", DATA, BANK[$11]
dr $44000, $48000, 1
SECTION "bank12", DATA, BANK[$12]
dr $48000, $4c000, 1
SECTION "bank13", DATA, BANK[$13]
dr $4c000, $50000, 1
SECTION "bank14", DATA, BANK[$14]
dr $50000, $54000, 1
SECTION "bank15", DATA, BANK[$15]
dr $54000, $58000, 1
SECTION "bank16", DATA, BANK[$16]
dr $58000, $5c000, 1
SECTION "bank17", DATA, BANK[$17]
dr $5c000, $60000, 1
SECTION "bank18", DATA, BANK[$18]
dr $60000, $64000, 1
SECTION "bank19", DATA, BANK[$19]
dr $64000, $68000, 1
SECTION "bank1a", DATA, BANK[$1a]
dr $68000, $6c000, 1
SECTION "bank1b", DATA, BANK[$1b]
dr $6c000, $70000, 1
SECTION "bank1c", DATA, BANK[$1c]
dr $70000, $74000, 1
SECTION "bank1d", DATA, BANK[$1d]
dr $74000, $78000, 1
SECTION "bank1e", DATA, BANK[$1e]
dr $78000, $7c000, 1
SECTION "bank1f", DATA, BANK[$1f]
dr $7c000, $80000, 1
SECTION "bank20", DATA, BANK[$20]
dr $80000, $84000, 1
SECTION "bank21", DATA, BANK[$21]
dr $84000, $88000, 1
SECTION "bank22", DATA, BANK[$22]
dr $88000, $8c000, 1
SECTION "bank23", DATA, BANK[$23]
dr $8c000, $90000, 1
SECTION "bank24", DATA, BANK[$24]
dr $90000, $94000, 1
SECTION "bank25", DATA, BANK[$25]
dr $94000, $98000, 1
SECTION "bank26", DATA, BANK[$26]
dr $98000, $9c000, 1
SECTION "bank27", DATA, BANK[$27]
dr $9c000, $a0000, 1
SECTION "bank28", DATA, BANK[$28]
dr $a0000, $a4000, 1
SECTION "bank29", DATA, BANK[$29]
dr $a4000, $a8000, 1
SECTION "bank2a", DATA, BANK[$2a]
dr $a8000, $ac000, 1
SECTION "bank2b", DATA, BANK[$2b]
dr $ac000, $b0000, 1
SECTION "bank2c", DATA, BANK[$2c]
dr $b0000, $b4000, 1
SECTION "bank2d", DATA, BANK[$2d]
dr $b4000, $b8000, 1
SECTION "bank2e", DATA, BANK[$2e]
dr $b8000, $bc000, 1
SECTION "bank2f", DATA, BANK[$2f]
dr $bc000, $c0000, 1
SECTION "bank30", DATA, BANK[$30]
dr $c0000, $c4000, 1
SECTION "bank31", DATA, BANK[$31]
dr $c4000, $c8000, 1
SECTION "bank32", DATA, BANK[$32]
dr $c8000, $cc000, 1
SECTION "bank33", DATA, BANK[$33]
dr $cc000, $d0000, 1
SECTION "bank34", DATA, BANK[$34]
dr $d0000, $d4000, 1
SECTION "bank35", DATA, BANK[$35]
dr $d4000, $d8000, 1
SECTION "bank36", DATA, BANK[$36]
dr $d8000, $dc000, 1
SECTION "bank37", DATA, BANK[$37]
dr $dc000, $e0000, 1
SECTION "bank38", DATA, BANK[$38]
dr $e0000, $e4000, 1
SECTION "bank39", DATA, BANK[$39]
dr $e4000, $e8000, 1
SECTION "bank3a", DATA, BANK[$3a]
dr $e8000, $ec000, 1
SECTION "bank3b", DATA, BANK[$3b]
dr $ec000, $f0000, 1
SECTION "bank3c", DATA, BANK[$3c]
dr $f0000, $f4000, 1
SECTION "bank3d", DATA, BANK[$3d]
dr $f4000, $f8000, 1
SECTION "bank3e", DATA, BANK[$3e]
dr $f8000, $fc000, 1
SECTION "bank3f", DATA, BANK[$3f]
dr $fc000, $100000, 1
SECTION "bank40", DATA, BANK[$40]
dr $100000, $104000, 1
SECTION "bank41", DATA, BANK[$41]
dr $104000, $108000, 1
SECTION "bank42", DATA, BANK[$42]
dr $108000, $10c000, 1
SECTION "bank43", DATA, BANK[$43]
dr $10c000, $110000, 1
SECTION "bank44", DATA, BANK[$44]
dr $110000, $114000, 1
SECTION "bank45", DATA, BANK[$45]
dr $114000, $118000, 1
SECTION "bank46", DATA, BANK[$46]
dr $118000, $11c000, 1
SECTION "bank47", DATA, BANK[$47]
dr $11c000, $120000, 1
SECTION "bank48", DATA, BANK[$48]
dr $120000, $124000, 1
SECTION "bank49", DATA, BANK[$49]
dr $124000, $128000, 1
SECTION "bank4a", DATA, BANK[$4a]
dr $128000, $12c000, 1
SECTION "bank4b", DATA, BANK[$4b]
dr $12c000, $130000, 1
SECTION "bank4c", DATA, BANK[$4c]
dr $130000, $134000, 1
SECTION "bank4d", DATA, BANK[$4d]
dr $134000, $138000, 1
SECTION "bank4e", DATA, BANK[$4e]
dr $138000, $13c000, 1
SECTION "bank4f", DATA, BANK[$4f]
dr $13c000, $140000, 1
SECTION "bank50", DATA, BANK[$50]
dr $140000, $144000, 1
SECTION "bank51", DATA, BANK[$51]
dr $144000, $148000, 1
SECTION "bank52", DATA, BANK[$52]
dr $148000, $14c000, 1
SECTION "bank53", DATA, BANK[$53]
dr $14c000, $150000, 1
SECTION "bank54", DATA, BANK[$54]
dr $150000, $154000, 1
SECTION "bank55", DATA, BANK[$55]
dr $154000, $158000, 1
SECTION "bank56", DATA, BANK[$56]
dr $158000, $15c000, 1
SECTION "bank57", DATA, BANK[$57]
dr $15c000, $160000, 1
SECTION "bank58", DATA, BANK[$58]
dr $160000, $164000, 1
SECTION "bank59", DATA, BANK[$59]
dr $164000, $168000, 1
SECTION "bank5a", DATA, BANK[$5a]
dr $168000, $16c000, 1
SECTION "bank5b", DATA, BANK[$5b]
dr $16c000, $170000, 1
SECTION "bank5c", DATA, BANK[$5c]
dr $170000, $174000, 1
SECTION "bank5d", DATA, BANK[$5d]
dr $174000, $178000, 1
SECTION "bank5e", DATA, BANK[$5e]
dr $178000, $17c000, 1
SECTION "bank5f", DATA, BANK[$5f]
dr $17c000, $180000, 1
SECTION "bank60", DATA, BANK[$60]
dr $180000, $184000, 1
SECTION "bank61", DATA, BANK[$61]
dr $184000, $188000, 1
SECTION "bank62", DATA, BANK[$62]
dr $188000, $18c000, 1
SECTION "bank63", DATA, BANK[$63]
dr $18c000, $190000, 1
SECTION "bank64", DATA, BANK[$64]
dr $190000, $194000, 1
SECTION "bank65", DATA, BANK[$65]
dr $194000, $198000, 1
SECTION "bank66", DATA, BANK[$66]
dr $198000, $19c000, 1
SECTION "bank67", DATA, BANK[$67]
dr $19c000, $1a0000, 1
SECTION "bank68", DATA, BANK[$68]
dr $1a0000, $1a4000, 1
SECTION "bank69", DATA, BANK[$69]
dr $1a4000, $1a8000, 1
SECTION "bank6a", DATA, BANK[$6a]
dr $1a8000, $1ac000, 1
SECTION "bank6b", DATA, BANK[$6b]
dr $1ac000, $1b0000, 1
SECTION "bank6c", DATA, BANK[$6c]
dr $1b0000, $1b4000, 1
SECTION "bank6d", DATA, BANK[$6d]
dr $1b4000, $1b8000, 1
SECTION "bank6e", DATA, BANK[$6e]
dr $1b8000, $1bc000, 1
SECTION "bank6f", DATA, BANK[$6f]
dr $1bc000, $1c0000, 1
SECTION "bank70", DATA, BANK[$70]
dr $1c0000, $1c4000, 1
SECTION "bank71", DATA, BANK[$71]
dr $1c4000, $1c8000, 1
SECTION "bank72", DATA, BANK[$72]
dr $1c8000, $1cc000, 1
SECTION "bank73", DATA, BANK[$73]
dr $1cc000, $1d0000, 1
SECTION "bank74", DATA, BANK[$74]
dr $1d0000, $1d4000, 1
SECTION "bank75", DATA, BANK[$75]
dr $1d4000, $1d8000, 1
SECTION "bank76", DATA, BANK[$76]
dr $1d8000, $1dc000, 1
SECTION "bank77", DATA, BANK[$77]
dr $1dc000, $1e0000, 1
SECTION "bank78", DATA, BANK[$78]
dr $1e0000, $1e4000, 1
SECTION "bank79", DATA, BANK[$79]
dr $1e4000, $1e8000, 1
SECTION "bank7a", DATA, BANK[$7a]
dr $1e8000, $1ec000, 1
SECTION "bank7b", DATA, BANK[$7b]
dr $1ec000, $1f0000, 1
SECTION "bank7c", DATA, BANK[$7c]
dr $1f0000, $1f4000, 1
SECTION "bank7d", DATA, BANK[$7d]
dr $1f4000, $1f8000, 1
SECTION "bank7e", DATA, BANK[$7e]
dr $1f8000, $1fc000, 1
SECTION "bank7f", DATA, BANK[$7f]
dr $1fc000, $200000, 1