Main Config

Filename discordconnector.cfg

Webhook URL

Type: String, default value: ``

Discord channel webhook URL. For instructions, reference the 'MAKING A WEBHOOK' section of Discord's documentation.

Webhook Events

Type: String, default value: ALL

Specify a subset of possible events to send to the primary webhook. Format should be the keyword 'ALL' or a semi-colon separated list, e.g. serverLifecycle;playerAll;playerFirstAll;leaderboardsAll;

A full list of valid options for this are here.

Secondary Webhook URL

Type: String, default value: ``

Discord channel webhook URL. For instructions, reference the 'MAKING A WEBHOOK' section of Discord's documentation.

Secondary Webhook Events

Type: String, default value: ALL

Specify a subset of possible events to send to the secondary webhook. Format should be the keyword 'ALL' or a semi-colon separated list, e.g. serverLifecycle;playerAll;playerFirstAll;leaderboardsAll;

A full list of valid options for this are here.

Log Debug Messages

Type: Boolean, default value: false

Enable this setting to listen to debug messages from the mod. This will help with troubleshooting issues.

Use fancier discord messages

Type: Boolean, default value: false

Enable this setting to use embeds in the messages sent to Discord. Currently this will affect the position details for the messages.

Ignored Players

Type: String, default value: ``

It may be that you have some players that you never want to send Discord messages for. Adding a player name to this list will ignore them.

Format should be a semicolon-separated list: Stuart;John McJohnny;Weird-name1

Ignored Players (Regex)

Type: String, default value: ``

It may be that you have some players that you never want to send Discord messages for. This option lets you provide a regular expression to filter out players if their name matches.

Format should be a valid string for a .NET Regex (reference: docs.microsoft.com)

Send Positions with Messages

Type: Boolean, default value: true

Disable this setting to disable any positions/coordinates being sent with messages (e.g. players deaths or players joining/leaving). (Overwrites any individual setting.)

Collect Player Stats

Type: Boolean, default value: true

Disable this setting to disable all stat collection. (Overwrites any individual setting.)

Stat Collection Details

Stat collection will create a file in the discordconnector config directory records.db, where it will record the number of times each player joins, leaves, dies, shouts or pings.

If this is set to false, DiscordConnector will not keep a record of number of times each player does something it alerts to.

If this is false, it takes precedent over the "Send leader board updates" setting and no leader boards will get sent.

The stat collection database uses the LiteDB library and if you are so inclined they offer a database gui which you can use to view/modify this database. (Find the LiteDB Editor on their site.)

Announce Player Firsts

Type: Boolean, default value: true

Disable this setting to disable all extra announcements the first time each player does something. (Overwrites any individual setting.)

How to discern players in Record Retrieval

Type: RetrievalDiscernmentMethods, default value: PlayerId

Acceptable values: PlayerId, Name, NameAndPlayerId

Choose a method for how players will be separated from the results of a record query (used for statistic leader boards).

Discernment Methods

Options	Description
Name	Treat each CharacterName as a separate player
PlayerId	Treat each PlayerId as a separate player
NameAndPlayerId	Treat each [PlayerId:CharacterName] combo as a separate player

What is the PlayerID?

The player ID is the player's hostname, i.e. for a player connecting using the Steam version of the game, their PlayerId would be something like STEAM_120390101034 (STEAM_<steam id>). Players connecting from other platforms will have different formatting for this.

Examples of other platforms are the game pass and xbox version of Valheim.

Send Non-Player Shouts to Discord

Type: Boolean, default value: false

Enable this setting to have shouts which are performed by other mods/the server/non-players to be sent to Discord as well.

Muted Players

These are still subject to censure by the muted player regex and list.