pokehacks/pokecrystal-board
0
0
Fork 0
mirror of https://gitlab.com/xCrystal/pokecrystal-board.git synced 2024-09-09 09:51:34 -07:00
Code Issues Packages Projects Releases Wiki Activity

INSTALL: Use git clone --recursive.

Browse Source
This commit is contained in:
yenatch 2015-02-06 13:41:57 -08:00
parent f8acaf69f0
commit 5e8112e305
1 changed files with 67 additions and 82 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

149
INSTALL.md
View File

@ -1,3 +1,68 @@
# Linux
sudo apt-get install make gcc bison git python python-setuptools
git clone git://github.com/bentley/rgbds.git
cd rgbds
sudo make install
cd ..
git clone --recursive git://github.com/kanzure/pokecrystal.git
cd pokecrystal
- Copy a Pokémon Crystal rom into `pokecrystal/`. Name it **baserom.gbc**. Eventually this will not be required.
To build **pokecrystal.gbc**:
make
# OS X
On 10.8 or earlier, download and install **Command Line Tools for Xcode**.
On 10.9 or later:
xcode-select --install
In the shell, run:
git clone git://github.com/bentley/rgbds.git
cd rgbds
sudo make install
cd ..
git clone --recursive git://github.com/kanzure/pokecrystal.git
cd pokecrystal
- Copy a Pokémon Crystal rom into `pokecrystal/`. Name it **baserom.gbc**. Eventually this will not be required.
To build **pokecrystal.gbc**:
make
# Windows
To build on Windows, use [**Cygwin**](http://cygwin.com/install.html) (32-bit).
In the installer, select the following packages: `make` `git` `python` `python-setuptools` `gcc` `libsasl2` `ca-certificates`
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`.
In the **Cygwin terminal**:
git clone --recursive git://github.com/kanzure/pokecrystal.git
cd pokecrystal
- Copy a Pokémon Crystal rom into `C:\cygwin\home\<username>\pokecrystal`. Name it **baserom.gbc**. Eventually this will not be required.
To build:
make
# Vagrant
The simplest way to get pokecrystal to compile is to use Vagrant and
@ -13,13 +78,12 @@ VirtualBox. Follow these steps:
cd vagrantbox
vagrant init pokecrystal
vagrant up
vagrant ssh -c "cd /vagrant && git clone git://github.com/kanzure/pokecrystal.git"
vagrant ssh -c "cd /vagrant/pokecrystal && git submodule init && git submodule update"
vagrant ssh -c "cd /vagrant && git clone --recursive git://github.com/kanzure/pokecrystal.git"
vagrant ssh
```
Running "vagrant ssh" will give you a shell to type commands into for compiling
the source code. The the "virtualbox" directory on the host appears as a shared
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 the project, run these commands in the guest (that is, inside "vagrant
@ -31,82 +95,3 @@ ssh"):
To make the build work you will need to copy baserom.gbc into the "pokecrystal"
directory inside the "virtualbox" directory on the host machine. Eventually
this will not be required.
# Linux
Dependencies:
sudo apt-get install make gcc bison git python python-setuptools
The assembler used is [**rgbds**](https://github.com/bentley/rgbds).
git clone git://github.com/bentley/rgbds.git
cd rgbds
sudo mkdir -p /usr/local/man/man{1,7}
sudo make install
cd ..
Set up the repository.
git clone git://github.com/kanzure/pokecrystal.git
cd pokecrystal
git submodule init
git submodule update
easy_install pypng
make pngs
- Copy your Pokémon Crystal rom into `pokecrystal/`. Name it **baserom.gbc**.
To build **pokecrystal.gbc**:
make
This should take about 30 seconds.
Subsequent builds are much faster (2-10 seconds).
# OS X
Download and install **Command Line Tools for Xcode**.
Then follow the Linux instructions.
If you have Xcode already, you can get Command Line Tools with:
xcode-select --install
# Windows
It's recommended that you use a virtual machine running Linux or OS X.
If you insist on Windows, use [**Cygwin**](http://cygwin.com/install.html) (32-bit).
Dependencies are downloaded in the installer rather than the command line.
Select the following packages:
* make
* git
* python
* python-setuptools
* gcc
* libsasl2
* ca-certificates
To install rgbds, extract the contents of
**http://iimarck.us/etc/rgbds.zip**
and put them in `C:\cygwin\usr\local\bin`.
Then set up the repository. In the **Cygwin terminal**:
git clone git://github.com/kanzure/pokecrystal.git
cd pokecrystal
git submodule init
git submodule update
easy_install pypng
make pngs
- Copy your Pokémon Crystal rom into `C:\cygwin\home\<username>\pokecrystal`. Name it **baserom.gbc**.
To build:
make