@@ -1,7 +1,4 @@
|
||||
# Discord Rich Presence Plugin for Navidrome
|
||||
|
||||
[](https://github.com/navidrome/discord-rich-presence-plugin/actions/workflows/build.yml)
|
||||
[](https://github.com/navidrome/discord-rich-presence-plugin/releases/latest/download/discord-rich-presence.ndp)
|
||||
# Discodrome, a work of Discord Rich Presence Plugin for Navidrome
|
||||
|
||||
**Attention: This plugin requires Navidrome 0.61.0 or later.**
|
||||
|
||||
@@ -9,7 +6,7 @@ This plugin integrates Navidrome with Discord Rich Presence, displaying your cur
|
||||
The goal is to demonstrate the capabilities of Navidrome's plugin system by implementing a real-time presence feature using Discord's Gateway API.
|
||||
It demonstrates how a Navidrome plugin can maintain real-time connections to external services while remaining completely stateless.
|
||||
|
||||
Based on the [Navicord](https://github.com/logixism/navicord) project.
|
||||
Based on the [discord-rich-presence-plugin](https://github.com/navidrome/discord-rich-presence-plugin) project.
|
||||
|
||||
**⚠️ WARNING: This plugin requires storing Discord user tokens, which may violate Discord's Terms of Service. Use at your own risk.**
|
||||
|
||||
@@ -26,13 +23,12 @@ Based on the [Navicord](https://github.com/logixism/navicord) project.
|
||||
- Optional album art from [Cover Art Archive](https://coverartarchive.org) for MusicBrainz-tagged music
|
||||
- Optional image hosting via [uguu.se](https://uguu.se) for non-public Navidrome instances
|
||||
|
||||
<img alt="Discord Rich Presence showing currently playing track with album art, artist, and playback progress" src="https://raw.githubusercontent.com/navidrome/discord-rich-presence-plugin/master/.github/ss-richpresence.webp">
|
||||
|
||||
|
||||
## Installation
|
||||
|
||||
### Step 1: Download and Install the Plugin
|
||||
1. Download the `discord-rich-presence.ndp` file from the [releases page](https://github.com/navidrome/discord-rich-presence-plugin/releases)
|
||||
1. Download the `discodrome.ndp` file from the [releases page](https://git.atri.dad/atridad/discodrome/releases)
|
||||
2. Copy it to your Navidrome plugins folder. Default location: `<navidrome-data-directory>/plugins/`
|
||||
|
||||
### Step 2: Create a Discord Application
|
||||
@@ -115,7 +111,6 @@ For album artwork to display in Discord, Discord needs to be able to access the
|
||||
|
||||
Access the plugin configuration in Navidrome: **Settings > Plugins > Discord Rich Presence**
|
||||
|
||||
<img alt="Plugin configuration panel showing all available settings" src="https://raw.githubusercontent.com/navidrome/discord-rich-presence-plugin/master/.github/ss-config.webp">
|
||||
|
||||
### Configuration Fields
|
||||
|
||||
@@ -249,7 +244,7 @@ make build
|
||||
make package
|
||||
```
|
||||
|
||||
The `make package` command creates `discord-rich-presence.ndp` containing the compiled WebAssembly module and manifest.
|
||||
The `make package` command creates `discodrome.ndp` containing the compiled WebAssembly module and manifest.
|
||||
|
||||
### Manual Build Options
|
||||
|
||||
@@ -257,16 +252,15 @@ The `make package` command creates `discord-rich-presence.ndp` containing the co
|
||||
```sh
|
||||
# Install TinyGo first: https://tinygo.org/getting-started/install/
|
||||
tinygo build -target wasip1 -buildmode=c-shared -o plugin.wasm -scheduler=none .
|
||||
zip discord-rich-presence.ndp plugin.wasm manifest.json
|
||||
zip discodrome.ndp plugin.wasm manifest.json
|
||||
```
|
||||
|
||||
#### Using Standard Go
|
||||
```sh
|
||||
GOOS=wasip1 GOARCH=wasm go build -buildmode=c-shared -o plugin.wasm .
|
||||
zip discord-rich-presence.ndp plugin.wasm manifest.json
|
||||
zip discodrome.ndp plugin.wasm manifest.json
|
||||
```
|
||||
|
||||
### Output
|
||||
- `plugin.wasm`: The compiled WebAssembly module
|
||||
- `discord-rich-presence.ndp`: The complete plugin package ready for installation
|
||||
|
||||
- `discodrome.ndp`: The complete plugin package ready for installation
|
||||
|
||||
Reference in New Issue
Block a user