Configuration

All configuration of FactionsChat3 is handled in the config.yml file generated in your FactionsChat plugin folder after first run. This file will also be updated with new values when the plugin is updated with new features.

Example

##############################################
#                                            #
#         FactionsChat by Ymerejliaf         #
#        ----------------------------        #
#           Main Configuration File          #
#                                            #
##############################################
version: 1



#----------------- Chat Settings -----------------#
# Chat-related settings not specific to any channel
# https://github.com/JeremyFail/MassiveCraft/wiki/FactionsChat#configuration
ChatSettings:
  # The chat format for all messages. Supports PlaceholderAPI placeholders if PAPI is installed.
  # Supports color codes (ampersand or section sign, including hex codes).
  # Also supports modifiers such as |rp (right padding) or |lp (left padding), which 
  # conditionally add right/left padding (a space) if the placeholder is not empty.
  #
  # See the wiki for a list of built-in/supported tags, list of modifiers, and for more details:
  # https://github.com/JeremyFail/MassiveCraft/wiki/FactionsChat#placeholders
  ChatFormat: '%factions_chat_prefix|rp%&r&f<%rel_factions_relation_color%%factions_player_rankprefix%%factions_faction_name|rp%&r%DISPLAYNAME%> %factions_chat_color%%MESSAGE%'
  # If true, allows color codes/formatting in chat messages (if players also have permission to use them)
  AllowColorCodes: true
  # If true, allows clickable links in chat messages (if players also have permission to send them)
  AllowClickableLinks: true
  # If true, will underline clickable links in chat messages
  AllowClickableLinksUnderline: true
  # Determines the range (in blocks) for local chat visibility
  LocalChatRange: 1000



#---------------- Prefix Settings ----------------#
# Chat prefixes for each channel - controls what is displayed in the %factions_chat_prefix% placeholder.
# <fcolor> is a placeholder for the faction colors set in the factions config files
# Supports legacy color/format codes using the section sign (§)
# NOTE: This prefix will not actually be used in the message text unless the %factions_chat_prefix% placeholder is used.
ChatPrefixes:
  Ally: '§e[<fcolor>ALLY§e]§r'
  Truce: '§e[<fcolor>TRUCE§e]§r'
  Faction: '§e[<fcolor>FACTION§e]§r'
  Enemy: '§e[<fcolor>ENEMY§e]§r'
  Neutral: '§e[<fcolor>NEUTRAL§e]§r'
  Local: '§e[§rLOCAL§e]§r'
  Global: '§e[§6GLOBAL§e]§r'
  Staff: '§e[§4STAFF§e]§r'
  World: '§e[§3WORLD§e]§r'



#-------------- Text Color Settings --------------#
# Text colors for each channel - controls what color is returned from the %factions_chat_color% placeholder.
# <fcolor> is a placeholder for the faction colors set in the factions config files
# Supports legacy color/format codes using the section sign (§)
# NOTE: These colors will not actually be used in the message text unless the %factions_chat_color% placeholder is used.
TextColors:
  Ally: '<fcolor>'
  Truce: '<fcolor>'
  Faction: '<fcolor>'
  Enemy: '<fcolor>'
  Neutral: '<fcolor>'
  Local: '§r'
  Global: '§6'
  Staff: '§4'
  World: '§3'



#--------------- Discord Settings ----------------#
# Settings for the DiscordSRV integration (requires DiscordSRV to be installed).
# The channel ID for the channel in your discord guild to link staff chat to
# Right click the text channel, select "copy ID" and replace the current value with copied ID
DiscordSRV:
  StaffChannel: '000000000000000000'

Options Explanation

• ChatSettings:
  Controls various global chat-related settings

• ChatFormat: Sets the format that all messages will conform to. Placeholders can be used which will be replaced with actual values. Supports PlaceholderAPI placeholders if PAPI is installed, otherwise supports built-in placeholders (see list below in the Placeholders section).

• AllowColorCodes: Whether color/formatting codes (including RGB hex color codes) should be allowed. Note that players will still need the proper permission to use color/formatting codes in addition to this setting being enabled.

• AllowClickableLinks: Whether to allow URLs to be sent in chat that players can click on. Note that players will still need the proper permission to be able to send links.

• AllowClickableLinksUnderline: Whether to allow URLs that are sent in chat to be underlined or not.

• LocalChatRange: Sets how far (in blocks) local chat messages can be seen from the sender.

• ChatPrefixes:
  Customize the prefix shown before messages in each channel. Use <fcolor> to automatically use the faction color based on the current faction relationship that channel represents.

• TextColors:
  Set the color of the message text for each channel. Use Minecraft color codes (e.g., §6 for gold) or <fcolor> for faction color.

• DiscordSRV:
  Controls integration settings with DiscordSRV.

• StaffChannel: If using DiscordSRV, set this to your Discord staff channel's ID to relay staff chat.

After making changes, use /f c reload to apply them.

For more details on formatting and color codes, see the Minecraft Formatting Codes page in the Minecraft Wiki.