104 lines
3.7 KiB
Markdown
104 lines
3.7 KiB
Markdown
# 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 is a lightweight, secure, and feature-rich Discord terminal client. Heavily work-in-progress, expect breaking changes.
|
|
|
|
|
|
|
|
## Features
|
|
|
|
- Lightweight
|
|
- Configurable
|
|
- Mouse & clipboard support
|
|
- Notifications
|
|
- 2-Factor authentication
|
|
- Discord-flavored markdown
|
|
|
|
## Installation
|
|
|
|
### Prebuilt binaries
|
|
|
|
You can download and install a [prebuilt binary here](https://nightly.link/ayn2op/discordo/workflows/ci/main) for Windows, macOS, or Linux.
|
|
|
|
### Package managers
|
|
|
|
- Arch Linux: `yay -S discordo-git`
|
|
- FreeBSD: `pkg install discordo` or via the ports system `make -C /usr/ports/net-im/discordo install clean`.
|
|
- Nix (NixOS, home-manager)
|
|
- Downstream nixpkgs installation: Add `pkgs.discordo` to `environment.systemPackages` or `home.packages`.
|
|
<!-- Temporary until downstream home-manager module -->
|
|
- Upstream flake installation: Add `inputs.discordo.url = "github:ayn2op/discordo"`. Install using `inputs.discordo.homeModules.default` (`.enable, .package, .settings TOML`).
|
|
- Windows (Scoop):
|
|
|
|
```sh
|
|
scoop bucket add vvxrtues https://github.com/vvirtues/bucket
|
|
scoop install discordo
|
|
```
|
|
|
|
### Building from source
|
|
|
|
```bash
|
|
git clone https://github.com/ayn2op/discordo
|
|
cd discordo
|
|
go build .
|
|
```
|
|
|
|
### Linux clipboard support
|
|
|
|
- `xclip` or `xsel` for X11 (`apt install xclip`)
|
|
- `wl-clipboard` for Wayland (`apt install wl-clipboard`)
|
|
|
|
## Usage
|
|
|
|
1. Run the `discordo` executable with no arguments.
|
|
|
|
> If you are logging in using an authentication token, provide the `token` command-line flag to the executable (eg: `--token "OTI2MDU5NTQxNDE2Nzc5ODA2.Yc2KKA.2iZ-5JxgxG-9Ub8GHzBSn-NJjNg"`). The token is stored securely in the default OS-specific keyring.
|
|
|
|
2. Enter your email and password and click on the "Login" button to continue.
|
|
|
|
## Configuration
|
|
|
|
The configuration file allows you to configure and customize the behavior, keybindings, and theme of the application.
|
|
|
|
- Unix: `$XDG_CONFIG_HOME/discordo/config.toml` or `$HOME/.config/discordo/config.toml`
|
|
- Darwin: `$HOME/Library/Application Support/discordo/config.toml`
|
|
- Windows: `%AppData%/discordo/config.toml`
|
|
|
|
[The default configuration can be found here](./internal/config/config.toml).
|
|
|
|
## FAQ
|
|
|
|
### Manually adding token to keyring
|
|
|
|
Do this if you get the error:
|
|
|
|
> failed to get token from keyring: secret not found in keyring
|
|
|
|
#### MacOS
|
|
|
|
Run the following command in a terminal window with `sudo` to create the `token` entry.
|
|
|
|
```sh
|
|
security add-generic-password -s discordo -a token -w "DISCORD TOKEN HERE"
|
|
```
|
|
|
|
#### Linux
|
|
|
|
1. Start the keyring daemon.
|
|
|
|
```sh
|
|
eval $(gnome-keyring-daemon --start)
|
|
export $(gnome-keyring-daemon --start)
|
|
```
|
|
|
|
2. Create the `login` keyring if it does not exist already. See [GNOME/Keyring](https://wiki.archlinux.org/title/GNOME/Keyring) for more information.
|
|
|
|
3. Run the following command to create the `token` entry.
|
|
|
|
```sh
|
|
secret-tool store --label="DISCORD TOKEN HERE" service discordo username token
|
|
```
|
|
|
|
4. When it prompts for the password, paste your token, and hit enter to confirm.
|
|
|
|
> [!IMPORTANT]
|
|
> Automated user accounts or "self-bots" are against Discord's Terms of Service. I am not responsible for any loss caused by using "self-bots" or Discordo.
|