Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Stream Settings

These options control custom stream configuration. With the exception of Use Defaults and Global Tags, the options on this page are per-stream.

Use Defaults

Streams.UseDefaultList
Default: true

If this is enabled, the streams configured in the list will be ignored in favor of the default streams.

List

Streams.List
Configuration for chat streams. The options in this section are per-stream.

Some options are not available for certain chat types; if this is the case, they will not be editable in the configuration menu.

Enabled

Streams.List.Enable
Default: true

Controls whether this stream is enabled.

Stream Type

Streams.List.Stream
Default: custom

The type of the stream.

Using a value other than custom for this option disables some other options. These will be inherited from the stream type.

Options:

  • custom
  • say
  • yell
  • private
  • faction
  • safehouse
  • general
  • admin
  • whisper
  • low
  • me
  • meloud
  • mequiet
  • mewhisper
  • do
  • doloud
  • doquiet
  • dowhisper
  • ooc
  • narrate

Name

Streams.List.Name
The name of the stream.

Streams that have duplicate names or share a name with a stream type are ignored.

Other reserved names are server, discord, radio, and speech.

This option is only enabled if Stream Type is set to custom.

Command

Streams.List.Command
The primary command to use to send a message on the stream. Defaults to the name of the stream.

Short Command

Streams.List.ShortCommand
A short command that can be used to send a message on the stream.

Chat Type

Streams.List.ChatType
Default: say

The type of chat this stream sends messages over.

This option is only enabled if Stream Type is set to custom.

Options:

  • say
  • shout
  • faction
  • safehouse
  • whisper
  • general
  • admin

Category

Streams.List.Category
Default: chat

The category of this stream.

This is used to categorize streams for retaining options.

This option is only enabled if Stream Type is set to custom.

Options:

  • chat
  • rp
  • other

Default Message Color

Streams.List.DefaultColor
The default color used for messages sent over this stream.

Range

Streams.List.Range
Default: 30
Minimum: 1
Maximum: 60

The range of this stream.

This option is only enabled for ranged chat types.

Range (Signed)

Streams.List.RangeSigned
Default: 0
Minimum: 0
Maximum: 60

The range of this stream, when used with a signed language.

A value of 0 indicates that the non-signed range should be used.

This option is only enabled for ranged chat types.

Vertical Range

Streams.List.VerticalRange
Default: 2
Minimum: 1
Maximum: 32

The vertical range of this stream.

A value of 0 indicates that vertical levels should be ignored.

This option is only enabled for ranged chat types.

Vertical Range (Signed)

Streams.List.VerticalRangeSigned
Default: 1
Minimum: 0
Maximum: 60

The vertical range of this stream, when used with a signed language.

A value of 0 indicates that the non-signed range should be used.

This option is only enabled for ranged chat types.

Perception Range

Streams.List.PerceptionRange
Default: 0
Minimum: 0
Maximum: 60

The range in which an indicator that something was said out-of-range will send.

A value of 0 means nothing out-of-range will be perceived.

This option is only enabled for ranged chat types.

Perception Range (Signed)

Streams.List.PerceptionRangeSigned
Default: 0
Minimum: 0
Maximum: 60

The range in which an indicator that something was said out-of-range will send, when sent in a signed roleplay language.

A value of 0 means nothing out-of-range will be perceived.

This option is only enabled for ranged chat types.

Chat Format

Streams.List.ChatFormat
Default: $Default()

Controls how messages sent on this stream appear in chat.

Overhead Format

Streams.List.OverheadFormat
Default: $Default()

Format used for overhead speech bubbles.

This option is only enabled for ranged chat types.

Allow Buffs

Streams.List.AllowBuffs
Default: false

If this is enabled and buffs are turned on, sending a message on this stream will apply a buff.

Allow Mentions

Streams.List.AllowMentions
Default: false

If this is enabled, mentions will be allowed on this stream.

Allow RP Languages

Streams.List.AllowLanguages
Default: false

If this is enabled, this stream will use the player’s current language when sending messages.

Allow Typing Indicator

Streams.List.AllowTypingIndicator
Default: false

If this is enabled, typing on the stream will trigger the typing indicator.

Attract Zombies

Streams.List.AttractZombies
Default: false

If this is enabled and zombie attraction is enabled, messages on this stream can attract zombies.

This option is only enabled for ranged chat types.

Use Narrative Style

Streams.List.UseNarrativeStyle
Default: false

If this is enabled and narrative style is on, messages on this stream will use narrative style.

Tags

Streams.List.Tags
Tags that modify the appearance and behavior of the stream.

Aliases

Streams.List.Aliases
List of additional aliases that can be used to send messages on the stream.

Roles

Streams.List.Roles
List of roles that can use this stream. If the list is empty, the stream will not be limited to any roles.

Global Tags

Streams.GlobalTags
Additional tags to include in every stream.

Defaults:

  • ActionAsterisks
  • IncludeAdminIndicator