Adding Games

Adding Games

We have a games.json file located here which you can edit to add your favorite games!

Formatting of the games.json file

Example of the formatting

{
	"games": [
		{
			"description": "Description of the game",
			"developer": "Developer of the game",
			"id": "id-of-the-game",
			"image": "id-of-the-game.png",
			"name": "Title Case: Name of the Game",
			"releaseDate": "?", // optional (currently unused)
			"embedURL": "https://urlofthegame.tld", // optional
			"popular": true, // optional
			"emulator": "ruffle", // optional
			"tags": [
				"action",
				"adventure",
				"casual",
				"indie",
				"multiplayer",
				"racing",
				"rpg",
				"simulation",
				"sports",
				"strategy"
			]
		}
	]
}

description: Required. Full description of the game, not too long or short.

developer: Required. Ensure to give credit to everyone necessary.

id: Required. Ensure that there are no spaces and that everything is lowercase.

image: Required. This will grab the image from the ./static/game/img folder, the filename should match the id.

name: Required. The name that will be shown to the user. Usually in title case.

releaseDate: Unused/optional. May be used in the future for now it is usually ?.

embedURL: Optional. If the game is only accessible through a proxy then include the URL that should be proxied.

popular: Optional. Boolean (either true or false). Applies only if the game is popular or not.

emulator: Optional. Can either be ruffle or emulatorjs. If it is ruffle then there only needs to be the swf file in /static/game/[id-of-game]/[id-of-game].swf otherwise the necessary files (index.html, etc.) must be included in the /static/game/[id-of-game] folder.

tags: Either an empty array or any combination of the following options: action, adventure, casual, indie, multiplayer, racing, rpg, simulation, sports, or strategy.

Folder Layout and Images

• If the game has static assets (i.e. it isn't proxied) then the necessary files must be placed in the /static/game/[id-of-game] folder along with an index.html file.
• An image must be placed in the ./static/game/img directory that matches the image provided in the JSON file (usually id-of-game.png).