ValheimRcon
This plugin adds RCON protocol support to your Valheim server.
- Introduces several commands for interacting with the server remotely
- Supports sending command execution results to Discord
- Provides an extensible RCON command interface that can be used by third-party mods
- Plugin is protected against most potential threats, preventing unauthorized access to the server via the RCON protocol
Usage
- Install the plugin to your Valheim server
- Start the server to generate the configuration file
- Configure the plugin in
BepInEx/config/org.tristan.rcon.cfg:
- Set the RCON port (default is server port + 2)
- Change the RCON password. Do not leave the default password, as it is insecure!
- Provide a Discord webhook URL to see command results in your Discord (optional but recommended)
- Restart the server to apply the changes
- Connect to the server using an RCON client (web or desktop application)
- After connecting you will be able to execute commands in the console.
Command List
View all available commands:
list
Chat
Sends a message to the global chat:
say {text}
Displays a message in the center of the screen for all players:
showMessage {text}
Displays a ping at the specified coordinates:
ping {x} {y} {z}
Player Interaction
Deals damage to the player in the specified amount:
damage {steam id or nickname} {damage amount}
Heals the player by the specified amount of HP:
heal {steam id or nickname} {heal amount}
Creates an item at the player's coordinates with the given amount and level. If the player is not moving, the item should be added to their inventory immediately:
give {steam id or nickname} {item} {quality} {count}
Teleports the player to the specified coordinates:
teleport {steam id or nickname} {x} {y} {z}
Utility Commands
Creates an object (any available in the game) at the specified coordinates:
spawn {object name} {level} {count} {x} {y} {z}
Adds an admin:
addAdmin {steam id}
Removes an admin:
removeAdmin {steam id}
Adds a player to the whitelist:
addPermitted {steam id}
Removes a player from the whitelist:
removePermitted {steam id}
Displays the list of admins:
adminlist
Displays the list of banned players:
banlist
Displays the list of players in the whitelist:
permitted
Disconnects a player from the server:
kick {steam id or nickname}
Bans a player by nickname or steam ID:
ban {steam id or nickname}
Bans a player by steam ID:
banSteamId {steam id}
Unbans a player by name or steam ID:
unban {steam id or nickname}
Displays the list of online players:
players
Find a player by nickname or steam ID:
findPlayer {steam id or nickname}
Displays the current global keys:
globalKeys
Adds a global key:
addGlobalKey {key}
Removes a global key:
removeGlobalKey {key}
Displays a set of server stats (FPS, load, etc.):
serverStats
Finds all object by prefab name and optionally by creator ID:
findObjects {prefab name} [creator id]
Find all objects created by a specific player:
findObjectsByCreator {creator id}
Displays the current server time:
time
Shows the last few lines of the server logs. The full server log file is also sent to Discord:
logs
Saves the world:
save
Notice
If result of command execution is too long, it will be truncated in the RCON client, but the full result will be sent to Discord if you have configured a webhook URL in the plugin settings.
For example if you execute findObjects command, it could return a lot of objects, and the RCON client will show only few of them. But the full result will be sent to Discord.
Examples
Gives player Ragnar level 4 Blackmetal Sword:
give Ragnar SwordBlackmetal 4 1
Spawns 4 level 3 Boars at coordinates x:90 y:31 z:90:
spawn Boar 3 4 90 31 90
Sends a message Hello everyone! to the global chat:
say Hello everyone!
Custom commands
If you are a modder and want to add your own RCON commands for your server, read this documentation.
Contacts
If you have any questions / bug reports / suggestions for improvement or found incompatibility with another mod, feel free to contact me in discord typedeff or on GitHub
