oiupoyt/discordo
1
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Better docs

Browse source
This commit is contained in:
ayn2op 2023-06-21 17:20:21 +05:30
parent bb53c7c11e
commit 1cc238c3a9
3 changed files with 31 additions and 44 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -68,14 +68,6 @@ sudo mv ./discordo /usr/local/bin
[Here.](./docs)
### Configuration
A default configuration file is created on first start-up at `$HOME/.config/discordo/config.yml` on Unix, `$HOME/Library/Application Support/discordo/config.yml` on Darwin, and `%AppData%/discordo/config.yml` on Windows.
Optionally, you can specify an alternative configuration file location with the `config` command-line flag to the executable (eg: `--config OPTIONAL/PATH/HERE.yml`).
Similarly, a log file is created on first start-up at `$HOME/.cache/discordo/logs.txt` on Unix, `$HOME/Library/Caches/discordo/logs.txt` on Darwin, and `%LocalAppData%/discordo/logs.txt` on Windows.
## 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.

31
docs/README.md
View file

@ -30,36 +30,9 @@ Use the `--token` flag:
discordo --token "OTI2MDU5NTQxNDE2Nzc5ODA2.Yc2KKA.2iZ-5JxgxG-9Ub8GHzBSn-NJjNg"
```
## Keybindings
## Logs
Keybindings are configurable in the [configuration file](#configuration).
| Action | Keybinding |
| --------------------- | ---------- |
| **Guilds Tree** | |
| Focus | Alt + g |
| | |
| **Messages Text** | |
| Focus | Alt + m |
| Show image | i |
| Copy message content | c |
| Reply without mention | r |
| Reply with mention | R |
| Select reply | s |
| Reply previous | Up arrow |
| Select next | Down arrow |
| Select first | Home |
| Select last | End |
| | |
| **Message Input** | |
| Focus | Alt + i |
| Send message | Enter |
| Paste from clipboard | Ctrl + v |
| Launch editor | Ctrl + e |
## Log files
The log file is stored in the following location:
The log file is created on first start-up at the following location:
| Operating System | Log File Location |
| ---------------- | ---------------------------------------- |

36
docs/configuration.md
View file

@ -1,7 +1,6 @@
## Configuration
# Configuration
The configuration file allows you to edit keybindings or change the theme.
By default, it is stored in the following location:
The configuration file allows you to customize behavior, keybindings, and theme of the application. It is created on first start-up at the following location:
| Operating System | Configuration File Location |
| ---------------- | ------------------------------------------------------- |
@ -9,8 +8,31 @@ By default, it is stored in the following location:
| Darwin | `$HOME/Library/Application Support/discordo/config.yml` |
| Windows | `%AppData%/discordo/config.yml` |
You can also use the `--config` flag to specify a different location for the configuration file:
Optionally, you can specify a different location for configuration file with the `config` command-line flag to the executable (eg: `--config foo/bar/conf.yml`).
```
discordo --config "/foo/bar/config.yml"
```
## Keybindings
Keybindings are configurable in the [configuration file](#configuration).
| Action | Keybinding |
| --------------------- | ---------- |
| **Guilds Tree** | |
| Focus | Alt + g |
| | |
| **Messages Text** | |
| Focus | Alt + m |
| Show image | i |
| Copy message content | c |
| Reply without mention | r |
| Reply with mention | R |
| Select reply | s |
| Reply previous | Up arrow |
| Select next | Down arrow |
| Select first | Home |
| Select last | End |
| | |
| **Message Input** | |
| Focus | Alt + i |
| Send message | Enter |
| Paste from clipboard | Ctrl + v |
| Launch editor | Ctrl + e |