summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRemy Oukaour <remy.oukaour@gmail.com>2017-12-24 18:40:20 -0500
committerRemy Oukaour <remy.oukaour@gmail.com>2017-12-24 18:40:20 -0500
commite80dba39155f488944d53fd66b922520055863b7 (patch)
tree8242bf66b697d6dfd5a894fdbad317992775dc61
parent1522140e418a3b4f9406a3c4e74a83454e378c1e (diff)
Start documentation for assembly language
Note: Resolved #340, #381, and #393 previously.
-rw-r--r--FAQ.md6
-rw-r--r--docs/assembly_programming.md15
2 files changed, 21 insertions, 0 deletions
diff --git a/FAQ.md b/FAQ.md
index 1cf0ea139..030725a9e 100644
--- a/FAQ.md
+++ b/FAQ.md
@@ -8,6 +8,7 @@
- [Can't build ROM; "Segmentation fault" from `rgbgfx`](#cant-build-rom-segmentation-fault-from-rgbgfx)
- [Can't build ROM; "Section is too big" or "Unable to place section in bank"](#cant-build-rom-section-is-too-big-or-unable-to-place-section-in-bank)
- [How do I edit maps?](#how-do-i-edit-maps)
+- [How do I write new features?](#how-do-i-write-new-features)
- [I need more help!](#i-need-more-help)
@@ -38,6 +39,11 @@ If you added or changed any code, it has to fit in the **memory banks**. The 2MB
For `asm` scripts, read [docs/map_scripts.md](docs/map_scripts.md). For `blk` layouts, try [crowdmap](crowdmap) or [Polished Map](polished-map).
+## How do I write new features?
+
+There are a number of special-purpose scripting languages used for different purposes, as described in [docs](docs/). For more general features, you'll need to code directly in assembly language. See [docs/assembly_language.md](docs/assembly_language.md).
+
+
## I need more help!
Try asking on IRC or Discord (see [README.md](README.md)).
diff --git a/docs/assembly_programming.md b/docs/assembly_programming.md
new file mode 100644
index 000000000..c04710b05
--- /dev/null
+++ b/docs/assembly_programming.md
@@ -0,0 +1,15 @@
+# Assembly Programming
+
+- [**RGBDS documentation**](rgbds-doc): Includes information on the RGBDS tools and the assembly language syntax.
+- [**Pan Docs**](pan-docs): Everything You Always Wanted To Know About GAMEBOY (but were afraid to ask).
+- [**GameBoy Programming Manual](gb-manual): The official GameBoy programming and hardware manual by Nintendo.
+- [**GameBoy Opcode Summary**](gb-opcodes): Describes the opcodes of GameBoy assembly language.
+- [**GameBoy Memory Map**](gb-memory-map): Describes the GameBoy Color address space.
+- [**awesome-gbdev**](awesome-gbdev): A curated list of Game Boy development resources such as tools, docs, emulators, related projects and open-source ROMs.
+
+[rgbds-doc]: https://rednex.github.io/
+[pan-docs]: http://bgb.bircd.org/pandocs.htm
+[gb-manual]: https://ia801906.us.archive.org/19/items/GameBoyProgManVer1.1/GameBoyProgManVer1.1.pdf
+[gb-opcodes]: http://www.devrs.com/gb/files/opcodes.html
+[gb-memory-map]: http://gameboy.mongenel.com/dmg/asmmemmap.html
+[awesome-gbdev]: https://github.com/avivace/awesome-gbdev