Skip to content

Commit 048e02e

Browse files
committed
feat: Add debug compatibility mode for localization lookup failures in README files
1 parent db73e61 commit 048e02e

2 files changed

Lines changed: 24 additions & 0 deletions

File tree

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,18 @@ There is currently no conflict between this library and BaseMod.
1111

1212
Documentation index: [Docs/README.md](Docs/README.md)
1313

14+
## Debug Compatibility Mode
15+
16+
RitsuLib provides a debug compatibility mode for localization lookup failures.
17+
18+
- Setting: debug_compatibility_mode
19+
- Default: disabled (false)
20+
- Behavior when enabled: missing LocTable keys no longer throw immediately; they fall back to key placeholder text and emit a warning log.
21+
22+
Settings file path on Windows:
23+
24+
%appdata%\SlayTheSpire2\steam\<user_id>\mod_data\com.ritsukage.sts2-RitsuLib\settings.json
25+
1426
## License
1527

1628
MIT

README.zh.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,18 @@ English README: [README.md](README.md)
1111

1212
文档入口: [Docs/README.md](Docs/README.md)
1313

14+
## Debug 兼容模式
15+
16+
RitsuLib 提供了一个用于本地化缺失场景的 debug 兼容模式。
17+
18+
- 配置项: debug_compatibility_mode
19+
- 默认值: 关闭(false)
20+
- 开启后行为: LocTable 缺失键不再直接抛异常,而是回退为 Key 占位符并输出警告日志。
21+
22+
Windows 下 settings 文件路径:
23+
24+
%appdata%\SlayTheSpire2\steam\<user_id>\mod_data\com.ritsukage.sts2-RitsuLib\settings.json
25+
1426
## 许可证
1527

1628
MIT

0 commit comments

Comments
 (0)