/INSTALL.md

https://github.com/xCrystal/pokecrystal · Markdown · 84 lines · 54 code · 30 blank · 0 comment · 0 complexity · 08e7cbbfa2d3507839b87c85207326df MD5 · raw file

  1. # Instructions
  2. The source files are assembled into a ROM using [**rgbds**](https://github.com/rednex/rgbds).
  3. These instructions explain how to set up the tools required to build.
  4. If you run into trouble, ask for help on IRC or Discord (see [README.md](README.md)).
  5. ## Linux
  6. ```bash
  7. sudo apt-get install make gcc bison git libpng-dev
  8. git clone https://github.com/rednex/rgbds
  9. cd rgbds
  10. sudo make install
  11. cd ..
  12. git clone https://github.com/pret/pokecrystal
  13. cd pokecrystal
  14. ```
  15. To build **pokecrystal.gbc**:
  16. ```bash
  17. make
  18. ```
  19. ## Mac
  20. In **Terminal**, run:
  21. ```bash
  22. xcode-select --install
  23. git clone https://github.com/rednex/rgbds
  24. cd rgbds
  25. sudo make install
  26. cd ..
  27. git clone https://github.com/pret/pokecrystal
  28. cd pokecrystal
  29. ```
  30. To build **pokecrystal.gbc**:
  31. ```bash
  32. make
  33. ```
  34. ## Windows
  35. Download [**Cygwin**](http://cygwin.com/install.html): **setup-x86_64.exe** for 64-bit Windows, **setup-x86.exe** for 32-bit.
  36. Run setup and leave the default settings. At "Select Packages", choose to install the following:
  37. - `make`
  38. - `git`
  39. - `gcc-core`
  40. Then download [**rgbds**](https://github.com/rednex/rgbds/releases/): the latest **win64.tar.gz** or **win32.tar.gz** release. Extract it and put all the `exe` and `dll` files individually in **C:\Cygwin64\usr\local\bin**.
  41. **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.
  42. In the **Cygwin terminal**, enter these commands:
  43. ```bash
  44. git clone https://github.com/pret/pokecrystal
  45. cd pokecrystal
  46. ```
  47. To build **pokecrystal.gbc**:
  48. ```bash
  49. make
  50. ```
  51. To build **pokecrystal11.gbc**:
  52. ```bash
  53. make crystal11
  54. ```