main/Configuration

Configuration

config.yml

channels:
    enable: true
    limit: -1
    range: 15
pm:
    display-colour: ''
    format: '%chtag%prefix%display%suffix whispers: %colour%message'
emote:
    format: '* %prefix%display%suffix %message'
logging:
    chat:
        log: false
        colour: true
    debug: []
metrics-statistics: true
formatting:
    format: '%chtag%prefix%display%suffix: %colour%message'
    tag-format:
        default: '%tag%'
        tags:
            chtag: '[%tag%]'
filtering:
    censor: '*'
    phrases: []
PathDescription
channels.enableWhether channels are enabled
channels.limitThe maximum amount of channels, -1 for unlimited
channels.rangeThe range of local ranged channels
pm.display-colourThe display colour of private messages
pm.formatThe format of private messages
emote.formatThe format of emotes
logging.chat.logWhether to log chat to the console, may receive double messages if console joins a channel
logging.chat.colourWhether the logged chat should be coloured, some consoles do not support colouring
logging.debugThe Ids of debuggers to start debugging, -1 for all
metrics-statisticsWhether to hook Plugin Metrics
formatting.formatFormat for chat
formatting.tag-format.defaultDefault format for tags
formatting,tag-format.tags.<tag>Format for the specified tag
filtering.censorThe censor used for obfuscating
filtering.phrasesPhrases or words to censor

channel.yml

type: ''
status: ''
aliases: []
display-colour: ''
format: ''
password: ''
range: ''
tag: ''
whitelist: false
data:
blacklist: []
whitelist: []
operators: []
PathDescription
typeThe type of channel loader used to load the channel
statusThe status of the channel (default, none, staff)
aliasesThe aliases of the channel
display-colourThe display colour of chat in the channel
formatThe format of chat in the channel
passwordThe password of the channel, blank for no password
rangeThe range of the channel (channel, global, local, world)
tagThe tag of the channel
whitelistWhether the channel is whitelist only
data.<key>Data of the channel
blacklistThe blacklist of the channel
whitelistThe whitelist of the channel
operatorsThe list of operators of the channel

participants.yml

CONSOLE:
    channels:
        current: ''
        all: []
    data:
        display-name: '&4Server&f'
NodinChan:
    channels:
        current: ''
        all: []
    data:
        prefix: '&4Dev&f'
Notch:
    channels:
        current: ''
        all: []
    data:
        suffix: ' &fthe &6Creator&f'
Steve:
    channels:
        current: ''
        all: []
    data:
        suffix: ' &fthe &4Adventurer&f'
SomeRandomGuy:
    channels:
        current: ''
        all: []
    data:
        display-name: 'Random Guy'
        prefix: 'This is a '
        suffix: ' on your Server'
PathDescription
<name>.channels.currentThe current channel of the player
<name>.channels.allAll joined channels
<name>.data.<key>Data of the player

topic.yml

page:
    width: 55
    height: 9
topics:
    About:
        description: "About TitanChat"
        information: >
            TitanChat is a chat management and formatting plugin,
            its high flexibility is what makes it special.
            Instead of having a large bulk of hardcoded supports for other plugins,
            an addon system was implemented so that addons,
            custom channels and external commands can be coded to support other plugins and add new features.
            The built in commands in TitanChat help make your chat management task easier.
            Channels can also be disabled to have your old global Minecraft chat,
            but giving you more control over chat.
commands:
    Info:
        information: |
            Gives information about TitanChat through various topics.
            Alias: '?', 'help'
            Usage: /tc ? [topic/page]...
PathDescription
page.heightThe page height of topics
page.widthThe page width of topics
topics.<topic>.descriptionThe description of the topic
topics.<topic>.informationThe information shown when the topic is viewed
commands.<command>.informationThe information shown when the topic about the command is viewed