Back to NxLabs

NxLabs / Vintage Story

Notice Board Discord Companion

SBy SiiMeR

A companion mod to the Noticeboard mod that adds the ability to pull data from a Discord channel

Notice Board Discord Companion

Description

Requires the Notice Board mod to be installed

 

<pre>A helper mod to the Notice board mod that syncs messages from a Discord channel to in-game noticeboards.
The mod is useful if you have an announcements channel that you want displayed in-game (for example a pigeons channel in roleplay servers).</pre>

&nbsp;

Features

  • Configurable syncing interval via SyncIntervalSeconds
  • Sync messages starting from 24 hours ago so if your server is down it will catch up&nbsp;
  • Configurable delay to wait before posting on boards via DelayBeforeShowingSeconds (if you want to simulate the message traveling across lands before arriving on a noticeboard)&nbsp;
  • Opt-in system via a new "Is public?" toggle on the board&nbsp;
  • Increased board height (300 -&gt; 550px) to allow for better message reading experience&nbsp;
  • Prevents duplicate messages from being inserted&nbsp;
  • Multiple consecutive messages by the same user are joined together (they must be posted within 1 minutes of eachother)
  • The text itself is converted from Discord Markdown into VTML before being displayed&nbsp;
    • User, role, channel mentions are stripped out
    • Emojis are stripped out&nbsp;
    • Timestamps are rendered into a dd.MM.yyyy, HH:mm format in the GMT timezone
    • Spoilers are replaced by the text inside spoilers
    • Empty spoilers are removed
    • Code blocks are converted into text with special color
    • Headers are converted into &lt;strong&gt; tags
    • Italic is converted into &lt;i&gt; tags
    • Underlines are converted into regular text
    • Trailing spaces are removed on each line
    • Multiple newlines in a row are collapsed into 2&nbsp;
    • Links are rendered as VTML links, making them clickable&nbsp;
    • Leading and trailing whitespace is removed
    • All remaining &gt; and &lt; chars are converted into &amp;gt; and &amp;lt; so it does not trip up the VTML parser

&nbsp;

Setup

<pre>1. Create a Discord bot at the Developer Portal
2. Invite the bot to your server with message read permissions
3. Edit ModConfig/noticeboarddiscord.json:

``json<br />{<br /> "DiscordBotToken": "your-bot-token",<br /> "DiscordChannelId": "channel-id",<br /> "SyncIntervalSeconds": 600,<br /> "DelayBeforeShowingSeconds": 300<br />}<br />``</pre>

&nbsp;

Download

No download link is available for this entry right now.

Ratings & reviews

No ratings yet

Sign in to leave a rating or comment.