game.json Config

name string

The name of your game.

{
  "name": "TG Template"
}

author string

The author of your game.

{
  "author": "C0mplexity"
}

description? string

A description of your game.

{
  "description": "A basic template that you can use to build games for Tiny Games."
}

icon? string

A path to the icon for your game.

{
  "icon": "./icon.png"
}

thumbnail? string

A path to the thumbnail for your game.

{
  "thumbnail": "./thumbnail.png"
}

socials? string[]

An array of social media links for the author(s) of your game.

{
  "socials": [
    "https://github.com/C0mplexity0"
  ]
}

appRoot string

The root directory of your app code.

{
  "appRoot": "./app"
}

webRoot string

The root directory of your web code.

{
  "webRoot": "./web"
}

devAppRoot? string

The root directory of your app code to be used when developing your game.

{
  "devAppRoot": "./dev/app"
}

devWebRoot? string

The root directory of your web code to be used when developing your game.

{
  "devWebRoot": "./dev/web"
}

devAppUrl? string

A URL to your app page to be used when developing your game. You may want to use this when developing a game with vite, for example.

{
  "devAppUrl": "http://localhost:3000"
}

devWebUrl? string

A URL to your web page to be used when developing your game. You may want to use this when developing a game with vite, for example.

{
  "devWebUrl": "http://localhost:3001"
}