That's awesome! Here are some tips to get you going.
The term slug is used for the name of the file, without the .yml
extension. So e.g., the artist file for Hellbeard can be found in
artist/hellbeard.yml; in his case, his slug is
hellbeard. Easy, right?
The known artists on textmod.es can be found in the artist folder,
every artist has its own YAML file with information. For artists that go by
different aliases, we use the most dominant current used alias for the file
name, the rest of the aliases go in the aliases list.
Possible fields on an artist:
| Field | Type | Description |
|---|---|---|
| name | text | (Nick)name of the artist |
| aliases | list of slug | Aliases of the artist |
| country | text | ISO 3166-1 alpha-2 country code (lower case) |
| biography | markdown1 | Some words about the artist's history etc. |
| social | map of text | Social media profiles of the artist |
Possible social site tags:
| Tag | Site | Value |
|---|---|---|
| artcity | http://artcity.bitfellas.org/ | User ID |
| behance | https://www.behance.net/ | Username |
| csdb | https://csdb.dk/ | Scener ID |
| demozoo | https://demozoo.org/ | Scener ID |
| deviantart | https://www.deviantart.com/ | Username |
| https://www.facebook.com/ | Profile ID or page name | |
| flickr | https://www.flickr.com/ | Profile ID |
| github | https://github.com/ | Username |
| google+ | https://plus.google.com/ | +Username or Profile ID |
| https://instagram.com/ | Username | |
| https://linkedin.com/ | Username or Profile ID | |
| https://pinterest.com/ | Username | |
| pouet | https://www.pouet.net/ | User ID |
| https://twitter.com/ | Twitter handle | |
| vimeo | https://vimeo.com/ | Username |
| youtube | https://youtube.com/ | Username or Channel ID |
Crew information pages can be found in the crew folder.
Possible fields on a crew:
| Field | Type | Description |
|---|---|---|
| name | text | Full name of the crew |
| aliases | list of slug | Aliases of the crew |
| leaders | list of slug | Artist slugs of the leaders of the crew |
| website | url | Website of the crew |
| about | markdown1 | Some words about the crew's history etc. |
| members | list of slug | Permanent crew members' slugs. |
Pack information pages can be found in the pack folder. Each release year gets its own sub directory. Pack names are normalized to lower case and in case the file name uses a different encoding (such as Code Page 437), we use the UTF-8 equivalent characters. The same is done to filenames in the archive, files referenced in the pack use the UTF-8 equivalent of the filename to ensure consistency across edits. You may use Python to convert between encodings:
>>> jp = '\x83l\x83I\x81E\x83g\x81[\x83L\x83\x87\x81[.ans'
>>> print jp.decode('shift_jis')
ネオ・トーキョー.ansPossible fields on a pack:
| Field | Type | Description |
|---|---|---|
| name | text | Base name of the pack (without extension) |
| year | integer | Year of publication |
| group | slug (opt) | Group slug (will be merged into groups) |
| groups | list of slug | Group slugs |
| artist | slug | Artist slug, for solo-packs |
| artists | list of slug | Artist slugs, for non group-affiliated |
| files | file map (opt) | Keyed on filename in the archive, see below |
| match | glob map (opt) | Match on filename to artist slug by glob |
Files may be omitted, you list individual files to override certain attributes
such as artists (if not captured by match for example) or to override the
file font.
Possible fields on a file:
| Field | Type | Description |
|---|---|---|
| artist | slug | Artist slug (merged into artists) |
| artists | list of slug | Artist slugs |
| font | font name | Font override (overrides SAUCE record) |
More on the pack attribute match. This is a hash map of glob-to-slug. A
glob is a matching pattern that may contain wildcard characters:
| Wildcard | Meaning |
|---|---|
? |
Exactly one character |
* |
Zero or more characters |
This can be used to quickly match files in a pack from the same artist, e.g.:
match:
Luciano*: luciano
n-*: nail
wz-*: whazzit