Home

Configuration

BetterForgeChat uses standard Forge configuration files found in your config/ directory as config/bfcmod-common.toml, these files can be edited by VIM or whatever Windows plebs use (I use Arch btw). The default configuration file is shown below:

[BetterForgeChatModConfig]
	#  Controls the chat message format
	#    $prefix is replaced by the user's prefix or nothing if the user has no prefix
	#    $suffix is replaced by the user's suffix or nothing if the user has no suffix
	#    $name is replaced by the user's name, or nickname if they have one
	playerNameFormat = "$prefix$name$suffix"
	#  Controls the chat message format
	#    $time is replaced by the timestamp field or nothing if disabled
	#    $name is replaced by the user's name, or nickname if they have one
	#    $msg is replaced by the username's message (if you use it more then once it WILL break this mod)
	chatMessageFormat = "[$time] $name: $msg"
	#  Timestamp format following the java SimpleDateFormat
	#    Read more here: https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html
	timestampFormat = "hh:mm"
	#  Enables or disables the filling in of timestamps
	enableTimestamp = true
	#  Enables or disables FTB essentials nickname integration
	useFtbEssentials = true
	#  Enables or disables LuckPerms integration
	useLuckPerms = true
	#  Enables or disables custom tab list information
	tabList = true
	#  Enables or disables prefixes&suffixes in the tab list
	tabListMetadata = true
	#  Enables or disables nicknames in the tab list
	tabListNicknames = false
	#  Enables or disables the /colors command
	enableColorsCommand = true
	#  Enables or disables markdown styling
	markdownEnabled = true

Changes are automatically reloaded where possible.

Permissions

How they work?

BetterForgeChat uses the Forge PermissionAPI to register and handle permissions with any off-the-shelf permission manager. We recommend the use of LuckPerms since it was used during the development of BetterForgeChat however FTBRanks and other similar permissions managers should work just fine as long as they use the Forge PermissionAPI

Permissions can be given or removed from a player to enable and disable features of BetterForgeChat, for instance if colors and styled chat should only be reserved for server administrators you can use your permission manager to disable colors and styles for regular players:

/lp group default permission set bfcmod.chat.colors false
/lp group default permission set bfcmod.chat.styles false
/lp group admin permission set bfcmod.chat.colors true
/lp group admin permission set bfcmod.chat.styles true

For some permisssion managers sometimes you may need to enable the physical command as well as the permission node, as shown below:

/lp group default permission set command.colors true
/lp group default permission set bfcmod.commands.colors true

Available permissions

BetterForgeChat has the following available permissions:

Permission node	Name	Description	Type	Default
bfcmod.chat.colors	Chat colors	Enables/Disables colors in chat	boolean	true
bfcmod.chat.styles	Chat styles	Enables/Disables styles in chat	boolean	true
bfcmod.chat.styles.md	Chat markdown styling	Enables/Disables markdown styling in chat	boolean	true
bfcmod.tablist.nickname	Tab list nicknames	Enables/Disables nicknames showing in the tab list	boolean	true
bfcmod.tablist.metadata	Tab list metadata	Enables/Disables prefixes&suffixes showing in the tab list	boolean	true
bfcmod.commands.colors	Colors command	Enables/Disables the "/colors" command	boolean	true
bfcmod.commands.bfc.allowed	BetterForgeChat command	Enables/Disables the "/bfc" command	boolean	true
bfcmod.commands.bfc.colors	BetterForgeChat colors sub-command	Enables/Disables the "/bfc colors" sub-command	boolean	true
bfcmod.commands.bfc.info	BetterForgeChat info sub-command	Enables/Disables the "/bfc info" sub-command	boolean	true