开始创作
模组介绍与作者资料
让使用者知道这是怎样的作品,以及在哪里找到你。
先找对资料文件的位置
| 类型 | 资料文件 | 图片路径从哪里开始 |
|---|---|---|
| 角色、迷你宠物 | 模组目录下的 info/info.json |
info/ 文件夹 |
| 独立物品模组 | 模组目录下的 info.json |
物品模组根目录 |
资料图片放在对应位置,并按配置里的文件名引用。不要把角色的 info/ 路径结构原样套到物品模组。
角色与迷你宠物示例
下面是一份完整的 info/info.json 起点。所有名字和介绍都是示例,请替换为你的作品;图片也需要自行准备。
{
"coverImages": ["preview.png"],
"pfp": "portrait.png",
"petName": "小伙伴",
"tages": {"原创": "#BDD7EE"},
"intro": "一位喜欢散步的小伙伴。",
"author": {
"name": "你的名字",
"pfp": "author.png",
"frameColor": "#8FAADC",
"links": {},
"infos": "动画与素材制作。"
}
}
字段名确实是 tages,请保留这个拼写,不要自行改成 tags。petName 尽量简短,避免特殊字符;底本建议不超过 10 个字。
物品模组示例
物品模组使用 modName,而不是 petName,也不需要照搬角色的 coverImages:
{
"pfp": "cover.png",
"modName": "午后点心",
"intro": "几份适合午后的点心。",
"author": {
"name": "你的名字",
"pfp": "author.png",
"frameColor": "#8FAADC",
"links": {}
}
}
将这份完整示例保存为物品模组根目录的 info.json,把示例图片放在同一目录。
各项资料怎么填?
| 字段 | 用途 |
|---|---|
coverImages |
角色 / 迷你宠物的预览图片列表,可为空列表 |
pfp |
模组头像或代表图;不是作者头像 |
petName / modName |
对应类型的作品名称 |
tages |
标签文字到颜色值的映射 |
intro |
作品介绍,保存后检查显示是否完整 |
author.name / author.pfp |
作者名字 / 头像图片 |
author.frameColor |
作者头像框颜色 |
author.infos |
作者的额外说明 |
author.links |
平台名称到个人 ID 的映射 |
添加作者主页
author.links 填平台个人 ID,不填完整网址。底本列出的平台键包括 BiliBili、微博、抖音、GitHub、爱发电、TikTok 和 YouTube。先使用空对象 {},有真实主页资料后再填写。
例如在编辑器中给 BiliBili 添加你自己的数字 ID,保存后在软件的模组信息窗口检查跳转。不要把示例作者的 ID 当成自己的发布。
Put information in the right place
| Mod type | Information file | Image paths are relative to |
|---|---|---|
| Character or mini-pet | info/info.json inside the mod |
The info/ folder |
| Standalone item mod | info.json inside the mod |
The item mod root |
Place the images accordingly and match the configured file names. Do not copy a character’s info/ directory structure unchanged into an item mod.
Character and mini-pet example
This is a complete starting info/info.json. Replace the illustrative names and descriptions and supply your own images.
{
"coverImages": ["preview.png"],
"pfp": "portrait.png",
"petName": "Little Friend",
"tages": {"Original": "#BDD7EE"},
"intro": "A little companion who enjoys walking.",
"author": {
"name": "Your name",
"pfp": "author.png",
"frameColor": "#8FAADC",
"links": {},
"infos": "Animation and artwork."
}
}
The field really is spelled tages; do not rename it to tags. Keep petName short and avoid special characters. The source recommends no more than 10 characters.
Item mod example
Item mods use modName, not petName, and do not need the character’s coverImages field:
{
"pfp": "cover.png",
"modName": "Afternoon Snacks",
"intro": "A few treats for a quiet afternoon.",
"author": {
"name": "Your name",
"pfp": "author.png",
"frameColor": "#8FAADC",
"links": {}
}
}
Save this complete example as info.json at the item mod root, with its images in the same folder.
Field reference
| Field | Purpose |
|---|---|
coverImages |
Character / mini-pet preview image list; may be empty |
pfp |
Mod portrait or representative image, not the author’s portrait |
petName / modName |
Name appropriate to the mod type |
tages |
Map of tag text to color values |
intro |
Mod description; check that it displays fully |
author.name / author.pfp |
Creator name / portrait |
author.frameColor |
Creator portrait border color |
author.infos |
Additional creator information |
author.links |
Map of platform names to profile IDs |
Add creator profiles
Use personal IDs in author.links, not full URLs. The source lists BiliBili, 微博, 抖音, GitHub, 爱发电, TikTok and YouTube as platform keys. Leave an empty object {} until you have real profile details.
For example, assign your own numeric ID to BiliBili in your editor, then check the destination from the mod information window. Do not publish an example creator’s ID as your own.
文档持续完善中。 查看原始开发文档 ↗