Pk16 Test

Author: Dakorias

.github/ISSUE_TEMPLATE/blank_issue.md

@@ -0,0 +1,4 @@
+---
+name: Update to pokecrystal
+about: Suggest a possible change to pokecrystal itself.
+---

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: pret Discord
+    url: https://discord.gg/d5dubZ3
+    about: If you need help with using pokecrystal, or just have general questions about it, ask in our Discord server!

.github/webhook.sh

@@ -0,0 +1,13 @@
+#!/bin/sh
+set -e
+
+# Report unnamed symbols
+content="$(tools/unnamed.py -r . pokecrystal.sym | grep -v -e '^lib/mobile/' -e '^mobile/' | head)"
+
+curl -H 'Content-Type: application/json' -X POST "$DISCORD_WEBHOOK_URL" -d@- << EOF
+{
+    "username": "OK",
+    "avatar_url": "https://i.imgur.com/38BQHdd.png",
+    "content": "\`\`\`$(echo "$content" | sed -E ':a;N;$!ba;s/\r{0,1}\n/\\n/g')\`\`\`"
+}
+EOF

.github/workflows/main.yml

@@ -0,0 +1,77 @@
+name: CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@master
+
+      - name: Checkout rgbds
+        uses: actions/checkout@master
+        with:
+          path: rgbds
+          ref: v0.6.1
+          repository: gbdev/rgbds
+
+      - name: Install rgbds
+        working-directory: rgbds
+        run: |
+          sudo make install
+
+      - name: Remove rgbds
+        run: |
+          rm -rf rgbds
+
+      - name: Compare
+        if: ${{ github.repository_owner == 'pret' }}
+        run: |
+          make DEBUG=1 -j$(nproc) compare
+          if ! git diff-index --quiet HEAD --; then
+            echo 'Uncommitted changes detected:'
+            git diff-index HEAD --
+            return 1
+          fi
+
+      - name: Make
+        if: ${{ github.repository_owner != 'pret' }}
+        run: |
+          make -j$(nproc)
+          if ! git diff-index --quiet HEAD --; then
+            echo 'Uncommitted changes detected:'
+            git diff-index HEAD --
+            return 1
+          fi
+
+      - name: Discord webhook
+        if: ${{ github.event_name == 'push' && github.repository_owner == 'pret' }}
+        env:
+          DISCORD_WEBHOOK_URL: ${{ secrets.DISCORD_WEBHOOK_URL }}
+        run: |
+          .github/webhook.sh
+
+      - name: Checkout symbols
+        if: ${{ github.event_name == 'push' && github.repository_owner == 'pret' }}
+        uses: actions/checkout@master
+        with:
+          path: symbols
+          ref: symbols
+
+      - name: Move symbols
+        if: ${{ github.event_name == 'push' && github.repository_owner == 'pret' }}
+        run: |
+          cp -v *.sym symbols/
+          cp -v *.map symbols/
+
+      - name: Update symbols
+        if: ${{ github.event_name == 'push' && github.repository_owner == 'pret' }}
+        uses: EndBug/add-and-commit@v9
+        with:
+          cwd: "./symbols"
+          add: "*.sym *.map"
+          message: ${{ github.event.commits[0].message }}

FAQ.md

@@ -0,0 +1,123 @@
+# FAQ
+
+
+## Questions
+
+- [What is pokecrystal11.gbc?](#what-is-pokecrystal11gbc)
+- [What is pokecrystal_au.gbc?](#what-is-pokecrystal_augbc)
+- [I can't build the ROM, `make` just prints an error!](#i-cant-build-the-rom-make-just-prints-an-error)
+  - [`gcc`: command not found](#gcc-command-not-found)
+  - ["ERROR: `UNION` already defined"](#error-union-already-defined)
+  - ["ERROR: Macro not defined"](#error-macro-not-defined)
+  - ["Expression must be 8-bit"](#expression-must-be-8-bit)
+  - ["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)
+- [How do I share code on Discord?](#how-do-i-share-code-on-discord)
+- [I need more help!](#i-need-more-help)
+
+
+## What is pokecrystal11.gbc?
+
+Version 1.1 of Pokémon Crystal, which fixed some issues with the initial international release. `make crystal11` defines `_CRYSTAL11` so the assembly builds the changed version.
+
+
+## What is pokecrystal_au.gbc?
+
+The Australian release of Pokémon Crystal, which is based on the international 1.1 release but censors gambling references from the Game Corners. `make crystal_au` defines `_CRYSTAL11` and `_CRYSTAL_AU` so the assembly builds the changed version.
+
+
+## I can't build the ROM, `make` just prints an error!
+
+Reread [INSTALL.md](INSTALL.md) carefully, and make sure you're following all its steps.
+
+### `gcc`: command not found
+
+You need to install `gcc`. If you're using Cygwin, re-run its setup, and at "Select Packages", choose to install `gcc-core`.
+
+### "ERROR: `UNION` already defined"
+
+Download [**rgbds 0.6.0**][rgbds] or newer. Older versions will not work.
+
+### "ERROR: Macro not defined"
+
+Download [**rgbds 0.6.0**][rgbds] or newer. Older versions will not work.
+
+### "Expression must be 8-bit"
+
+Download [**rgbds 0.6.0**][rgbds] or newer. Older versions will not work.
+
+### "Segmentation fault" from `rgbgfx`
+
+If you are using 64-bit Windows, download [**64-bit Cygwin**][cygwin] and [**64-bit rgbds**][rgbds].
+
+### "Section is too big" or "Unable to place section in bank"
+
+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 added or changed any code, it has to fit in the **memory banks**. The 2MB ROM is divided into 128 banks of 4KB ($4000 bytes) each, numbered $00 to $7F. The linkerscript [layout.link](layout.link) lists which `SECTION`s go in which banks. Try moving some code into a new section.
+
+### "Invalid file or object file version"
+
+Run `make clean` to remove all the old `o` files, then re-run `make`.
+
+### "Syntax error"
+
+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 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?
+
+For `asm` scripts, read [docs/map_event_scripts.md](https://pret.github.io/pokecrystal/map_event_scripts). For `blk` layouts, use [Polished Map][polished-map].
+
+
+## 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](gimp) will do the right job, while other tools such as [paint.net](paintdotnet) or Photoshop might mess it up and output palettes of 255 colors even though only using 4. You may try using tools like [GraphicsGale](graphicsgale) or [IrfanView](irfanview) to fix this, or sometimes resaving the image in Paint seems to help.
+
+Some image `.png` files are grayscale. 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?
+
+There are a number of special-purpose scripting languages, as described in [docs](https://pret.github.io/pokecrystal/). For more general features, you'll need to code directly in [assembly language][asm]. Some of the [tutorials][tutorials] for specific features may also be helpful.
+
+
+## How do I share code on Discord?
+
+If you're looking for help on Discord, you'll probably need to share your code. How to do this:
+
+- Post *short* pieces of code in Discord messages, surrounded with three <code>\`\`\`backticks\`\`\`</code> to make a [code block][markdown].
+- Post longer pieces of code by linking to [GitHub Gist][gist], [Pastebin][pastebin], [Hastebin][hastebin], or other such sites.
+- Share your entire pokecrystal project at once by hosting it on GitHub as a fork of this repository. Read the [GitHub Help][forkhelp] for details.
+
+If your code is on GitHub, you can [link to specific lines][snippethelp]. Put "`#L42`" at the end of a URL to link to line 42, or "`#L10-L20`" to link to lines 10-20. For example: [https://github.com/pret/pokecrystal/blob/master/main.asm#L21-L26](https://github.com/pret/pokecrystal/blob/master/main.asm#L21-L26)
+
+
+## I need more help!
+
+Try asking on Discord or IRC (see [README.md](README.md)).
+
+[cygwin]: https://cygwin.com/install.html
+[rgbds]: https://github.com/gbdev/rgbds/releases
+[polished-map]: https://github.com/Rangi42/polished-map
+[gimp]: https://www.gimp.org/
+[paintdotnet]: https://www.getpaint.net/
+[graphicsgale]: https://graphicsgale.com/us/
+[irfanview]: https://www.irfanview.com/
+[asm]: https://github.com/pret/pokecrystal/wiki/Assembly-programming
+[tutorials]: https://github.com/pret/pokecrystal/wiki/Tutorials
+[markdown]: https://support.discordapp.com/hc/en-us/articles/210298617
+[gist]: https://gist.github.com/
+[pastebin]: https://pastebin.com/
+[hastebin]: https://hastebin.com/
+[forkhelp]: https://help.github.com/en/github/getting-started-with-github/fork-a-repo
+[snippethelp]: https://help.github.com/en/github/managing-your-work-on-github/creating-a-permanent-link-to-a-code-snippet

STYLE.md

@@ -0,0 +1,150 @@
+# Style Guide
+
+Some of the code will disagree with this guide. Older code is less likely to be correct. Use your best judgement.
+
+When you come across an edge case that isn't referenced in this guide, please add it.
+
+
+## Comments
+
+```asm
+; Use tabs for indentation, and spaces for alignment.
+; When tabs get in the way of alignment, use spaces instead.
+
+; Comments lead with spaces after the semicolon.
+
+; 80 char soft limit. This isn't enforced, but you should try to keep lines from being any longer.
+; rgbasm doesn't have newline escapes so there's no avoiding exceeding the limit for longer macros.
+
+; capitalization and punctuation dont matter
+; but it should be consistent with the surroundings
+
+; Space out paragraphs with two newlines. Don't put ;s on blank lines.
+
+; Code comments should be wrapped to whatever
+; is most readable rather than what's closest
+; to the 80 char limit.
+
+; Especially since most code is going to be
+; under 30 chars per line, including tabs.
+
+; Comments should go above the code they're describing, not below, and not inline.
+	ld a, [hl]
+	add b
+	ld [hl], a
+	ret
+
+; Avoid comments on the same line as instructions.
+	cp 10
+	jr c, .elsewhere ; don't do this
+
+; If you have a larger comment and want to make
+; a side note on a snippet of code:
+	; You can indent the comment,
+	; but each line should be shorter
+	; and spaced away from the parent comment
+	halt
+	nop
+
+; To comment out code, put the ; before the tab indent.
+;	nop
+	cp 10
+;	jr c, .bye
+	ret
+```
+
+## Labels
+
+```asm
+; ROM Labels
+PascalCase: ; label
+PascalCase:: ; global label
+.snake_case ; local jump
+.PascalCase: ; an atomic chunk of code or data that's local
+; don't define unused labels when a comment would do
+
+; Labels are prefixed with lower case letters depending on location
+wPascalCase: ; wram
+sPascalCase: ; sram
+vPascalCase: ; vram
+hPascalCase: ; hram
+PascalCase:  ; rom
+
+; Some constants are also prefixed
+DEF rBGP EQU $ff47 ; hardware register
+
+; Most other constants should be upper case
+DEF UPPER_CASE EQU 1
+
+; Long lists of constants should be aligned
+DEF SHORT_CONSTANT       EQU 1
+DEF LONGER_CONSTANT      EQU 2
+DEF PRETTY_LONG_CONSTANT EQU 3
+DEF TINY                 EQU 4
+
+DEF BUT_ONLY_RELATED_CONSTANTS EQU 5
+```
+
+## Directives
+
+```asm
+; meta and high-level directives should be uppercase
+SECTION "section", ROMX
+INCLUDE "filename"
+INCBIN "filename"
+MACRO my_macro
+	nop
+ENDM
+DEF TEST EQUS "test"
+PURGE TEST
+DEF TEST EQU 2
+
+; data macros should be lowercase
+	db 1
+	dw 2
+	my_macro SOME_CONSTANT
+	; one exception is RGB
+	RGB 31, 31, 31
+
+; code macros are currently lowercase but this seems to be causing confusion with actual instructions
+	ld b, TEST
+	farcall DistantFunction
+	ret
+
+; the rest is up to you, just be consistent (prefer lowercase)
+set X, 1
+rept 10
+	nop
+endr
+```
+
+## Macros
+
+```asm
+MACRO when_in_doubt_lowercase
+
+; only shift if it's required or more readable
+	; dont
+	db \1
+	shift
+	db \1
+
+	; do
+rept 10
+	db \1
+	shift
+endr
+
+	; do
+	db \1, \2, \3, \4, \5
+	shift 5
+	db \1, \2, \3, \4, \5
+
+ENDM
+
+
+MACRO UPPER_CASE_IS_OK_SOMETIMES
+
+; but I can't think of any examples besides ACRONYMS
+ENDM
+```

WTW.cheats

@@ -0,0 +1,6 @@
+# 
+0100FAC2
+0100FBC2
+0100FCC2
+0100FDC2
+0100FAC2