1.1.1 • Published 2 years ago

@theshadoweevee/discordchatter-alpha v1.1.1

Weekly downloads
-
License
ISC
Repository
github
Last release
2 years ago

DiscordChatter For BDS eXtended

A simple plugin that allows communication between a BDSX enabled server and a Discord server!

This allows you to choose a Discord Server where various server events will be posted. Of course, this also allows chat between the server and Discord! Any in-game messages will appear in Discord and any messages sent in the channel the plugin posts to will appear to users in-game.

Installation

As of right now, the best way to install the plugin is by downloading the repository. Once it's downloaded, extract the folder "BDSX-Discord-Chatter-Plugin-main" to your plugins folder of your BDSX server. Hopefully this will be accessable via npm in the future.

Setup

  • Install the plugin
  • Create a new Discord Bot
    • Open https://discord.com/developers/applications and sign in
    • Click "New Application" and give the bot a name, then click Create
    • Click the Bot option in the sidebar
    • Click "Add Bot" then "Yes, do it!"
      • Note: If nothing happens and Discord says "Too many users have this username, please try another.", follow these steps again choosing a more unique name.
    • Give the bot a unique name
    • Copy the token. This will need to be put in the bots configuration in the next steps.
      • IMPORTANT: This token gives anyone with it access to the bot. NEVER share it publically!
      • Due to the sensitity of the token, it can only be entered via console or manually.
      • If anyone gains access to your bot regenerate this token ASAP from this screen.
  • Start the server
  • Run the commands in the below table to configure the bot!
  • The config file can also be found in {bdsx root}/bedrock_server/configs/Discord-Chatter/config.json.

Configuration

To configure the plugin, fill in the command below with the correct information based on the table.
Run dc config {Option} {Input} in the console to change the configuration

Config OptionInput TypeRequiredPermission Needed
tokenDiscord Bot TokenYesConsole
chanIDDiscord Channel ID (See Note)YesOP
BotEnabledBoolean (True/False)NoOP
PostDiscordMessagesToConsoleBoolean (True/False)NoOP
EnableJoinLeaveMessagesBoolean (True/False)NoOP
EnableServerStartStopMessagesBoolean (True/False)NoOP

If you are setting the channel ID, prefix it with "chanID_" For example, to set the channel ID the bot works in, run dc config chanID chanID_846147660843188235 in the console.

To get a Discord Channel ID see this Discord Help Article

Incompatibilities