[1.2.1] no Discord message sent despite successful CATest()

[gyroplast]

Problem Description

The mod is enabled, and after setting a valid Discord webhook, I do receive the test message in the Discord channel when running CATest(), but no player or monster death is reported as a Discord message, only as a server broadcast, i. e. a message displayed at the top of the screen to all currently logged-in players. My expectation was that, if the test was successful, all player and monster deaths are announced in the Discord channel.

[gyroplast]

Up to and including version 1.2.1 it is default behaviour to only announce any death as a server broadcast, and the mod configuration must be changed in order to actually send messages to an external messenger service like Discord. The intention was to prevent invalid requests to third-party services and be a good network neighbor, but this clashes with user's expectation for the mod to "just work" after setting the bare required minimum of a Discord webhook and not having to fiddle with a configuration file needlessly.

As a Discord webhook URL is plausibility-checked before sending any request anyway, the mod will not generate bad traffic by default. To fix this UX issue, the default settings shall be comprehensively inclusive, that is even if no configuration is provided, setting a Discord webhook URL shall be sufficient to have all monster deaths and player deaths announced on all supported channels, i. e. Discord and Server at the moment. Only if a user wants to disable certain messages, configuration will be necessary.

Workaround for 1.2.1

To have messages sent to Discord, provide at least the necessary configuration settings, announce_death for monster deaths, and death_player for player deaths, in your server's modoverrides.lua:

  ["workshop-2594707725"]={
    configuration_options={
      -- Default Settings
      -- All announce channel selection options are set to a numeric value.
      -- If the value is 1, the announcement will be disabled.
      -- If the value is 2, the Default Setting will be used.
      -- If the value is 4, the announcement will be a server broadcast.
      -- If the value is 8, the announcement will be sent to Discord.
      -- The values can be added to announce on multiple channels, f. ex.:
      -- If the value is 12, the announcement will be broadcast on the
      -- server (4) AND sent to Discord (8), since 12 = 4 + 8. 
      announce_death=12, -- where to announce boss monster death, default setting
      death_player=12   -- where to announce player death, default setting
    },
    enabled=true
  }

Please refer to the documentation for a fully commented configuration snippet you can just copy into your modoverrides.lua and edit to your liking, saving you the annoying step of copying this information from a client-hosted instance as usually proposed.

If you're running a client-hosted server, you can of course just configure the mod over the game's GUI, and change the general default options Announce Player Deaths and Announce Monster Death to Discord & Server.

You will of course still have to set a webhook URL to have messages sent to Discord successfully, but these options are a "main switch" of sorts to define what kind of messages you want to have announced where, exactly.