plugin.json object
This article is not related to the default Open Ticket functionality but to Plugin Development!
You will use this config when creating and using plugins. (Read More)
The plugin.json file serves as the configuration file for Open Ticket plugins.
This file contains essential settings for a plugin and how it should behave or appear in the console.
With plugin.json, you can define many aspects of your plugin. Here are some examples:
- Identification: Define the id, name and description of your plugin.
- Appearance: Add additional tags, urls, authors, and descriptions.
- Versioning & Priority: Set the version of your plugin and choose the loading priority.
- Events: Define global events for other plugins to use.
- Dependencies: Notify the bot about required dependencies and incompatible plugins.
If you need help with configuring the config, feel free to join our discord server!
Table Of Contents
General
These are the required general properties for your plugins.
"name" string
Default Value: "Example Plugin"
The display name of the plugin. This is shown in various locations, including the logs & startup screen.
✅ Choose a clear and unique name to avoid conflicts with other plugins.
"id" string
Default Value: "example-plugin"
Allowed Values: A-Z, a-z, 0-9, dash, no spaces
The unique identifier for the plugin. This should be a lowercase, hyphenated string. Make sure there are no other plugins with the same id in existence.
The folder name of your plugin must be the same as the specified id! Your plugin won't load otherwise.
✅ The plugin ID must remain the same across updates to ensure compatibility.
"version" string
Default Value: "1.0.0"
The version of the plugin, following semantic versioning (major.minor.patch).
This version will be used in logs, errors & debug messages of your plugin.
Use this feature to detect updates of your plugin and migrate any outdated databases to make sure they stay compatible.
✅ Updating the version helps track changes and resolve compatibility issues.
"startFile" string
Default Value: "index.ts"
The entry file of the plugin that will be executed when the plugin is loaded.
Both TypeScript and JavaScript files are accepted.
As a result of the bot compilation process, some paths might change!
- From
./plugins/<plugin-name>/... - To
./dist/plugins/<plugin-name>/...
ODJsonConfig, ODJsonDatabase & ODJsonLanguage will handle this change automatically.
✅ Ensure this file exists in your plugin folder.
"enabled" boolean
Default Value: false
Determines whether the plugin is enabled when the bot starts.
✅ This will not erease any databases or stored information from the plugin.
"priority" number
Default Value: 0
Defines the loading order of the plugin. Higher values will be loaded first.
✅ A higher priority is useful when other plugins depend on your plugin being initialized.
"events" array
Default Value: [] (Empty Array)
A list of event names that the plugin emits. These will be registered in the opendiscord.events variable and are available for all plugins on startup.
Make sure your plugin emits events using the ODEvent class.
✅ Events allow other plugins to react to specific actions happening in your plugin.
"npmDependencies" array
Default Value: [] (Empty Array)
A list of NPM packages that the plugin requires to function.
✅ Dependencies should still be installed manually and should be kept to a minimum if possible.
"requiredPlugins" array
Default Value: [] (Empty Array)
A list of other plugins that must be installed for this plugin to work.
✅ If a required plugin is missing, this plugin will not load.
"incompatiblePlugins" array
Default Value: [] (Empty Array)
A list of plugins that cannot be used together with this plugin.
✅ Define incompatible plugins to prevent conflicts and errors in functionality.
Details
An object containing metadata about the plugin, such as author, description, and tags. Some of these properties will be shown in the console on startup.
"details"."author" string
Default Value: "DJj123dj"
The name of the plugin's creator. It's recommended to use your discord or github username.
✅ Use a recognizable name so users know who developed the plugin.
"details"."shortDescription" string
Default Value: "A simple template for an Open Ticket v4 plugin!"
A brief description of the plugin’s purpose. This will be shown in the console & logs on startup.
✅ Keep it short but informative to quickly convey the plugin's function.
"details"."longDescription" string
Default Value: "A simple example of an Open Ticket v4 plugin!"
A more detailed explanation of what the plugin does. Should also be the first sentence in the README.md file of the plugin.
✅ Use this section to explain the functionalities in more detail.
"details"."imageUrl" string
This feature does currently not serve a real purpose but can be used as decoration or metadata.
Default Value: "" (Empty String)
A URL to a marketing image for this plugin.
✅ Adding an image makes your plugin stand out in the plugin library.
"details"."projectUrl" string
This feature does currently not serve a real purpose but can be used as decoration or metadata.
Default Value: "" (Empty String)
A URL to the plugin’s GitHub repository or official website.
✅ Providing a project URL allows users to find documentation and report issues.
"details"."tags" array
This feature does currently not serve a real purpose but can be used as decoration or metadata.
Default Value: ["template","example","default"]
An array of tags to categorize the plugin.
✅ Use relevant tags to improve discoverability in the plugin manager.
Example File
All variables above have been made acording to this config for Open Ticket v4.0.0. This configuration might change in future versions!
{
"name":"Example Plugin",
"id":"example-plugin",
"version":"1.0.0",
"startFile":"index.ts",
"enabled":false,
"priority":0,
"events":[],
"npmDependencies":[],
"requiredPlugins":[],
"incompatiblePlugins":[],
"details":{
"author":"DJj123dj",
"shortDescription":"A simple template for an Open Ticket v4 plugin!",
"longDescription":"A simple example of an Open Ticket v4 plugin!",
"imageUrl":"",
"projectUrl":"",
"tags":["template","example","default"]
}
}