Updating to Bit 2024.1
Bit 2024.1 changes a LOT of things, please follow this guide to get your plugins updated!
Bit 2024.1 is currently unfinished, however all changes here are all confirmed and no other changes will be made.
As Bit 2024.1 is a major release, previous versions of the bot cannot be supported!
plugin.json changes
All settings now use snake-case for their names!
The events and commands values have been changed to use booleans instead of strings (this is to prevent issues) and plugin versions are now required to use semantic versioning (major.minor.patch)
The bitVersion field is being removed as it will now be part of the requirements settings
Example plugin.json
How will plugin requirements work
Plugins Requirements are not ready. This information should be considered conceptual at best!
The bot will cross reference the plugin requirements array within the plugin.json file with the bots plugin list (Currently not available). Each requirement will be listed as plugin-id:version within the Plugin List.
Plugins are required to have bit-core as a level 1 requirement as the requirements system is replacing the old bitVersion setting.
For Example
The above code will
Check if the current bit-core version is 2024.1.0
Fail to start if bit-core is not installed or the version is not 2024.1.0
Check if the Jupiter plugin is installed
Fail to start if the plugin isn't loaded, but will output to the console of the version is not the same.
Check if the bot has the Dismon Plugin 2.0.0
If Dismon is not found, the bot will instead output to the console and parts of this plugin will be disabled. If the version does not match, the bot will only output to the console.
Check if the logging plugin is installed
Fail to start if it is.
There are 3 requirement levels
Level 1, requires the external plugin at that specific version be loaded for your plugin to work.
Level 2, requires the external plugin to be loaded regardless of said external plugins version
Level 3, is basically a soft requirement, the external plugin is not "required" but part of the your plugin will not work without it. (You should include a check for this in your code)
Level 4, the plugin will NOT start if a plugin of this level is also loaded. This can be used for plugins that are incompatible with yours.
Plugin ID's
Plugins now 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.
update.json changes
All options are now in snake case, however plugins that are made for older versions of Bit should use the legacy values. The "latest" field has been removed and all the various bit versions are under an array, if your plugin is available for legacy versions of Bit, please use the legacy values as well (We're aware this may be annoying for some, as Bit matures and we start to create a consistent code style, various things will change)
Update JSON Example
Update JSON Example with Legacy Options - As the "developer" option was never actually used, it should NOT be used when legacy versions are available.
New command options
Commands have been updated to include some new custom values. These new custom values allow for creating user-installable apps!
Cooldown - The cooldown setting sets an optional cooldown (defaults to 3 seconds) on bot commands. This setting is in seconds.
integration_types - This array allows for setting when different commands CAN show up in the client, for example setting integration_types.user to true allows the command to be seen/used when the bot is used as a user-installed app, and integration_types.guild allows the command to be seen/used when the bot is used as a guild-installed app (the way bots have always been installed). Both options can be true.
context_types - This array allows for setting where a command can show up in the client. For example, context_types.guild_channel allows the command to be seen in guild channels, context_types.bot_dm allows the command to be seen in the bots DM's and context_types.private_channel allows the command to be used in the users private DM's (with other people) and group DMs. However context_types.private_channel only works if the integration_types.user is on.
Format
Last updated