Writing plugin.manifest files

Learn here how to create and use plugins.

Moderator: Plugin Moderators

User avatar
Kamikazi
Inhabitant of a Conurbation
Reactions:
Posts: 463
Joined: 27 Jan 2018, 00:58
Location: Zaragoza, ESPAÑA
Plugins: Showcase Store
Version: Beta
Contact:

Platform

Plugin Creator

Writing plugin.manifest files

#1

Post by 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.
Last edited by Kamikazi on 16 May 2020, 13:56, edited 4 times in total.

User avatar
JustAnyone
Developer
Reactions:
Posts: 3336
Joined: 23 Jul 2017, 12:45
Location: Easter Island
Plugins: Showcase Store

Platform

Re: Writing .manifest files

#2

Post by JustAnyone »

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

User avatar
Kiki012
Inhabitant of a Conurbation
Reactions:
Posts: 389
Joined: 06 Jan 2020, 09:57
Location: Java-indonesia
Plugins: Showcase Store
Version: Beta
Contact:

Plugin Creator

Platform

Re: Writing .manifest files

#3

Post by Kiki012 »

Useful
꧋ꦱꦼꦭꦩꦠ꧀ꦝꦠꦁꦥꦼꦁꦒꦸꦤ꧉
🇮🇩 Situs saya
🇬🇧 My Website


User avatar
KINGTUT10101
1,000,000 inhabitants
Reactions:
Posts: 2192
Joined: 07 Jul 2016, 22:50
Location: 'Merica
Plugins: Showcase Store
Version: Beta
Contact:

Platform

Plugin Creator

Re: Writing .manifest files

#4

Post by KINGTUT10101 »

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

User avatar
JustAnyone
Developer
Reactions:
Posts: 3336
Joined: 23 Jul 2017, 12:45
Location: Easter Island
Plugins: Showcase Store

Platform

Re: Writing .manifest files

#5

Post by JustAnyone »

KINGTUT10101 wrote:
29 Jan 2020, 17:12
Will adding a manifest to a store plug-in cause problems?
It shouldn'tTM

yusuf8a684
Reactions:

Re: Writing .manifest files

#6

Post by yusuf8a684 »

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

User avatar
Goldfih
Settler
Reactions:
Posts: 6
Joined: 01 Aug 2020, 05:23
Plugins: Showcase Store
Version: Beta

Platform

Re: Writing plugin.manifest files

#7

Post by Goldfih »

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

User avatar
CommanderABab
AB
Reactions:
Posts: 10597
Joined: 07 Jun 2016, 21:12
Plugins: Showcase Store
Version: Beta

Platform

Plugin Creator

Re: Writing plugin.manifest files

#8

Post by CommanderABab »

The same text editor as jsons. :)

User avatar
Goldfih
Settler
Reactions:
Posts: 6
Joined: 01 Aug 2020, 05:23
Plugins: Showcase Store
Version: Beta

Platform

Re: Writing plugin.manifest files

#9

Post by Goldfih »

:?:
CommanderABab wrote:
07 Aug 2020, 17:31
The same text editor as jsons. :)
Thanks, but why ny plugins alway error?? I already have json and manifest file
Goldfih

User avatar
CommanderABab
AB
Reactions:
Posts: 10597
Joined: 07 Jun 2016, 21:12
Plugins: Showcase Store
Version: Beta

Platform

Plugin Creator

Re: Writing plugin.manifest files

#10

Post by CommanderABab »

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

drmdarsh09
Settler
Reactions:
Posts: 7
Joined: 16 Aug 2020, 08:07

Re: Writing plugin.manifest files

#11

Post by 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

drmdarsh09
Settler
Reactions:
Posts: 7
Joined: 16 Aug 2020, 08:07

Re: Writing plugin.manifest files

#12

Post by 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

User avatar
CommanderABab
AB
Reactions:
Posts: 10597
Joined: 07 Jun 2016, 21:12
Plugins: Showcase Store
Version: Beta

Platform

Plugin Creator

Re: Writing plugin.manifest files

#13

Post by CommanderABab »

Try:

Code: Select all

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

drmdarsh09
Settler
Reactions:
Posts: 7
Joined: 16 Aug 2020, 08:07

Re: Writing plugin.manifest files

#14

Post by drmdarsh09 »

CommanderABab wrote:
08 Sep 2020, 17:16
Try:

Code: Select all

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

User avatar
KINGTUT10101
1,000,000 inhabitants
Reactions:
Posts: 2192
Joined: 07 Jul 2016, 22:50
Location: 'Merica
Plugins: Showcase Store
Version: Beta
Contact:

Platform

Plugin Creator

Re: Writing plugin.manifest files

#15

Post by KINGTUT10101 »

Can we define a minimum version in these manifest files?

Sharizal zul
Small-town resident
Reactions:
Posts: 39
Joined: 17 Jun 2021, 17:33
Plugins: Showcase Store
Version: Beta

Re: Writing plugin.manifest files

#16

Post by 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

User avatar
JustAnyone
Developer
Reactions:
Posts: 3336
Joined: 23 Jul 2017, 12:45
Location: Easter Island
Plugins: Showcase Store

Platform

Re: Writing plugin.manifest files

#17

Post by JustAnyone »

plugin.manifest.json is not a valid manifest file

It must be plugin.manifest

User avatar
Kiki012
Inhabitant of a Conurbation
Reactions:
Posts: 389
Joined: 06 Jan 2020, 09:57
Location: Java-indonesia
Plugins: Showcase Store
Version: Beta
Contact:

Plugin Creator

Platform

Re: Writing plugin.manifest files

#18

Post by Kiki012 »

Suggestions for manifest:
• Required Plugin
• Minimum Version
• Additional Thing
꧋ꦱꦼꦭꦩꦠ꧀ꦝꦠꦁꦥꦼꦁꦒꦸꦤ꧉
🇮🇩 Situs saya
🇬🇧 My Website


Kiti_mat
Townsman
Reactions:
Posts: 67
Joined: 12 Jun 2019, 20:47
Plugins: Showcase Store

Re: Writing plugin.manifest files

#19

Post by Kiti_mat »

Where to insert this .manifest file? it is necessary to create a file separately or in .json
I live in Russia, but I am not Russian. :img :teach :bc :android :linux
Я Живу в России, но я не Русский.
Republic Of Siste-Alheims .
Capital City: Alekseevskoe.
Continent: Asia .
Official language: Russian, Tatar, Chuvash .

User avatar
Lobby
Developer
Reactions:
Posts: 3679
Joined: 26 Oct 2008, 12:34
Plugins: Showcase Store
Version: Beta

Platform

Re: Writing plugin.manifest files

#20

Post by Lobby »

It's a file that you place alongside the json file.
=^._.^= ∫

Post Reply Previous topicNext topic

Return to “Tutorials and Documentation”