作者数据文件编写指南

一般的作者数据文件收录流程如下图所示。若在参照个别作者数据文件时发现与本指南不符，请以本指南为准。

flowchart LR
  A(开始) --> meta

  subgraph meta [编写作者数据文件]
    确定作者标识符 --> 创建数据文件 --> 填写名称属性 --> 选填别名属性 --> 填写身份属性 --> 选填头像属性 --> 选填链接属性
  end

  meta ---> cooperate

  subgraph cooperate [多人协作]
    创建拉取请求 --> X
    直接发送数据文件 --> X
    X((审查与补正))
  end

  X -- 通过 --> Y[收录] --> Z(结束)
  X -- 不通过 --> Z

Loading

目录

• 编写作者数据文件
  • 了解 FGI 作者数据库
  • 数据文件的编写要求
  • 作者标识符
  • 名称属性（name）
  • 别名属性（aliases）
  • 身份属性（type）
  • 头像属性（avatar）
  • 链接属性（links）
• 附录
  • 注释

编写作者数据文件

了解 FGI 作者数据库

生成作者页面的材料

FGI 抽取作者的数据文件生成其网站页面。​这些文件存放于本项目 games 仓库的 authors 子目录（games/authors）。若欲修改现有的作者页面，只需要编辑对应的数据文件；若欲创建新的作者页面，则需要新建对应的数据文件。

引用媒体资源的方式

FGI 通过文件名内部引用作者的作者头像。

数据文件的编写要求

FGI 的作者数据文件均为 YAML 格式文件，其内容格式（例如缩进用空格的个数和位置）必须符合 YAML 语法，否则 FGI 将无法正常处理此文件。虽然填写和修改数据文件需要了解的 YAML 语法很少，但如果你还不熟悉 YAML，我们建议你参考或套用现有的数据文件。

FGI 项目仓库已使用 .gitattributes 要求 git 使用 LF 换行符，数据文件内必须使用 LF 换行符。

另外，为增强数据文件的易读性，每个一级属性后应当插入一个空行。

作者标识符

作者标识符（ID）是用于引用作者的字符串，作者数据文件和作者头像都以此命名。

每个作者的标识符唯一且不可重复，并且只能包含 ASCII 字符集中的英文（大小写均可）、数字和下横线 _（U+005F），不得以单独一个下横线开头。

作者标识符优先取用该作者的正式英语自称（保留原始大小写），其次取用该作者最广泛传播的英语别称。​

例如，《天合会》开发者戴拉克斯的英文自称是 DelaX，其作者数据文件是“DelaX.yaml”。

若该作者无英语自称或别称：

• 原自称全部字符均为 ASCII 字符集中的英文、数字或下横线的，直接选取该自称。
• 原自称为日语的，取其罗马音表示，每个词组的罗马字首字母大写。
• 原自称为汉语的，取其拼音表示，每个字的拼音首字母大写。

若该作者的自称包含空格或特殊符号，则应当以下横线代替，多个下横线应当合并成一个下横线。

名称属性（name）

name: 作者名称

此属性为必填属性。

作者名称应当优先取用该作者的正式自称，其次取用该作者最广泛使用的别称，再次取用该作者最广泛传播的别称。

例如，《逃》开发者“剑大”的正式自称是 Zoharwolf，其名称属性中应当填入 Zoharwolf。

若该作者名称带有西文冒号 :（U+003A）或西文撇号 '（U+0027），则应当使用西文引号 "（U+0022）将作者名称括起来。

别名属性（aliases）

aliases:
  - 作者别名1
  - 作者别名2
  以此类推……

此属性为选填属性。

作者别名应当按照知名度从大到小依次填写，别名同样是可由 FGI 站内搜索的字段。

身份属性（type）

type: 作者身份类型

此属性为必填属性。

此属性用以指明该作者的身份类型。

类型	含义
personal	个人
small-team	独立游戏团队
company	公司
publisher	发行商
unknown	未知

头像属性（avatar）

avatar: 作者头像图片文件名（含格式后缀）

此属性为选填属性。

作者头像应当优先取用该作者最能代表其自身当前设定的自定头像，其次取用该作者最广泛使用的自定头像。对仅仅有效画面区域不同的同一内容头像，应当优先取用有效画面区域最大的图片。

在内容上，不得人为裁剪头像的有效画面区域。

例如，不得将方形头像裁成圆形头像。

在规格上，作者头像的标准（最大）尺寸为宽64px，高64px。

尽量制作标准尺寸规格的头像。若原始头像小于标准尺寸，则应当通过裁剪图片使图片宽高比例保持 1:1，不得强制放大原图。若原始头像大于标准尺寸，则应当通过缩小、裁剪等方式使其符合标准尺寸。

头像文件体积不得超过10KiB，压缩超过此体积的图片时不得出现明显失真（振铃效应、方块效应、色调分离、噪点等）。

作者头像图片通常应当存放于 games/assets/_avatar，并以作者标识符命名。

链接属性（links）

links:
  - name: 链接名称一
    uri: 网址
  - name: 链接名称二
    uri: 网址
  以此类推……

此属性为选填属性。

链接属性中应当填入该作者的社交平台、赞助平台等账号链接。

其中，社交平台不可指向非公开邀请的群组，并且应当充分尊重作者的隐私，不得泄露作者不愿公开的社交平台账号。

我们为常见的链接名称创建了“预设名称”。在 name 分属性中写入预设名称，则可以在不同语言的 FGI 站点上自动显示该语言的链接名称，省去翻译的步骤。使用预设名称的链接也会自动配备对应站点的图标。

点此查看针对作者的预设名称

预设名称	链接站点
.website	个人网站
.patreon	Patreon
.weibo	微博
.furaffinity	Fur Affinity
.twitter	Twitter
.facebook	Facebook
.tumblr	Tumblr
.pixiv	Pixiv
.discord	Discord
.youtube	Youtube

我们还为常用的链接网址创建了“简写 URI”。在 uri 分属性中写入简写形式的网址，可以让数据文件更具可读性。

点此查看针对作者的简写 URI

目标站点	简写 URI	特征字段来源
Twitter	twitter:ID	twitter.com/ID
Facebook	facebook:ID	facebook.com/ID
Discord	discord:ID	discord.gg/ID
Patreon	patreon:ID	patreon.com/ID
Youtube	youtube:ID	youtube.com/ID
Pixiv	pixiv:ID	pixiv.net/users/ID
Fur Affinity	furaffinity:ID	furaffinity.net/user/ID
Tumblr	tumblr:ID	ID.tumblr.com
DeviantArt	deviantart:ID	deviantart.com/ID

若写入自定名称，可以选择为该链接指定一个图标以替换默认图标。即在 icon 分属性中填入 FGI 图标库中图标的文件名（不含格式后缀）。

此属性为选填属性。

  - name: 链接名称
    icon: 图标名称
    uri: 网址

附录

注释

# 注释

若在编写数据文件时有特殊或例外情况，应当在数据文件中通过注释的形式写明。