Merge pull request #74 from nwesterhausen/dev

1.4.0 bugfix and variables
nwesterhausen · Oct 22, 2021 · 6cf2c4f · 6cf2c4f
2 parents 7105504 + fe2e9f8
commit 6cf2c4f
Show file tree

Hide file tree

Showing 22 changed files with 908 additions and 159 deletions.
diff --git a/Metadata/CHANGELOG.md b/Metadata/CHANGELOG.md
@@ -2,6 +2,28 @@
 
 A full changelog for reference.
 
+### Version 1.4.0
+
+Features:
+
+- 10 user defined variables that can be used an any messages (%VAR1% thru %VAR10%). These are set in their own configuration file, 
+`games.nwest.valheim.discordconnector-variables.cfg` which will get generated first time 1.4.0 is run.
+- The position of where the player/ping/event coordinates are inserted into messages is configurable using the `%POS%` variable in
+the messages config. It won't be replaced if the "send coordinates" toggle is off for that message. If you don't include a `%POS%`
+variable, it will append the coordinates as happens with previous versions.
+
+Fixes:
+
+- Fixed an off-by-one error in the Top Players leaderboard (the default leaderboard) (Thanks @thedefside)
+- Fixed configuration not referencing proper settings (Thanks @thedefside)
+- Fixed event messages (now properly functioning on dedicated servers)
+
+Breaking Changes:
+
+- If you used `%PLAYERS%` in any of the event messages, you need to remove it. With the changes required for the event messages
+functionality, it is not supportable at this time.
+
+
 ### Version 1.3.0
 
 Features:

diff --git a/Metadata/DiscordConnector-Nexus.readme b/Metadata/DiscordConnector-Nexus.readme
@@ -1,4 +1,4 @@
-DISCORD CONNECTOR - 1.3.0
+DISCORD CONNECTOR - 1.4.0
 Connect your Valheim server to a Discord Webhook. Works for both dedicated and client-hosted servers. (Visit the github repo for a how-to guide.)
 
 :: REQUIREMENTS ::
@@ -13,6 +13,7 @@ Connect your Valheim server to a Discord Webhook. Works for both dedicated and c
 - Will use an embed for coordinates if enabled
 - Periodic leader board messages with death,ping,shout and join|leave leader. (optional)
 - A message for the first time a player does something (join and death by default, can be entirely disabled)
+- Add almost anything to your messages with 10 user defined variables
 
 :: SUPPORTED MESSAGES ::
 - Server startup (server starting, loading the world)

diff --git a/Metadata/README.md b/Metadata/README.md
@@ -55,9 +55,23 @@ records.json 1.2.0+ (PlayerName changed to Key)
 [{"Category":"death","Values":[{"Key":"Xithyr","Value":13} ...
 ```
 
-### Version 1.3.0
+### Version 1.4.0
 
 Features:
 
-- Additional leaderboard options. The existing leaerboard option will now default to sending top 3 players for what is enabled. 
-You can enable a highest and lowest leaderboard for each tracked stat now. All leaderboards get sent on the same interval.
+- 10 user defined variables that can be used an any messages (%VAR1% thru %VAR10%). These are set in their own configuration file, 
+`games.nwest.valheim.discordconnector-variables.cfg` which will get generated first time 1.4.0 is run.
+- The position of where the player/ping/event coordinates are inserted into messages is configurable using the `%POS%` variable in
+the messages config. It won't be replaced if the "send coordinates" toggle is off for that message. If you don't include a `%POS%`
+variable, it will append the coordinates as happens with previous versions.
+
+Fixes:
+
+- Fixed an off-by-one error in the Top Players leaderboard (the default leaderboard) (Thanks @thedefside)
+- Fixed configuration not referencing proper settings (Thanks @thedefside)
+- Fixed event messages (now properly functioning on dedicated servers)
+
+Breaking Changes:
+
+- If you used `%PLAYERS%` in any of the event messages, you need to remove it. With the changes required for the event messages
+functionality, it is not supportable at this time.
diff --git a/Metadata/manifest.json b/Metadata/manifest.json
@@ -1,6 +1,6 @@
 {
   "name": "DiscordConnector",
-  "version_number": "1.3.0",
+  "version_number": "1.4.0",
   "website_url": "https://github.com/nwesterhausen/valheim-discordconnector",
   "description": "Connects your Valheim server to a Discord webhook. Works for both dedicated and client-hosted servers.",
   "dependencies": ["denikson-BepInExPack_Valheim-5.4.1600"]

diff --git a/README.md b/README.md
@@ -39,5 +39,6 @@ Thanks for the helpful contributions!
 
 - @Digitalroot
 - @nwesterhausen
+- @thedefside
 
 Thanks for an excellent original plugin @aequasi!
diff --git a/docs/changelog.md b/docs/changelog.md
@@ -2,6 +2,27 @@
 
 A full changelog
 
+### Version 1.4.0
+
+Features:
+
+- 10 user defined variables that can be used an any messages (%VAR1% thru %VAR10%). These are set in their own configuration file, 
+`games.nwest.valheim.discordconnector-variables.cfg` which will get generated first time 1.4.0 is run.
+- The position of where the player/ping/event coordinates are inserted into messages is configurable using the `%POS%` variable in
+the messages config. It won't be replaced if the "send coordinates" toggle is off for that message. If you don't include a `%POS%`
+variable, it will append the coordinates as happens with previous versions.
+
+Fixes:
+
+- Fixed an off-by-one error in the Top Players leaderboard (the default leaderboard) (Thanks @thedefside)
+- Fixed configuration not referencing proper settings (Thanks @thedefside)
+- Fixed event messages (now properly functioning on dedicated servers)
+
+Breaking Changes:
+
+- If you used `%PLAYERS%` in any of the event messages, you need to remove it. With the changes required for the event messages
+functionality, it is not supportable at this time.
+
 ### Version 1.3.0
 
 Features: