[game-data-packager] 03/09: Document vendor-specific metadata

[Simon McVittie]

This is an automated email from the git hooks/post-receive script.

smcv pushed a commit to branch master
in repository game-data-packager.

commit 4f1118fafd6ece484f4af544fa5c6698861d51e0
Author: Simon McVittie <smcv at debian.org>
Date:   Sat Oct 24 20:47:06 2015 +0100

    Document vendor-specific metadata
---
 doc/adding_a_game.mdwn | 46 ++++++++++++++++++++++++++++++++++++++++++++++
 doc/tags.txt           |  6 ++++++
 2 files changed, 52 insertions(+)

diff --git a/doc/adding_a_game.mdwn b/doc/adding_a_game.mdwn
index 6a35ff3..8d0607a 100644
--- a/doc/adding_a_game.mdwn
+++ b/doc/adding_a_game.mdwn
@@ -117,6 +117,52 @@ to mapping:
   sets to install
 * `engine`: let you overide the engine in special cases
 
+#### Steam games
+
+For games that can be bought from Steam, the top-level metadata, the
+individual packages or both can have a mapping named `steam`, with
+these keys:
+
+* `id`: the numeric identifier of the game, as seen in
+  URLs like http://store.steampowered.com/app/2280/
+* `path`: the directory below `steamapps` where Steam installs the game,
+  usually starting with `common/`
+
+#### GOG games
+
+Similar to Steam, games sold on gog.com can have a mapping named `gog`
+with these keys:
+
+* `url`: the game-specific part of games' URLs, such as
+  `the_ultimate_doom` for http://www.gog.com/game/the_ultimate_doom
+* `pp`: an affiliate ID, typically used to donate to a relevant game engine
+  (if not specified, g-d-p will use ScummVM's affiliate ID)
+* `path`: the directory below `GOG Games` where the GOG installer puts
+  the game by default, or a list of strings if more than one directory
+  is used by different installer versions. game-data-packager will
+  search any directory that starts with this string, so language
+  suffixes are not necessary: if GOG will install "Some Game (German)",
+  only "Some Game" is needed.
+
+#### Origin games
+
+Similar to Steam, games sold on Origin can have a mapping named `origin`
+with these keys:
+
+* `path`: the directory below `Origin Games` where Origin installs the game
+
+Use the `url_misc` top-level key for Origin download URLs: see
+`data/syndicate.yaml` and `data/theme-hospital.yaml` for examples.
+
+#### dotemu games
+
+Similar to Steam, games sold on dotemu can have a mapping named `dotemu`
+with these keys:
+
+* `id`: the numeric identifier of the game
+* `pp`: an affiliate ID, typically used to donate to a relevant game engine
+  (if not specified, g-d-p will use ScummVM's affiliate ID)
+
 ### Step 2: required files for the `.deb`
 
 #### things to include in the template package
diff --git a/doc/tags.txt b/doc/tags.txt
index 71ce916..45c89f9 100644
--- a/doc/tags.txt
+++ b/doc/tags.txt
@@ -11,6 +11,11 @@ genre: string
 steam:
   id: int
   path: string
+gog:
+  url: string
+  pp: string (hash)
+  game: string
+  path: string (prefix)
 try_repack_from: list
 missing_langs: list
 
@@ -47,6 +52,7 @@ packages:
       url: string
       pp: string (hash)
       game: string
+      path: string (prefix)
     steam:
       id: int
       path: string

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-games/game-data-packager.git