Plugin manifest

The manifest file plugin.manifest was introduced in version 1.8.15 to support the use of local plugins in the online mode.

It must be included at the root directory of your plugin and must be named exactly plugin.manifest for the game to recognize it.

This file is a requirement if you want to create an encrypted .ttplugin file and use privileged features.

Minimal example

An example manifest file could look like this:

plugin.manifest:

{
  "id": "$justanyone_dsa_manifest00",
  "version": 42,
  "title": "DSA Integration",
  "text": "This integration adds better supply systems, few new service cars, a new road which is faster and cheaper, a new disaster, DSA flags, new buildings, a lot of events, a space dimension to explore, new methods to earn money and much more.",
  "author": "JustAnyone",
  "thumbnail": "iap.png"
}

The iap.png is an image included together with the manifest file.

Attributes

Manifest file support the following attributes:

author

Type: string

The name of the author behind the plugin.

category

Type: boolean

Whether the plugin should show up in the plugins category.

Added in version 1.11.72

id *

Type: string

A unique identifier that uniquely identifies the plugin.

min version

Type: integer

Specifies the minimum version of the game that the plugin can run under.

multiplayer

Type: boolean

Whether the plugin can be used in online mode.

Added in version 1.8.33

once

Type: boolean

Whether the plugin manifest should be loaded once.

What this means is that if another manifest is encountered with the same ID, game will ignore loading it rather than failing with an error message.

permanent

Type: boolean

Whether the plugin counts as a local plugin.

platforms

Type: string array

An array of platforms that the plugin can run under. Generally, this should only be used in case of Lua or shader plugins as regular plugins should be compatible with every platform.

Internally, the platform is determined by ApplicationType enumerable which is provided by libgdx.

Supported values: android, desktop, ios.

Example

In this example we limit our plugin to iOS and PC platforms.

{
    "id": "$my_amazing_plugin_manifest00",
    "title": "My amazing plugin",
    "platforms": ["desktop", "ios"]
}

text

Type: string

The description of the plugin.

thumbnail

Type: string

The path to the plugin thumbnail image.

title *

Type: string

The title of the plugin.

url

Type: string

A URL that points to a place from where the plugin can be obtained.

Added in version 1.8.16

version

Type: integer

A positive integer that specifies the plugin version.