# @theshadoweevee/discordchatter-alpha

> Integrate Discord with BDSX! Send messages to and from your servers!

Latest version **1.1.1** (published 2022-03-01) · ISC license · 0 weekly downloads

## Install

```sh
npm install @theshadoweevee/discordchatter-alpha
pnpm add @theshadoweevee/discordchatter-alpha
yarn add @theshadoweevee/discordchatter-alpha
bun add @theshadoweevee/discordchatter-alpha
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.1.1 |
| Published | 2022-03-01 |
| First published | 2022-03-01 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 45.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 8 |
| Author | TheShadowEevee |
| Maintainers | theshadoweevee |
| Keywords | Discord, BDSX, Server Utility |

## Links

- npm: https://www.npmjs.com/package/@theshadoweevee/discordchatter-alpha
- Repository: https://github.com/TheShadowEevee/BDSX-Discord-Chatter-Plugin
- Homepage: https://github.com/TheShadowEevee/BDSX-Discord-Chatter-Plugin#readme
- Issues: https://github.com/TheShadowEevee/BDSX-Discord-Chatter-Plugin/issues
- npm.io page: https://npm.io/package/@theshadoweevee/discordchatter-alpha

## Dependencies (1)

- [discord.js](https://npm.io/package/discord.js.md) ^11.6.4 <12.0.0

## Alternatives

- [lodash.assign](https://npm.io/package/lodash.assign.md) — 2.3M weekly downloads
- [lodash.chunk](https://npm.io/package/lodash.chunk.md) — 1.8M weekly downloads
- [react-native-ios-utilities](https://npm.io/package/react-native-ios-utilities.md) — 138.5K weekly downloads
- [@technically/lodash](https://npm.io/package/@technically/lodash.md) — 50.9K weekly downloads
- [@fluid-topics/ft-icon](https://npm.io/package/@fluid-topics/ft-icon.md) — 20.6K weekly downloads

## Recent versions

- 1.1.1 (latest) — 2022-03-01

## README

# DiscordChatter For BDS eXtended

A simple plugin that allows communication between a [BDSX enabled server](https://github.com/bdsx/bdsx) 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 Option                 | Input Type                    | Required                      | Permission Needed             |
| ----------------------------- | ----------------------------- | ----------------------------- | ----------------------------- |
| token                         | Discord Bot Token             | Yes                           | Console                       |
| chanID                        | Discord Channel ID (See Note) | Yes                           | OP                            |
| BotEnabled                    | Boolean (True/False)          | No                            | OP                            |
| PostDiscordMessagesToConsole  | Boolean (True/False)          | No                            | OP                            |
| EnableJoinLeaveMessages       | Boolean (True/False)          | No                            | OP                            |
| EnableServerStartStopMessages | Boolean (True/False)          | No                            | OP                            |

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](https://support.discord.com/hc/en-us/articles/206346498-Where-can-I-find-my-User-Server-Message-ID-)

## Incompatibilities

- Due to issues with Chakra, discord.js needs to be below version 12. This will be changed ASAP once a fix is made upstream. See https://github.com/chakra-core/ChakraCore/issues/3448

---
_Source: https://npm.io/package/@theshadoweevee/discordchatter-alpha · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._