Migrate to module-owns-placement (a816 HEAD)

build.py

@@ -106,6 +106,7 @@ def build_patch(input, output, lang):
         symbols={"LANG": lang},
         include_paths=[Path("src")],
         prelude_file=Path("config.i"),
+        overlap_mode="warn",
     )
 
     if result.exit_code != 0:
@@ -165,7 +166,9 @@ def build_fixed_asset(table, input_file, binary_text_file):
     write_pointers_value_as_binary(pointers, binary_text_file)
 
 
-def build_fixed_to_ptr_asset(table, input_file, binary_text_file, pointers_file, buffer_width=None):
+def build_fixed_to_ptr_asset(
+    table, input_file, binary_text_file, pointers_file, buffer_width=None
+):
     pointers = read_fixed_from_xml(
         input_file, table, formatter=lambda t: t.strip() + "[end]"
     )
@@ -184,7 +187,7 @@ def build_fixed_to_ptr_asset(table, input_file, binary_text_file, pointers_file,
             print(f"{text} is too long ({ptr_len}px , {math.ceil(ptr_len / 8)} tiles)")
 
     text = table.to_text(max_ptr[1].value)
-    print(f"{text} is the largest ({max_length}px ({math.ceil(max_length/8)})")
+    print(f"{text} is the largest ({max_length}px ({math.ceil(max_length / 8)})")
     write_pointers_value_as_binary(pointers, binary_text_file)
 
     write_pointers_addresses_as_binary(
@@ -327,8 +330,7 @@ def add_custom_kernings(text: str, advance: int) -> None:
         known_pairs_to_kern = [
             "Ya",
             "Pa",
-            "Po"
-            "Fa",
+            "PoFa",
             "Fe",
             "Fo",
             "Fu",
@@ -489,6 +491,12 @@ def build_assets(assets):
             menu_table,
         ),
         ("fixed", menu_table, os.path.join(text_root, "items.xml"), "assets/items.dat"),
+        (
+            "fixed",
+            menu_table,
+            os.path.join(text_root, "items_unleashed.xml"),
+            "assets/items_unleashed.dat",
+        ),
         ("fixed", menu_table, os.path.join(text_root, "magic.xml"), "assets/magic.dat"),
         (
             "fixed",
@@ -528,7 +536,7 @@ def build_assets(assets):
             os.path.join(text_root, "monsters_long.xml"),
             "assets/monsters_long.dat",
             "assets/monsters_long.ptr",
-            80
+            80,
         ),
         (
             "nullterminated",

config.i

@@ -13,6 +13,7 @@ ENABLE_BUTTON_DISPLAY := 1
 BATTLE_CMD_VWF := 1
 BATTLE_NAMES_VWF := 1
 BATTLE_MONSTERS_VWF := 1
+BATTLE_ITEMS_VWF := 1
 INVENTORY_ROLLING_BUFFER := 1
 TREASURE_INVENTORY_ROLLING := 1  ; WIP, treasure rolling-buffer scaffolding only
 TREASURE_DEBUG_ALWAYS_DROP := 1  ; force every win to drop an item (testing)

ff4.s

@@ -53,42 +53,48 @@ conditional_bg1_vofs := 0x208000
 dialog_bank_ptr_base = 0x218000
 
 
-*=0xFFC0
+.alloc at 0x00FFC0 {
     ; patch snes cartridge type
-    ; original PCB: SHVC-1A3B
-    ; target PCB: SHVC-1A5B
+    ; original PCB: SHVC-1A3B  ;  target PCB: SHVC-1A5B
     .ascii "Final Fantasy IV     "
+}
 
-;FFD5 20H / 30H Map Mode
-
-*=0xFFD6
+.alloc at 0x00FFD6 {
+    ; FFD5 20H / 30H Map Mode
     .db 0x02  ; Cartridge Type
     .db 0x0B  ; ~ 0BH ROM Size
     .db 0x07  ; RAM Size
+}
+
 .if ENABLE_BRK_HANDLER {
-    *=0x00FFE0
-; JML trampoline in vector-table padding  ; native/emu BRK vectors point here.
-    jmp.l brk_handler
-    *=0x00FFE6
-    .dw 0xFFE0
-    *=0x00FFFE
-    .dw 0xFFE0
+    ; JML trampoline in vector-table padding; native/emu BRK vectors point here.
+    .alloc at 0x00FFE0 {
+        jmp.l brk_handler
+    }
+    .alloc at 0x00FFE6 {
+        .dw 0xFFE0
+    }
+    .alloc at 0x00FFFE {
+        .dw 0xFFE0
+    }
 }
 
 
-*=0x008031
-    ; déroutage pour ajouter le splash screen
-.if ENABLE_INTRO {
-    jsr.l start_splash_screen
-} else {
-    jsr.l clear_ram
+; déroutage pour ajouter le splash screen
+.alloc at 0x008031 {
+    .if ENABLE_INTRO {
+        jsr.l start_splash_screen
+    } else {
+        jsr.l clear_ram
+    }
 }
 
 
-*=0x00B463
-    ; déroutage pour utiliser la vwf dans les dialogues.
+; déroutage pour utiliser la vwf dans les dialogues.
+.alloc at 0x00B463 {
     jsr.l vwfstart
     rts
+}
 
 ; ============================================================================
 ; Bank-20 relocated region.
@@ -129,8 +135,14 @@ _cond_skip_bg1vofs:
 
 clear_ram:
 """
-Clear the dialog VWF tile buffer at $702000-$706FFF (16-bit zeroes) after letting the boot ROM init at
-$15C9AA.
+Clear the dialog VWF tile buffer + engine scratch at $702000-$7070FF
+(includes VWF_CONFIG_BASE, VWF_CHR_DIRTY / DIRTY_B, VWF_CALLER_CTX, and
+the secondary descriptor fields) after letting the boot ROM init at
+$15C9AA. Range was $5000 bytes pre-secondary-descriptor  ; bumped to
+$5100 so the new dirty / vram_word / byte_count / src_offset bytes
+land zero on cold boot instead of inheriting random SRAM and
+triggering a bogus secondary flush on the very first NMI (which trashed
+the save-selection sprite CHR).
 """
 
 
@@ -142,7 +154,7 @@ $15C9AA.
 _loop:
     sta.l 0x702000, x
     inx
-    cpx.w #0x5000
+    cpx.w #0x5100
     bne _loop
     }
     rtl
@@ -167,6 +179,30 @@ Output: X = offset into ItemName table.
     rtl
 
 
+multiply_item_index_17:
+"""
+Relocated multiply-by-ITEM_UNLEASHED_RECORD_SIZE for the items_unleashed
+name offset. Called from $019023 via JSL when the field menu is
+wired to the 17-byte assets_items_unleashed_dat table.
+Input: $43 = item ID (16-bit mode active).
+Output: X = offset into ItemName table.
+"""
+
+
+; ITEM_UNLEASHED_RECORD_SIZE = 17 = (id << 4) + id.
+    lda 0x43
+    pha
+    asl
+    asl
+    asl
+    asl  ; * 16
+    clc
+    adc 0x01, s  ; * 16 + id = * 17
+    tax
+    pla  ; balance stack
+    rtl
+
+
 multiply_by_12:
 """A: value to multiply  ; returns A*12 in A."""
     php
@@ -184,6 +220,29 @@ multiply_by_12:
     rtl
 
 
+multiply_by_17:
+"""
+A: value to multiply  ; returns A*17 in A. Mirror of multiply_by_12
+sized for the 17-byte assets_items_unleashed_dat stride.
+"""
+
+
+    php
+    rep #0x20
+    and.w #0x00FF
+    pha
+    asl
+    asl
+    asl
+    asl
+    clc
+    adc 0x01, s  ; * 16 + value = * 17
+    sta 0x01, s
+    pla
+    plp
+    rtl
+
+
 brk_handler:
 """
 BRK trap: mask interrupts, disable NMI, fetch the BRK signature byte
@@ -223,7 +282,6 @@ signature byte sits at PB:(PC - 1).
 ; and matches the legacy `*=0x208000` chain so .import modules without
 ; their own `*=` directive land in bank-20 as expected.
 
-*=0x208100
     ; --- Imported modules ---------------------------------------------------
 
 .import "libmz"
@@ -253,6 +311,7 @@ signature byte sits at PB:(PC - 1).
 }
 
 .import "ingame/places_names_window"
+.import "ingame/items_menu_vwf"
 .import "menus/system_menus_text"
 .import "dakuten"
 .import "menus/start_screen_text"
@@ -265,6 +324,7 @@ signature byte sits at PB:(PC - 1).
 .if INVENTORY_ROLLING_BUFFER {
     .import "ingame/init_bg_scroll_hdma"
     .include "src/ingame/inventory_rolling.s"
+    .include "src/lib/rolling_inventory_engine.s"
 }
 
 .if TREASURE_INVENTORY_ROLLING {
@@ -275,6 +335,7 @@ signature byte sits at PB:(PC - 1).
 
 ; --- Binary text assets -------------------------------------------------
 
+
 .incbin "assets/attack_names.ptr"
 .incbin "assets/attack_names.dat"
 .incbin "assets/monsters_long.ptr"
@@ -310,4 +371,12 @@ signature byte sits at PB:(PC - 1).
     stx 0xb3
     jmp.w 0xED96
 }
-;end
+
+; Park the 17-byte-stride items_unleashed.dat in an empty bank so the
+; full 4352-byte table fits without crossing a LoROM bank boundary
+; (which would otherwise leave the upper half of the table at
+; $21:0xxx, an address LoROM does not map back to ROM data).
+
+.alloc at 0x238000 {
+    .incbin "assets/items_unleashed.dat"
+}

plans/battle_items_vwf.md

@@ -0,0 +1,117 @@
+# Battle items VWF
+
+## What
+
+Replace the fixed-width 12-character item-name rendering in the battle
+inventory with the existing 8x8 VWF blitter (`battle_render.display_char`).
+Lets proportionally-spaced French names fit the 15-tile slot budget that
+the rolling inventory already reserves, removes hard truncation, frees
+the per-glyph padding wasted on narrow characters.
+
+## Why
+
+Vanilla `DrawInventoryItemText` packs item names as 12 fixed tile IDs
+into a 48-byte buffer. Our rolling inventory expanded to 60 bytes (15
+tiles per row × 2 bytes), but the renderer still emits one tile-id per
+character, so a 12-character French name like `Médaille d'Or` either
+overflows or truncates. VWF rendering pulls the same name through
+`battle_render.display_char`, allocating CHR dynamically and packing
+proportional glyphs into 15 tiles of horizontal pixels (~120 px).
+
+## Boundaries
+
+- In scope: battle inventory (the in-battle item menu).
+- In scope: the rolling-buffer slot refresh hook (re-render on
+  scroll edge).
+- Out of scope: equipped-items buffer ($9A00). Equip menu rendering
+  stays fixed-width for this PR; can follow up.
+- Out of scope: item descriptions (already VWF via small_vwf).
+- Out of scope: field inventory VWF. Same approach, different surface.
+
+## Approach
+
+1. **Reserve a battle_render region for inventory**. Current regions
+   (`src/battle/message.s:143-150`):
+   ```
+   0x00-0x3F messages
+   0x40-0x7F monster names
+   0x80-0xAF char names
+   0xB0-0xEF commands
+   ```
+   Add `0xF0-0xFF` (16 tiles = 512B CHR) for inventory item name. With
+   6 ring slots and 15 tiles per name, the ring needs ~90 tiles. Either
+   extend the CHR window past $BDE0 (free runway up to roughly
+   $BFE0-ish per the audit) or reuse the commands region during the
+   item-menu mode (commands hide when inventory is open).
+2. **Patch `DrawInventoryItemText`** at `$02:9FA4`. Replace the
+   per-character tile-id copy with a `battle_render.init_inventory`
+   + per-byte `display_char` loop, then write the resulting tile IDs
+   into the existing 60-byte slot at `$97A6 + slot * 60`.
+3. **Quantity digits**. Stay fixed-width for now (the rightmost 2
+   tiles per row in the slot layout). Avoids a special-case digit
+   path in display_char.
+4. **Trash icon**. Existing 2x2 fixed glyph stays. Item id $FF skips
+   the VWF render path.
+5. **Tilemap layout unchanged**. The slot still consumes 30 tiles
+   (15 × 2 rows), still gets DMA'd to VRAM tilemap by the existing
+   rolling-buffer transfer. Only the CHR pointed at by the tile IDs
+   changes.
+
+## Files
+
+- `src/battle/items_patches.s` — hook `DrawInventoryItemText` text
+  copy loop.
+- `src/battle/message.s` — add inventory region constants +
+  `init_inventory` entry.
+- `src/battle/inventory_rolling.s` — slot-refresh callsite. Already
+  pre-renders on swap / scroll; VWF render lands at the same site.
+- `tests/test_battle_init.py` — extend with an "open battle
+  inventory" frame that captures the VWF rendered names.
+
+## Tests
+
+- Battle init smoke unchanged (no item menu open).
+- New `tests/test_battle_inventory_vwf.py`: load a battle-with-items
+  kss, open the item menu, capture screen golden showing
+  VWF-rendered names.
+- `tests/_profile/profile_battle_vwf.py` exercised with the inventory
+  open; confirm `_display_char` calls fit within budget on edge
+  frames (re-render is one slot, ~15 chars × 4.4k cy = 66k cy ≈ 18%
+  of frame).
+
+## Risks
+
+- **CHR overflow**: 90 tiles for the ring needs $A000-base allocation
+  past current region. Audit the $BDE0-? runway carefully before
+  expanding.
+- **Tile-id collision with commands**: if commands region 0xB0-0xEF
+  is the chosen reuse target, items render must wait for cmd window
+  to be hidden. The existing battle inventory open path already
+  hides the cmd window via the slice-2 gates, but verify.
+- **Edge-slot render time**: VWF blit of one item name on scroll
+  edge must fit in ~1 vblank. Item names are ~12-15 chars × 4.4k cy
+  = 53-66k cy ≈ 15-18% of frame budget. Headroom OK.
+- **dakuten/special chars**: item names with accents flow through
+  `battle_display_dakuten_char`. Already handled by the existing VWF
+  path. Verify on `Médaille` etc.
+
+## Phasing
+
+| phase | scope | size |
+|---|---|---|
+| 1 | Region reservation + region-init helper | ~50 lines asm |
+| 2 | `DrawInventoryItemText` VWF hook + slot write | ~150 lines asm |
+| 3 | Rolling-buffer slot-refresh wiring | ~80 lines asm |
+| 4 | Goldens + smoke test for battle inventory | tests |
+| 5 | Polish: quantity-digit alignment, trash icon | small |
+
+Each phase commits independently. PR can land as either one chunk or
+phase-by-phase depending on review cadence.
+
+## Crack
+
+The 90-tile CHR budget is the load-bearing assumption. If the
+$A000-$BFFF window proves too tight, fall back to reusing commands
+region 0xB0-0xEF during item-menu mode and round-trip the cmd window
+on close. Adds a tilemap clear on transition but keeps the CHR
+footprint where it is.