Skip to content

nwesterhausen/valheim-discordconnector

Repository files navigation

Discord Connector

CodeQL Build GitHub release (latest by date) Thunderstore.io NexusMods Built against Valheim version

Connect your Valheim server to Discord. (See website for installation or configuration instructions). This plugin is largely based on valheim-discord-notifier, but this plugin supports randomized messages, muting players, and Discord message embeds.

Plugin Details

See the README for the plugin.

Changelog

See the changelog.

Building

To build, first get the path to your Valheim installation and also use the publicize tool to create a publicized version of the game. I'm not sure without that, if it will fail to build or not.

Then, run the following command to build the project:

dotnet build \
   -c Release \
   /p:GamePath="C:\Program Files (x86)\Steam\steamapps\common\Valheim" \
   valheim-discordconnector.sln

Post build, the compiled library and its dependencies get copied into bin/DiscordConnector which enables you to simply copy that folder into $(GamePath)/BePinEx/plugins for testing or use.

The compiled plugin will be in a zip ready for upload at bin/DiscordConnector.zip.

Dependencies

For JSON serialization, using Newtonsoft.Json

For data storage/retrieval using LiteDB (If you want to read the database file generated, you can use LiteDB Studio)

Release Steps

Before release, to bump the version the following needs changed:

  1. Update the version of the plugin in these files
    • src/PluginInfo.cs
    • Metadata/DiscordConnector-Nexus.readme
    • Metadata/manifest.json
    • Metadata/thunderstore.toml
  2. Finalize the changelog entry in docs/changelog.md
  3. Copy changelog notes into Metadata/README.md