diff options
| author | Pinapelz <yukais@pinapelz.com> | 2025-06-21 11:53:18 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2025-06-21 11:53:18 -0700 |
| commit | a9eadcc3a53c96657963e1d3a17dba87c0e02739 (patch) | |
| tree | 852c161743aa7c42904627b5d8094a6cf3bf627f | |
| parent | 1e197556481181dbf1f0239f4ec2740cfa5aa790 (diff) | |
Update README.md
| -rw-r--r-- | README.md | 24 |
1 files changed, 23 insertions, 1 deletions
@@ -1,3 +1,25 @@ # tiny-discord-feed -Get your Discord messages as a feed. Requires BetterDiscord +Get your Discord messages as a singular mega feed. Requires BetterDiscord + + +> Compatible and responsive with any display size, although a vertical display looks the nicest + +# Setup +1. Download and Install [BetterDiscord](https://betterdiscord.app/) +2. Head to settings and find the Plugins section (under BetterDiscord). From here click the folder icon to open the folder where plugins are stored +3. Download the [BDFireToWebSocket](https://github.com/pinapelz/BDFireToWebsocket/releases/latest/download/BDFireToWebsocket.plugin.js) plugin file, and drag this into that folder +4. Clone this repo and run this application (Install Node and pnpm if you haven't already) +``` +git clone https://github.com/pinapelz/tiny-discord-feed +pnpm install +pnpm start +``` +**(Builds not available at this time. Please run from source)** + +5. Click configure in the top right. You'll need to configure the channels you want to receive messages for as well as give them an alias. + +> To get the Channel ID for either a DM or a channel in a server, simply right click on it in Discord and choose `Copy Channel ID` + +6. Head back to Discord and go to the Plugins tab again. From here click on the `Settings` icon under the BDFireToWebSocket plugin and "Reconnect to WebSocket" + |