plugin.json

All the plugin.json options for a Bit Plugin and what they're used for

Option	Description	Accepted Values	Default Value
name	The plugins name	string	Bit Core
id	The plugins ID	string (requirements below)	bit-core
developer	The plugins developer	string	Lockyz Media
version	What version the plugin is	string	2024.1.0
support	A place to go to get support	string	https://github.com/Lockyz-Media/bit/issues
update_url	A url pointing to a json file used for the update notification system	string/url	https://cdn.lockyzmedia.com/discord/bots/bit/plugins/core/update.json
events	Whether the plugin has events or not	boolean (true/false)	true
commands	whether the plugin has slash commands or not	boolean (true/false)	true
hasIndex	Whether the plugin can start on bot startup or not	boolean (true/false)	true
mainFile	The file the bot should use to find the startup function	string	index.js
list_in_plugins_command	Whether to display the plugin in the plugins command	boolean (true/false)	true
requirements	The various requirements for the plugin	array	See Below

Example

{
    "name": "Bit Core",
    "id": "bit-core",
    "developer": "Lockyz Media",
    "version": "2024.1.0",
    "support": "https://github.com/Lockyz-Media/bit/issues",
    "update_url": "https://cdn.lockyzmedia.com/discord/bots/bit/plugins/core/update.json",
    "events": true,
    "commands": true,
    "hasIndex": true,
    "mainFile": "index.js",
    "list_in_plugins_command": true,
    "requirements": {
        "bit": {
            "version": "2024.1.0",
            "level": "1"
        }
    }
}

Plugin IDs

Plugins use an ID system to make it easier for developers wanting to use your code, to do their code. Plugin IDs will be used for plugin requirements, querying plugins (ex. loading the plugin list), and other bot functions. All plugins must use unique ID's when loaded into the bot, otherwise the bot will disable the plugin loaded second (We will only enforce plugin ID's in our certified plugins program. Plugins with the ID of bit-core will cause the bot to crash).

Plugin ID requirements are:

MUST be in Kebab Case (ex. kebab-case)!

CANNOT include numbers!

CANNOT include symbols bar the dash (-) that replaces the space!

CANNOT include a space - this WILL break the bot, use a dash (-) instead!

CANNOT use the name bit-core

CANNOT use offensive language.