Differences

This shows you the differences between two versions of the page.

--- wswan:guide:wfconfig [2024/02/17 11:10] – asie
+++ wswan:guide:wfconfig [2025/06/17 19:33] (current) – asie
@@ Line 1: / Line 1: @@
-====== wfconfig.toml ======
+====== Project configuration ======
+===== wfconfig.toml =====
 wfconfig.toml serves as a project-wide configuration file.
-===== cartridge =====
+==== cartridge ====
   * **rom_banks** - The number of 64KB ROM banks used by your project; normally, this value is calculated automatically as your project grows in scope.
@@ Line 18: / Line 20: @@
   * **vertical** - Set to ''true'' if your program starts out in the vertical orientation; this adjusts the boot ROM's splash screen appropriately.
-==== Metadata only ====
+=== Metadata only ===
 The following fields have no effect on execution and exist solely as metadata:
-  * **publisher_id'', **game_id**, **game_version** - Numeric fields describing the game's unique ID.
+  * **publisher_id**, **game_id**, **game_version** - Numeric fields describing the game's unique ID.
   * **color** - Set to ''true'' if your program uses Color modes (regardless of whether it's mandatory or optional).
-  * **rtc** - Set to ''true'' if your program uses the Bandai 2003 mapper's real-time clock functionality.
+  * **mapper** - The mapper used by your cartridge. The following values are supported:
+    * ''"2001"'' - Bandai 2001 mapper. Supports EEPROM communication.
+    * ''"2003"'' - Bandai 2003 mapper. Supports RTC communication, GPIO pins.
-==== Advanced ====
+=== Advanced ===
 Don't touch these unless you're building custom hardware.
@@ Line 34: / Line 38: @@
   * **unlock_internal_eeprom** - Set to ''true'' if your program intends to read to the normally locked area of internal EEPROM. **Note that, if used irresponsibly, this can lead to a brick on Color consoles!**
   * **disable_custom_boot_splash** - Set to ''true'' to force using the default boot splash on Color consoles, as opposed to the one stored in the internal EEPROM. May be used to unbrick consoles in some cases.
+===== libws =====
+libws comes with some configuration options of its own, using defines:
+  * ''-DLIBWS_USE_EXTBANK'' - if defined, the ''ws_bank'' ROM memory wrappers/functions in ''<ws/memory.h>'' will use the 16-bit bank I/O ports exclusive to the 2003 mapper, as opposed to the default 8-bit bank I/O ports.