Staff++
latest
latest
  • Staff++
  • General information
    • Quick start
    • Reload Configuration
    • Multi Server Setup
    • General Configuration
    • Other
      • Text parsing
      • Styling the GUIs
        • Gui structure
        • Selectors
      • Configuring command hooks
  • Permissions & Commands
    • Commands
    • Permissions
      • Legacy permissions
  • Features
    • Alerts
      • X-Ray
    • Alt account detection
    • Authentication
    • Banning
      • IP Banning
        • Messages
      • Fixed Ban Reason
      • Templates
    • Blacklist
    • Broadcasting
    • Chat module
    • Chest/Inventory Interaction
    • Command detection
    • Examine players
    • Freezing
      • Command hooks
      • Luckperms integration
      • Chat channels
    • Infractions
    • Investigate
      • Command hooks
    • Join messages
    • Player IPs
    • Kicking
    • Muting
      • Appealing
    • Protection
    • Player information
    • Player notes
    • Reporting
      • Command hooks
      • Messages
      • Finding reports
      • Report types & Reasons
      • Chat channels
    • Staff Chat
    • Staff Mode
      • Multiple modes
      • Staff Modules
      • Custom Staff Modules
        • State dependent modules
      • Command hooks
      • Luckperms integration
    • Staff Locations
    • Teleporting
    • Vanish
      • Luckperms integration
    • Warnings
      • Quick start
      • Severity levels
      • Thresholds
      • Actions (punishments)
      • Appealing
      • Warning workflow
  • Web Platform
    • Register Players
    • Setup Web Platform
    • Architecture
  • Integrations
    • Discord Integration
      • Staff Chat
      • Template Packs
      • Customize Discord Templates
    • Trello Integration
    • PAPI expansion
      • PAPI Examples
  • Migration guides
    • Staff+ migration guide
    • Migrating to >=V1.16.43
    • Upgrading Discord Integration to 1.16.51
  • Developers
    • API guide
Powered by GitBook
On this page
  • Introduction
  • Configuration
  • Examples:

Was this helpful?

  1. Integrations

Discord Integration

PreviousArchitectureNextStaff Chat

Last updated 10 months ago

Was this helpful?

Introduction

Discord integration lets Staff++ notify certain events to your discord server using discord webhooks.

To Enable integration you need to install a separate plugin:

Configuration

The configuration of the discord integration plugin is fairly simple.

StaffPlusPlusDiscord:
    templatePack: "default" # Choose from template packs "default" or "videndum"
    # The time format which will be used in the discord messages. 
    # This needs to be a valid datetime pattern according to: https://docs.oracle.com/javase/8/docs/api/java/time/format/DateTimeFormatter.html
    timestamp-format: "yyyy-MM-dd'T'HH:mm:ss"
    # REPORTS

    reports:
        # The discord webhook url. This can be found in you discord server settings
        webhookUrl: ""
        # Optional webhook url. When provided, reports linked to a player will be send on this url.
        playerReportsWebhookUrl: ""
        # Trigger a discord message when some player opens a new report
        notifyOpen: false
        # Trigger a discord message when a staff member for some reason decides to not handle a report and he unassigns himself
        notifyReopen: false
        # Trigger a discord message when a staff member assigns himself to an open report
        notifyAccept: false
        # Trigger a discord message when a staff member rejects a report
        notifyReject: false
        # Trigger a discord message when a staff member resolves a report
        notifyResolve: false

    warnings:
        webhookUrl: ""
        notifyCleared: false
        notifyCreate: false
        notifyThresholdReached: false
        appeals:
            webhookUrl: ""
            notifyCreate: false
            notifyApproved: false
            notifyRejected: false
    bans:
        webhookUrl: ""
        ban: false
        unban: false
        extension: false
        reduction: false
        appeals:
            webhookUrl: ""
            notifyCreate: false
            notifyApproved: false
            notifyRejected: false
    ipbans:
        webhookUrl: ""
        ban: false
        unban: false
    kicks:
        webhookUrl: ""
        kick: false
    mutes:
        webhookUrl: ""
        mute: false
        unmute: false
        appeals:
            webhookUrl: ""
            notifyCreate: false
            notifyApproved: false
            notifyRejected: false
    altDetect:
        webhookUrl: ""
        # Levels that should be notified to discord, leave empty to disable all notifications. Should be semi-colon separated
        # possible values: POSITIVE, FAIRLY_POSITIVE, POSSIBLE, NOT_LIKELY
        # example value: POSITIVE;FAIRLY_POSITIVE
        enabledTrustLevels: ""
    xray:
        webhookUrl: ""
        # Ores that should be notified to discord, leave empty to disable all notifications. Should be semi-colon separated
        # possible values: any bukkit material
        # example value: DIAMOND;REDSTONE
        enabledOres: ""
    staffmode:
        webhookUrl: ""
        # Trigger a discord message whenever a staffmember enters staffmode
        notify-enter: false
        # Trigger a discord message whenever a staffmember enters staffmode
        notify-exit: false
    chat:
        webhookUrl: ""
        # Trigger a discord message whenever a a player sends a chat message containing predefined words/phrases
        phrase-detection: false
    commanddetection:
        enabled: false
        webhookUrl: ""
    staffchat:
        sync: false

commands

Command`

Description

/staffplusplusdiscord reload

Reload the entire configuration, this includes the discord templates and webhook urls.

permissions

Permission

Description

staffplusplusdiscord.reload

Allows using the reload command

Examples:

Report

Warning

Make sure you create a webhook on your discord server. This can be done by following this guide: Once you created the webhook paste it inside the configuration file.

All discord templates can be .

https://www.spigotmc.org/resources/staff-discord-integration.83871/
https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks
customized