From b384673e3006804d47f6699da69d06640aca2187 Mon Sep 17 00:00:00 2001 From: Randy Thiemann Date: Wed, 25 Oct 2023 06:48:14 +0200 Subject: [PATCH] Update readme. --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3a480ab..b746a3f 100644 --- a/README.md +++ b/README.md @@ -97,9 +97,14 @@ Please do not try running it on older emulators such as VBA, since this game use - B — Go back to title -## Building +## Building and Development The game can be built using gnu make and the RGBDS toolchain. +A few guidelines are in effect: +- If you add a bank, please add a section to `bankid.asm` and follow the existing format. +- If your code breaks existing save data, please update `SAVE_MAGIC_X` in `globals.asm`. This only needs to be done if existing save data would be completely incompatible. +- If you wish to save integer ID's they can be added to SRAM in `InitializeSRAM` and `RestoreSRAM`. However if you're saving a memory address, you should use `PartiallyInitializeSRAM` rather than `InitializeSRAM` so that it gets invalidated on every build. + ## License Copyright (C) 2023 - Randy Thiemann