yuzu-emu/yuzu-games-wiki
1
0
Fork 0
mirror of https://github.com/yuzu-emu/yuzu-games-wiki.git synced 2024-10-19 12:08:19 +02:00
Code Issues Packages Projects Releases Wiki Activity

Remove metadata section from CONTRIBUTING.md (#90)

Browse Source
This commit is contained in:
M&M 2019-07-14 10:30:56 -07:00 committed by MysticExile
parent efc6753ccf
commit 77a6132919
1 changed files with 0 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
CONTRIBUTING.md
View File

@ -11,7 +11,6 @@ Contributions to the yuzu Games Wiki are welcomed, as keeping all of the data up
- [Title IDs](#title-ids)
- [TOML](#toml)
- [Code](#code)
- [Metadata](#metadata)
- [Icon](#icon)
- [Boxart](#boxart)
- [Game Screenshots](#game-screenshots)
@ -57,44 +56,6 @@ At the root, there's a folder for each game. The names of these folders should f
- Names should be lowercase to ensure consistency.
- Have a wiki page with the same name.
### Metadata
The metadata for the game is located at `/<Game Name>/game.dat`. This is required info about the game, all feilds are mandatory unless noted otherwise. The DAT values (See: [TOML](#toml)) are:
- `title` (String): English title of the game. This doesn't have to match the wiki or folder name, so there can be spaces.
- `description` (String): Get these from [Wikipedia](https://en.wikipedia.org/wiki/List_of_Nintendo_Switch_games). Short, 2-3 line description of the game.
- `github_issues` (Array of integers): The GitHub issue IDs for the game. See: [GitHub Issues](#github-issues).
- `needs_system_files` (Boolean): Whether the game requests the system files or not, regardless of whether it could be played without them (See: [yuzu Version](#yuzu-version)).
- `needs_shared_font` (Boolean): Whether the game requests the shared font or not, regardless of whether it could be played without them (See: [yuzu Version](#yuzu-version)).
- `game_type` (String): Whether the game has a retail release, `"switch"` or if it's an E-Shop **exclusive**, `"eshop"`. This line is optional for retail releases.
- `releases` (Array of tables): Info about each release of the game. **The USA release should come first.**
- `title` (String): Title ID of this release of the game. See: [Title IDs](#title-ids).
- `region` (String): Region of the game. Possible values are:
- `aus`
- `chn`
- `eur`
- `jpn`
- `kor`
- `twn`
- `usa`
- `all` (Don't tag a game released in multiple regions as `all`. This is reserved for specific games released as such.)
- `release_date` (String): When the game was released in this region. See: [Dates](#dates).
- `title` (String): Title ID of this release of the game which was used during testing. See: [Title IDs](#title-ids).
An example of a game metadata file is the one for [Pokemon: Let's Go, Eevee!](https://github.com/yuzu-emu/yuzu-games-wiki/blob/master/games/pokemon-lets-go-eevee/game.dat):
```toml
title = "Pokemon: Let's Go, Eevee!"
description = "Pokemon: Let's Go, Eevee! is a role-playing video game that was developed by Game Freak and published by The Pokemon Company and Nintendo for the Nintendo Switch. The game is the first installment of the main Pokemon RPG series for the Nintendo Switch. It is a enhanced remake of the 1998 video game Pokemon Yellow."
wiki_override = "pokemon-lets-go"
github_issues = [1935]
needs_system_files = false
needs_shared_font = false
game_type = "switch"
[[ releases ]]
title = "0100187003A36000"
region = "all"
release_date = "2018-11-16"
```
### Icon
The icon for a game is located at `/<Game Name>/icon.png` (See: [Screenshots](#screenshots). The suggested process for getting one is:
- Make sure the game is in your yuzu game directory.