morphine-VampireWebhook icon

VampireWebhook

A simple package for sending messages to Discord.

Last updated 2 weeks ago
Total downloads 141
Total rating 1 
Categories Server Mods Oakveil Update
Dependency string morphine-VampireWebhook-0.1.0
Dependants 1 other package depends on this package

This mod requires the following mods to function

BepInEx-BepInExPack_V_Rising-1.733.2 icon
BepInEx-BepInExPack_V_Rising

BepInEx pack for V Rising. Preconfigured and includes Unity Base DLLs.

Preferred version: 1.733.2
deca-VampireCommandFramework-0.10.2 icon
deca-VampireCommandFramework

Command framework for developers to easily create universal commands for their plugins.

Preferred version: 0.10.2

README

VampireWebhook - Simple Discord webhook integration

Features

  • Loads webhook from hook.txt
  • Allows mods to send messages to discord
  • Format messages with markdown syntax

For admins and server owners:

To properly setup this mod you need to:

  • Create a hook.txt file in \BepInEx\config\
  • Go to your discord and get your webhook url in the channel you want messages sent to. (how to get hook url)
  • Add the webhook url to hook.txt
  • ‼️NOTE: Do not share the webhook url with anyone. Don't post it when asking for support either.
  • Add the VampireWebhook.dll to \BepInEx\plugins\
  • You're good to go!

Setttings

The settings file will be created at: BepInEx\config\phlebotomist.morphine.VampireWebhook.cfg Set the value to false if you need to turn off the webhook for some reason.

[General]

## toggle for sending messages to the webhook
# Setting type: Boolean
# Default value: true
UseDiscordWebhook = true

For devs:

The code is pretty short and I added doc comments above all functions but here's a quick overview of how it's intended to be used.

SendDiscordMessageAsync can be used to send the messages. HookEnabled is public so you can short circuit any proccessing or string building if the hook is turned off, however it is not required.

using VampireWebhook;

private static void exmapleMessageBuilder(int someNumber){
    if (!HookEnabled())
        return;

    string myString = $"Wow it's over: {someNumber}!"
    _ = DiscordWebhook.SendDiscordMessageAsync(myString)

}

credits and thanks:

Want to give thanks to Deca, Odjit and everyone in the VrisingModing discord who helped answer questions.

Support:

  • I go by Morphine on the Vrising modding Discord
  • Additionally feel free to open issues on the github

Pull Requests:

I want to keep this thing simple but if there's anything you think I missed or did stupid I will try to review any PR's in a timely manner. Feel free to msg me on Discord (@morphine) if I don't respond within a day.