Formatting

This section includes options related to formatting, including various format strings which can be used for advanced customization.

All of the format strings default to $Default(), which gets the default content. The tokens and options that each format accepts are available in the in-game configuration menu.

Chat Text

Format.Chat
Format strings used to control how messages appear in chat.

Prefix Format

Format.Chat.Prefix
Default: $Default()

Defines the value of the prefix token in the final chat format.

Final Format

Format.Chat.Final
Default: $Default()

Format used for the final chat message, after all other format strings have been applied.

Overhead Text

Format.Overhead
Format strings used to control how ranged messages appear over characters’ heads.

Prefix Format

Format.Overhead.Prefix
Default: $Default()

Defines the value of the prefix token in the final overhead format.

Final Format

Format.Overhead.Final
Default: $Default()

Format used for the final overhead message, after all other format strings have been applied.

Perception Range Text

Format.PerceptionRange
Format strings for text to display when a message is out of range, but within range for perceiving that something was said.

Chat Format

Format.PerceptionRange.Chat
Default: $Default()

Defines how out-of-range perceived messages display in chat.

Overhead Format

Format.PerceptionRange.Overhead
Default: $Default()

Defines how out-of-range perceived messages display overhead.

Components

Format.Component
Format strings used to define specific values in other format strings.

Name

Format.Component.Name
Default: $Default()

Defines the values of the name and rawName tokens in other format strings.

Tag

Format.Component.Tag
Default: $Default()

Format used for chat tags when a player enables the relevant option. This controls the value of the tag token in other format strings.

Timestamp

Format.Component.Timestamp
Default: $Default()

Format used for timestamps when a player enables the relevant option. This controls the value of the timestamp token in other format strings.

Icon

Format.Component.Icon
Default: $Default()

Defines the value of the icon token in other format strings.

Language

Format.Component.Language
Default: $Default()

Defines the value of the language token in the final chat format.

Embedded Quotes

Format.Component.EmbeddedQuote
Default: $Default()

Defines the format used for quotes embedded in actions.

Embedded Actions

Format.Component.EmbeddedAction
Default: $Default()

Format used for actions embedded in text.

Filters

Format.Filter
Format strings used to control whether an input is allowed.

Chat Input Filter

Format.Filter.ChatInput
Default: $Default()

Filters chat input before sending it. If this results in the empty string or sets an error token, the input won’t be sent.

The default filter handles disallowing signed languages over the radio and truncation.

Name Filter

Format.Filter.Name
Default: $Default()

Filters names set with the /name and /nickname commands. If this results in the empty string or sets an error token, the command will fail.

Status Filter

Format.Filter.Status
Default: $Default()

Filters statuses set with the /status command. If this results in the empty string or sets an error token, the command will fail.

The default filter handles enforcing minimum and maximum length.

In-Game Names

Format.MenuName
Options that control how character names are displayed within in-game menus.

Trade Window

Format.MenuName.Trade
Default: $Default()

The format used for names in the item trading UI.

Medical Window

Format.MenuName.Medical
Default: $Default()

The format used for names in the medical check UI.

Mini-Scoreboard

Format.MenuName.MiniScoreboard
Default: $Default()

The format used for names in the admin mini-scoreboard.

Other

Format.Other
Other options related to formatting.

PM Parentheses

Format.Other.PMParentheses
Default: 2
Minimum: 0
Maximum: 5

The amount of parentheses to include around names in private messages.

Default Name Mode

Format.Other.DefaultNameMode
Default: name

The mode to use for the name format unless overridden by an argument.

The name mode uses the chat nickname, username uses the player username, and both includes both separated by a slash.

Options:

• name
• username
• both

Default Name Mode (Per Chat Type)

Format.Other.DefaultNameModeForChatType
The mode to use for the name format for a chat type unless overridden by an argument.

This maps chat types to options for Default Name Mode.

Defaults:

• admin = username
• whisper = both

Volume Indicator

Format.Other.VolumeIndicators
Text to use for volume indicators. Keys should be one of Loud, Quiet, or Whisper.

Default:

• Loud = Long