add release instructions and where to look. (#141)

dqx-translation-project · Oct 26, 2023 · a7bde47 · a7bde47
1 parent 36796ab
commit a7bde47
Show file tree

Hide file tree

Showing 2 changed files with 65 additions and 0 deletions.
diff --git a/RELEASES.md b/RELEASES.md
@@ -1,3 +1,61 @@
+# Testing checklist
+
+- When you open clarity with DQX closed, does the "Important Notice" text get found?
+    - If no, check:
+        - `common.process.wait_for_dqx_to_launch`
+        - `common.signatures.notice_string`
+- Do player nameplates translate?
+    - If no, check:
+        - `clarity.scan_for_player_names`
+        - `common.signatures.player_name_pattern`
+- Do NPC, monster and party name nameplates translate?
+    - If no, check:
+        - `clarity.scan_for_npc_names`
+        - `common.signatures.npc_monster_pattern`
+- Do concierge names translate?
+    - If no, check:
+        - `clarity.scan_for_concierge_names`
+        - `common.signatures.concierge_name_pattern`
+- Does the player's sibling name translate?
+    - If no, check:
+        - `clarity.scan_for_sibling_name`
+        - `common.signatures.sibling_name_pattern`
+- Do the party members on the right side of the screen translate?
+    - If no, check:
+        - `clarity.scan_for_menu_ai_names`
+        - `common.signatures.menu_ai_name_pattern`
+- Do player names in the communication window translate? (team, friends)
+    - If no, check:
+        - `clarity.scan_for_menu_ai_names`
+        - `common.signatures.comm_name_pattern_1`
+        - `common.signatures.comm_name_pattern_2`
+- Does the player's walkthrough text in the command menu translate?
+    - If no, check:
+        - `clarity.loop_scan_for_walkthrough`
+        - `common.signatures.walkthrough_pattern`
+- When you talk to an NPC, does it translate into English (from the database)?
+    - Make sure the text is in the database when testing
+    - If no, check:
+        - `logs/console.log`
+        - `hooking.dialog`
+- When you talk to an NPC, does it translate into English (from a translate API)?
+    - Make sure the text **isn't** in the database when testing
+    - If no, check:
+        - `logs/console.log`
+        - `hooking.dialog`
+- Does master quest description text translate?
+    - If no, check:
+        - `logs/console.log`
+        - `hooking.network_text`
+- Does story so far translate?
+    - If no, check:
+        - `logs/console.log`
+        - `hooking.network_text`
+- Do quest descriptions translate?
+    - If no, check:
+        - `logs/console.log`
+        - `hooking.quest`
+
 # Release instructions
 
 Releases are performed through Github Action workflows.

diff --git a/app/common/signatures.py b/app/common/signatures.py
@@ -164,6 +164,13 @@
 #############################################
 
 # pattern for npc/monsters to rename. (49 bytes)
+# covers:
+#   - NPC nameplates
+#   - Monster nameplates
+#   - Monter name references when inspecting
+#   - Monster names appearing in the battle menu
+#   - Party nameplates (don't confuse with party names on the right side of the screen)
+#       - Does not do the player's nameplate
 # npc:     3C 49 ?? ?? 00 00 00 00 00 00 00 00 00 00 00 00 ?? ?? ?? ?? 00 ?? ?? ?? ?? ?? ?? ?? 00 00 00 00 ?? 00 00 00 4C 07 ?? ?? ?? ?? ?? ?? 88 07 ?? ?? E?
 # monster: 3C 49 ?? ?? 00 00 00 00 00 00 00 00 00 00 00 00 ?? ?? ?? ?? 00 ?? ?? ?? ?? ?? ?? ?? 00 00 00 00 ?? 00 00 00 34 F5 ?? ?? ?? ?? ?? ?? 88 07 ?? ?? E?
 # party:   3C 49 ?? ?? 00 00 00 00 00 00 00 00 00 00 00 00 ?? ?? ?? ?? 00 ?? ?? ?? ?? ?? ?? ?? 00 00 00 00 ?? 00 00 00 A0 F7 ?? ?? ?? ?? ?? ?? 88 07 ?? ?? E?