Difference between revisions of "Game-ui.xml"

From MythTV Official Wiki
Jump to: navigation, search
m
 
(9 intermediate revisions by the same user not shown)
Line 35: Line 35:
 
| style="background:darkturquoise" align="center" | <b>Yes</b>
 
| style="background:darkturquoise" align="center" | <b>Yes</b>
 
|-  
 
|-  
| gametitle
+
| title
 
| align="center"  | textarea
 
| align="center"  | textarea
 
| Plain english title of the selected item.
 
| Plain english title of the selected item.
| align="center"  | <b>Yes</b>
+
| align="center"  | No
 
|-  
 
|-  
| style="background:darkturquoise" | systemname
+
| style="background:darkturquoise" | system
 
| style="background:darkturquoise" align="center" | textarea
 
| style="background:darkturquoise" align="center" | textarea
 
| style="background:darkturquoise" | The game system of the selected item.
 
| style="background:darkturquoise" | The game system of the selected item.
| style="background:darkturquoise" align="center" | <b>Yes</b>
+
| style="background:darkturquoise" align="center" | No
 
|-  
 
|-  
| yearname
+
| year
 
| align="center"  | textarea
 
| align="center"  | textarea
 
| The Year of release of the selected item.
 
| The Year of release of the selected item.
| align="center"  | <b>Yes</b>
+
| align="center"  | No
 
|-  
 
|-  
| style="background:darkturquoise" | genrename
+
| style="background:darkturquoise" | genre
 
| style="background:darkturquoise" align="center" | textarea
 
| style="background:darkturquoise" align="center" | textarea
 
| style="background:darkturquoise" | The Genre of the selected item.
 
| style="background:darkturquoise" | The Genre of the selected item.
| style="background:darkturquoise" align="center" | <b>Yes</b>
+
| style="background:darkturquoise" align="center" | No
 
|-  
 
|-  
| showfavorite
+
| favorite
| align="center"  | textarea
+
| align="center"  | statetype
| Whether or not the selected item is a favorite (Yes/No).
+
| Whether or not the selected item is a favorite (Yes/No). State names are "yes" and "no"
| align="center"  | <b>Yes</b>
+
| align="center"  | No
 
|-  
 
|-  
| style="background:darkturquoise" | gameimage
+
| style="background:darkturquoise" | screenshot
 
| style="background:darkturquoise" align="center" | imagetype
 
| style="background:darkturquoise" align="center" | imagetype
 
| style="background:darkturquoise" | A screenshot for the selected item.
 
| style="background:darkturquoise" | A screenshot for the selected item.
| style="background:darkturquoise" align="center" | <b>Yes</b>
+
| style="background:darkturquoise" align="center" | No
 
|-  
 
|-  
| boxart
+
| coverart
 
| align="center"  | imagetype
 
| align="center"  | imagetype
 
| The box image of the selected item.
 
| The box image of the selected item.
| align="center"  | <b>Yes</b>
+
| align="center"  | No
 
|-  
 
|-  
 
| style="background:darkturquoise" | fanart
 
| style="background:darkturquoise" | fanart
 
| style="background:darkturquoise" align="center" | imagetype
 
| style="background:darkturquoise" align="center" | imagetype
 
| style="background:darkturquoise" | The fanart image for the selected item.
 
| style="background:darkturquoise" | The fanart image for the selected item.
| style="background:darkturquoise" align="center" | <b>Yes</b>
+
| style="background:darkturquoise" align="center" | No
 +
|-
 +
| description
 +
| align="center"  | textarea
 +
| The plot text for the selected item.
 +
| align="center"  | No
 
|}
 
|}
 
  
 
=== The "gamedetailspopup" window ===
 
=== The "gamedetailspopup" window ===
Line 84: Line 88:
 
| align="center"  |<b>Description</b>  
 
| align="center"  |<b>Description</b>  
 
| align="center"  |<b>Required?</b>
 
| align="center"  |<b>Required?</b>
 +
|-
 +
| screenshot
 +
| align="center"  | imagetype
 +
| Screenshot for the selected item.
 +
| align="center"  | <b>Yes</b>
 
|-  
 
|-  
 
| style="background:darkturquoise" | fanart
 
| style="background:darkturquoise" | fanart
Line 90: Line 99:
 
| style="background:darkturquoise" align="center" | <b>Yes</b>
 
| style="background:darkturquoise" align="center" | <b>Yes</b>
 
|-  
 
|-  
| boxart
+
| coverart
 
| align="center"  | imagetype
 
| align="center"  | imagetype
 
| Box art for the selected item.
 
| Box art for the selected item.
 
| align="center"  | <b>Yes</b>
 
| align="center"  | <b>Yes</b>
 
|-  
 
|-  
| style="background:darkturquoise" | gamename
+
| style="background:darkturquoise" | title
 
| style="background:darkturquoise" align="center" | textarea
 
| style="background:darkturquoise" align="center" | textarea
 
| style="background:darkturquoise" | Plain english name of the selected item.
 
| style="background:darkturquoise" | Plain english name of the selected item.
Line 145: Line 154:
 
| align="center"  | <b>Yes</b>
 
| align="center"  | <b>Yes</b>
 
|-  
 
|-  
| style="background:darkturquoise" | play_button
+
| style="background:darkturquoise" | plot
| style="background:darkturquoise" align="center" | button
+
| style="background:darkturquoise" align="center" | textarea
| style="background:darkturquoise" | "Play" button.
+
| style="background:darkturquoise" | The plot for the selected item.
 
| style="background:darkturquoise" align="center" | <b>Yes</b>
 
| style="background:darkturquoise" align="center" | <b>Yes</b>
 
|-  
 
|-  
Line 154: Line 163:
 
| "Done" (Cancel) button.
 
| "Done" (Cancel) button.
 
| align="center"  | <b>Yes</b>
 
| align="center"  | <b>Yes</b>
 +
|-
 +
| style="background:darkturquoise" | play_button
 +
| style="background:darkturquoise" align="center" | button
 +
| style="background:darkturquoise" | "Play" button.
 +
| style="background:darkturquoise" align="center" | <b>Yes</b>
 
|}
 
|}
 +
  
 
=== The "edit_metadata" window ===
 
=== The "edit_metadata" window ===
Line 164: Line 179:
 
| align="center"  |<b>Required?</b>
 
| align="center"  |<b>Required?</b>
 
|-  
 
|-  
| style="background:darkturquoise" | gamename_edit
+
| style="background:darkturquoise" | title_edit
 
| style="background:darkturquoise" align="center" | textedit
 
| style="background:darkturquoise" align="center" | textedit
 
| style="background:darkturquoise" | Edit widget for game name.
 
| style="background:darkturquoise" | Edit widget for game name.
Line 173: Line 188:
 
| Edit widget for game genre.
 
| Edit widget for game genre.
 
| align="center"  | <b>Yes</b>
 
| align="center"  | <b>Yes</b>
-  
+
|-  
 
| style="background:darkturquoise" | year_edit
 
| style="background:darkturquoise" | year_edit
 
| style="background:darkturquoise" align="center" | textedit
 
| style="background:darkturquoise" align="center" | textedit
Line 183: Line 198:
 
| Edit widget for game country.
 
| Edit widget for game country.
 
| align="center"  | <b>Yes</b>
 
| align="center"  | <b>Yes</b>
-  
+
|-  
 
| style="background:darkturquoise" | publisher_edit
 
| style="background:darkturquoise" | publisher_edit
 
| style="background:darkturquoise" align="center" | textedit
 
| style="background:darkturquoise" align="center" | textedit
Line 189: Line 204:
 
| style="background:darkturquoise" align="center" | <b>Yes</b>
 
| style="background:darkturquoise" align="center" | <b>Yes</b>
 
|-  
 
|-  
| favorite_check
+
| description_edit
| align="center"  | checkbox
+
| align="center" | textedit
| checkbox to make game a favorite.
+
| Edit widget for game plot.
| align="center"  | <b>Yes</b>
+
| align="center" | <b>Yes</b>
 +
|-
 +
| style="background:darkturquoise" |favorite_check
 +
| style="background:darkturquoise" align="center"  | checkbox
 +
| style="background:darkturquoise" |checkbox to make game a favorite.
 +
| style="background:darkturquoise" align="center"  | <b>Yes</b>
 +
|-
 +
| coverart_button
 +
| align="center" | button
 +
| Button to bring up file browser for box art.
 +
| align="center" | <b>Yes</b>
 
|-  
 
|-  
| style="background:darkturquoise" | boxart_button
+
| style="background:darkturquoise" |fanart_button
| style="background:darkturquoise" align="center" | button
+
| style="background:darkturquoise" align="center" | button
| style="background:darkturquoise" | Button to bring up file browser for box art.
+
| style="background:darkturquoise" |button to bring up file browser for fanart.
| style="background:darkturquoise" align="center" | <b>Yes</b>
+
| style="background:darkturquoise" align="center" | <b>Yes</b>
 
|-  
 
|-  
| fanart_button
+
| screenshot_button
| align="center" | button
+
| align="center" | button
| button to bring up file browser for fanart.
+
| Button to bring up file browser for screenshot.
| align="center" | <b>Yes</b>
+
| align="center" | <b>Yes</b>
 
|-  
 
|-  
| style="background:darkturquoise" | boxart_text
+
| style="background:darkturquoise" |coverart_text
 
| style="background:darkturquoise" align="center" | textarea
 
| style="background:darkturquoise" align="center" | textarea
| style="background:darkturquoise" | Text of absolute path to boxart image file.
+
| style="background:darkturquoise" |Text of absolute path to boxart image file.
 
| style="background:darkturquoise" align="center" | <b>Yes</b>
 
| style="background:darkturquoise" align="center" | <b>Yes</b>
 
|-  
 
|-  
Line 214: Line 239:
 
| align="center"  | <b>Yes</b>
 
| align="center"  | <b>Yes</b>
 
|-  
 
|-  
| style="background:darkturquoise" | done_button
+
| style="background:darkturquoise" |screenshot_text
| style="background:darkturquoise" align="center" | button
+
| style="background:darkturquoise" align="center" | textarea
| style="background:darkturquoise" | "Done" button.
+
| style="background:darkturquoise" |Text of absolute path to screenshot image file.
 
| style="background:darkturquoise" align="center" | <b>Yes</b>
 
| style="background:darkturquoise" align="center" | <b>Yes</b>
 +
|-
 +
| done_button
 +
| align="center"  | button
 +
| "Done" button.
 +
| align="center"  | <b>Yes</b>
 +
|}

Latest revision as of 21:30, 23 September 2009

The game-ui.xml file governs the layout and behavior of the MythGame plugin. It consists of the following windows and named attributes:

MythGame Plugin Windows

Window Name Type Description
gameui Window The Main MythGame Interface
gamedetailspopup Popup Window The Game Info Screen
edit_metadata Window Edit Game Metadata screen.


The "gameui" window

Widget Name Widget Type Description Required?
gametreelist buttontree Button Tree for emulator/game/genre hierarchy. Yes
title textarea Plain english title of the selected item. No
system textarea The game system of the selected item. No
year textarea The Year of release of the selected item. No
genre textarea The Genre of the selected item. No
favorite statetype Whether or not the selected item is a favorite (Yes/No). State names are "yes" and "no" No
screenshot imagetype A screenshot for the selected item. No
coverart imagetype The box image of the selected item. No
fanart imagetype The fanart image for the selected item. No
description textarea The plot text for the selected item. No

The "gamedetailspopup" window

Widget Name Widget Type Description Required?
screenshot imagetype Screenshot for the selected item. Yes
fanart imagetype Fanart for the selected item. Yes
coverart imagetype Box art for the selected item. Yes
title textarea Plain english name of the selected item. Yes
allsystems textarea Plain english emulator name. Yes
gametype textarea Internal myth emulator type name. Yes
crc textarea CRC value for the selected item. Yes
romname textarea Name of the ROM file. Yes
rompath textarea Path to the ROM file. Yes
publisher textarea The publisher of the selected item. Yes
year textarea Release year of the selected item. Yes
genre textarea Genre of the selected item. Yes
country textarea Country of the selected item. Yes
plot textarea The plot for the selected item. Yes
done_button button "Done" (Cancel) button. Yes
play_button button "Play" button. Yes


The "edit_metadata" window

Widget Name Widget Type Description Required?
title_edit textedit Edit widget for game name. Yes
genre_edit textedit Edit widget for game genre. Yes
year_edit textedit Edit widget for game release year. Yes
country_edit textedit Edit widget for game country. Yes
publisher_edit textedit Edit widget for game publisher. Yes
description_edit textedit Edit widget for game plot. Yes
favorite_check checkbox checkbox to make game a favorite. Yes
coverart_button button Button to bring up file browser for box art. Yes
fanart_button button button to bring up file browser for fanart. Yes
screenshot_button button Button to bring up file browser for screenshot. Yes
coverart_text textarea Text of absolute path to boxart image file. Yes
fanart_text textarea Text of absolute path to fanart image file. Yes
screenshot_text textarea Text of absolute path to screenshot image file. Yes
done_button button "Done" button. Yes