Writing plugin.manifest files

Learn here how to create and use plugins.

Moderator: Plugin Moderators

User avatar
Kamikazi
Inhabitant of a Conurbation
Reactions:
Posts: 411
Joined: Sat Jan 27, 2018 0:58
Location: Zaragoza, ESPAÑA
Plugins: Show
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 Sat May 16, 2020 13:56, edited 4 times in total.

User avatar
Dominykas
Developer
Reactions:
Posts: 3164
Joined: Sun Jul 23, 2017 12:45
Location: Easter Island
Plugins: Show

Platform

Re: Writing .manifest files

#2

Post by Dominykas »

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

User avatar
Kiki012
Inhabitant of a Megacity
Reactions:
Posts: 210
Joined: Mon Jan 06, 2020 9:57
Location: No one care
Plugins: Show
Version: Beta

Plugin Creator

Platform

Re: Writing .manifest files

#3

Post by Kiki012 »

Useful
Image...image credits:here!
"Creating Plugin is not easy as Playing the game"
Change my mind


free stuff! :bp

User avatar
KINGTUT10101
1,000,000 inhabitants
Reactions:
Posts: 2119
Joined: Thu Jul 07, 2016 22:50
Location: 'Merica
Plugins: Show
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
Dominykas
Developer
Reactions:
Posts: 3164
Joined: Sun Jul 23, 2017 12:45
Location: Easter Island
Plugins: Show

Platform

Re: Writing .manifest files

#5

Post by Dominykas »

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

User avatar
yusuf8a684
Inhabitant of a Planet
Reactions:
Posts: 1362
Joined: Sun Dec 10, 2017 22:09
Location: Turkiye
Plugins: Show

Plugin Creator

Platform

Re: Writing .manifest files

#6

Post by yusuf8a684 »

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

I can't define my self time to time... Just do not %100 trust me. Texting that honestly...

Know your friends well, enemies

Sagm
Settler
Reactions:
Posts: 6
Joined: Sat Aug 01, 2020 5:23

Re: Writing plugin.manifest files

#7

Post by Sagm »

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

User avatar
CommanderABab
AB
Reactions:
Posts: 9356
Joined: Tue Jun 07, 2016 21:12
Plugins: Show
Version: Beta

Platform

Plugin Creator

Re: Writing plugin.manifest files

#8

Post by CommanderABab »

The same text editor as jsons. :)
...............:) .Image

Sagm
Settler
Reactions:
Posts: 6
Joined: Sat Aug 01, 2020 5:23

Re: Writing plugin.manifest files

#9

Post by Sagm »

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

User avatar
CommanderABab
AB
Reactions:
Posts: 9356
Joined: Tue Jun 07, 2016 21:12
Plugins: Show
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. :)
...............:) .Image

drmdarsh09
Settler
Reactions:
Posts: 6
Joined: Sun Aug 16, 2020 8: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: 6
Joined: Sun Aug 16, 2020 8: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: 9356
Joined: Tue Jun 07, 2016 21:12
Plugins: Show
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"
}
...............:) .Image

drmdarsh09
Settler
Reactions:
Posts: 6
Joined: Sun Aug 16, 2020 8:07

Re: Writing plugin.manifest files

#14

Post by drmdarsh09 »

CommanderABab wrote:
Tue Sep 08, 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: 2119
Joined: Thu Jul 07, 2016 22:50
Location: 'Merica
Plugins: Show
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?

Post Reply Previous topicNext topic

Return to “Tutorials and Documentation”