summaryrefslogtreecommitdiff
path: root/INSTALL.md
blob: fd8ad8d0918be68af1098c8f2fca7c3e995dd147 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
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.

If you run into trouble, ask on irc ([**freenode#pret**](https://kiwiirc.com/client/irc.freenode.net/?#pret)).


# NOTICE

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.

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.


# Linux

Python 2.7 is required.

```bash
sudo apt-get install make gcc bison git python

git clone https://github.com/rednex/rgbds
cd rgbds
sudo make install
cd ..

git clone --recursive https://github.com/pret/pokegold
cd pokegold
```

To build **pokegold.gbc**:

```bash
make gold
```

To build **pokesilver.gbc**:

```bash
make silver
```

To build both ROMs:

```bash
make
```


# Mac

In **Terminal**, run:

```bash
xcode-select --install

git clone https://github.com/rednex/rgbds
cd rgbds
sudo make install
cd ..

git clone --recursive https://github.com/pret/pokegold
cd pokegold
```

To build **pokegold.gbc**:

```bash
make gold
```

To build **pokesilver.gbc**:

```bash
make silver
```

To build both ROMs:

```bash
make
```


# Windows

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`

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`.

In the **Cygwin terminal**:

```bash

git clone --recursive https://github.com/pret/pokegold
cd pokegold
```

To build **pokegold.gbc**:

```bash
make gold
```

To build **pokesilver.gbc**:

```bash
make silver
```

To build both ROMs:

```bash
make
```