@chojs23/concord 2.1.11

package/README.md

@@ -0,0 +1,644 @@
+# Concord
+
+<img width="1613" height="848" alt="concord - a feature-rich TUI client for
+  Discord" src="./docs/example.png" />
+
+Concord is a feature-rich TUI (terminal user interface) client for Discord, written in Rust with ratatui. Full Discord experience, right in your terminal.
+
+## Table of contents
+
+- [Installation](#installation)
+- [Features](#features)
+- [Configuration](#configuration)
+- [Performance](#performance)
+- [FAQ](#faq)
+- [Security](#security)
+- [Contributing](#contributing)
+- [License](#license)
+
+## Installation
+
+### Homebrew
+
+```sh
+brew install chojs23/tap/concord
+```
+
+### npm
+
+```sh
+npm install -g @chojs23/concord
+```
+
+You can also run Concord without a global install:
+
+```sh
+npx @chojs23/concord
+```
+
+The npm package installs a prebuilt binary from the GitHub Release artifacts.
+
+### Cargo
+
+Install native audio dependencies first. On macOS with Homebrew:
+
+```sh
+brew install opus pkg-config
+```
+
+On Fedora:
+
+```sh
+sudo dnf install opus-devel alsa-lib-devel pkgconf-pkg-config
+```
+
+On Debian or Ubuntu:
+
+```sh
+sudo apt install libopus-dev libasound2-dev pkg-config
+```
+
+On macOS with Homebrew:
+
+```sh
+brew install opus pkg-config
+```
+
+```sh
+cargo install concord
+```
+
+To install without local voice playback and microphone support:
+
+```sh
+cargo install concord --no-default-features
+```
+
+To install the latest unreleased version directly from the Git repository:
+
+```sh
+cargo install --git https://github.com/chojs23/concord
+```
+
+### Nix
+
+Run without installing (requires flakes enabled):
+
+```sh
+nix run github:chojs23/concord
+```
+
+Install into your profile:
+
+```sh
+nix profile install github:chojs23/concord
+```
+
+Or add the flake as an input in your own `flake.nix`:
+
+```nix
+{
+  inputs.concord.url = "github:chojs23/concord";
+}
+```
+
+### GitHub Release installer
+
+Install the latest release with the cargo-dist shell installer:
+
+```sh
+curl --proto '=https' --tlsv1.2 -LsSf https://github.com/chojs23/concord/releases/latest/download/concord-installer.sh | sh
+```
+
+On Windows, use the PowerShell installer instead:
+
+```powershell
+powershell -ExecutionPolicy Bypass -c "irm https://github.com/chojs23/concord/releases/latest/download/concord-installer.ps1 | iex"
+```
+
+The installer places `concord` under `$CARGO_HOME/bin`, which is usually
+`~/.cargo/bin` on Unix and `%USERPROFILE%\.cargo\bin` on Windows.
+
+### Build from source
+
+You need the Rust stable toolchain, Cargo, and the native dependencies listed in
+the Cargo install section.
+
+```sh
+git clone https://github.com/chojs23/concord.git
+cd concord
+cargo build --release
+```
+
+The release binary is produced at:
+
+```sh
+target/release/concord
+```
+
+To build without local voice playback and microphone support, disable default features:
+
+```sh
+cargo build --release --no-default-features
+```
+
+On WSLg, audio is usually exposed through PulseAudio instead of a real ALSA
+sound card. If playback does not start, check that PulseAudio and ALSA routing
+work before debugging Discord voice itself:
+
+```sh
+pactl info
+paplay /usr/share/sounds/alsa/Front_Center.wav
+aplay -D pulse /usr/share/sounds/alsa/Front_Center.wav
+```
+
+## Features
+
+### Authentication
+
+- **Token** : paste an existing Discord token.
+- **Email / Password** : login with credentials. MFA (TOTP, SMS) is fully supported.
+- **QR Code** : scan the code from the Discord mobile app.
+
+Email and QR code logins may trigger a CAPTCHA challenge on Discord's side. We cannot solve that, so I strongly recommend using token authentication.
+
+Tokens are saved under Concord's config directory in plain text. See the Security section below for details.
+
+### Guilds & Channels
+
+- Browse servers with guild folder grouping
+- Navigate text channels, threads, and forum channels
+- View and filter forum posts (active / archived)
+- Load pinned messages per channel
+- Open channel actions for pinned messages, thread lists, and mark-as-read
+- Join and leave voice channels
+- Highlight active voice speakers in voice channel participant rows
+- Track unread messages and mention counts per channel
+- Mute and unmute channels and servers
+- Leave the selected server after confirmation
+
+### Messaging
+
+- Send, edit, and delete messages
+- Upload / Download attachments
+- Search messages with filters with `/`
+- Use @mention autocomplete
+- Use custom emoji from other servers when your account supports it
+- Send custom emoji your account cannot use directly as image links when enabled
+- View full message history
+- Rich content display (embeds, attachments, stickers, and mentions)
+- Detect URLs in message bodies and markdown links, then open them in your default browser
+- Direct message shortcuts for copy, reply, edit, delete, reactions, URL opening,
+  and image viewing. More message actions are available from the action menu.
+
+#### Markdown Rendering
+
+![Markdown rendering example](./docs/markdown-example.png)
+
+Concord renders a practical subset of Discord-style Markdown in message bodies:
+
+- Headings: `# H1`, `## H2`, `### H3`
+- Quotes: `> quoted text`
+- Bullets: `- item` and `* item`
+- Inline styles: `**bold**`, `*italic*`, and `` `inline code` ``
+- Fenced code blocks with optional language labels, rendered as compact boxes
+- Raw URLs and markdown link destinations are underlined and can be opened from message actions
+
+### Reactions & Polls
+
+- View, add, and remove emoji reactions (Unicode and custom server emoji)
+- Use custom emoji from other servers as reactions when your account supports it
+- Browse who reacted with a specific emoji
+- View and vote on polls
+
+### Media & Images
+
+Image rendering is powered by [ratatui-image](https://github.com/benjajaja/ratatui-image). On startup, Concord queries the terminal to detect the best available graphics protocol. Supported protocols:
+
+- **Kitty Graphics Protocol** - Kitty, WezTerm, Ghostty, etc.
+- **iTerm2 Inline Images** - iTerm2, WezTerm, mintty, etc.
+- **Sixel** - foot, mlterm, xterm (if compiled with Sixel support), etc.
+- **Halfblocks** (fallback) - works on any terminal, but uses block characters instead of true pixels.
+
+If your terminal does not support any graphics protocol, images will be rendered as halfblock approximations. For the best experience, use a terminal that supports the Kitty or iTerm2 protocol.
+
+You can toggle image viewing on or off in the configuration file. When image viewing is off, attachments and emojis will be shown as text placeholders.
+
+### Members & Profiles
+
+- Member list with grouping
+- Presence indicators (Online, Idle, DND, Offline)
+- View User profile
+
+### Typing Indicators & Read State
+
+- Live "user is typing..." indicators
+- Unread message tracking with mention counts
+- Mark server, channel as read
+
+### Notifications
+
+- Desktop notifications for Discord messages that pass your Discord
+  notification settings
+- Active channel notifications are suppressed so Concord does not notify for
+  the conversation you are already viewing
+- Voice join and leave notification sounds while you are connected to voice.
+  You can keep the built-in tones or configure custom WAV files.
+
+### Navigation & Keyboard shortcuts
+
+> ⚠️ Keymap action names and default bindings may have breaking changes between releases.
+
+All default key settings in this section can be customized. See
+[Keymap options](./docs/keymap-options.md) for the config format and supported
+actions.
+
+Concord has a four-pane.
+**Guilds (1)**, **Channels (2)**, **Messages (3)**, **Members (4)**
+
+With default vim-style navigation:
+
+| Key                                       | Action                                          |
+| ----------------------------------------- | ----------------------------------------------- |
+| `1` `2` `3` `4`                           | Focus pane                                      |
+| `Tab` / `Shift+Tab`                       | Cycle focus forward / backward                  |
+| `h` / `l`, `←` / `→`                      | Move focus left / right                         |
+| `j` / `k`, `↑` / `↓`, `Ctrl+n` / `Ctrl+p` | Move down / up                                  |
+| `J`, `K` / `H`, `L`                       | Scroll viewport                                 |
+| `Ctrl+d` / `Ctrl+u`                       | Half-page scroll                                |
+| `Alt+h/l/←/→`                             | Resize focused pane width                       |
+| `gg` / `G`                                | Jump or scroll to top / bottom                  |
+| `Enter`                                   | Open or activate the selected item              |
+| `/`                                       | Filter Guilds/Channels, search Messages/Members |
+| `Space`                                   | Open leader shortcut window                     |
+| `i`                                       | Text insert mode                                |
+| `Esc`                                     | Close popup, cancel mode, or go back            |
+| `q`                                       | Quit Concord                                    |
+
+`Ctrl+n` and `Ctrl+p` are fixed row movement keys. The default `j` and `k`
+row movement keys are `SelectNext` and `SelectPrevious` and can be changed in
+`keymap.toml`.
+
+#### Leader key
+
+Press `Space` to open the leader shortcut window.
+
+| Key sequence     | Action                            |
+| ---------------- | --------------------------------- |
+| `Space`, `1`     | Toggle the Servers pane           |
+| `Space`, `2`     | Toggle the Channels pane          |
+| `Space`, `4`     | Toggle the Members pane           |
+| `Space`, `a`     | Open actions for the focused pane |
+| `Space`, `p`     | Open my profile settings          |
+| `Space`, `o`     | Choose concord option category    |
+| `Space`, `v`     | Voice command prefix              |
+| `Space`, `Space` | Open the fuzzy channel switcher   |
+
+#### Action menus
+
+Focus a pane, then press `Space`, `a` to open actions for that pane. Action
+shortcuts are shown inside the leader popup and only run when the action is
+enabled. In the Messages pane, the selected message also supports these direct
+shortcuts:
+
+Message shortcuts:
+
+| Shortcut | Action              | Description                                                 |
+| -------- | ------------------- | ----------------------------------------------------------- |
+| `y`      | Copy                | Copy the selected message text and show a short toast       |
+| `r`      | Add/remove reaction | Open the reaction picker for the selected message           |
+| `R`      | Reply               | Start a reply to the selected message                       |
+| `d`      | Delete              | Open a delete confirmation before deleting the message      |
+| `e`      | Edit                | Start editing the selected message when editing is allowed  |
+| `o`      | Open URL            | Open the selected message URL, or choose from multiple URLs |
+| `v`      | View attachment     | Open the selected message's attachment viewer               |
+
+Message action menu shortcuts:
+
+| Shortcut | Action                      | Description                                                 |
+| -------- | --------------------------- | ----------------------------------------------------------- |
+| `y`      | Copy                        | Copy the selected message text and show a short toast       |
+| `r`      | Add/remove reaction         | Open the reaction picker for the selected message           |
+| `R`      | Reply                       | Start a reply to the selected message                       |
+| `d`      | Delete                      | Open a delete confirmation before deleting the message      |
+| `e`      | Edit                        | Start editing the selected message when editing is allowed  |
+| `o`      | Open URL                    | Open the selected message URL, or choose from multiple URLs |
+| `v`      | View attachment             | Open the selected message's attachment viewer               |
+| `g`      | Go to referenced message    | Go to the replied or forwarded message                      |
+| `p`      | show message sender profile | Open the selected message author's profile                  |
+| `P`      | Pin / unpin                 | Open a pin or unpin confirmation for the selected message   |
+| `t`      | Open thread                 | Open the selected message's thread                          |
+| `u`      | Show reacted users          | Show users who reacted to the selected message              |
+| `c`      | Choose poll votes           | Choose poll votes for the selected message                  |
+
+When the attachment viewer is open, press `d` to download the current attachment directly.
+
+Server actions:
+
+| Shortcut | Action              | Description                                           |
+| -------- | ------------------- | ----------------------------------------------------- |
+| `m`      | Mark server as read | Mark all unread viewable channels in this server read |
+| `u`      | Mute / unmute       | Toggle server notification mute                       |
+| `l`      | Leave server        | Open a confirmation before leaving this server        |
+
+Channel actions:
+
+| Shortcut | Action               | Description                                  |
+| -------- | -------------------- | -------------------------------------------- |
+| `j`      | Join voice           | Join the selected voice channel              |
+| `l`      | Leave voice          | Leave the current voice channel              |
+| `p`      | Show pinned messages | Open the selected channel's pinned messages  |
+| `t`      | Show threads         | List threads for the selected channel        |
+| `m`      | Mark as read         | Mark the selected channel read               |
+| `u`      | Mute / unmute        | Toggle channel or category notification mute |
+
+Voice commands:
+
+| Sequence          | Action       | Description                               |
+| ----------------- | ------------ | ----------------------------------------- |
+| `Space`, `v`, `d` | Deafen voice | Toggle Concord's Discord voice deaf state |
+| `Space`, `v`, `m` | Mute voice   | Toggle Concord's Discord voice mute state |
+| `Space`, `v`, `l` | Leave voice  | Leave the current Concord voice channel   |
+
+#### Composer
+
+You can paste copied files into the composer to attach them. Pending uploads
+are shown above the input before sending.
+
+| Shortcut                   | Action            | Description                                                      |
+| -------------------------- | ----------------- | ---------------------------------------------------------------- |
+| `Ctrl+v`                   | paste clipboard   | Attach copied files or images when present, otherwise paste text |
+| `Ctrl+e`                   | open $EDITOR      | Open $EDITOR on the current draft for long editing               |
+| `Ctrl+c`                   | clear             | Clear current draft                                              |
+| `Ctrl+Left`/ `Ctrl+Right`  | Jump word         | Jump the cursor by word                                          |
+| `Ctrl+Backspace`/ `Ctrl+w` | Delete word       | Delete the word before the cursor                                |
+| `Delete`                   | Detach attachment | Removes the last pending attachment                              |
+
+#### Mention picker
+
+When the @mention picker is open, use `Up` / `Down`,
+`Ctrl+p` / `Ctrl+n`, `Tab`, or `Enter` to choose a mention.
+
+#### Emoji picker
+
+Type `:` plus at least two letters, such as `:he`, to pick Unicode, server, or
+cross-server custom emoji while writing a message.
+
+When `emojis_as_links` is enabled, custom emoji your account cannot send
+directly are inserted as Discord image links instead.
+
+To react from the composer, select a message, enter insert mode, then type
+`+:`. The reaction picker opens for that message. Press `/` to search, Enter to
+lock the filter, then Enter again or use a shown shortcut to react.
+
+#### Bot commands
+
+When the composer input starts with a slash `/`, the command suggestion popup
+
+## Configuration
+
+Concord options are stored under Concord's config directory. If
+`XDG_CONFIG_HOME` is set, Concord uses `$XDG_CONFIG_HOME/concord/config.toml`
+for app options and `$XDG_CONFIG_HOME/concord/keymap.toml` for key settings.
+Otherwise it uses the platform config directory. The usual fallback is
+`~/.config/concord/config.toml` and `~/.config/concord/keymap.toml` on Linux,
+matching files under `~/Library/Application Support/concord/` on macOS, and the
+roaming AppData config directory on Windows.
+
+You can change some configuration from the in-app Options menu, and Concord saves them back
+to `config.toml`. Key settings are read from `keymap.toml`.
+
+<details>
+<summary>Default config</summary>
+
+```toml
+[display]
+# Master switch that hides all image previews when true.
+disable_image_preview = false
+
+# Show user avatars next to messages and in profile views.
+show_avatars = true
+
+# Render inline image previews for attachments and embeds.
+show_images = true
+
+# Preview quality: efficient, balanced, high, or original.
+image_preview_quality = "balanced"
+
+# Render custom Discord emoji as images when possible.
+show_custom_emoji = true
+
+# Crop avatars into circles instead of showing square images.
+circular_avatars = false
+
+[composer]
+# Send custom emoji your account cannot use directly as image links.
+emojis_as_links = false
+
+[notifications]
+# Show desktop notifications for Discord messages that pass notification rules.
+desktop_notifications = true
+
+# Optional notification icon to include in notifications. May not work on all platforms.
+# When unset, no icon is used. It must either be a name of an icon (typically in /usr/share/icons)
+# or a path to an icon.
+notification_icon = "/path/to/icon.svg"
+
+# Optional WAV files for voice join and leave notification sounds.
+# When unset, Concord uses built-in generated tones.
+voice_join_sound = "/path/to/join.wav"
+voice_leave_sound = "/path/to/leave.wav"
+
+[voice]
+# Join or update Discord voice with Concord self-muted.
+self_mute = false
+
+# Join or update Discord voice with Concord self-deafened.
+self_deaf = false
+
+# Allow microphone transmit while this session is joined and not self-muted.
+allow_microphone_transmit = false
+
+# Voice activity threshold in dB. Lower values transmit quieter input.
+microphone_sensitivity = -30
+
+# Microphone input volume percentage, from 0 to 100.
+microphone_volume = 100
+
+# Received voice playback volume percentage, from 0 to 100.
+voice_output_volume = 100
+```
+
+</details><br>
+
+`image_preview_quality` supports these values:
+
+- `efficient`: smaller preview requests to reduce bandwidth and memory use.
+- `balanced`: default quality with bounded resource use.
+- `high`: sharper resized previews using lossless quality.
+- `original`: request the original source image for previews when possible.
+
+This setting only applies to attachment, embed, and attachment viewer previews.
+Avatars and custom emoji keep their separate small-image behavior.
+
+<details>
+<summary>Default keymap config</summary>
+
+```toml
+[keymap]
+leader = "space"
+StartComposer = "i"
+OpenPaneFilter = "/"
+FocusGuildPane = "1"
+FocusChannelPane = "2"
+FocusMessagePane = "3"
+FocusMemberPane = "4"
+SelectNext = "j"
+SelectPrevious = "k"
+CycleFocusNext = { keys = ["tab", "l", "right"] }
+CycleFocusPrevious = { keys = ["<S-tab>", "h", "left"] }
+HalfPageDown = "<C-d>"
+HalfPageUp = "<C-u>"
+ScrollViewportDown = "J"
+ScrollViewportUp = "K"
+JumpTop = "gg"
+JumpBottom = "G"
+ScrollHorizontalLeft = "H"
+ScrollHorizontalRight = "L"
+ResizePaneLeft = { keys = ["<A-h>", "<A-left>"] }
+ResizePaneRight = { keys = ["<A-l>", "<A-right>"] }
+Quit = "q"
+CopyMessage = "y"
+ReactMessage = "r"
+ReplyMessage = "R"
+DeleteMessage = "d"
+EditMessage = "e"
+OpenMessageUrl = "o"
+ViewMessageAttachment = "v"
+ToggleGuildPane = "<leader>1"
+ToggleChannelPane = "<leader>2"
+ToggleMemberPane = "<leader>4"
+OpenFocusedPaneAction = "<leader>a"
+OpenCurrentUserProfile = "<leader>p"
+OpenOptions = "<leader>o"
+ChannelSwitcher = "<leader><leader>"
+VoiceDeafen = "<leader>vd"
+VoiceMute = "<leader>vm"
+VoiceLeave = "<leader>vl"
+
+[keymap.groups]
+"<leader>v" = "Voice"
+
+[keymap.guild_actions]
+MarkAsRead = "m"
+MuteServer = "u"
+LeaveServer = "l"
+
+[keymap.channel_actions]
+JoinVoice = "j"
+LeaveVoice = "l"
+ShowPinnedMessages = "p"
+ShowThreads = "t"
+MarkAsRead = "m"
+MuteChannel = "u"
+
+[keymap.message_actions]
+CopyMessage = "y"
+ReactMessage = "r"
+ReplyMessage = "R"
+DeleteMessage = "d"
+EditMessage = "e"
+OpenMessageUrl = "o"
+ViewMessageAttachment = "v"
+GoToReferencedMessage = "g"
+ShowMessageProfile = "p"
+PinMessage = "P"
+OpenThread = "t"
+ShowReactionUsers = "u"
+OpenPollVotePicker = "c"
+
+[keymap.member_actions]
+ShowProfile = "p"
+
+[keymap.composer]
+OpenEditor = "<C-e>"
+PasteClipboard = "<C-v>"
+InsertNewline = { keys = ["<S-enter>", "<C-enter>", "<A-enter>"] }
+Submit = "enter"
+Close = "esc"
+ClearInput = "<C-c>"
+RemoveLastAttachment = "delete"
+DeletePreviousChar = "backspace"
+DeletePreviousWord = { keys = ["<C-backspace>", "<C-w>"] }
+MoveCursorUp = "up"
+MoveCursorDown = "down"
+MoveCursorWordLeft = "<C-left>"
+MoveCursorLeft = "left"
+MoveCursorWordRight = "<C-right>"
+MoveCursorRight = "right"
+MoveCursorHome = "home"
+MoveCursorEnd = "end"
+```
+
+</details><br>
+
+You can customize key bindings. Check the [Keymap options](./docs/keymap-options.md) for the config format, supported actions.
+
+## Performance
+
+Concord is designed to stay lightweight in normal terminal use. In observed
+typical use, it usually uses about 20-40 MB of memory.
+
+Image-heavy screens can temporarily use more memory because compressed image
+bytes need to be decoded before they can be rendered in the terminal. When many
+images are loaded, memory can briefly rise to around 100-200 MB while decoding
+and then drop again as work completes and caches are pruned.
+
+To keep resource usage bounded, Concord limits media work in several places:
+
+- Attachment previews are downloaded with an 8 MiB per-preview cap.
+- Attachment downloads are capped at 64 MiB.
+- Up to 4 attachment previews are fetched at once.
+- Up to 2 inline image previews are decoded at once.
+- Inline image previews, avatars, and custom emoji use small LRU caches.
+- Image preview requests prefer resized Discord proxy URLs sized for the
+  terminal instead of original full-size media when possible.
+- The preview quality preset can lower preview source dimensions or opt into
+  original source images. It does not change avatar or custom emoji sizing.
+
+Message history is also cached with a per-channel limit, so long-running
+sessions do not keep every message in memory forever.
+
+## FAQ
+
+### Can my account be blocked?
+
+Honestly, no.
+
+There are some path that did trigger a account block:
+
+- Trying to **create a new DM channel and send a message to an unknown user**(meaning there was no pre-existing DM created through the Discord client) can immediately block your account temporarily.
+- Some features that requires a hCapcha challenge on Discord's side.
+
+Other features have not caused blocks in my testing.
+
+That said, Concord is not an official Discord client. Using unofficial clients, automated user accounts, or self-bots can violate Discord's TOS, so there is always some risk. Use it at your own discretion.
+
+### Does Concord support CAPTCHA?
+
+No. If Discord requires a CAPTCHA during login, use token login instead.
+
+## Security
+
+- Tokens are stored as **plain text** in Concord's config directory. So keep that file secure and do not share it. You can use the token from that file to log in to the official Discord client, so treat it like a password.
+- On Unix, the credential's parent directory is created with `0700` and the credential file with `0600` permissions.
+- All concord state (config, keymap, credential, log) lives under a single `concord/` directory inside `XDG_CONFIG_HOME` when it is set, or inside the platform config directory otherwise.
+- No system keychain integration yet.
+
+## Contributing
+
+Any issues, pull requests, and feedback are welcome. See [CONTRIBUTING.md](./CONTRIBUTING.md) for details.
+
+## License
+
+Concord is licensed under GPL-3.0-only.