Added patches section to metadata concepts.

metadata-restructure
Emily Frost 4 years ago
parent e467a483f9
commit bce55ec9b5
Signed by: Emily
GPG Key ID: AA5D42849F1CBDC9

@ -1,13 +1,11 @@
# Metadata definitions
# TODO
* Add a new category for romhacks (like releases but for romhacks) and their respective versions.
* Decide on a file structure. This shouldn't be one giant json file, but it needs to be split in
useful ways.
## Image
- A stored copy of a game's disk image. For example:
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
@ -23,13 +21,13 @@
- Where the hash came from, who dumped it, etc
## Release
- A single release of a game. For example: Star Fox 64 (U) v1.2
A single release of a game. For example: Star Fox 64 (U) v1.2
* UUID
* name
- The release's name in the language and script it was released in.
* region
- The region intended for release.
- The official release code for the game.
* version
- The release version of the game. Some are verison numbers, some are just sequential
release numbers.
@ -42,7 +40,7 @@
- The UUID of the platform that this release is built for.
## Release group
- A container for all languages and versions of a release. For example, the Star Fox 64 release
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
@ -56,7 +54,7 @@
region or something.
## Platform
- A single set of hardware and/or software that shares compatibility. For example:
A single set of hardware and/or software that shares compatibility. For example:
- Nintendo Entertainment System
- Microsoft Windows 7
- Microsoft Windows 98
@ -71,6 +69,17 @@
* shortcode
- A small, three-letter code for the platform. This is essentially for directory names.
## Patches
Unofficial patches or mods for a game, usually called romhacks.
* UUID
* name
- The patch's name in it's original language.
* file sha1sum
- The patch file's sha1sum.
* target image
- The UUID of the image that the patch is intended to be applied to.
# Design notes
* This spec is designed with the intent to be imported into databases while also being reasonably

Loading…
Cancel
Save