Game Metadata Contents - Revision history

Tom Voros: /* Contents */

2025-08-19T03:37:02Z

Contents

← Older revision		Revision as of 23:37, 18 August 2025
Line 62:		Line 62:
	\|-		\|-
	\| Trailers \|\| "trailers" \|\| String Array \|\| URLs to videos		\| Trailers \|\| "trailers" \|\| String Array \|\| URLs to videos
			\|-
			\|Platforms
			\|"platforms"
			\|String Array
			\|E.g. "windows", "mac", "linux", "android", "ps5", etc.
	\|-		\|-
	\| News Feed \|\| "newsFeed" \|\| String \|\| URL for an RSS feed for news/updates about the game		\| News Feed \|\| "newsFeed" \|\| String \|\| URL for an RSS feed for news/updates about the game

2025-08-18T17:25:54Z

← Older revision		Revision as of 13:25, 18 August 2025
Line 1:		Line 1:
	<onlyinclude>		<onlyinclude>
	The [[Game Metadata]] file should contain the essential details about a game. For example: title, developer, publisher, description, genre, URL(s) to buy or download, etc. We should include information that would be useful to a potential player when browsing games to check out~~, so we~~ can look at existing platforms like Steam and itch.io for inspiration.		The [[Game Metadata]] file should contain the essential details about a game. For example: title, developer, publisher, description, genre, URL(s) to buy or download, etc. We should include information that would be useful to a potential player when browsing games to check out. We can look at existing platforms like Steam and itch.io for inspiration.

	We'll need to decide exactly which details we want to include and how they should be represented in JSON.</onlyinclude>		We'll need to decide exactly which details we want to include and how they should be represented in JSON.</onlyinclude>

2025-08-18T16:00:48Z

Schema Identifier

← Older revision		Revision as of 12:00, 18 August 2025
Line 29:		Line 29:
	If we use a common file format like JSON it might be useful in some cases if the file includes something to identify it as a "Game Metadata" file specifically. We could include something like this in the metadata:<syntaxhighlight lang="json">		If we use a common file format like JSON it might be useful in some cases if the file includes something to identify it as a "Game Metadata" file specifically. We could include something like this in the metadata:<syntaxhighlight lang="json">
	"schema": "game-metadata"		"schema": "game-metadata"
	</syntaxhighlight>		</syntaxhighlight>Should we formalize the schema even further with [https://json-schema.org JSON Schema] or is that overkill?

	=== Schema Version ===		=== Schema Version ===

2025-08-18T15:57:06Z

Localization

← Older revision		Revision as of 11:57, 18 August 2025
Line 14:		Line 14:
	The metadata schema should provide a way to include localized properties. You should also be able to specify what language the base properties are in. We shouldn't assume the base language will always be English.		The metadata schema should provide a way to include localized properties. You should also be able to specify what language the base properties are in. We shouldn't assume the base language will always be English.

	<syntaxhighlight lang="~~JSON~~">		<syntaxhighlight lang="json">
	{		{
	"title": "洞窟物語",		"title": "洞窟物語",
	"language": "jp",		"language": "jp",
	"localization":		"localization": {
	[		"en": {
	{		"title": "Cave Story"
	"~~language~~": ~~"en",~~		}
	"title": "Cave Story"
	}		}
	]
	}		}
	</syntaxhighlight>		</syntaxhighlight>

2025-08-18T15:52:39Z

Example

← Older revision		Revision as of 11:52, 18 August 2025
Line 99:		Line 99:
	<syntaxhighlight lang="json" line="1">		<syntaxhighlight lang="json" line="1">
	{		{
	"title": "Hollow Knight",		"schema": "game-metadata",
	"description": "Forge your own path in Hollow Knight! An epic action adventure through a vast ruined kingdom of insects and heroes. Explore twisting caverns, battle tainted creatures and befriend bizarre bugs, all in a classic, hand-drawn 2D style.",		"schema-version": "0.1",
	"developer": "Team Cherry",
	"publisher": "Team Cherry",		"title": "Hollow Knight",
	"links": [		"description": "Forge your own path in Hollow Knight! An epic action adventure through a vast ruined kingdom of insects and heroes. Explore twisting caverns, battle tainted creatures and befriend bizarre bugs, all in a classic, hand-drawn 2D style.",
	"https://www.hollowknight.com/",		"developer": "Team Cherry",
	"https://store.steampowered.com/app/367520/Hollow_Knight/",		"publisher": "Team Cherry",
	"https://www.gog.com/en/game/hollow_knight"		"links": [
	],		"https://www.hollowknight.com/",
	"genre": [		"https://store.steampowered.com/app/367520/Hollow_Knight/",
	"Metroidvania",		"https://www.gog.com/en/game/hollow_knight"
	"Platformer",		],
	"Singleplayer"		"genre": [
	],		"Metroidvania",
	"tags": [		"Platformer",
	"2D",		"Singleplayer"
	"Indie",		],
	"Exploration"		"tags": [
	]		"2D",
			"Indie",
			"Exploration"
			]
	}		}
	</syntaxhighlight>		</syntaxhighlight>

2025-08-18T15:51:42Z

Considerations

@@ Line 26: / Line 26: @@
+   ]
+}
 </syntaxhighlight>

2025-08-18T03:35:47Z

Example

← Older revision		Revision as of 23:35, 17 August 2025
Line 87:		Line 87:
	== Example ==		== Example ==

	<syntaxhighlight lang="~~JSON~~">		<syntaxhighlight lang="json" line="1">
	{		{
	"title": "Hollow Knight",		"title": "Hollow Knight",

2025-08-18T02:00:17Z

Contents

@@ Line 57: / Line 57: @@
 | News Feed || "newsFeed" || String || URL for an RSS feed for news/updates about the game
 |}
 === Possible Inclusions ===

2025-08-18T01:56:05Z

Contents

← Older revision		Revision as of 21:56, 17 August 2025
Line 33:		Line 33:
	\|+ Metadata Contents		\|+ Metadata Contents
	\|-		\|-
	! Item !! JSON Name !! Type		! Item !! JSON Name !! Type !! Notes
	\|-		\|-
	\| Title \|\| "title" \|\| String		\| Title \|\| "title" \|\| String \|\|
	\|-		\|-
	\| Description \|\| "description" \|\| String		\| Description \|\| "description" \|\| String \|\|
	\|-		\|-
	\| Developer \|\| "developer" \|\| String		\| Developer \|\| "developer" \|\| String \|\|
	\|-		\|-
	\| Publisher \|\| "publisher" \|\| String		\| Publisher \|\| "publisher" \|\| String \|\|
	\|-		\|-
	\| Links \|\| "links" \|\| String Array		\| Links \|\| "links" \|\| String Array \|\| URLs to personal websites or store pages
	\|-		\|-
	\| Genre \|\| "genre" \|\| String Array		\| Genre \|\| "genre" \|\| String Array \|\|
	\|-		\|-
	\| Tags \|\| "tags" \|\| String Array		\| Tags \|\| "tags" \|\| String Array \|\|
			\|-
			\| Cover Art \|\| "coverArt" \|\| String \|\| URL to an image
			\|-
			\| Screenshots \|\| "screenshots" \|\| String Array \|\| URLs to images
			\|-
			\| Trailers \|\| "trailers" \|\| String Array \|\| URLs to videos
			\|-
			\| News Feed \|\| "newsFeed" \|\| String \|\| URL for an RSS feed for news/updates about the game
	\|}		\|}

2025-08-18T01:52:02Z

Contents

@@ Line 49: / Line 49: @@
 | Tags || "tags" || String Array
 |}
 == Example ==