You are viewing a potentially older version of this package. View all versions.
warpalicious-DiscordTools-1.1.0 icon

DiscordTools

Request client log file from a Discord command

Date uploaded a month ago
Version 1.1.0
Download link warpalicious-DiscordTools-1.1.0.zip
Downloads 684
Dependency string warpalicious-DiscordTools-1.1.0

This mod requires the following mods to function

denikson-BepInExPack_Valheim-5.4.2333 icon
denikson-BepInExPack_Valheim

BepInEx pack for Valheim. Preconfigured with the correct entry point for mods and preferred defaults for the community.

Preferred version: 5.4.2333

README

DiscordTools

DiscordTools is a client/server mod for sending a client LogOutput.log file to Discord.

Features

  • Server command: client-logs {playerNameOrSteamID}
  • Client log upload when a player logs out.
  • Client log upload attempt when a player quits the game.
  • Server archive folders include both player name and stable player ID.
  • Server writes JSON metadata and lookup indexes.

How to use

  • Requires a Discord bot with a compatible upload API if you want logs posted to Discord.
  • Install DiscordTools on the dedicated server and on every client that should be able to send logs.
  • Set DISCORDTOOLS_BOT_API_URL and DISCORDTOOLS_BOT_API_KEY in the dedicated server config file.
  • Run client-logs {playerNameOrSteamID} on the server to request that player's log.
  • Logs are saved on the server disk and, when configured, sent to Discord as a .log attachment.

Server Storage

Logs are stored under BepInEx/client-logs by default:

client-logs/
  players/{playerName}_{playerId}/
    player.json
    latest.json
    logs/{yyyy-MM}/
      {timestamp}_{reason}_{playerName}_LogOutput.log.gz
      {timestamp}_{reason}_{playerName}_LogOutput.json
  index/
    players.json
    recent.json
  incoming/
  bot-upload-failed/

Older archives stored under players/{playerId}/ remain readable.

Donations/Tips

I make mods because I enjoy it and want to make Valheim more enjoyable for everyone. If you feel like saying thanks you can tip me here.

My Ko-fi: ko-fi

Source Code

Source code is available on Github.

Github Repository: DiscordTools

CHANGELOG

Version Update Notes
1.4.0 - Removed Discord link, creative inventory, creative biome, and siege portal bridge behavior now provided by PraetorisClient
- Kept client log requests, logout/quit uploads, server archive storage, and bot API uploads
1.3.2 - Rebuilt DiscordTools from merged main for the siege portal bridge and creative biome override release
1.3.1 - Added creative biome override RPC for server-side creative zones
1.3.0 - Added creative inventory RPC for server-side tools that need a trusted client inventory count
- Added optional item-entry details for player inventory and Shudnal ExtraSlots inventories
1.2.0 - Added in-game !link CODE support for linking a Valheim player to a Discord user
- Added server-side link API posting with player ID, player name, endpoint, and platform display name
- Added server-only link API URL configuration and environment variable support
1.1.0 - Store new client log archives in folders named with both player name and stable player ID
- Added folder-aware metadata and indexes for players with multiple character names
- Preserved legacy players/{playerId} index paths when old archives exist
- Updated bot upload metadata to include the archive folder path
1.0.0 - Initial release
- Added server command to request a connected player's full BepInEx log
- Added client log upload on logout and quit
- Added server-side archive organized by player ID and month
- Added optional Discord bot API upload with server-only credentials