fast-patch-notes

Fast Patch Notes A Discord bot that turns quick messages into standardized patch notes. Write a simple update in the configured channel and let the bot handle the rest: it republishes the message as a webhook embed, creates a discussion thread, mentions configured roles and adds feedback reactions.

FULLY CUSTOMIZABLE!

Features

Automatic patch notes Turns regular messages into organized embeds while preserving lists and line breaks.	Webhook publishing Uses a configured webhook or automatically creates one with a custom name and avatar.
Discussion threads Creates a thread on the patch notes message to keep update discussions in one place.	Mentions and reactions Sends configured role mentions and adds positive and negative feedback reactions.

Preview

See the bot formatting a message into patch notes.

Requirements

• Node.js 20 or newer
• A bot created in the Discord Developer Portal
• Message Content Intent enabled for the bot
• Discord channel permissions for messages, webhooks, reactions and threads

How to create and invite a bot

## Invite The Bot 1. Open the Discord Developer Portal: https://discord.com/developers/applications 2. Open your bot application. 3. Go to **OAuth2** > **URL Generator**. 4. Under **Scopes**, select: - `bot` 5. Under **Bot Permissions**, select: - View Channels - Send Messages - Manage Messages - Manage Webhooks - Add Reactions - Read Message History - Create Public Threads - Send Messages in Threads 6. Copy the generated URL at the bottom of the page and open it in your browser. After inviting the bot, check the channel configured in `target_channel_id` and make sure the bot role can view and send messages there.

VPS Setup and configuration

Fast Patch Notes is designed to stay online, so a VPS is a great place to run it. The example below assumes a Linux VPS, connected through SSH, with Node.js 20 or newer available.

Clone fast-patch-notes into your VPS:

git clone https://github.com/leogianfagna/fast-patch-notes.git
cd fast-patch-notes

Install dependencies:

npm install

Copy the example file and open your config:

cp config.example.yml config.yml
nano config.yml

Bot Token

Your bot created in the Discord Developer Portal has a token. Copy it and place it in token:

# Bot token. You can also set it through the DISCORD_TOKEN environment variable.
token: "PUT_YOUR_BOT_TOKEN_HERE"

Target Channel

The bot listens to one text channel in your server. Copy that channel ID and place it in target_channel_id:

# Channel the bot should watch.
target_channel_id: "1524803982105772213"

Mentioned Roles

The bot can mention roles to notify players. Add every role ID you want to notify to the mentioned_roles array:

# Roles mentioned in the next message, right after the embed.
mentioned_roles:
  - "123456789012345678"

Start The Bot

npm start

You should see something like this:

> fast-patch-notes@1.0.0 start
> node src/index.js

Bot online as YOUR-BOT#2826. Configured channel: 1524803982105772213.
Watching channel 1524803982105772213.

Keep It Online With PM2

On a VPS, you usually want the bot to keep running after you close the SSH session. Install PM2 and start the bot with it:

sudo npm install -g pm2
pm2 start src/index.js --name fast-patch-notes
pm2 save
pm2 startup

Useful PM2 commands:

pm2 logs fast-patch-notes
pm2 restart fast-patch-notes
pm2 stop fast-patch-notes

Enyoy 👍

This site is open source. Improve this page.