Warning

This document is for Red's development version, which can be significantly different from previous releases. If you're a regular user, you should read the Red documentation for the current stable release.

Reports

This is the cog guide for the reports cog. You will find detailed docs about usage and commands.

[p] is considered as your prefix.

Note

To use this cog, load it by typing this:

[p]load reports

Usage

Create user reports that server staff can respond to.

Users can open reports using [p]report. These are then sent to a channel in the server for staff, and the report creator gets a DM. Both can be used to communicate.

Commands

report

Syntax

[p]report [text]

Description

Send a report.

Use without arguments for interactive reporting, or do [p]report [text] to use it non-interactively.

Arguments

  • [text]: The content included within the report.

report interact

Note

This command is locked to the mod role.

Syntax

[p]report interact <ticket_number>

Description

Open a message tunnel.

This tunnel will forward things you say in this channel to the ticket opener’s direct messages.

Tunnels do not persist across bot restarts.

Arguments

  • <ticket_number>: The ticket number to open the tunnel in.

reportset

Note

This command is locked to the admin role.

Syntax

[p]reportset

Description

Manage Reports.

reportset output

Note

This command is locked to the admin role.

Syntax

[p]reportset output <channel>

Description

Set the channel where reports will be sent.

Arguments

  • <channel>: You can either mention the channel, provide its exact name or its ID.

reportset toggle

Note

This command is locked to the admin role.

Syntax

[p]reportset toggle

Description

Enable or disable reporting for this server.