Bit 5.2 to Bit 2024.1

Things to remember

• Make sure ALL plugins are updated to 2024.1

  • Bit 2024.1 makes MAJOR changes to the bots command handler. Things WILL break

• Make sure to delete all the Bit and Bit Core files. This means EVERYTHING bar the /plugins folder and then everything inside the /plugins/bit-core folder!

Updating config.json

All config options are in snake case now. Please see the example below!

The config now requires a guild_only, language and dev_only field, you can follow the format below (using their default values)

"guildOnly": false,
"language": "en",
"devmode": false

Currently, language can only be "en".

Example

{
    "embed_colours": {
        "positive": "#00FF1C",
        "negative": "#FF0000",
        "neutral": "#9013FE",
        "main": "#86C1FD",
        "secondary": "#50E3C2"
    },
    "botIDs": {
        "logs": "LOGGING ID",
        "guild": "GUILD ID",
        "client": "CLIENT/APPLICATION ID",
        "owner": "OWNER ID"
    },
    "activities": {
        "type": "custom, playing, listening or watching",
        "state": "The text that displays as the status",
        "status": "online, idle, invisible or dnd"
    },
    "guildOnly": false,
    "language": "en",
    "devmode": false,
    "token": "BOT TOKEN"
}

As part of the Bit Core plugin, Bit (without any other plugins) only has the following commands

A plugin for accessing a vast database of Pokemon information

Developer: Lockyz Media

User Installable: Yes

Guild Installable: Yes

This plugin requires:

(Specific versions are currently not listed and are assumed to be latest)

DismonDB node.js module

pokedex api node.js module

@napi-rs/canvas node.js module

Source Code: https://github.com/Bit-Plugins/Dismon/

Download (Free): https://www.lockyzmedia.com/shop/dismon-plugin-bit/

An example plugin for Bit

Developer: Lockyz Media

User Installable: No

Guild Installable: Yes

GitHub Repo: https://github.com/Bit-Plugins/example-plugin

Folder Structure

Bit Plugins follow the following folder structure

• Folder-Name

• commands

• command.js

• events

• event.js

• plugin.json

Please see the plugin.json file for a list of support values in the current Bit: Core version.

Simply send us an email at admin@lockyzmedia.com with a link to your plugins code on github, a basic description of your plugin and we'll review it and maybe add it here

An XP Plugin for Bit

Developer: Lockyz Media

User Installable: No

Guild Installable: Yes

How to Install

• Make sure to install better-sqlite3 (Check out this guide for any issues https://github.com/WiseLibs/better-sqlite3/blob/HEAD/docs/troubleshooting.md)

• Unzip and place the "xp-plugin" folder in the plugins folder of Bit: Core

Source Code: https://github.com/Bit-Plugins/XP-Plugin/

Download (Free): https://www.lockyzmedia.com/shop/xp-plugin-bit/

Bit Core

This repo was created to allow users to view all code exclusively within Bit Core. This also allows us to make changes to Bit Core without updating the main Bit repository.

Developer: Lockyz Media

User Installable: Yes

Guild Installable: Yes

GitHub Repo: https://github.com/Bit-Plugins/bit-core

How to install

An install guide has not been created for this plugin as it is automatically added as part of Bit.

A moderation plugin for bit

Developer: Lockyz Media

User Installable: No

Guild Installable: Yes

Supported Bit Versions

Bit 5.2.x

Setup Instructions

1 – Download and setup Bit

2 – Download this plugin and unzip into the bit/plugins folder

3 – Update ALL values within the config.json

4 – This plugin should now work 🙂

Download

Source Code: https://github.com/Bit-Plugins/Jupiter

Follow the documentation listed on the plugins documentation page. Or follow the basic example below (some plugins will require installing specific node.js modules and will not work if these modules are not installed prior)

Simply unzip the plugins folder into the bit/plugins folder.

You should then run the deploy script deploy.js as of 2024.1

A logging plugin created for Bit 5

Developer: Lockyz Media

User Installable: No

Guild Installable: Yes

Source Code: https://github.com/Bit-Plugins/logging-plugin/

Download (Free): https://www.lockyzmedia.com/shop/logging-plugin-bit/

Command Example

Getting Started

1. Download our example plugin

2. Customise it to your hearts content

3. Email us at admin@lockyzmedia.com to get your plugin certified

These guides assume you already know basic node.js and/or how to create a Discord bot using discord.js

Where can I get support?

We have a whole discord server for support which you can find here

Will this give me a virus?

Nope, unless you found the "source" code on a shady site that has inserted a virus.

Can you add feature X?

You're always welcome to suggest features on our Discord Server. Or you can make a pull request on our GitHub repo

Bit is a completely customisable Discord Bot

Source Code: https://github.com/Lockyz-Media/bit

Created by Lockyz Media https://lockyzmedia.com/

Updating to Bit 2024.1?

For the BotUpdating

For Plugin Developers Updating to Bit 2024.1

Wanting to make a plugin?

Simply follow our guide Create Plugins

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

{
    "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"
        }
    }
}

How will plugin requirements work

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 as a level 1 requirement as the requirements system is replacing the old bitVersion setting.

For Example

"requirements": {
    "bit": {
        "version": "2024.1.0",
        "level": "1",
    },
    "jupiter": {
        "version": "0.2.0",
        "level": "2",
    },
    "dismon": {
        "version": "2.0.0",
        "level": "3",
    },
    "logging": {
        "version": "2.0.0",
        "level": "4",
    }
}

The above code will

1. Check if the current bit version is 2024.1.0

2. Fail to start if bit is not installed or the version is not 2024.1.0

3. Check if the Jupiter plugin is installed

4. Fail to start if the plugin isn't loaded, but will output to the console of the version is not the same.

5. Check if the bot has the Dismon Plugin 2.0.0

6. 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.

7. Check if the logging plugin is installed

8. 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

{
    "download_link": "https://cdn.lockyzmedia.com/bit/plugins/xp/latest.zip",
    "bit_versions": {
        "2024.1": "2.0.0"
    }
}

Update JSON Example with Legacy Options - As the "developer" option was never actually used, it should NOT be used when legacy versions are available.

{
    "download_link": "https://cdn.lockyzmedia.com/bit/plugins/xp/latest.zip",
    "bit_versions": {
        "2024.1": "2.0.0",
    },
    "downloadLink": "https://cdn.lockyzmedia.com/bit/plugins/xp/latest.zip",
    "latest": "2.0.0",
    "5.1": "1.0.0",
    "5.0": "1.0.0"
}

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

// Cooldowns can be any number upto the 32-bit integer limit. This number is in seconds!
cooldowns: 5,

integration_types: {
    user: true,
    guild: true,
},

context_types: {
    guild_channel: true,
    bot_dm: true,
    private_channel: true,
},

Run code on bot startup

Bit now allows plugins to run code on startup!

This means that within your plugin.json file you can tell the bot to run the code within the mainFile file!

The starting function MUST be called startFunction the casing of the function name MAY change in the future to increase consistency within Bit.

Example - index.js from Bit: Core

module.exports = {
    startFunction: function startFunction() {
        console.log("Bit: Core Successfully Loaded!")
    }
};

The bot will check the update json for the latest version of the plugin, where to download it from and what version of Bit: Core it's for.

Update JSON Example

{
    "download_link": "https://cdn.lockyzmedia.com/bit/plugins/xp/latest.zip",
    "bit_versions": {
        "2024.1": "2.0.0"
    }
}

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

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.

Plugin Requirements

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 as a level 1 requirement as the requirements system has replaced the old bitVersion setting.

For Example

"requirements": {
    "bit": {
        "version": "2024.1.0",
        "level": "1",
    },
    "jupiter": {
        "version": "0.2.0",
        "level": "2",
    },
    "dismon": {
        "version": "2.0.0",
        "level": "3",
    },
    "logging": {
        "version": "2.0.0",
        "level": "4",
    }
}

The above code will

1. Check if the current bit version is 2024.1.0

2. Fail to start if bit is not installed or the version is not 2024.1.0

3. Check if the Jupiter plugin is installed

4. Fail to start if the plugin isn't loaded, but will output to the console of the version is not the same.

5. Check if the bot has the Dismon Plugin 2.0.0

6. 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.

7. Check if the logging plugin is installed

8. 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.