diff options
Diffstat (limited to 'INSTALL.md')
-rw-r--r-- | INSTALL.md | 39 |
1 files changed, 26 insertions, 13 deletions
diff --git a/INSTALL.md b/INSTALL.md index e74db0e9e..6e2ea4bb4 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -9,13 +9,10 @@ md5: 9f2922b235a5eeb78d65594e82ef5dde Save it as **baserom.gbc** in the repository. - Feel free to ask us on **[nucleus.kafuka.org #skeetendo](https://kiwiirc.com/client/irc.nolimitzone.com/?#skeetendo)** if something goes wrong. - - # Windows If you're on Windows and can't install Linux, **Cygwin** is a great alternative. @@ -39,7 +36,6 @@ During the install: * **python-setuptools** * **unzip** - ## Using Cygwin Launch the **Cygwin terminal**. @@ -56,7 +52,6 @@ pwd cd /away/we/go ``` - ## Getting up and running We need three things to assemble the source into a rom. @@ -65,8 +60,6 @@ We need three things to assemble the source into a rom. 2. a **pokecrystal** repository 3. a **base rom** -- - We use **rgbds** to spit out a Game Boy rom from source. ```bash cd /usr/local/bin @@ -96,10 +89,17 @@ md5: 9f2922b235a5eeb78d65594e82ef5dde Name it **baserom.gbc**. -- +**pokecrystal** only compiles with the use of a git submodule. To activate the submodule type: + +``` +git submodule init +git submodule update +``` Now you should be able to build **pokecrystal.gbc** for the first time. -This assembles a new rom from the source code. + +This compiles a new rom from the source code, with any patches filled in from the base rom. + ```bash make ``` @@ -112,8 +112,6 @@ Your first build processes every source file at once. After that, **only modified source files have to be processed again**, so compiling again should be a few seconds faster. - - # Linux ```bash @@ -131,7 +129,16 @@ cd .. # download pokecrystal git clone git://github.com/kanzure/pokecrystal.git cd pokecrystal -pip install -r requirements.txt + +# grab extras/ which is required for compiling +git submodule init +git submodule update + +# install python requirements +pip install -r extras/requirements.txt + +# use hexdump to diff binary files +git config diff.hex.textconv hexdump ``` Put your base rom in the pokecrystal repository. Name it **baserom.gbc**. @@ -145,7 +152,6 @@ That will take between 3 and 15 seconds, depending on your computer. If you see `cmp baserom.gbc pokecrystal.gbc` as the last line, the build was successful! Rejoice! - # Now what? **[pokecrystal.asm](https://github.com/kanzure/pokecrystal/blob/master/pokecrystal.asm)** is a good starting point. @@ -169,3 +175,10 @@ We'll be happy to answer any **questions** on **[nucleus.kafuka.org #skeetendo](https://kiwiirc.com/client/irc.nolimitzone.com/?#skeetendo)**. +Other **make targets** that may come in handy: + +`make clean` deletes any preprocessed source files (.tx), rgbds object files and pokecrystal.gbc, in case something goes wrong. + +`make pngs` decompresses any **lz** files in gfx/ and then exports any graphics files to **png**. + +`make lzs` does the reverse. This is already part of the build process, so **modified pngs will automatically be converted to 2bpp and lz-compressed** without any additional work. |