# Metadata definitions

## Platform
A single set of hardware and/or software that shares compatibility. For example:
	- Nintendo Entertainment System
	- Microsoft Windows 7
	- Microsoft Windows 98

	* name
		- The English name of the platform. As with release group names, this is mostly for
			hand-editing data.
	* regional_names
		- A hash map with the keys being language identifers (en-US, jp, fr, etc) and the values
			being the platform's name in the language and script it was released in.
	* shortcode
		- A small, three to five letter code for the platform. This must be unique among other
			platforms.
	* release groups
		- A list containing release groups for this platform.

## Release group
A container for all languages and versions of a release. For example, the Star Fox 64 release
	group would	contain all of the following releases:
	- Star Fox 64 (U) v1.2
	- Star Fox 64 (U) v1.0
	- Star Fox 64 (J) v1.0
	- Lylat Wars (E) v1.0

	* name
		- The English name for the release group. This is largely for contributors to quickly
			understand the raw data, as frontends should ideally pull the name from a configured
			region or something.
	* releases
		- A list containing all releases in this release group.

## Release
A single release of a game. For example: Star Fox 64 (U) v1.2

	* name
		- The release's name in the language and script it was released in.
	* region
		- The official release code for the game.
	* version
		- The release version of the game. Some are verison numbers, some are just sequential
			release numbers.
	* disambiguation (can be empty)
		- If this release is different in a way that isn't region or version, that information goes
			here.
	* images
		- A list of all images of this release.
## Image
A stored copy of a game's disk image. For example:
	- Star Fox 64 (U) v1.2.z64
	- Star Fox 64 (U) v1.2.v64

	* format
		- The format this image is stored in. For example: bin, iso, chd, z64, v64
	* sha1sum
		- The sha1sum hash of this specific image.
	* dump credit
		- Where the hash came from, who dumped it, etc
	* patches (can be empty)
		- A list of patches that are intended to apply to this image.

## Patches
Unofficial patches or mods for a game, usually called romhacks.

	* name
		- The patch's name in it's original language.
	* file sha1sum
		- The patch file's sha1sum.

# Design notes

* This spec is designed with the intent to be imported into databases while also being reasonably
hand-editable for contributors.

* Releases have multiple images to account for different formats. The z64 and v64 images of the
same N64 game are different files with different hashes.