Add the function to resize the Character Widths for custom Languages and Easier Way to create Language Files

ASM/c/message.c

@@ -47,6 +47,83 @@ uint16_t FILENAME_ENCODING_WIDE[256] = {
 extern uint8_t PLAYER_NAMES[256][8];
 extern uint8_t PLAYER_NAME_ID;
 uint16_t current_textbox_id;
+
+typedef struct WideCharWidthOverride {
+    uint16_t code;
+    uint8_t width;
+    uint8_t reserved;
+} WideCharWidthOverride;
+
+extern uint16_t LANG_WIDE_CHAR_WIDTH_COUNT;
+extern WideCharWidthOverride LANG_WIDE_CHAR_WIDTH_OVERRIDES[];
+extern uint8_t LANG_WIDE_TEXT_ENGLISH_METRICS;
+
+#define G_REG_EDITOR_PTR ((int16_t**)0x8011BA60)
+
+#define WIDE_TEXT_INIT_XPOS_REG_INDEX 0x580
+#define WIDE_TEXT_LINE_SPACING_REG_INDEX 0x582
+#define WIDE_TEXT_CHAR_SCALE_REG_INDEX 0x583
+
+uint16_t Message_GetWideCharWidth(uint16_t character) {
+    uint16_t count = LANG_WIDE_CHAR_WIDTH_COUNT;
+
+    for (uint16_t i = 0; i < count; i++) {
+        if (LANG_WIDE_CHAR_WIDTH_OVERRIDES[i].code == character) {
+            return LANG_WIDE_CHAR_WIDTH_OVERRIDES[i].width;
+        }
+    }
+
+    return 16;
+}
+
+uint16_t Message_GetWideCharScaledAdvance(uint16_t character, uint16_t textCharScale) {
+    return (uint16_t)(((uint32_t)Message_GetWideCharWidth(character) * (uint32_t)textCharScale) / 100U);
+}
+
+static int16_t Message_GetWideTextCharScaleValue(void) {
+    return (LANG_WIDE_TEXT_ENGLISH_METRICS != 0) ? 75 : 88;
+}
+
+static int16_t Message_GetWideTextLineSpacingValue(void) {
+    return (LANG_WIDE_TEXT_ENGLISH_METRICS != 0) ? 12 : 18;
+}
+
+static int16_t Message_GetWideTextInitXPosValue(void) {
+    return (LANG_WIDE_TEXT_ENGLISH_METRICS != 0) ? 65 : 50;
+}
+
+uint16_t Message_GetWideTextCharScale(void) {
+    return (uint16_t)Message_GetWideTextCharScaleValue();
+}
+
+uint16_t Message_GetWideTextLineSpacing(void) {
+    return (uint16_t)Message_GetWideTextLineSpacingValue();
+}
+
+uint16_t Message_GetWideTextInitXPos(void) {
+    return (uint16_t)Message_GetWideTextInitXPosValue();
+}
+
+void Message_ApplyJpTextMetrics(void) {
+    int16_t* regEditor = *G_REG_EDITOR_PTR;
+
+    if (regEditor == NULL) {
+        return;
+    }
+
+    regEditor[WIDE_TEXT_CHAR_SCALE_REG_INDEX] = Message_GetWideTextCharScaleValue();
+    regEditor[WIDE_TEXT_LINE_SPACING_REG_INDEX] = Message_GetWideTextLineSpacingValue();
+    regEditor[WIDE_TEXT_INIT_XPOS_REG_INDEX] = Message_GetWideTextInitXPosValue();
+}
+
+void Message_ApplyWideTextNewline(MessageContext* msgCtx) {
+    // Force wide-mode newline spacing to use the same runtime flag as the glyph metrics.
+    // This avoids depending on a possibly stale R_TEXT_LINE_SPACING value.
+    Message_ApplyJpTextMetrics();
+    msgCtx->textPosY += Message_GetWideTextLineSpacingValue();
+    msgCtx->textPosX = Message_GetWideTextInitXPosValue();
+}
+
 // Helper function for adding characters to the decoded message buffer
 void Message_AddCharacter(MessageContext* msgCtx, void* pFont, uint32_t* pDecodedBufPos, uint32_t* pCharTexIdx, uint8_t charToAdd) {
     uint32_t decodedBufPosVal = *pDecodedBufPos;

ASM/src/config.asm

@@ -348,3 +348,41 @@ CFG_BOSSES:
 ; Bosses are listed twice, first 12 are sorted by the same order as the dungeon entrances (including the 3 with no bosses), then 9 in the usual dungeon order.
 
 .align 4
+
+;==================================================================================================
+; Language character width table
+;==================================================================================================
+; f32[144].  The front-end writes language-specific widths here from property.json:CHAR_WIDTHS.
+; The Message_DrawText hijack redirects the original sFontWidths load to this table.
+; Keep this after the existing configuration tables so older CFG_* addresses do not move.
+
+.align 4
+.area 0x240, 0
+LANG_CHAR_WIDTHS:
+.endarea
+
+
+;==================================================================================================
+; Language wide character width override table
+;==================================================================================================
+; Used only by JP/wide text mode languages.
+; Runtime default width is fixed at 16 pixels. Only entries listed in property.json:CHAR_WIDTHS
+; are written here, using compact pseudo-variable-length entries:
+;   u16 code, u8 width, u8 reserved
+; LANG_WIDE_TEXT_ENGLISH_METRICS is written by Patches.py from
+; lang_property.wide_text_english_metrics. 0 = vanilla JP metrics, 1 = English-like metrics.
+
+.align 4
+LANG_WIDE_TEXT_ENGLISH_METRICS:
+.byte 0
+.byte 0, 0, 0
+
+.align 4
+LANG_WIDE_CHAR_WIDTH_COUNT:
+.halfword 0
+.halfword 0
+
+.align 4
+.area 0x1000, 0
+LANG_WIDE_CHAR_WIDTH_OVERRIDES:
+.endarea

ASM/src/hacks/message.asm

@@ -11,3 +11,162 @@
 ; Replaces  li  t7,1      (msgCtx->stateTimer = 1)
 .org 0x800debb8     ; in Message_DrawMain
     li  t7,2        ; Add one extra frame between Ocarina effect and Nayru killed
+
+;================================================================================
+; Repoint vanilla non-wide message character width table
+;================================================================================
+; This file is included by ASM/src/hacks.asm as hacks/message.asm.
+;
+; Object/map note for this hack context:
+;   .headersize maps z_message_z_game_over.o .text offset 0 to VRAM 0x800D5EF0.
+;   Message_OpenText is .text + 0x6948, therefore 0x800DC838 here.
+;   The sFontWidths HI/LO relocation sites are Message_OpenText - 0x279C / -0x278C.
+;
+; LANG_CHAR_WIDTHS is added after CFG_BOSSES in config.asm. Newly-added config labels
+; are not always visible in this armips pass, so this uses the already-visible
+; CFG_BOSSES anchor instead of referencing LANG_CHAR_WIDTHS directly.
+;
+; Current config layout:
+;   CFG_BOSSES size = 21 * 0x9 = 0xBD
+;   LANG_CHAR_WIDTHS starts at CFG_BOSSES + 0xBD
+;   vanilla raw-byte index compensation = 0x20 * sizeof(f32) = 0x80
+;   load base = LANG_CHAR_WIDTHS - 0x80 = CFG_BOSSES + 0x3D
+
+.definelabel MESSAGE_OPEN_TEXT_VRAM, 0x800DC838
+
+.org MESSAGE_OPEN_TEXT_VRAM - 0x279C
+    lui     at, hi(LANG_CHAR_WIDTHS - 0x80)
+
+.org MESSAGE_OPEN_TEXT_VRAM - 0x278C
+    lwc1    f16, lo(LANG_CHAR_WIDTHS - 0x80)(at)
+
+
+;================================================================================
+; JP/wide text metrics runtime switch
+;================================================================================
+; The old Python-side immediate patch was fragile because it depended on exact ROM
+; offsets. Hook the JP branch in Message_OpenText instead. Non-JP text still uses
+; the original English branch. JP/wide languages call the C helper, which checks
+; LANG_WIDE_TEXT_ENGLISH_METRICS and writes either vanilla JP metrics or English-like
+; metrics at runtime.
+;
+; Original JP branch in z_message_z_game_over.o:
+;   Message_OpenText + 0x108  (.text + 0x6A50)  starts JP metrics writes
+;   Message_OpenText + 0x144  (.text + 0x6A8C)  rejoins after metrics selection
+
+.definelabel MESSAGE_OPEN_TEXT_JP_METRICS_VRAM, MESSAGE_OPEN_TEXT_VRAM + 0x108
+.definelabel MESSAGE_OPEN_TEXT_AFTER_METRICS_VRAM, MESSAGE_OPEN_TEXT_VRAM + 0x144
+
+.org MESSAGE_OPEN_TEXT_JP_METRICS_VRAM
+.area 0x24, 0
+    ; Preserve the live values used after the metrics block.
+    addiu   sp, sp, -0x08
+    sw      v1, 0x0000(sp)      ; current textId
+    jal     Message_ApplyJpTextMetrics
+    sw      a1, 0x0004(sp)      ; gSaveContext pointer
+    lw      v1, 0x0000(sp)
+    lw      a1, 0x0004(sp)
+    addiu   sp, sp, 0x08
+    b       MESSAGE_OPEN_TEXT_AFTER_METRICS_VRAM
+    nop
+.endarea
+
+;================================================================================
+; Wide/Japanese newline metrics override
+;================================================================================
+; The normal newline path reads R_TEXT_LINE_SPACING and R_TEXT_INIT_XPOS directly.
+; Hook it so wide_text_english_metrics also controls line distance even if a later
+; game path restores the vanilla JP register values.
+
+.definelabel MESSAGE_DRAW_TEXT_WIDE_NEWLINE_VRAM,       0x800D7CF8
+.definelabel MESSAGE_DRAW_TEXT_WIDE_AFTER_NEWLINE_VRAM, 0x800D7D1C
+
+.org MESSAGE_DRAW_TEXT_WIDE_NEWLINE_VRAM
+.area (MESSAGE_DRAW_TEXT_WIDE_AFTER_NEWLINE_VRAM - MESSAGE_DRAW_TEXT_WIDE_NEWLINE_VRAM), 0
+    jal     Message_ApplyWideTextNewline
+    or      a0, s1, r0          ; s1 = &play->msgCtx in Message_DrawTextWide
+    b       MESSAGE_DRAW_TEXT_WIDE_AFTER_NEWLINE_VRAM
+    nop
+.endarea
+
+;================================================================================
+; Wide/Japanese message width override lookup
+;================================================================================
+; Replaces the post-draw width handling in Message_DrawTextWide. The vanilla code
+; has several hard-coded JP punctuation advances, then a 16px default. For the
+; language override system, the C helper first searches LANG_WIDE_CHAR_WIDTH_*
+; and returns default 16 when the character is not listed. This keeps ROM usage
+; low and gives CHAR_WIDTHS precedence over every wide character.
+;
+; Offsets from z_message_z_game_over.o:
+;   Message_DrawTextWide = .text + 0x1C10
+;   default glyph draw setup starts at .text + 0x2E30
+;   post Message_DrawTextChar width handling starts at .text + 0x2E50
+;   next loop continuation starts at .text + 0x2F84
+;
+; v3 only changed metrics in Message_OpenText. Some message paths can still render
+; with stale JP scale/spacing, so v4 also reapplies metrics immediately before
+; every wide glyph is drawn. This guarantees Message_DrawTextChar sees the
+; English-like R_TEXT_CHAR_SCALE value and later newline handling sees the
+; English-like R_TEXT_LINE_SPACING value.
+
+.definelabel MESSAGE_DRAW_TEXT_WIDE_BEFORE_DRAW_VRAM, 0x800D8D20
+.definelabel MESSAGE_DRAW_TEXT_WIDE_AFTER_WIDTH_VRAM,  0x800D8E74
+.definelabel MESSAGE_DRAW_TEXT_CHAR_VRAM,              0x800D6470
+
+.org MESSAGE_DRAW_TEXT_WIDE_BEFORE_DRAW_VRAM
+.area (MESSAGE_DRAW_TEXT_WIDE_AFTER_WIDTH_VRAM - MESSAGE_DRAW_TEXT_WIDE_BEFORE_DRAW_VRAM), 0
+    ; Ensure R_TEXT_CHAR_SCALE / R_TEXT_LINE_SPACING / R_TEXT_INIT_XPOS are current
+    ; before Message_DrawTextChar computes sCharTexSize and sCharTexScale.
+    ; The current wide character is in t0/t8 depending on the path; preserve the
+    ; canonical t0 value on the stack before calling C helpers.
+    or      t0, t0, r0          ; current wide character was reloaded into t0 by prior paths
+    sw      t0, 0x0050(sp)
+    jal     Message_ApplyJpTextMetrics
+    nop
+
+    ; Displaced vanilla setup for Message_DrawTextChar.
+    ; Message_DrawTextChar is a vanilla z_message function and is not visible as a
+    ; symbol in this armips pass, so call its local VRAM address explicitly.
+    ;   t9 = font->charTexBuf base saved at 0x58(sp)
+    ;   charTexIdx = 0x128(sp)
+    ;   a0 = play, a1 = texture pointer, a2 = &gfx
+    lw      t0, 0x0050(sp)       ; restore current wide character after helper call
+    lw      t9, 0x0058(sp)
+    lhu     t8, 0x0128(sp)
+    lw      a0, 0x0138(sp)
+    addiu   a2, sp, 0x0124
+    addu    a1, t9, t8
+    jal     MESSAGE_DRAW_TEXT_CHAR_VRAM
+    addiu   a1, a1, 0x0008
+
+    lw      t0, 0x0050(sp)       ; Message_DrawTextChar clobbers t-registers
+
+    ; displaced: charTexIdx += FONT_CHAR_TEX_SIZE
+    lhu     t7, 0x0128(sp)
+    addiu   t7, t7, 0x0080
+    sh      t7, 0x0128(sp)
+
+    ; a0 = current wide character, a1 = R_TEXT_CHAR_SCALE
+    lw      t6, 0x0000(s7)       ; gRegEditor pointer, as used by vanilla Message_DrawTextWide
+    or      a0, r0, t0
+    jal     Message_GetWideCharScaledAdvance
+    lh      a1, 0x0B06(t6)
+
+    ; msgCtx->textPosX += scaled advance
+    lh      t6, 0x63D8(s0)
+    addiu   at, s1, 0x7FFF
+    addu    t7, t6, v0
+    sh      t7, 0x63D9(at)
+
+    ; Message_DrawTextChar and helper calls clobber t-register constants used by
+    ; the next loop iteration.
+    ori     t1, r0, 0x819F
+    ori     t2, r0, 0x81A3
+    ori     t3, r0, 0x81A4
+    ori     t4, r0, 0x81A5
+    ori     t5, r0, 0x8170
+
+    b       MESSAGE_DRAW_TEXT_WIDE_AFTER_WIDTH_VRAM
+    nop
+.endarea