Creating a Plugin

This guide explains how to create a plugin for Buildware-Tools and share it with the community.

---

Step 1 — Create a GitHub Repository

Create a new public repository on GitHub with any name you want.

---

Step 2 — Add the Required Topic

Go to your repository on GitHub:
Settings → Topics → type buildware-plugin → Save

Without this tag, Buildware-Tools will refuse to install your plugin.

---

Step 3 — Add the Required Files

Your repository must contain exactly these two files:

your-plugin/
├── plugin.json    ← plugin metadata
└── main.py        ← plugin entry point

---

Step 4 — Fill in plugin.json

{
    "name"      : "Display name shown in the Buildware menu",
    "author"    : "Your GitHub username",
    "category"  : "OSINT / Network / Utilities / Roblox / Discord",
    "version"   : "1.0",
    "github"    : "https://github.com/YourUsername/your-plugin-repo",
    "buildware" : "3.0",
    "requires"  : ["requests", "bs4"]
}

Field	Required	Description
name	✅	Display name shown in the Buildware menu
author	✅	Your GitHub username
category	✅	OSINT / Network / Utilities / Roblox / Discord
version	✅	Plugin version, e.g. "1.0"
github	✅	Full repository URL, used by the update system
buildware	❌	Minimum Buildware-Tools version required
requires	❌	List of pip packages to auto-install

---

Step 5 — Write your Code in main.py

Start your main.py with the following imports:

import sys, os
sys.path.insert(0, os.path.join(os.path.dirname(__file__), "..", ".."))

from Core.Utils import *
from Core.Config import *

All available functions and variables are inside Core/Utils.py.
Read it carefully before you start — everything you need is in there.

A minimal working plugin looks like this:

import sys, os
sys.path.insert(0, os.path.join(os.path.dirname(__file__), "..", ".."))

from Core.Utils import *
from Core.Config import *

Title("My Plugin")

try:
    Scroll(f"""
 {INFO} Hello from my plugin!
""")

    value = input(f"{INPUT} Enter something {red}->{reset} ").strip()

    print(f"\n{SUCCESS} You entered: {red}{value}", reset)

    Continue()
    Reset()

except Exception as e:
    Error(e)

---

Step 6 — Share your Plugin

Push your repository to GitHub and share the link.
Users can install it via:
Plugin Manager → Install Plugin → paste your GitHub URL

Your plugin will also be discoverable at:
https://github.com/topics/buildware-plugin

---

Tips

• Always call Reset() at the end to return to the main menu
• Always wrap your code in try / except Exception as e: Error(e)
• Use Continue() before Reset() to let the user read the output
• Increment your version in plugin.json when you push updates — users will see an update notification in Manage Plugins