Making plugins for beginners

Learn here how to create and use plugins.

Moderator: Plugin Moderators

User avatar
TheoTown_Socials
Villager
Reactions:
Posts: 20
Joined: 07 Oct 2024, 16:52
Location: https://www.instagram.com/theotowngame/
Plugins: Showcase Store

Making plugins for beginners

#1

Post by TheoTown_Socials »

I have compiled this tutorial for our new players who are new to learning how to make plugins.

STEP 1: CHOOSING A REFERENCE:
Start by browsing the web for real life references of buildings until you find a building you like.
I have chosen this as my reference
Hospital reference.png
STEP 2: CHOOSE A TEMPLATE
Choose a template from here: viewtopic.php?t=3207
I have chosen a 3x5 for my plugin. You may choose any template or make your own since the version 1.12.49 which allows non-square buildings or arbitrary sizes. You can read more about it here: viewtopic.php?t=28150

STEP 3: GRAPHICS
Choose a pixel drawing of choice. It can be any app which allows transparency options and allows to draw pixel by pixel. Ideally, it should also have layers but it is not required.
I use paint.net but many creators use pixel studio or ibis paint x.
The rough scale is a human is 3 pixels tall (6ft or 1.8m), therefore making a pixel 2ft or 0.6m
The buildings shadows fall straight to the right of the building to the same length as the height of the building.
Here is the graphics that was made for this tutorial:
Graphics tutorial.png
Note: the pink background was added so the building is more visible. When exporting, the background should be transparent.

STEP 4: JSON
Once you are done with the graphics, you now need a json.
You can do this using the PCA website by JustAnyone: https://pca.svetikas.lt/
Or, you can do it manually using a text editor that allows saving as a json extention such as a notepad. Here I have used Visual Studio Code (VSC)

Here is an example of what a json would look (specifically, a hospital)

Code: Select all    Reset

[ { "id":"BNY_HEATHER_1", // this is a unique indicator, I recommend putting your name then plugin name/building "type":"medic", // find all types here: viewtopic.php?f=41&t=1355 "title":"Heather Health Facility", "text":"A hospice where your citizens can seek healthcare. \nBuilt in 1982, the hospital has won numerous industry awards including [undisclosed].", "price":30000, "monthly price":150, "influence health":80, "provide aspect health care":32000, //the number of patients that can be treated "width":3, "height":5, "requirements":[{"type":"RANK", "lvl":7}], //this is when the building gets unlocked "frames": [ {"bmp":"heather_hospital.png","w":128,"count":2} ], "performance":true, //when performance is increased, the monthly cost gets scaled with it "draw ground":true, //without this, the ground would be water "rotation aware":true //this building uses 2 frames as it is a non-square building } ]
JSON checker
Check
Refer to the attached zip file for what what a json would look like for a plugin with multiple buildings.
Note: Using plugins for excessive influences, to generate excessive income or exploit game features will not be tolerated and may get your account banned.

STEP 5: MANIFEST FILE
Create a manifest file. This is what it would look like:

Code: Select all

{
    "id": "BNY_Heather_Health_Facility",
    "version": 1,
    "title": "Heather Health Facility",
    "text": "The plugin adds 2 additional healthcare buildings for your city. Unlocked at level 7, it closely follows the attributes of the 4x4 building in-game with just a slightly higher influence and monthly price.",
    "author": "Bunny & TheoTown Socials",
    "thumbnail": "manifest_preview.png"
}
You only need 1 manifest per plugin. This is not required but when included will show a preview of the plugin under local plugins in-game.
The file needs to be named "plugin.manifest" otherwise there would be an error.

STEP 6: IMPORTING TO GAME
To import to your game, find and place the plugin inside the plugin folder which you can find here:

Windows: C:\Users(insert username)\TheoTown or %USERPROFILE%\TheoTown

Android: /storage/emulated/0/Android/data/info.flowersoft.theotown.theotown/files

ios: Search "TheoTown" in the file manager app

If you cannot access game files through these directories, game has an in-built file manager for mobile devices which is accessible from the region view menu.

You can find the building in the relevant category. Here I would find it under services > medic as I had used the type "medic".

STEP 7: HELPFUL GUIDES
Here are some additional tutorials that may be helpful:
- JustAnyone's plugin creator website documents almost all game attributes and tutorials: https://pca.svetikas.lt/docs/
- Kulche goes into more detail on how to draw a building: viewtopic.php?f=41&t=10287
- rtobby made a tutorial on how how to improve the plugin quality: viewtopic.php?f=41&t=13798
- Game graphics are helpful to eyedrop a specific colour or make use of vanilla textures such as trees: viewtopic.php?t=5659
- Use the game jsons to pick appropriate values for your buildings: viewtopic.php?t=5661

You can find additional help here or on our Discord server!

Step 8: UPLOADING TO STORE OR FORUM
IMPORTANT: if you are posting to the plugin store, ensure you read the rules first: viewtopic.php?t=9085. Plugins uploaded to the store can be downloaded in-game but has a strict quality requirement which is enforced by our plugin moderation team.
We recommend uploading first plugins to the forum for feedback as forum is less strict on plugin quality requirements. You can upload to forum showcase here: viewforum.php?f=43

And here is how our final building(s) looks like (and the final zip file for you to inspect):
Hospital final.png
Heather Health Facility.zip
(320.52 KiB) Downloaded 82 times

Enjoy plugin creation mayors! <3
Last edited by TheoTown_Socials on 31 Jan 2026, 11:49, edited 1 time in total.
Reason: Update template line from 1:2/2:1 requirement to be in-line with non-arbitrary size support (with link).

User avatar
Neruenz
Settler
Reactions:
Posts: 2
Joined: 10 Jan 2026, 22:23

Re: Making plugins for beginners

#2

Post by Neruenz »

Thank you for this tutorial, just exactly what I need right now (⁠人⁠ ⁠•͈⁠ᴗ⁠•͈⁠)

User avatar
KarzWa
Settler
Reactions:
Posts: 3
Joined: 09 Jan 2026, 04:10

Re: Making plugins for beginners

#3

Post by KarzWa »

1 Tile is equal to how many pixel?

User avatar
PBbunnypower
Inhabitant of a Megacity
Reactions:
Posts: 277
Joined: 26 Aug 2022, 11:49
Plugins: Showcase Store
Version: Beta

Plugin Creator

Platform

Re: Making plugins for beginners

#4

Post by PBbunnypower »

@KarzWa
The rough scale is a human is 3 pixels tall (6ft or 1.8m), therefore making a single pixel 2ft or 0.6m
1 tile is 16 in height and 32 in width.

User avatar
Temcy69
Settler
Reactions:
Posts: 2
Joined: 10 Jan 2026, 20:19

Re: Making plugins for beginners

#5

Post by Temcy69 »

Do you know how to maximize this influence? I tried to go beyond the limits but always hit the limit.

User avatar
PBbunnypower
Inhabitant of a Megacity
Reactions:
Posts: 277
Joined: 26 Aug 2022, 11:49
Plugins: Showcase Store
Version: Beta

Plugin Creator

Platform

Re: Making plugins for beginners

#6

Post by PBbunnypower »


User avatar
Temcy69
Settler
Reactions:
Posts: 2
Joined: 10 Jan 2026, 20:19

Re: Making plugins for beginners

#7

Post by Temcy69 »

PBbunnypower wrote:
23 Jan 2026, 08:08
@Temcy69 Refer to this: viewtopic.php?p=240367#p240367
very helpful, thank you

User avatar
IDK120391919393
Settler
Reactions:
Posts: 2
Joined: 11 Jan 2026, 13:38

Re: Making plugins for beginners

#8

Post by IDK120391919393 »

But im not pro json

User avatar
PBbunnypower
Inhabitant of a Megacity
Reactions:
Posts: 277
Joined: 26 Aug 2022, 11:49
Plugins: Showcase Store
Version: Beta

Plugin Creator

Platform

Re: Making plugins for beginners

#9

Post by PBbunnypower »

@IDK120391919393 Use pca in that case: https://pca.svetikas.lt/. We would also be happy to help you with what attributes you need on here or Discord.

Post Reply Previous topicNext topic

Return to “Tutorials and Documentation”