Discord Bot Plugin for Valheim

Enables two-way communication between your Valheim server and Discord channels.

Features

• 🗨️ Chat Integration: Send messages between Discord and in-game chat
• 🤖 Discord Commands: Execute server commands from Discord
• 📢 Server Notifications: Get notified when the server starts up
• Death GIF / Screenshot
• Screenshot to Discord chat command / hotkey

Prerequisites

• BepInEx installed
• JsonDotNet installed
• Discord Webhooks configured for your server
• Discord Bot Token (If you want your discord server to be able to send messages into your game)

Installation

Discord Setup

How to create Discord Bot

1. Create a Discord Application
   • Go to the Discord Developer Portal
   • Click "New Application" (top-right)
   • Give your application a name (e.g. ValheimBot) and click "Create".
2. Add a Bot to the Application
   • In the left sidebar, click "Bot"
   • Click "Add Bot" ----> confirm by clicking "Yes, do it!"
   • You now have a bot user attached to your application.
   • You must enable Message Content Intent
3. Copy the Bot Token
   • On the Bot page, under the "Token" section, click "Reset Token" (or "Copy" if it is already shown).
   • Confirm, then copy the generated token.
   • Keep this token secret!, if it leaks, click "Reset Token" to generate a new one
4. Invite the Bot to your Discord Server
   • In the sidebar, click "O2Auth2" ----> "URL Generator".
   • Under SCOPES, check bot
   • Under BOT PERMISSIONS, check the permissions your bot will need
     • Send Messages
     • Read Message History
     • View Channels
   • Copy the generated URL at the bottom
   • Open that URL in your browser and invite the bot to your Discord server

Creating Discord Webhooks

Webhooks allow the plugin to send messages to Discord channels without using the bot's identity.

1. Create Webhook

   • Go to "Integrations" tab
   • Click "Create Webhook"
   • Give it a name (e.g., "Valheim Chat")

2. Copy Webhook URL

   • Click "Copy Webhook URL"
   • Save this URL for your plugin configuration

Getting Channel IDs

You'll need Discord Channel IDs for the bot to read messages:

1. Enable Developer Mode

   • In Discord, go to User Settings (gear icon)
   • Go to "Advanced" settings
   • Enable "Developer Mode"

2. Copy Channel IDs

   • Right-click on each channel you want to use
   • Select "Copy ID"
   • Save these IDs for your configuration

Configure the Plugin

After first run, configuration files will be generated in BepInEx/config/. Edit the Discord Bot config file to set up your:

• Channel IDs
• Webhook URLs
• Bot Token [SERVER ONLY]

Configurations

Find DiscordBot plugin configurations in BepinEx/config/RustyMods.DiscordBot.cfg

Here's what your configuration might look like:

[1 - General]

## If on, the configuration is locked and can be changed by server admins only. [Synced with Server]
Lock Configuration = On

## Set interval between check for messages in discord, in seconds [Synced with Server]
Poll Interval = 5

## If on, errors will log to console as warnings [Synced with Server]
Log Errors = Off

[2 - Notifications]

## Set webhook to receive notifications, like server start, stop, save etc... [Synced with Server]
Webhook URL = https://discord.com/api/webhooks/1405043541192741007/X-WuWkr_0ApZ4JHq7_TOeMHfRCErXgUZkVnE_oh_yfy2mWKRShHK-wDzdasdWWDzdjk

## If on, bot will send message when server is starting [Synced with Server]
Startup = Off

## If on, bot will send message when server is shutting down [Synced with Server]
Shutdown = Off

## If on, bot will send message when server is saving [Synced with Server]
Saving = Off

## If on, bot will send message when player dies [Synced with Server]
On Death = On

## If on, bot will send message when new player connects [Synced with Server]
New Connection = Off

[3 - Chat]

## Set discord webhook to display chat messages [Synced with Server]
Webhook URL = https://discord.com/api/webhooks/1404119063046652035/OqBFopk29Cku3_4TiLCJVwaagkyLVsdlkjasd239-sdjzdHH7vHh_RfWy1d3

## Set channel ID to monitor for messages [Synced with Server]
Channel ID = 9839768234583209

## If on, bot will send message when player shouts and monitor discord for messages [Synced with Server]
Enabled = On

[4 - Commands]

## Set discord webhook to display feedback messages from commands [Synced with Server]
Webhook URL = https://discord.com/api/webhooks/1404941903144685779/gc8DFwfIO5eUnxzoJ1Dqsi-iX68GLUMWz_3sdlkjasd9DDAS7tKfB1qWuYN

## Set channel ID to monitor for input commands [Synced with Server]
Channel ID = 1106947857194165898

## List of discord admins, who can run commands [Synced with Server]
Discord Admin = .rusty,.warp

[5 - Setup]
## Add bot token here, server only
BOT TOKEN = 

Usage

In-Game to Discord

• Any message sent as a shout in the in-game chat will appear in your configured Discord chat channel
• Server events (like startup) will be posted to the notification channel
• Death events will be posted to the death feed channel

Discord to In-Game

• Messages sent in the configured Discord chat channel will appear in the in-game chat
• Commands sent in the configured Discord command channel will be executed on the server

Discord Commands

Send commands in your designated command channel:

• Commands should start with a command prefix !
• Example: !listplayers to list online players
• Example: !save to save the world

Commands

Legend:

- <string:Parameter> - Text parameter
- <int:Parameter> - Number parameter
- <float:Parameter> - Decimal number parameter
- <parameter?> - Optional parameter
- [Admin Only] - Command restricted to registered Discord admins

General Commands

❓ help

Description: List of all available commands
Usage: !help

⚠️ listadmins [Admin Only]

Description: List of discord admins registered to plugin
Usage: !listadmins

Player Management

🐉 listplayers [Admin Only]

Description: List of active players with their positions
Usage: !listplayers

❌ kick [Admin Only]

Description: Kicks player from server
Usage: !kick <string:PlayerName>

🎁 give [Admin Only]

Description: Adds item directly into player inventory
Usage: !give <string:PlayerName> <string:ItemName> <int:Stack> <int?:Quality> <int?:Variant>
Example: !give PlayerName IronSword 1 3 0

🌹 pos [Admin Only]

Description: Get player's current position coordinates
Usage: !pos <string:PlayerName>

🐅 die [Admin Only]

Description: Kills specified player
Usage: !die <string:PlayerName>

Teleportation Commands

🏃 teleport [Admin Only]

Description: Teleport player to location, bed, or another player
Usage:

• teleport <string:PlayerName> bed - Teleport to bed
• teleport <string:PlayerName> <string:OtherPlayerName> - Teleport to another player
• teleport <string:PlayerName> <float:x> <float:y> <float:z> - Teleport to coordinates

⛳ teleportall [Admin Only]

Description: Teleports all players to specified coordinates
Usage: !teleportall <float:x> <float:y> <float:z>

Environment & Weather

🌪️ listenv

Description: List of available environments
Usage: !listenv

✨ env [Admin Only]

Description: Force environment on all players
Usage: !env <string:EnvironmentName>
Example: !env Twilight_Clear

✨ resetenv [Admin Only]

Description: Reset environment on all players to default
Usage: !resetenv

Spawning & Creatures

❗ spawn [Admin Only]

Description: Spawns prefab at location
Usage:

• !spawn <string:PrefabName> <int:Level> <string:PlayerName> - Spawn at player location
• !spawn <string:PrefabName> <int:Level> <float:x> <float:y> <float:z> - Spawn at coordinates
  Example: !spawn Troll 3 PlayerName

Events

🌙 listevents [Admin Only]

Description: List of available event names
Usage: !listevents

⭐ event [Admin Only]

Description: Starts an event on a player
Usage: !event <string:EventName> <string:PlayerName>
Example: !event Wolves PlayerName

Player Effects & Skills

🚀 liststatus

Description: List of available status effects
Usage: !liststatus

🍕 addstatus [Admin Only]

Description: Add status effect to player
Usage: !addstatus <string:PlayerName> <string:StatusEffect> <float:Duration>
Example: !addstatus PlayerName Rested 300

🙏 listskills

Description: List of available skills
Usage: !listskills

💪 raiseskill [Admin Only]

Description: Raises player's skill level
Usage: !raiseskill <string:PlayerName> <string:SkillType> <float:Amount>
Example: !raiseskill PlayerName Swords 10

Server Management

💾 save [Admin Only]

Description: Save player profiles and world
Usage: !save

😊 message [Admin Only]

Description: Broadcast message to all players (appears center screen)
Usage: !message <message text>
Example: !message Server restart in 5 minutes!

🦄 setkey [Admin Only]

Description: Set global key (affects world state)
Usage: !setkey <string:GlobalKeyName>
Example: !setkey defeated_bonemass

Admin Management

🔑 addadmin [Admin Only]

Description: Adds discord username to admin list
Usage: !addadmin <string:Username>

🔒 removeadmin [Admin Only]

Description: Remove discord username from admin list
Usage: !removeadmin <string:Username>

Notes

• Admin Commands: Commands marked with [Admin Only] can only be used by Discord users registered in the admin list
• Player Names: Use exact player names as they appear in-game (case sensitive)
• Coordinates: Use world coordinates (you can get these with the pos command)
• Item Names: Use exact prefab names from the game
• Error Handling: The bot will respond with error messages if commands fail or parameters are incorrect

1.2.7

• made all webhook urls shared via custom synced value instead of being visible in config file, to make urls hidden from clients to avoid abuse
• added on new day quips
• day quips are shown in-game
• added webhooks config for use cheat command notifications
• added boss death notifications
• added webhooks config for on boss death

1.2.6

• death quips are now shown in-game
• new config detailed logs
• discord bot will write detailed logs on configs/DiscordBot folder on game shutdown
• new config use server key for ChatAI, if client does not have key and config is on then will try to use server's API key
• fixed login message not showing if logout --> login by resetting flag on logout
• added config to choose gemini model
• added notification config for when player uses cheat terminal console command

1.2.5

• prompts now are broadcasted and sent to discord as well
• new discord command: !prompt [text] (uses server's key)
• modified how messages sent from discord are parsed to allow for chat and command channel to share same ID
• if chat and command channel are the same, I check if first argument is a command and try to run it, else runs as a chat message
• fixed new day notifications not working on dedicated servers
• updated manifest bepinex dependency
• added beta feature: jobs - which can run commands on intervals (see readme for details)

1.2.4

• Added more details to events
• Added new day notifications
• Added ChatAI, with multiple AI API provider options
• Required: add your own AI API key to use ChatAI, not synced with server, so each client will need to provide their own API Key
• Added chat command: /prompt
• removed local player check for chat, will use world name if no local player, this allows other mods that sends text to trigger forwarding to discord.

1.2.3

• Fixed screenshot resizing
• Added feature request for multiple webhook notifications
• Added random event notification
• Added author to !whisper command, to know who send whisper

1.2.2

• Overhaul screen capture to use built-in Unity Screen Capture instead of Camera RenderTexture
• to avoid render texture related crashes (perhaps due Graphic API differences)
• Downside, I need to hide Hud, Chat and Console while capturing to hide UI overlays
• Upside, it is simpler resource management and no direct camera manipulation

1.2.1

• show chat panel whenever discord sends message to game

1.2.0

• fixed wrong update version

1.1.3

• Added null checks to new chat messages

1.1.21

• Configurable hotkey to take screenshot (default: None), requested.

1.1.2

• Added death screenshot configurable On/Off
• Added config for death webhook URL, to separate from notifications
• If you want to keep using notification URL, just input same URL
• new in-game chat command: /selfie
• Tweaked config layout, added category Death Feed
• Added death GIF, if On, records death and creates gif instead of taking a delayed screenshot
• GIF Configs FPS, Duration, Resolution
• If feed is not appearing, GIF file size might be too large, try lowering settings

1.1.1

• Fixed: Resolved TaskCanceledException during WebSocket reconnection attempts
  • Caused stack trace errors when heartbeat acknowledgment failed
  • Now handles task cancellation by checking connection state changes

1.1.0

• Switched to websocket for security reasons
• REQUIRED ACTION: You must enable Message Content Intent in Discord Developer Portal
  • Go to https://discord.com/developers/applications
  • Select your bot application
  • Navigate to the "Bot" section
  • Enable "Message Content Intent" under "Privileged Gateway Intents"
  • Your bot will not receive message content without this setting enabled

Important: Bots in 100+ servers require Discord verification to use Message Content Intent.

1.0.11

• fixed (in-game) printing as $label_ingame

1.0.1

• small code clean-up
• fixed give item command food showing up when eating
• added API for other plugin's to add commands
• added death quips, configurable, name of file must not be changed or it won't be able to update

1.0.0

• Initial release