如何贡献名称预设
本项目支持自定义和扩展角色“名称预设”(例如“现代小说”、“西幻”、“古风女频”等),名称预设用于在创建或编辑角色时一键随机生成符合特定风格的姓名。
名称预设完全通过静态的 JSON 文件进行配置。以下是贡献或添加自定义名称预设的具体步骤:
1. 创建预设 JSON 文件
所有的预设数据文件都存放在 public/character-name-presets/ 目录下。
请在该目录下创建一个新的 .json 文件,例如 my-custom-preset.json。预设文件需要遵循以下的数据结构:
{
"nameOrder": "surname-first",
"separator": "",
"surnames": [
"赵", "钱", "孙", "李"
],
"maleGivenNames": [
"明远", "亦航", "承安"
],
"femaleGivenNames": [
"若宁", "清妍", "晚晴"
]
}
字段详细说明:
surnames(必须): 姓氏列表(字符串数组)。不能为空。maleGivenNames(必须): 男性名字列表(字符串数组)。不能为空。femaleGivenNames(必须): 女性名字列表(字符串数组)。不能为空。nameOrder(可选): 姓名排列顺序。"surname-first":姓氏在前,名字在后(例如中文名,这是默认值)。"given-first":名字在前,姓氏在后(例如英文名)。
separator(可选): 姓与名之间的拼接分隔符。- 默认是空字符串
""(适用于中文)。 - 如果是西方姓名,通常需要设置为
" "(一个空格)。
- 默认是空字符串
提示:你可以参考已经存在的预设文件(如 modern-fiction.json 或 western-fantasy.json)来编写你自己的 JSON。
2. 在清单中注册预设
仅仅创建 JSON 文件是不够的,项目还需要知道这个预设的显示名称和文件路径。
打开 public/name_list.json 文件,在 JSON 对象中添加你的预设映射。键 (Key) 为前端界面上显示的“预设名称”,值 (Value) 为该 JSON 文件的访问路径。
例如:
{
"现代小说": "/character-name-presets/modern-fiction.json",
"古风女频": "/character-name-presets/ancient-female-fiction.json",
"古风男频": "/character-name-presets/ancient-male-fiction.json",
"西幻": "/character-name-presets/western-fantasy.json",
"我的自定义预设": "/character-name-presets/my-custom-preset.json"
}
3. 本地测试与提交
- 在本地启动项目(如运行
pnpm dev)。 - 进入应用的名称生成或角色编辑界面。
- 在名称预设的下拉列表中,检查是否出现了你添加的预设名称(例如“我的自定义预设”)。
- 点击随机生成按钮,分别测试生成“男”、“女”以及“未知/其他”性别时的名称:
- 验证性别名字池是否正确对应。
- 验证前后缀顺序(
nameOrder)和空格/分隔符(separator)是否符合预期。
如果一切正常,欢迎通过 Pull Request (PR) 提交你的预设,为社区提供更多丰富的角色命名风格!