discordo/README.md
rigormorrtiss e2b144d3a6 Add clipboard support (#21)
* Add clipboard support

* Add "Clipboard" heading to "Getting Started" sect.
2021-08-08 22:31:49 +04:00

49 lines
1.1 KiB
Markdown

# discordo
[WIP] Discordo is a terminal-based Discord client that aims to be lightweight, secure, and feature-rich.
![Preview](assets/preview.png)
## Features
- Lightweight
- Easy-to-use
- Secure
- Cross-platform
- Configurable
- Discord-flavored markdown
- Clipboard support
## Installation
### Building
```bash
git clone https://github.com/rigormorrtiss/discordo
cd discordo && go build
# optional
sudo mv ./discordo /usr/local/bin
```
## Getting Started
- Run the built executable in a new Terminal.
- Choose the preferred login method.
- Log in using the chosen login method and click on "Login" button to continue.
### Default Keybindings
- `Ctrl` + `G`: Sets the focus on the guilds dropdown.
- `Ctrl` + `J`: Sets the focus on the channels treeview.
- `Ctrl` + `K`: Sets the focus on the messages textview.
- `Ctrl` + `L`: Sets the focus on the message inputfield.
### Clipboard
- Requires `xclip` or `xsel` for X11.
- Requires `wl-clipboard` for Wayland.
## Disclaimer
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.