From 77a613291929485c468f859240101acfa5cf2581 Mon Sep 17 00:00:00 2001 From: M&M Date: Sun, 14 Jul 2019 10:30:56 -0700 Subject: [PATCH] Remove metadata section from CONTRIBUTING.md (#90) --- CONTRIBUTING.md | 39 --------------------------------------- 1 file changed, 39 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0ee7b59..7d76056 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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.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 `//icon.png` (See: [Screenshots](#screenshots). The suggested process for getting one is: - Make sure the game is in your yuzu game directory.