Writing plugin.manifest files

[Kamikazi]

What is plugin.manifest

The new manifest file is a new addition in 815 where it is needed for plugins to work in the Online regions multiplayer that aren't from the Plugin Store. It's not obligatory to upload your plugins in the forums with the file but it is highly appreciated if you make or update your plugins with the manifest file.It also allows the plugin to be managed with plugin store.

The file itself

The file MUST be called plugin.manifest so it can be properly recognised by the game. It MUST also be in the folder where the plugin is.

How to code plugin.manifest files

It follows the same structure you use for json, so there isn't anything new to learn.
Here is an example:

Code: Select all

{
  "id":"Test_kami",  // Unique id for the plugin, you can put anything here, as always it doesn't repeat with other ones
  "version":69, // Plugin version code, you can put any number here
  "title":"Test",   // Title for the plugin, pretty self-explanatory
  "text":"Testy test.", //Description of the Plugin. Optional
  "author":"Kamikazi", //The maker of the plugin (Yourself, basically)
  "thumbnail":"Something.png", // Thumbnail image file, like in the plugin store. Optional
  "category":false,   // Specify whether to show a category for the plugin. Optional
  "url":"https://forum.theotown.com/",  //Specify where the plugin can be downloaded from. Optional (816+)
  "multiplayer":true  //Specify whether the plugin can be used in online mode. True by default (833+)
}

Thanks to JA for giving the manifest file with some handy comments

NOTE: This tutorial is subject to change, since this is quite brand new.

[JustAnyone]

Thank you. We'll edit your post as needed to adapt to new changes.

[Yakka]

Useful

[KINGTUT10101]

Will adding a manifest to a store plug-in cause problems?

[JustAnyone]

Will adding a manifest to a store plug-in cause problems?

It shouldn'tTM

[yusuf8a684]

Thanks, that's a nice tutorial and an awesome addition to game :

[Goldfih]

What app must use to write a plugin.manifest files??

[CommanderABab]

The same text editor as jsons.

[Goldfih]

The same text editor as jsons.

Thanks, but why ny plugins alway error?? I already have json and manifest file

[CommanderABab]

I don't know. I would have to see the code.

[drmdarsh09]

I'm getting an error (this is my first plugin and I don't know what to do), can someone check the code and tell me what is wrong

Code: Select all    Reset

{
  "id":"Happy_Building"
  "title":"Test"
  "text":"test."
  "author":"drmdarsh09"
  "thumbnail":"HAPPY PICTURE (the bottle).png"
  "category":residential
}

JSON checker

Check

Output: Select all

...

[drmdarsh09]

I'm getting an error (this is my first plugin and I don't know what to do), can someone check the code and tell me what is wrong

Code: Select all    Reset

{
  "id":"Happy_Building"
  "title":"Test"
  "text":"test."
  "author":"drmdarsh09"
  "thumbnail":"HAPPY PICTURE (the bottle).png"
  "category":residential
}

JSON checker

Check

Output: Select all

...

[CommanderABab]

Try:

Code: Select all

{
  "id":"Happy_Building",
  "title":"Test",
  "text":"test.",
  "author":"drmdarsh09",
  "thumbnail":{"bmp":"HAPPY PICTURE (the bottle).png"},
  "category":"residential"
}

[drmdarsh09]

Try:

Code: Select all

{
  "id":"Happy_Building",
  "title":"Test",
  "text":"test.",
  "author":"drmdarsh09",
  "thumbnail":{"bmp":"HAPPY PICTURE (the bottle).png"},
  "category":"residential"
}

Thanks!

[KINGTUT10101]

Can we define a minimum version in these manifest files?

[Sharizal zul]

Why my plugin always get an error by using the manifest file that sent by pidroid. Have some text must to erase? In that manifest example code

[JustAnyone]

plugin.manifest.json is not a valid manifest file

It must be plugin.manifest

[Yakka]

Suggestions for manifest:
• Required Plugin
• Minimum Version
• Additional Thing

[Kiti_mat]

Where to insert this .manifest file? it is necessary to create a file separately or in .json

[Lobby]

It's a file that you place alongside the json file.