|
|
@@ -1,40 +1,73 @@
|
|
|
-# Discordo · [](https://discord.com/invite/VzF9UFn2aB) [](https://github.com/ayn2op/discordo/actions/workflows/ci.yml) [](https://goreportcard.com/report/github.com/ayn2op/discordo) [](https://github.com/ayn2op/discordo/blob/master/LICENSE)
|
|
|
+# Discordo Plus
|
|
|
|
|
|
-Discordo is a lightweight, secure, and feature-rich Discord terminal client. Heavily work-in-progress, expect breaking changes.
|
|
|
+A fork of [discordo](https://github.com/ayn2op/discordo) — a lightweight Discord terminal client — with image viewing and save support.
|
|
|
|
|
|
-
|
|
|
+## Changes from upstream
|
|
|
|
|
|
-## Installation
|
|
|
+- **Image viewer**: Opens image attachments (jpeg, png, webp, gif) in a configurable viewer (`imv` by default) instead of the browser
|
|
|
+- **Save image**: `S` keybind saves the selected message's image attachment to a configurable directory
|
|
|
+- **Attachment URL fix**: Links no longer break due to bad newline handling
|
|
|
+- **Tooltip**: `o open` appears in the bottom help bar when a message has attachments or URLs
|
|
|
|
|
|
-### Prebuilt binaries
|
|
|
+## Building on Arch Linux
|
|
|
|
|
|
-You can download and install a [prebuilt binary here](https://nightly.link/ayn2op/discordo/workflows/ci/main) for Windows, macOS, or Linux.
|
|
|
+### Requirements
|
|
|
|
|
|
-### Package managers
|
|
|
+```bash
|
|
|
+sudo pacman -S go imv wl-clipboard
|
|
|
+```
|
|
|
|
|
|
-- Arch Linux: `yay -S discordo-git`
|
|
|
-- Gentoo (available on the guru repos as a live ebuild): `emerge net-im/discordo`
|
|
|
-- FreeBSD: `pkg install discordo` or via the ports system `make -C /usr/ports/net-im/discordo install clean`.
|
|
|
-- Nix: Add `pkgs.discordo` to `environment.systemPackages` or `home.packages`.
|
|
|
+- `go` — Go compiler (1.22+)
|
|
|
+- `imv` — lightweight image viewer (Wayland + X11, supports jpeg/png/webp/gif)
|
|
|
+- `wl-clipboard` — clipboard support on Wayland (skip if using X11)
|
|
|
|
|
|
-- Windows (Scoop):
|
|
|
+### Build and install
|
|
|
|
|
|
-```sh
|
|
|
-scoop bucket add vvxrtues https://github.com/vvirtues/bucket
|
|
|
-scoop install discordo
|
|
|
+```bash
|
|
|
+git clone https://gogs.altsol.dev/claude/discordo-plus.git
|
|
|
+cd discordo-plus
|
|
|
+go build -o discordo-plus .
|
|
|
+sudo install -Dm755 discordo-plus /usr/local/bin/discordo-plus
|
|
|
```
|
|
|
|
|
|
-### Building from source
|
|
|
+### Run
|
|
|
|
|
|
```bash
|
|
|
-git clone https://github.com/ayn2op/discordo
|
|
|
-cd discordo
|
|
|
-go build .
|
|
|
+discordo-plus
|
|
|
+```
|
|
|
+
|
|
|
+On first launch, enter your Discord token or scan the QR code to log in.
|
|
|
+
|
|
|
+## Configuration
|
|
|
+
|
|
|
+Config file location: `~/.config/discordo/config.toml`
|
|
|
+
|
|
|
+The default config is used if no file exists. See [the default config](./internal/config/config.toml) for all options.
|
|
|
+
|
|
|
+### Image-related settings
|
|
|
+
|
|
|
+```toml
|
|
|
+# External image viewer (must accept a file path as first argument)
|
|
|
+# Set to "default" to use xdg-open
|
|
|
+image_viewer = "imv"
|
|
|
+
|
|
|
+# Directory for saved images (supports ~/, empty = current directory)
|
|
|
+image_save_dir = "~/Pictures/discordo"
|
|
|
+
|
|
|
+[keybinds.messages_list]
|
|
|
+# Open attachments/links from selected message
|
|
|
+open = "o"
|
|
|
+# Save image attachment from selected message
|
|
|
+save_image = "S"
|
|
|
```
|
|
|
|
|
|
-### Wayland clipboard support
|
|
|
+### Notes
|
|
|
|
|
|
-`wl-clipboard` is required for clipboard support.
|
|
|
+- If `imv` installs as `imv-x11` or `imv-wayland` without a plain `imv` binary, create a symlink:
|
|
|
+ ```bash
|
|
|
+ sudo ln -s /usr/bin/imv-wayland /usr/local/bin/imv
|
|
|
+ ```
|
|
|
+- Alternative viewers: `feh`, `sxiv`, `nsxiv` — set via `image_viewer` in config (note: `feh` lacks WebP support)
|
|
|
|
|
|
## Usage
|
|
|
|
