# cabal-discord-bridge

> You can use this tool, to automatically send messages from Cabal to Discord and vice-versa.

Latest version **1.0.1** (published 2022-04-16) · AGPL-3.0-or-later license · 0 weekly downloads

## Install

```sh
npm install cabal-discord-bridge
pnpm add cabal-discord-bridge
yarn add cabal-discord-bridge
bun add cabal-discord-bridge
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2022-04-16 |
| First published | 2022-04-16 |
| Weekly downloads | 0 |
| License | AGPL-3.0-or-later |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=16.6 |
| Dependencies | 3 |
| Unpacked size | 40.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | timgoeller |

## Links

- npm: https://www.npmjs.com/package/cabal-discord-bridge
- npm.io page: https://npm.io/package/cabal-discord-bridge

## Dependencies (3)

- [chalk](https://npm.io/package/chalk.md) ^4.1.0
- [discord.js](https://npm.io/package/discord.js.md) ^13.6.0
- [cabal-bot-core](https://npm.io/package/cabal-bot-core.md) ^1.0.10

## Recent versions

- 1.0.1 (latest) — 2022-04-16

## README

# Cabal-Discord Bridge

You can use this tool, to automatically send messages from Cabal to Discord and vice-versa.

## Steps to Run

- Clone the repository
- Create a config (see the config section)
- Add Discord bot to server, and give it a role with 'Manage Webhooks' permission
- Run `node index`

## Config

For this bridge to work, a `config.json` file must exist at the application root. You can take a look at `config.example.json` to see how this file is structured.

#### cabalKey

This is the key of the cabal that you want to bridge.

#### discordSecret

This is a token for a Discord bot. Take a look at [https://discord.com/developers/docs/intro] to see how to create a bot. The bridge will work on all severs that you add this bot to.

#### mappings

This array defines how messages should be passed between Cabal and Discord.

```js
"discord": [] // Array of Discord channels for this mapping
"cabal": [] // Array of Cabal channels for this mapping
"from": "cabal" || "discord" || "both" // Defines the direction in which messages should be bridged
```

#### logging

Set to `true` or `'info'`, to display forwarded messages along with meta information in console. Set it to `'debug'` to also display information about recieved events.

---
_Source: https://npm.io/package/cabal-discord-bridge · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._