Game-Decompilation/pokepinball
1
0
Fork 0
mirror of https://github.com/pret/pokepinball.git synced 2024-11-23 13:49:42 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Refresh build instructions

Browse Source
This commit is contained in:
libjet 2021-01-21 14:13:14 +00:00 committed by huderlem
parent 49c014f3dd
commit 9f755164ec
2 changed files with 70 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

85
INSTALL.md
View File

@ -1,49 +1,50 @@
# Linux
# Instructions
Dependencies:
These instructions explain how to set up the tools required to build **pokepinball**, including [**rgbds**](https://github.com/gbdev/rgbds), which assembles the source files into a ROM.
sudo apt-get install make gcc bison git
sudo easy_install pip
If you run into trouble, ask for help on IRC or Discord (see [README.md](README.md)).
The assembler used is [**rgbds**](https://github.com/bentley/rgbds) version [0.4.0](https://github.com/rednex/rgbds/releases/tag/v0.4.0).
## Linux
git clone https://github.com/rednex/rgbds
cd rgbds
sudo mkdir -p /usr/local/man/man{1,7}
sudo make install
cd ..
rm -rf rgbds
Open **Terminal** and enter the following commands, depending on which distro you're using.
Set up the repository.
### Debian or Ubuntu
git clone https://github.com/huderlem/pokepinball
cd pokepinball
To install the software required for **pokepinball**:
To build `pokepinball.gbc`:
```bash
sudo apt-get install make gcc git
```
make
Then follow the [**rgbds** instructions](https://rgbds.gbdev.io/install/source) to build **rgbds 0.4.2** from source.
This will take a few seconds the first time you build because it needs to process all of the graphics.
After that, you're ready to [build **pokepinball**](#build-pokepinball).
To remove all generated files by the build process:
### Arch Linux
make clean
To install the software required for **pokepinball**:
To compare the built `pokepinball.gbc` to the original ROM:
```bash
sudo pacman -S make gcc git rgbds
```
make compare
Now you're ready to [build **pokepinball**](#build-pokepinball).
If you want to compile and install **rgbds** yourself instead, then follow the [**rgbds** instructions](https://rgbds.gbdev.io/install/source) to build **rgbds 0.4.2** from source.
# OS X
## macOS
In the shell, run:
Install [**Homebrew**](https://brew.sh/). Follow the official instructions.
xcode-select --install
Open **Terminal** and prepare to enter commands.
Then follow the Linux instructions.
Then follow the [**rgbds** instructions](https://rgbds.gbdev.io/install/macos) for macOS to install **rgbds 0.4.2**.
Now you're ready to [build **pokepinball**](#build-pokepinball).
# Windows
## Windows
To build on Windows, install [**Cygwin**](http://cygwin.com/install.html) with the default settings.
@ -53,13 +54,33 @@ Select the following packages:
* git
* gcc-core
The latest pokepinball-compatible version of **rgbds** is [**0.4.0**](https://github.com/rednex/rgbds/releases/tag/v0.4.0). To install, put each of the files in the download in `C:\cygwin\usr\local\bin`.
The latest pokepinball-compatible version of **rgbds** is [**0.4.2**](https://github.com/gbdev/rgbds/releases/tag/v0.4.2). To install, put each of the files in the download in `C:\cygwin\usr\local\bin`.
Then set up the repository. In the **Cygwin terminal**:
Now you're ready to [build **pokepinball**](#build-pokepinball).
git clone https://github.com/pret/pokepinball.git
cd pokepinball
## Build pokepinball
To build `pokepinball.gbc`:
To download the **pokepinball** source files:
make
```bash
git clone https://github.com/pret/pokepinball
cd pokepinball
```
To build **pokepinball.gbc**:
```bash
make
```
To remove all generated files by the build process:
```bash
make clean
```
To compare the built **pokepinball.gbc** to the original ROM:
```bash
make compare
```

28
README.md
View File

@ -11,16 +11,19 @@ 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 Gold**][pokegold]
* Disassembly of [**Pokémon Crystal**][pokecrystal]
* Disassembly of [**Pokémon TCG**][poketcg]
* Disassembly of [**Pokémon Ruby**][pokeruby]
* Disassembly of [**Pokémon Fire Red**][pokefirered]
* Disassembly of [**Pokémon Emerald**][pokeemerald]
* Discord: [**pret**][Discord]
* irc: **irc.freenode.net** [**#pret**][irc]
- **Discord:** [pret][discord]
- **IRC:** [freenode#pret][irc]
Other disassembly projects:
- [**Pokémon Red/Blue**][pokered]
- [**Pokémon Yellow**][pokeyellow]
- [**Pokémon Gold/Silver**][pokegold]
- [**Pokémon Crystal**][pokecrystal]
- [**Pokémon TCG**][poketcg]
- [**Pokémon Ruby**][pokeruby]
- [**Pokémon FireRed**][pokefirered]
- [**Pokémon Emerald**][pokeemerald]
[pokered]: https://github.com/pret/pokered
[pokeyellow]: https://github.com/pret/pokeyellow
@ -30,5 +33,8 @@ To set up the repository, see [**INSTALL.md**](INSTALL.md).
[pokeruby]: https://github.com/pret/pokeruby
[pokefirered]: https://github.com/pret/pokefirered
[pokeemerald]: https://github.com/pret/pokeemerald
[Discord]: https://discord.gg/d5dubZ3
[docs]: https://pret.github.io/pokecrystal/
[wiki]: https://github.com/pret/pokecrystal/wiki
[tutorials]: https://github.com/pret/pokecrystal/wiki/Tutorials
[discord]: https://discord.gg/d5dubZ3
[irc]: https://kiwiirc.com/client/irc.freenode.net/?#pret