Channels

A channel is a separate chat group that players can send and receive messages in. Each channel has its own purpose and set of recipients, for example:

Global Chat - messages visible to everyone on the server. Staff Chat - messages only visible to staff members.

Format

channels:
    : 
        enabled: true
        require-permissions:
            # if enabled, users are required to have "astrachat.channels.global.read" to read messages
            read: true/false

            # if enabled, users are required to have "astrachat.channels.global.write" to send messages
            write: true/false
        # by default this format uses minimessage
        # to enable legacy support, set text.legacy-support to true
        format: "%prefix%%player%%suffix%<white>: %message%"

        # duration between each message in ticks
        # players with the "astrachat.channels.global.manage" permission can change this with /slowmode <channel> <time>
        # slowmode can be bypassed with the "astrachat.channels.global.manage" or "astrachat.admin" permissions
        default-slowmode: 20

        # use this in front of a message to type in this chat without switching channels.
        # leave blank to disable.
        shortcut-prefix: ""

        # you can use these commands to talk in this chat
        # using /global <message> would send a message in global chat
        commands:
            - global

Shortcut Prefix

A shortcut prefix gives you the option to type in this channel without typing a full command or completely changing channels.

channels:
    staff:
        shortcut-prefix: "#"

Custom Rules

AstraChat supports adding additional rules ontop of the 3 rules enabled by default.

Helpop

Helpop is in the configuration file by default but must be enabled.

channels:
    helpop:
        enabled: true
        require-permissions:
            # if enabled, users are required to have "astrachat.channels.helpop.read" to read messages
            read: true
        
            # if enabled, users are required to have "astrachat.channels.helpop.write" to send messages
            write: false
        
        format: "<dark_purple>[HELPOP]</dark_purple> %prefix%%player%%suffix%<gray>: %message%"
        
        # duration between each message in ticks
        # players with the "astrachat.channels.helpop.manage" permission can change this with /slowmode <channel> <time>
        # slowmode can be bypassed with the "astrachat.channels.helpop.manage" or "astrachat.admin" permissions
        default-slowmode: 80
        
        # use this in front of a message to type in this chat without switching channels.
        # leave blank to disable.
        shortcut-prefix: ""
        
        # you can use these commands to talk in this chat
        # using /helpop <message> would send a message to people with "astrachat.channels.helpop.read" permission
        commands:
            - helpop

Advertising

channels:
    advertising:
        enabled: true
        require-permissions:
            read: false
            write: false

        format: "<light_purple>[AD]</light_purple> %prefix%%player%%suffix%<gray>: %message%"

        default-slowmode: 1200
        
        shortcut-prefix: ""

        commands:
            - ad
            - advertise

Last updated