disdup

README

disdup - Discord message bouncer and duplicator

Package disdup implements a simple concurrent Discord message bouncer and transcriber which is able to transcribe incoming discord messages to various formats for bouncing and forwarding. It is designed for either self-hosting or for embedding in larger applications.

disdup is formatted primarily as an independent package, but also contains a pre-built CLI at cmd/disdup.

Formats

disdup supports bouncing to the following locations:

• Email (through smtp(s))
• IRC
• Plain logs

Install (package)

To use the disdup package, simply import

import "github.com/ethanv2/disdup"

Then run

go mod tidy

Install (CLI)

To use the disdup CLI, navigate to cmd/disdup. Before running anything, copy the sample configs to their actual locations (remove ".sample" from the end of their names). Then, modify them to your liking. Supported outputs and their configuration are listed below.

To build the CLI, run

go build

Alternatively, just

go run

Configuration

Configuration is parsed declaratively through the source code. The best way to see the details of the config is to read the source, or to run:

go doc -all conf

Primary config

The primary config is located at disdup.conf. It contains the bot's token and other bookkeeping details. It also contains a list of allowed guilds ("servers") and their properties. Guilds not listed in this configuration file will not be duplicated at all. Guilds may be specified by name or by ID (which can be copied from the Discord UI).

Each guild can have zero or more enabled_channels. If no enabled channels are listed, all channels are enabled. Else, only the channels listed by name or ID will be duplicated from. This does not override the guild being disabled.

Each guild can have zero or more enabled_users. If no enabled users are listed, all users are enabled. Else, only the users listed by full username "name#tag" or ID will be duplicated from. This does not override the enabled_channels, nor the guild being disabled.

Each guild also has an associated set of outputs, which are the names of the outputs specified in the outputs config file. See the next section for details.

Outputs

The outputs config is a map between output names and their properties. In the sample config, one output is declared named "print". These names may be referenced by the output array in a guild's configuration. Every output has an associated type and a list of args.

Available output types are as follows:

• "stdout": logs all messages to standard output in a known fashion. Can be collated by channel or by user and channel. Has a configurable prefix to denote output from this specific output.
• "command": runs a command with configurable arguments whenever a message is received. Arguments can contain formatting directives which pass information about a message to the command.
• "mail": send an email containing the message contents, attachments, etc. to a specific mailbox.

Outputs also take an object called args. These are specific to each output. Unknown options are ignored, but some outputs require that some args are provided. For instance, "command" requires that a "cmd" key for the command be provided.

Documentation

Overview

Package disdup implements a simple and programmable Discord message bouncer. It can be configured to duplicate messages from only certain guilds, channels or users and can convert messages to a variety of different formats.

Index

• Variables
• type Duplicator
  • func NewDuplicator(conf config.Config) (Duplicator, error)
  • func (d Duplicator) Close()
  • func (d Duplicator) Run() error
  • func (d Duplicator) Wait() chan error

Variables

var (
	ErrClosed = errors.New("duplicator: closed")
)

Duplicator errors.

Types

type Duplicator

type Duplicator struct {
	// contains filtered or unexported fields
}

func NewDuplicator

func NewDuplicator(conf config.Config) (Duplicator, error)

NewDuplicator initializes and starts running a new duplicator. As soon as this call completes, the duplicator is connected to Discord and serving events.

NOTE: This call returns asynchronously. To wait for the duplicator to complete, use Duplicator.Run or Duplicator.Wait. It is the caller's responsibility to call close and to check for errors from the runner channel.

func (Duplicator) Close

func (d Duplicator) Close()

Close terminates the duplicator. Any errors waiting to be received are discarded and all running goroutines terminate gracefully. It is safe to call Close after an error, although it is seldom necessary.

func (Duplicator) Run

func (d Duplicator) Run() error

Run runs the duplicator until an error occurs or the duplicator is instructed to stop.

func (Duplicator) Wait

func (d Duplicator) Wait() chan error

Wait returns a channel over which a single error may be received on duplicator termination.