-
Notifications
You must be signed in to change notification settings - Fork 46
Writing Author Description Files
This page was written by post-editing, we are looking for volunteers who are fluent in both Chinese and English to help us with delicate human translation.
A general author description file addition process is shown in the figure below. If you find any discrepancy with this guide when referring to certain author description files, please always follow this guide.
flowchart LR
A(Start) --> meta
subgraph meta [WRITING A AUTHOR DESCRIPTION FILE]
C[Determine author identifier] --> D[Create a description file] --> E[Fill in name attribute] --> F[Optionally fill in aliases attribute] --> G[Fill in type attribute] --> H[Optionally fill in avatar attribute] --> I[Optionally fill in links attribute]
end
meta ---> cooperate
subgraph cooperate [COLLABORATING WITH OTHERS]
V[Submit a pull request] --> X
W[Sending description files <br> directly to us] --> X
X((Review and Revision))
end
X -- Pass --> Y[The author was added to FGI] --> Z(End)
X -- Fail --> Z
FGI extracts the author's description file to generate its website page. The former is stored in games/games.
If you want to modify an existing author page, you only need to edit the corresponding description file. If you want to create a new author page, you need to create a new description file.
FGI refers to the author's avatar internally by filename.
Author description files are YAML formatted and their content formatting (such as the number and placement of spaces for indentation) must conform to YAML syntax, otherwise the file will not be processed properly by FGI. While there is very little YAML syntax to understand when filling out and modifying description files, we recommend that you refer to or adapt existing description files if you are not familiar with YAML.
FGI repositories already use .gitattributes to require git to use LF line breaks type, and LF line breaks type must be used within description files.
Furthermore, to enhance the readability of the description files, a blank line should be inserted after each primary attribute.
The author identifier (ID) is a string used to refer to an author, for which the author description file and avatar are named.
Each author identifier is unique and non-repeatable, and may only contain letters (upper and lower case), numbers and low line _ (U+005F) from the ASCII character set, and may not begin with a single low line.
Author identifiers are taken in first place by the formal English self-designation of that author ( preserving original case), and secondly by the most widely known English alias of that author.
If this author does not have a self-designation or alias in English:
- When all characters of the self-designation are English, numeric or underscore in the ASCII character set, the self-designation is taken directly.
- When the self-designation is in Japanese, the identifier is written by its rōmaji, and the initial letter of each phrase is capitalized.
- When the self-designation is in Chinese, the identifier is written by its pinyin, and the initial letter of each phrase is capitalized.
If the name of the author contains spaces or special symbols, they should be replaced by an low line. Multiple low lines should be combined into a single low line.
name: Author nameThis attribute is required.
The author's name should be taken in order of priority as the author's formal self-designation, followed by the author's most widely used alias, and again as the author's most widely spread alias.
If the name has a colon : (U+003A) or a apostrophe ' (U+0027), the name should be enclosed in quotation marks " (U+0022).
aliases:
- Alias A
- Alias B
…This attribute is optional.
The author alias should be filled out in descending order of popularity, and is also a searchable field on FGI.
type: Author identity typeThis attribute is required.
This attribute is used to indicate the identity type of this author.
- personal
- small-team
- company
- publisher
- unknown
avatar: Author avatar image file name (with format suffix)This attribute is optional.
The author's avatar should be taken in priority to the self-determined avatar that best represents the author's own current persona, followed by the most widely used self-determined avatar of the author. For avatars of the same content that differ only in the effective visual area, priority should be given to the image with the largest effective visual area.
In terms of content, the effective visual area of the avatar must not be cropped manually.
For example, a square avatar may not be cropped into a round avatar.
In terms of specifications, the standard (maximum) size of an author avatar is 64px × 64px.
Make avatars of standard size as much as possible. If the original avatar is smaller than the standard size, you should crop the image to keep the aspect ratio 1:1 and not force the original image to be enlarged. If the original avatar is larger than the standard size, it should be made to conform to the standard size by shrinking or cropping.
The size of the avatar file must not exceed 10KiB, and no significant distortion (ringing effect, square effect, tonal separation, noise, etc.) must occur when compressing image.
Author avatar images should usually be stored in games/assets/_avatar and named with the author identifier.
links:
- name: Link A name
uri: URI A
- name: Link B name
uri: URI B
…This attribute is optional.
The links attribute should be filled in with links to the author's social media platforms, sponsorship platforms and other accounts.
Among them, social platforms may not direct to groups that are not publicly invited, and should fully respect the author's privacy and not leak social platform accounts that the author does not want to expose.
We have created "Stock Link" for common links. By writing stock Links in the name sub-attribute, links name are automatically displayed on FGI in different languages, no need for translation. Stock links are also automatically equipped with a corresponding site icon.
Click here to see all stock links for author
| Stock Link | Linked site |
|---|---|
| .website | Personal website |
| .patreon | Patreon |
| .furaffinity | Fur Affinity |
| .tumblr | Tumblr |
| .pixiv | Pixiv |
| .discord | Discord |
| .youtube | Youtube |
We have also created URI shorthands for commonly links. Writing shorthand of URLs in the uri sub-attribute makes the data file more readable.
Click here to see all URI shorthands for author
| Linked site | URI shorthands | ID source |
|---|---|---|
| twitter:ID | twitter.com/ID | |
| 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 |
If a custom name is written, you can specify an icon for the link to replace the default icon. That is, fill in the icon sub-attribute with the file name of an icon in FGI Icon Library (without format suffix).
This attribute is optional.
- name: Link name
icon: Icon name
uri: URI# CommentsIf there are special or exceptional cases when writing description files, you should note them by means of comments.