pokecrystal-board/README.md

69 lines
1.6 KiB
Markdown
Raw Normal View History

2013-01-11 00:25:59 -08:00
# Pokémon Crystal
2012-03-04 19:31:27 -08:00
2013-01-11 00:25:59 -08:00
This is a hand-crafted disassembly of Pokémon Crystal.
2012-03-04 19:31:27 -08:00
2013-01-11 00:25:59 -08:00
The source code in this project successfully converts back into a ROM image. All source code is meticulously commented.
2012-03-04 19:31:27 -08:00
2013-01-11 00:25:59 -08:00
## Base ROM
2012-03-04 19:31:27 -08:00
2013-01-11 00:25:59 -08:00
The following ROM is required for compiling:
2012-03-04 19:31:27 -08:00
2013-01-11 00:25:59 -08:00
Pokemon - Crystal Version (UE) (V1.0) [C][!].gbc
2012-03-04 19:31:27 -08:00
2013-01-11 00:25:59 -08:00
md5: 9f2922b235a5eeb78d65594e82ef5dde
2012-03-04 19:31:27 -08:00
2013-01-11 00:25:59 -08:00
Eventually this will not be necessary.
## Installing
Simple.
``` bash
sudo apt-get install make gcc bison git python python-setuptools
# unittest2 is required if using python2.6
sudo easy_install unittest2
2013-02-07 18:39:25 -08:00
sudo easy_install pip
2013-01-11 00:25:59 -08:00
# download rgbds source code
git clone git://github.com/bentley/rgbds.git
# compile rgbds
cd rgbds
make
sudo make install
# check if rgbasm is installed now
which rgbasm
# download pokecrystal
git clone https://github.com/kanzure/pokecrystal.git
cd pokecrystal
2013-02-07 18:39:25 -08:00
pip install -r requirements.txt
2013-01-11 00:25:59 -08:00
make clean && make
```
Also, there are [Windows installation instructions](https://github.com/kanzure/pokecrystal/blob/master/INSTALL.md).
## Assembling
* To assemble, first install RGBDS and put it in your path. The version of RGBDS needed is [rgbds-linux](https://github.com/bentley/rgbds/).
* Next, copy the Pokémon ROM to this directory as "baserom.gbc".
* Then run "make" in your shell.
* This will output a file named "pokecrystal.gbc".
## See also
* disassembly of [Pokémon Red](http://bitbucket.org/iimarckus/pokered).
## Contributing
2013-01-11 00:35:28 -08:00
* Hang out with us on IRC, nucleus.kafuka.org #skeetendo ([or use mibbit](http://chat.mibbit.com/?server=nucleus.kafuka.org&channel=#skeetendo))
2013-01-11 00:25:59 -08:00
* Tackle some [issues](https://github.com/kanzure/pokecrystal/issues)!