SANDBOX — this is a test environment. No servers are actually deployed and no real payments are charged.
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

<p><strong>Requires the <a href="https://mods.vintagestory.at/noticeboard">Notice Board</a> mod to be installed</strong></p> <p>&nbsp;</p> <div> <pre>A helper mod to the Notice board mod that syncs messages from a Discord channel to in-game noticeboards.<br />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> </div> <p>&nbsp;</p> <h2>Features</h2> <div> <ul> <li>Configurable syncing interval via SyncIntervalSeconds</li> <li>Sync messages starting from 24 hours ago so if your server is down it will catch up&nbsp;</li> <li>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;</li> <li>Opt-in system via a new "Is public?" toggle on the board&nbsp;</li> <li>Increased board height (300 -&gt; 550px) to allow for better message reading experience&nbsp;</li> <li>Prevents duplicate messages from being inserted&nbsp;</li> <li>Multiple consecutive messages by the same user are joined together (they must be posted within 1 minutes of eachother)</li> <li>The text itself is converted from Discord Markdown into VTML before being displayed&nbsp; <ul> <li>User, role, channel mentions are stripped out</li> <li>Emojis are stripped out&nbsp;</li> <li>Timestamps are rendered into a dd.MM.yyyy, HH:mm format in the GMT timezone</li> <li>Spoilers are replaced by the text inside spoilers</li> <li>Empty spoilers are removed</li> <li>Code blocks are converted into text with special color</li> <li>Headers are converted into &lt;strong&gt; tags</li> <li>Italic is converted into &lt;i&gt; tags</li> <li>Underlines are converted into regular text</li> <li>Trailing spaces are removed on each line</li> <li>Multiple newlines in a row are collapsed into 2&nbsp;</li> <li>Links are rendered as VTML links, making them clickable&nbsp;</li> <li>Leading and trailing whitespace is removed</li> <li>All remaining &gt; and &lt; chars are converted into &amp;gt; and &amp;lt; so it does not trip up the VTML parser</li> </ul> </li> </ul> <div> <h2>&nbsp;</h2> </div> <h2>Setup<br /><br /></h2> <div> <pre>1. Create a Discord bot at the <a href="https://discord.com/developers/applications">Developer Portal</a><br />2. Invite the bot to your server with message read permissions<br />3. Edit ModConfig/noticeboarddiscord.json:<br /><br />``json<br />{<br /> "DiscordBotToken": "your-bot-token",<br /> "DiscordChannelId": "channel-id",<br /> "SyncIntervalSeconds": 600,<br /> "DelayBeforeShowingSeconds": 300<br />}<br />``</pre> </div> <p>&nbsp;</p> </div>

Download

No download link is available for this entry right now.

Ratings & reviews

No ratings yet

Sign in to leave a rating or comment.