ref: 10701150879fc3bdf28c096a0bb6d16e453ce239
parent: a71b28e5b724564fe19f329f5cbb474f8b111acb
author: mid-kid <esteve.varela@gmail.com>
date: Wed Aug 29 23:14:39 EDT 2018
Update documentation Added windows 10 (WSL) installation instructions and expanded linux instructions. Clarified things in FAQ.md.
--- a/FAQ.md
+++ b/FAQ.md
@@ -10,7 +10,9 @@
- ["Segmentation fault" from `rgbgfx`](#segmentation-fault-from-rgbgfx)
- ["Section is too big" or "Unable to place section in bank"](#section-is-too-big-or-unable-to-place-section-in-bank)
- ["Invalid file or object file version"](#invalid-file-or-object-file-version)
+ - ["Syntax error"](#syntax-error)
- [How do I edit maps?](#how-do-i-edit-maps)
+- [How do I edit the colors of an image?](#how-do-i-edit-the-colors-of-an-image)
- [How do I write new features?](#how-do-i-write-new-features)
- [I need more help!](#i-need-more-help)
@@ -46,10 +48,25 @@
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'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.
+
+
## How do I edit maps?
For `asm` scripts, read [docs/map_event_scripts.md](docs/map_event_scripts.md). For `blk` layouts, try [Polished Map][polished-map] or [crowdmap][crowdmap].
+
+
+## How do I edit the colors of an image?
+
+Most `.png` images are paletted PNGs. You can edit these with any program that supports creating PNGs with palette information. These palettes should consist of exactly 4 colors. Additionally, for Pokémon images, the first color should be white, and the last black. Tools such as Paint and [GIMP](https://www.gimp.org/) will do the right job, while other tools such as Photoshop might mess it up and output palettes of 255 colors even though only using 4. You may try using tools like [GraphicsGale](https://graphicsgale.com/us/) or [IrfanView](https://www.irfanview.com/) to fix this, or sometimes resaving the image in Paint seems to help.
+
+Some image `.png` files are greyscale. This indicates that even though these images do have proper colors in-game, they're shared with something else, and as such changing them will affect other things as well. Don't try opening the `.2bpp` files, these only contain the image data as well, not the palettes.
+
+It really depends on what image you're trying to change the colors of, where these colors are specified. Try looking for related files or `.pal` files.
## How do I write new features?
--- a/INSTALL.md
+++ b/INSTALL.md
@@ -6,20 +6,54 @@
If you run into trouble, ask for help on IRC or Discord (see [README.md](README.md)).
-## Linux
+## Windows 10
-```bash
-sudo apt-get install make gcc bison git libpng-dev
+Set up/install [Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/install-win10).
-git clone https://github.com/rednex/rgbds
-cd rgbds
-sudo make install
-cd ..
+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.
+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 your pokecrystal in `C:\Users\<user>\Desktop`:
+
+```
+cd /mnt/c/Users/<user>/Desktop
+```
+
+(Replace `<user>` with your username.)
+
+You will have to run this command each time you open WSL.
+
+Follow [the instructions for Linux](#linux) to complete the installation.
+
+If this doesn't work, try following the regular Windows installation instructions 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:
+
+- `make`
+- `git`
+- `gcc-core`
+
+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.
+
+In the **Cygwin terminal**, enter these commands:
+
+```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
@@ -26,7 +60,13 @@
make
```
+To build **pokecrystal11.gbc**:
+```bash
+make crystal11
+```
+
+
## Mac
In **Terminal**, run:
@@ -34,9 +74,9 @@
```bash
xcode-select --install
-git clone https://github.com/rednex/rgbds
+git clone --depth=1 https://github.com/rednex/rgbds
cd rgbds
-sudo make install
+sudo make CFLAGS=-O2 install
cd ..
git clone https://github.com/pret/pokecrystal
@@ -50,21 +90,62 @@
```
-## Windows
+## Linux
-Download [**Cygwin**](http://cygwin.com/install.html): **setup-x86_64.exe** for 64-bit Windows, **setup-x86.exe** for 32-bit.
+### Install the required software
-Run setup and leave the default settings. At "Select Packages", choose to install the following:
+#### 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`
-- `gcc-core`
+- `rgbds`
-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**.
+To build `rgbds` from source, if not available for your distro, you need, additionally:
+- `bison`
+- `libpng` (and the development headers)
-**Note: If you have an older rgbds, you will need to update to 0.3.3 or newer.** Ignore this if you have never installed rgbds before.
+And run the following commands:
+```bash
+git clone --depth=1 https://github.com/rednex/rgbds
+sudo make -C rgbds CFLAGS=-O2 install
+```
-In the **Cygwin terminal**, enter these commands:
+### Download and build the code
```bash
git clone https://github.com/pret/pokecrystal
@@ -75,10 +156,4 @@
```bash
make
-```
-
-To build **pokecrystal11.gbc**:
-
-```bash
-make crystal11
```