pokehacks/pokecrystal-board
0
0
Fork 0
mirror of https://gitlab.com/xCrystal/pokecrystal-board.git synced 2024-11-16 11:27:33 -08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #561 from Rangi42/master

Browse Source 
Revise documentation
This commit is contained in:
Rangi 2018-09-08 12:42:17 -04:00 committed by GitHub
commit 84cfbc70fa
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 143 additions and 117 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
FAQ.md
View File

@ -32,7 +32,7 @@ You need to install `gcc`. If you're using Cygwin, re-run its setup, and at "Sel
### "ERROR: `UNION` already defined"
Download [the latest **rgbds** release][rgbds]. Versions earlier than 0.3.3 will not work.
Download [**rgbds 0.3.7**][rgbds]. Older versions will not work.
### "Segmentation fault" from `rgbgfx`
@ -50,9 +50,9 @@ Run `make clean` to remove all the old `o` files, then re-run `make`.
### "Syntax error"
You've made a mistake while writing some of the code. Re-read the modifications you've made to the file it complains about and try to compare them with other code.
If you have not changed any of the asm, make sure you have the latest version of pokecrystal and the correct version of rgbds (see [INSTALL.md](INSTALL.md)).
If you're not using the latest version of [**rgbds**](https://github.com/rednex/rgbds/releases), update this as well. Don't forget to `make clean` afterwards.
If you added or changed any code, you've made a mistake while writing some of it. Re-read the modifications you've made to the file it complains about and try to compare them with other code.
## How do I edit maps?

250
INSTALL.md
View File

@ -1,59 +1,179 @@
# Instructions
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.
These instructions explain how to set up the tools required to build **pokecrystal**, including [**rgbds**](https://github.com/rednex/rgbds), which assembles the source files into a ROM.
If you run into trouble, ask for help on IRC or Discord (see [README.md](README.md)).
## Windows 10
Set up/install [Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/install-win10).
Download and install [**Windows Subsystem for Linux**](https://docs.microsoft.com/en-us/windows/wsl/install-win10). Then open the **WSL terminal**.
WSL has its own file system that's not accessible from Windows, but the Windows file system, *is* accessible from WSL. So you're going to want to install pokecrystal within the Windows file system.
WSL has its own file system that's not accessible from Windows, but Windows files *are* accessible from WSL. So you're going to want to install pokecrystal within Windows. You'll have to change the **current working directory** every time you open WSL.
The Windows `C:\` drive is called `/mnt/c/` in WSL. You will have to change the current working directory to within `/mnt/c/` every time you open WSL.
For example, if you want to store pokecrystal in **C:\Users\\*\<user>*\Desktop**, enter this command:
For example, if you want your pokecrystal in `C:\Users\<user>\Desktop`:
```
```bash
cd /mnt/c/Users/<user>/Desktop
```
(Replace `<user>` with your username.)
(The Windows `C:\` drive is called `/mnt/c/` in WSL. Replace *\<user>* in the example path with your username.)
You will have to run this command each time you open WSL.
Then follow [the instructions for **Linux**](#linux).
Follow [the instructions for Linux](#linux) to complete the installation.
If this doesn't work, try following the regular Windows installation instructions below.
If this doesn't work, try following [the regular Windows instructions](#windows) below.
## Windows
Download [**Cygwin**](http://cygwin.com/install.html): **setup-x86_64.exe** for 64-bit Windows, **setup-x86.exe** for 32-bit.
Run setup and leave the default settings. At "Select Packages", choose to install the following, all of which are in the "Devel" category:
Run setup and leave the default settings. At the "**Select Packages**" step, choose to install the following, all of which are in the "**Devel**" category:
- `make`
- `git`
- `gcc-core`
Click once on the text that says "Skip" next to each package to select the most recent version to install.
Click once on the text that says "**Skip**" next to each package to select the most recent version to install.
Then download [**rgbds**](https://github.com/rednex/rgbds/releases/): the latest **win64.zip** or **win32.zip** release. Extract it and put all the `exe` and `dll` files individually in **C:\cygwin64\usr\local\bin**.
**Note: If you have an older rgbds, you will need to update to 0.3.7 or newer.** Ignore this if you have never installed rgbds before.
**Note: If you already have an older rgbds, you will need to update to 0.3.7.** Ignore this if you have never installed rgbds before. If a version newer than 0.3.7 does not work, try downloading 0.3.7.
In the **Cygwin terminal**, enter these commands:
Now open the **Cygwin terminal** and enter the following commands.
Cygwin has its own file system that's within Windows, at **C:\cygwin64\home\\*\<user>***. If you don't want to store pokecrystal there, you'll have to change the **current working directory** every time you open Cygwin.
For example, if you want to store pokecrystal in **C:\Users\\*\<user>*\Desktop**:
```bash
cd /cygdrive/c/Users/<user>/Desktop
```
(The Windows `C:\` drive is called `/cygdrive/c/` in Cygwin. Replace *\<user>* in the example path with your username.)
Now you're ready to [build **pokecrystal**](#build-pokecrystal).
## Mac OS X
Open **Terminal** and enter the following commands.
To install the **Xcode Command Line Tools**:
```bash
xcode-select --install
```
To install **rgbds**:
```bash
git clone --depth=1 https://github.com/rednex/rgbds
sudo make -C rgbds CFLAGS=-O2 install
```
Now you're ready to [build **pokecrystal**](#build-pokecrystal).
## Linux
Open **Terminal** and enter the following commands, depending on which distro you're using.
### Debian or Ubuntu
To install the software required for **pokecrystal**:
```bash
sudo apt-get install make gcc git
```
To install **rgbds**:
```bash
sudo apt-get install bison libpng-dev
git clone --depth=1 https://github.com/rednex/rgbds
sudo make -C rgbds CFLAGS=-O2 install
```
### OpenSUSE
To install the software required for **pokecrystal**:
```bash
sudo zypper install make gcc git
```
To install **rgbds**:
```bash
sudo zypper install bison libpng16-devel
git clone --depth=1 https://github.com/rednex/rgbds
sudo make -C rgbds CFLAGS=-O2 install
```
### Arch Linux
To install the software required for **pokecrystal**:
```bash
sudo pacman -S make gcc git
```
To install **rgbds**:
```bash
sudo pacman -S bison libpng
git clone --depth=1 https://github.com/rednex/rgbds
sudo make -C rgbds CFLAGS=-O2 install
```
### Termux
To install the software required for **pokecrystal**:
```bash
sudo apt install make clang git sed
```
To install **rgbds**:
```bash
sudo apt install rgbds
```
### Other distros
If your distro is not listed here, try to find the required software in its repositories:
- `make`
- `gcc` (or `clang`)
- `git`
- `rgbds`
If `rgbds` is not available, you'll also need these:
- `bison`
- `libpng` (and the development headers)
To install **rgbds**:
```bash
git clone --depth=1 https://github.com/rednex/rgbds
sudo make -C rgbds CFLAGS=-O2 install
```
Now you're ready to [build **pokecrystal**](#build-pokecrystal).
## Build pokecrystal
To download the **pokecrystal** source files:
```bash
git clone https://github.com/pret/pokecrystal
cd pokecrystal
```
The files will be stored in **C:\cygwin64\home\<user>**.
To build **pokecrystal.gbc**:
```bash
@ -65,95 +185,3 @@ To build **pokecrystal11.gbc**:
```bash
make crystal11
```
## Mac
In **Terminal**, run:
```bash
xcode-select --install
git clone --depth=1 https://github.com/rednex/rgbds
cd rgbds
sudo make CFLAGS=-O2 install
cd ..
git clone https://github.com/pret/pokecrystal
cd pokecrystal
```
To build **pokecrystal.gbc**:
```bash
make
```
## Linux
### Install the required software
#### Debian/Ubuntu
```bash
sudo apt-get install make gcc bison git libpng-dev
git clone --depth=1 https://github.com/rednex/rgbds
sudo make -C rgbds CFLAGS=-O2 install
```
#### OpenSUSE
```bash
sudo zypper install make gcc bison git libpng16-devel
git clone --depth=1 https://github.com/rednex/rgbds
sudo make -C rgbds CFLAGS=-O2 install
```
#### Arch Linux
```bash
sudo pacman -S make gcc bison git libpng
git clone --depth=1 https://github.com/rednex/rgbds
sudo make -C rgbds CFLAGS=-O2 install
```
#### Termux
```bash
sudo apt install make clang git rgbds sed
```
#### Other distros
If your distro is not listed here, try to find the required software in the repositories:
- `make`
- `gcc` (or `clang`)
- `git`
- `rgbds`
To build `rgbds` from source, if not available for your distro, you need, additionally:
- `bison`
- `libpng` (and the development headers)
And run the following commands:
```bash
git clone --depth=1 https://github.com/rednex/rgbds
sudo make -C rgbds CFLAGS=-O2 install
```
### Download and build the code
```bash
git clone https://github.com/pret/pokecrystal
cd pokecrystal
```
To build **pokecrystal.gbc**:
```bash
make
```

4
Makefile
View File

@ -215,9 +215,6 @@ gfx/unknown/unknown_egg.2bpp: rgbgfx += -h
### Catch-all graphics rules
%.bin: ;
%.blk: ;
%.2bpp: %.png
$(RGBGFX) $(rgbgfx) -o $@ $<
$(if $(tools/gfx),\
@ -230,5 +227,6 @@ gfx/unknown/unknown_egg.2bpp: rgbgfx += -h
%.gbcpal: %.png
$(RGBGFX) -p $@ $<
%.dimensions: %.png
tools/png_dimensions $< $@