Image size information
[ouya-game-data.git] / game-metadata.html
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!DOCTYPE html>
3 <html xmlns="http://www.w3.org/1999/xhtml">
4  <head>
5   <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=utf-8"/>
6   <title>OUYA game meta data</title>
7   <style type="text/css">
8    thead th {
9      position: sticky;
10      top: 0px;
11      background-color: lightgrey;
12    }
13   </style>
14  </head>
15  <body>
16   <table border="1">
17    <thead>
18     <tr>
19      <th>Group</th>
20      <th>Datum</th>
21      <th>Game data field</th>
22      <th><a href="http://cweiske.de/ouya-store-api-docs.htm#get-https-devs-ouya-tv-api-v1-discover">Discover field</a></th>
23      <th><a href="http://cweiske.de/ouya-store-api-docs.htm#get-https-devs-ouya-tv-api-v1-apps-xxx">App field</a></th>
24      <th><a href="http://cweiske.de/ouya-store-api-docs.htm#get-https-devs-ouya-tv-api-v1-details">Details field</a></th>
25      <th><a href="https://gitlab.com/devirich/BrewyaOnOuya/blob/master/store/models.py">BrewyaOnOuya field</a></th>
26      <th>Example</th>
27      <th>Description</th>
28     </tr>
29    </thead>
30    <tbody>
31
32     <tr>
33      <td>app</td>
34      <td>Game title</td>
35      <td>title</td>
36      <td>title</td>
37      <td>title</td>
38      <td>title</td>
39      <td>App.title</td>
40      <td>Bloo Kid 2</td>
41      <td></td>
42     </tr>
43     <tr>
44      <td>app</td>
45      <td>Overview text</td>
46      <td>overview (optional)</td>
47      <td></td>
48      <td>overview</td>
49      <td>-</td>
50      <td>App.overview</td>
51      <td>Released in October 2015 by winterworks GmbH.</td>
52      <td></td>
53     </tr>
54     <tr>
55      <td>app</td>
56      <td>Description</td>
57      <td>description</td>
58      <td></td>
59      <td>description</td>
60      <td>description</td>
61      <td>App.description</td>
62      <td>Bloo Kid 2 is a classic 2D retro-style platformer experience with lovely designed pixel-graphics and a full chiptune soundtrack. Run, jump and swim your way through FIVE huge worlds with TWELVE levels each. Master brutal bossfights and discover lots of secrets in the world of Bloo Kid 2.\r\n\r\nBloo Kid 2 features:\r\n- five worlds with twelve levels each\r\n- handcrafted, colorful pixel-graphics\r\n- a full chiptune soundtrack\r\n- epic boss battles\r\n- tons of secrets\r\n- achievements</td>
63      <td></td>
64     </tr>
65     <tr>
66      <td>app</td>
67      <td>Number of players</td>
68      <td>players</td>
69      <td>gamerNumbers</td>
70      <td>gamerNumbers</td>
71      <td>gamerNumbers</td>
72      <td>App.playerNumbers</td>
73      <td>[1]</td>
74      <td>Any combination of 1-4</td>
75     </tr>
76     <tr>
77      <td>app</td>
78      <td>Genre list</td>
79      <td>genres</td>
80      <td>genres</td>
81      <td>genres</td>
82      <td>genres</td>
83      <td>App.genres</td>
84      <td>[Platformer, Retro]</td>
85      <td>
86       original genre list:
87       <ul>
88        <li>Adventure</li>
89        <li>App</li>
90        <li>Arcade/Pinball</li>
91        <li>Card/Casino</li>
92        <li>Dual Stick</li>
93        <li>Entertainment</li>
94        <li>Fight!</li>
95        <li>FPS/Shooter</li>
96        <li>Kids List</li>
97        <li>Meditative</li>
98        <li>Multiplayer</li>
99        <li>Music</li>
100        <li>Platformer</li>
101        <li>Puzzle/Trivia</li>
102        <li>Racing</li>
103        <li>Retro</li>
104        <li>Role-Playing</li>
105        <li>Short on Time?</li>
106        <li>Sim/Strategy</li>
107        <li>Sports</li>
108        <li>Utility</li>
109        <li>Video</li>
110       </ul>
111      </td>
112     </tr>
113     <tr>
114      <td>app</td>
115      <td>Package name</td>
116      <td>packageName</td>
117      <td>package</td>
118      <td></td>
119      <td>apk.package</td>
120      <td>App.packageName</td>
121      <td>evil.corptron.DuckGame</td>
122      <td>Run "aapt dump badging file.apk", field "package: name"</td>
123     </tr>
124     <tr>
125      <td>app</td>
126      <td>Details URL</td>
127      <td>-</td>
128      <td>url</td>
129      <td></td>
130      <td>-</td>
131      <td>-</td>
132      <td>ouya://launcher/details?app=evil.corptron.DuckGame</td>
133      <td></td>
134     </tr>
135     <tr>
136      <td>app</td>
137      <td>Game website</td>
138      <td>website (optional)</td>
139      <td></td>
140      <td>website</td>
141      <td>-</td>
142      <td>App.website</td>
143      <td>http://www.winterworks.de</td>
144      <td></td>
145     </tr>
146     <tr>
147      <td>app</td>
148      <td>Content rating</td>
149      <td>contentRating (optional)</td>
150      <td>contentRating</td>
151      <td>contentRating</td>
152      <td>suggestedAge</td>
153      <td>App.contentRating</td>
154      <td>Everyone</td>
155      <td>
156       <ul>
157        <li>Everyone</li>
158        <li>9+</li>
159        <li>12+</li>
160        <li>17+</li>
161       </ul>
162      </td>
163     </tr>
164     <tr>
165      <td>app</td>
166      <td>FIXME</td>
167      <td>premium (optional)</td>
168      <td>premium</td>
169      <td>premium</td>
170      <td>premium</td>
171      <td>App.premium</td>
172      <td>false</td>
173      <td></td>
174     </tr>
175     <tr>
176      <td>app</td>
177      <td>When the game was published</td>
178      <td>firstPublishedAt (optional)</td>
179      <td></td>
180      <td>firstPublishedAt</td>
181      <td>firstPublishedAt (unix timestamp)</td>
182      <td>App.firstPublishedAt</td>
183      <td>2015-10-09T07:53:25Z</td>
184      <td></td>
185     </tr>
186     <tr>
187      <td>app</td>
188      <td>Are there in-app purchases?</td>
189      <td>inAppPurchases (optional)</td>
190      <td>inAppPurchases</td>
191      <td></td>
192      <td>inAppPurchases</td>
193      <td>-</td>
194      <td>true</td>
195      <td></td>
196     </tr>
197     <tr>
198      <td>app</td>
199      <td>FIXME</td>
200      <td>-</td>
201      <td>type</td>
202      <td></td>
203      <td>type</td>
204      <td>-</td>
205      <td>app</td>
206      <td>
207       discover: "app", "discover" or "details_page" (for bundles)<br/>
208       details: "Game", FIXME
209      </td>
210     </tr>
211     <tr>
212      <td>app</td>
213      <td>Last update (unix timestamp)</td>
214      <td>-</td>
215      <td>updated_at</td>
216      <td></td>
217      <td>-</td>
218      <td>AppVersion.releaseTime</td>
219      <td>1417731390</td>
220      <td></td>
221     </tr>
222     <tr>
223      <td>app</td>
224      <td>Last update</td>
225      <td>releases.*.date (when "latest")</td>
226      <td>updatedAt</td>
227      <td></td>
228      <td>-</td>
229      <td>AppVersion.releaseTime</td>
230      <td>2014-12-04T22:16:30Z</td>
231      <td></td>
232     </tr>
233
234     <tr>
235      <td>?</td>
236      <td>Metadata about the file</td>
237      <td>-</td>
238      <td>-</td>
239      <td></td>
240      <td>metaData</td>
241      <td>-</td>
242      <td>["key:rating.average", "key:developer.name", "key:suggestedAge", "45.29 MiB"]</td>
243      <td>Always those 4 values and in the same order (at least for apps)</td>
244     </tr>
245
246     <tr>
247      <td>rating</td>
248      <td>Number of likes?</td>
249      <td>rating.likeCount (optional)</td>
250      <td></td>
251      <td>likeCount</td>
252      <td>-</td>
253      <td>Rating.likeCount</td>
254      <td>0</td>
255      <td></td>
256     </tr>
257     <tr>
258      <td>rating</td>
259      <td>Average rating</td>
260      <td>rating.average (optional)</td>
261      <td>rating.average</td>
262      <td>ratingAverage</td>
263      <td>rating.average</td>
264      <td>Rating.rating</td>
265      <td>4.1</td>
266      <td></td>
267     </tr>
268     <tr>
269      <td>rating</td>
270      <td>Number of ratings</td>
271      <td>rating.count (optional)</td>
272      <td>rating.count</td>
273      <td>ratingCount</td>
274      <td>rating.count</td>
275      <td>Rating.reviewCount</td>
276      <td>355</td>
277      <td></td>
278     </tr>
279
280     <tr>
281      <td>product</td>
282      <td>Promotion data</td>
283      <td>products.* (when "promoted=true")</td>
284      <td>promotedProduct</td>
285      <td>promotedProduct</td>
286      <td>promotedProduct</td>
287      <td>App.promotedProduct</td>
288      <td>null</td>
289      <td>May be "null" if none, otherwise object</td>
290     </tr>
291     <tr>
292      <td>product</td>
293      <td>Product key</td>
294      <td>products.*.identifier</td>
295      <td>promotedProduct.identifier</td>
296      <td>promotedProduct.identifier</td>
297      <td>promotedProduct.identifier</td>
298      <td>Product.identifier</td>
299      <td>unlock_rockets</td>
300      <td></td>
301     </tr>
302     <tr>
303      <td>product</td>
304      <td>Product name</td>
305      <td>products.*.name</td>
306      <td>promotedProduct.name</td>
307      <td>promotedProduct.name</td>
308      <td>promotedProduct.name</td>
309      <td>Product.name</td>
310      <td>Unlock Full Game</td>
311      <td></td>
312     </tr>
313     <tr>
314      <td>product</td>
315      <td>Product currency</td>
316      <td>products.*.currency</td>
317      <td>promotedProduct.currency</td>
318      <td>promotedProduct.currency</td>
319      <td>promotedProduct.currency</td>
320      <td>-</td>
321      <td>EUR</td>
322      <td></td>
323     </tr>
324     <tr>
325      <td>product</td>
326      <td>Product description</td>
327      <td>products.*.description</td>
328      <td>promotedProduct.description</td>
329      <td>promotedProduct.description</td>
330      <td>promotedProduct.description</td>
331      <td>Product.description</td>
332      <td>Remove the 9 satellites limitation. Infinite satellites!</td>
333      <td></td>
334     </tr>
335     <tr>
336      <td>product</td>
337      <td>Saving</td>
338      <td>-</td>
339      <td>promotedProduct.percentOff</td>
340      <td>promotedProduct.percentOff</td>
341      <td>promotedProduct.percentOff</td>
342      <td>-</td>
343      <td>0</td>
344      <td></td>
345     </tr>
346     <tr>
347      <td>product</td>
348      <td>Current price</td>
349      <td>products.*.localPrice</td>
350      <td>promotedProduct.localPrice</td>
351      <td>promotedProduct.localPrice</td>
352      <td>promotedProduct.localPrice</td>
353      <td>-</td>
354      <td>1.99</td>
355      <td></td>
356     </tr>
357     <tr>
358      <td>product</td>
359      <td>Previous price</td>
360      <td>products.*.originalPrice</td>
361      <td>promotedProduct.originalPrice</td>
362      <td>promotedProduct.originalPrice</td>
363      <td>promotedProduct.originalPrice</td>
364      <td>Product.originalPrice</td>
365      <td>1.99</td>
366      <td></td>
367     </tr>
368     <tr>
369      <td>product</td>
370      <td>FIXME</td>
371      <td>?</td>
372      <td>?</td>
373      <td>?</td>
374      <td>promotedProduct.type</td>
375      <td>?</td>
376      <td>"entitlement" (502x), null (758x)</td>
377      <td></td>
378     </tr>
379
380     <tr>
381      <td>apk</td>
382      <td>Human readable version</td>
383      <td>releases.*.name</td>
384      <td>latestVersion.versionNumber</td>
385      <td>versionNumber</td>
386      <td>version.number</td>
387      <td>Apk.versionName</td>
388      <td>1.6</td>
389      <td>Run "aapt dump badging file.apk", field "versionName"</td>
390     </tr>
391     <tr>
392      <td>apk</td>
393      <td>UUID of latest apk version</td>
394      <td>releases.*.uuid</td>
395      <td>
396       uuid<br/>
397       latestVersion.uuid
398      </td>
399      <td>
400       uuid<br/>
401       latestVersion
402      </td>
403      <td>version.uuid</td>
404      <td>App.uuid</td>
405      <td>780688a9-95ee-429a-8755-69a8d0c88fe0</td>
406      <td>The OUYA API does not have app UUIDs, only release/apk uuids. </td>
407     </tr>
408     <tr>
409      <td>apk</td>
410      <td>Internal version</td>
411      <td>releases.*.versionCode</td>
412      <td>-</td>
413      <td>-</td>
414      <td>apk.versionCode</td>
415      <td>Apk.versionCode</td>
416      <td>null, 120401, 11, 1001004</td>
417      <td>Run "aapt dump badging file.apk", field "versionCode"</td>
418     </tr>
419     <tr>
420      <td>apk</td>
421      <td>FIXME</td>
422      <td>releases.*.publicSize (optional)</td>
423      <td></td>
424      <td>publicSize</td>
425      <td>apk.publicSize</td>
426      <td>Apk.publicSize</td>
427      <td>27275</td>
428      <td></td>
429     </tr>
430     <tr>
431      <td>apk</td>
432      <td>FIXME</td>
433      <td>releases.*.nativeSize (optional)</td>
434      <td></td>
435      <td>nativeSize</td>
436      <td>apk.nativeSize</td>
437      <td>Apk.nativeSize</td>
438      <td>20292</td>
439      <td></td>
440     </tr>
441     <tr>
442      <td>apk</td>
443      <td>MD5 file hash</td>
444      <td>releases.*.md5sum</td>
445      <td>latestVersion.apk.md5sum</td>
446      <td>md5sum</td>
447      <td>apk.md5sum</td>
448      <td>Apk.md5sum</td>
449      <td>a5b0f82d54df5f551a64295e43771a10</td>
450      <td></td>
451     </tr>
452     <tr>
453      <td>apk</td>
454      <td>APK file size</td>
455      <td>releases.*.size</td>
456      <td></td>
457      <td>apkFileSize</td>
458      <td>apk.fileSize</td>
459      <td>Apk.size</td>
460      <td>25507828</td>
461      <td></td>
462     </tr>
463     <tr>
464      <td>apk</td>
465      <td>APK publish date</td>
466      <td>releases.*.date</td>
467      <td></td>
468      <td>publishedAt</td>
469      <td>version.publishedAt (unix timestamp)</td>
470      <td>AppVersion.releaseTime</td>
471      <td>2015-10-23T09:58:19Z</td>
472      <td></td>
473     </tr>
474     <tr>
475      <td>apk</td>
476      <td>downloadLink</td>
477      <td>releases.*.url</td>
478      <td></td>
479      <td></td>
480      <td>apk.filename</td>
481      <td>Apk.location</td>
482      <td>
483       url: https://devs-ouya-tv-prod.s3.amazonaws.com/apps/5a3fbb4d-852b-4af4-becc-324dce6a3b42/de.eiswuxe.blookid2/780688a9-95ee-429a-8755-69a8d0c88fe0/lFzMjcZyQauvWX5k8HvH_blookid2.apk<br/>
484       details: 1zbYKRSS1elKIYI9eseH_BombSquad-ouya-release.apk
485      </td>
486      <td>
487       Also in download.json<br/>
488       Details field: only a file name, no path/domain. Always set.
489      </td>
490     </tr>
491     <tr>
492      <td>apk</td>
493      <td>state</td>
494      <td>-</td>
495      <td>?</td>
496      <td>?</td>
497      <td>apk.state</td>
498      <td>?</td>
499      <td>
500       "complete"
501      </td>
502      <td></td>
503     </tr>
504
505     <tr>
506      <td>media</td>
507      <td>Discover image</td>
508      <td>media.discover</td>
509      <td>image</td>
510      <td></td>
511      <td>tileImage</td>
512      <td>Media</td>
513      <td>https://www.filepicker.io/api/file/05y2T8cKTY6cUfX7RYFR</td>
514      <td></td>
515     </tr>
516     <tr>
517      <td>media</td>
518      <td>Large image</td>
519      <td>media.large</td>
520      <td></td>
521      <td>mainImageFullUrl</td>
522      <td>-</td>
523      <td>App.titleImage</td>
524      <td>https://d3e4aumcqn8cw3.cloudfront.net/api/file/MASaiOBlTEO7GKYXsIns</td>
525      <td></td>
526     </tr>
527     <tr>
528      <td>media</td>
529      <td>FIXME</td>
530      <td>-</td>
531      <td>-</td>
532      <td>-</td>
533      <td>heroImage.url</td>
534      <td>?</td>
535      <td>
536       https://s3.amazonaws.com/ouya-screenshots/3d819f4e-2195-433c-81ea-c766a6f3144f/ouya-image20170118-3-i56ad1<br/>
537       null
538      </td>
539      <td>
540       Most games, had "null" here, only 14 had one set.
541       When this was set, mobileAppIcon was also set.
542      </td>
543     </tr>
544     <tr>
545      <td>media</td>
546      <td>Video</td>
547      <td>media.video (optional)</td>
548      <td></td>
549      <td>videoUrl</td>
550      <td></td>
551      <td>Media</td>
552      <td>https://vimeo.com/141878938</td>
553      <td></td>
554     </tr>
555     <tr>
556      <td>media</td>
557      <td>Game screenshots</td>
558      <td>media.screenshots (optional)</td>
559      <td></td>
560      <td>filepickerScreenshots</td>
561      <td>-</td>
562      <td>Media</td>
563      <td>[urls]</td>
564      <td></td>
565     </tr>
566     <tr>
567      <td>media</td>
568      <td>Detail video</td>
569      <td>media.details.*.url</td>
570      <td></td>
571      <td></td>
572      <td>mediaTiles.*.url (type=video)</td>
573      <td>?</td>
574      <td>
575       <pre>[
576   {
577     "type": "video",
578     "url": "https://vimeo.com/141878938"
579   }
580 ]</pre>
581      </td>
582      <td rowspan="4">
583       Allows free ordering of images and videos on the details page.<br/>
584       "fp" is probably "FilePicker".<br/>
585       fp_url is not used in OUYA's launcher.
586       The launcher loads the thumbnail at first, immediately after the full image.
587       If no mediaTile is available, the app's mainImageFullUrl
588       is used. When offline, the apk image is used.<br/>
589       <br/>
590       Game data information:
591       If details is not given or an emtpy array,
592       "mediaTile" array should automatically be created by combining
593       "media.large", "media.video" and "media.screenshots" into the
594       mediaTiles format.
595      </td>
596     </tr>
597     <tr>
598      <td>media</td>
599      <td>Detail image thumbnail</td>
600      <td>media.details.*.thumb</td>
601      <td></td>
602      <td></td>
603      <td>mediaTiles.*.urls.thumb (type=image)</td>
604      <td>?</td>
605      <td>
606       Thumbnails were all size 852x479
607       <pre>[
608   {
609     "type: "image",
610     "urls": [
611       "full": "http://...",
612       "thumb": "http://...",
613     ],
614     "fp_url": "http://...."
615   },
616 ]</pre>
617      </td>
618     </tr>
619     <tr>
620      <td>media</td>
621      <td>Detail image full resolution</td>
622      <td>media.details.*.url</td>
623      <td></td>
624      <td></td>
625      <td>mediaTiles.*.urls.full (type=image)</td>
626      <td>?</td>
627      <td>
628       Many detail images had a resolution of 1280x720.
629       <pre>[
630   {
631     "type: "image",
632     "urls": [
633       "full": "http://...",
634       "thumb": "http://...",
635     ],
636     "fp_url": "http://...."
637   }
638 ]</pre>
639      </td>
640     </tr>
641     <tr>
642      <td>media</td>
643      <td>Detail image file picker URL</td>
644      <td>-</td>
645      <td></td>
646      <td></td>
647      <td>mediaTiles.*.fp_url</td>
648      <td>?</td>
649      <td>
650       <pre>[
651   {
652     "type: "image",
653     "urls": [
654       "full": "http://...",
655       "thumb": "http://...",
656     ],
657     "fp_url": "http://...."
658   }
659 ]</pre>
660      </td>
661     </tr>
662     <tr>
663      <td>media</td>
664      <td>FIXME</td>
665      <td>-</td>
666      <td></td>
667      <td>mobileAppIcon</td>
668      <td>mobileAppIcon</td>
669      <td>App.iconImage</td>
670      <td>
671       null<br/>
672       https://s3.amazonaws.com/ouya-screenshots/3ae8fc67-f7f5-4f97-a48c-8ea2d31460fd/ouya-image20170911-3-v6tjz1
673      </td>
674      <td>
675       1246x null, rest had its own URL.
676       Set when heroImage was filled.
677      </td>
678     </tr>
679
680     <tr>
681      <td>developer</td>
682      <td>Developer name</td>
683      <td>developer.name</td>
684      <td></td>
685      <td>developer</td>
686      <td>developer.name</td>
687      <td>Developer.name</td>
688      <td>winterworks GmbH</td>
689      <td></td>
690     </tr>
691     <tr>
692      <td>developer</td>
693      <td>Developer support mail</td>
694      <td>developer.supportEmail (optional)</td>
695      <td></td>
696      <td>supportEmailAddress</td>
697      <td>-</td>
698      <td>Developer.supportEmail</td>
699      <td>null</td>
700      <td></td>
701     </tr>
702     <tr>
703      <td>developer</td>
704      <td>Support phone number</td>
705      <td>developer.supportPhone (optional)</td>
706      <td></td>
707      <td>supportPhone</td>
708      <td>-</td>
709      <td>Developer.supportPhone</td>
710      <td>null</td>
711      <td></td>
712     </tr>
713     <tr>
714      <td>developer</td>
715      <td>Developer is a founder</td>
716      <td>developer.founder (optional)</td>
717      <td></td>
718      <td>founder</td>
719      <td>developer.founder</td>
720      <td>Developer.founder</td>
721      <td>false</td>
722      <td></td>
723     </tr>
724     <tr>
725      <td>developer</td>
726      <td>Developer UUID</td>
727      <td>developer.uuid (optional)</td>
728      <td>-</td>
729      <td>-</td>
730      <td>developer.url (part of)</td>
731      <td>Developer.uuid</td>
732      <td>ouya://launcher/details?developer=5b015434-8a78-4274-aa5d-0cb2e330e50e</td>
733      <td></td>
734     </tr>
735
736    </tbody>
737   </table>
738  </body>
739 </html>