c0152662f0
* Add safe-guard to avoid nuking a whole hard-drive due to a potential bug * save files with their attachment UUID instead of filename, to avoid clashes * move main-code of the feature into a new package (file) |
||
|---|---|---|
| .circleci | ||
| .github | ||
| app | ||
| commands | ||
| config | ||
| discordutil | ||
| femto | ||
| fileopen | ||
| readstate | ||
| scripting | ||
| shortcuts | ||
| snap | ||
| syntax | ||
| times | ||
| tools | ||
| tview | ||
| ui | ||
| util | ||
| version | ||
| .gitignore | ||
| .travis.yml | ||
| LICENSE | ||
| README.md | ||
| appveyor.yml | ||
| cordless.json | ||
| cordless.json_template | ||
| cordless.rb_template | ||
| flags_windows.go | ||
| go.mod | ||
| go.sum | ||
| main.go | ||
| main_debug.go | ||
| release.sh | ||
| version.go_template | ||
README.md
Cordless
![](https://img.shields.io/appveyor/ci/Bios-Marcel/cordless?label=windows&logo=windows&logoColor=white")
Overview
- Credits
- How to install it
- Login
- Quick overview - Navigation (switching between boxes / containers)
- Extending Cordless via the scripting interface
- Contributing
- This project isn't for you, if
- Similar projects
- Troubleshooting
WARNING: Third party clients are discouraged and against the Discord TOS.
Cordless is a custom Discord client that aims to have a low memory footprint and be aimed at power-users.
The application only uses the official Discord API and doesn't send data to third parties. However, this application is not an official product by Discord Inc.
Installation
Building from source
In order to execute the following command, you need to install go 1.13 or higher. You can find golang packages at (https://golang.org/doc/install).
UPDATES HAVE TO BE INSTALLED MANUALLY
Make sure $GOPATH/bin is in your systems PATH variable, since the
binary will be put into that folder. Afterwards install or update cordless
via the command:
go get -u github.com/Bios-Marcel/cordless
Note:
- X11 users need
xclipin order to copy and paste. - Wayland users need
wl-clipboardin order to copy and paste. - Mac OS users probably want
pngpastein order to copy and paste.
Installing on Linux
Snap
Currently I can't release new snap versions due to a bug!
Run (Might require sudo):
snap install cordless
Snap will automatically install updates.
Arch based Linux distributions
On Arch based distributions, you can use the AUR package to install cordless:
$ git clone https://aur.archlinux.org/cordless-git.git
$ cd cordless-git
$ makepkg -sric
or use your favourite AUR helper.
Installing on Windows
In order to install the latest version on Windows, you first need to install scoop.
After installing scoop, run the following:
This adds the bucket (repository) that contains cordless to your local scoop installation, allowing you to install any package it contains. Afterwards it installs cordless for your current windows user.
scoop bucket add biosmarcel https://github.com/Bios-Marcel/scoopbucket.git
scoop install cordless
Updates can be installed via:
scoop update cordless
Installing on macOS
Use Homebrew to install cordless on macOS:
brew tap Bios-Marcel/cordless
brew install cordless
If you don't install via cordless via brew, then you should have to get
pngpaste in order to be able to paste image data.
Login
Logging in works via the UI on first startup of the application.
If you are logging in with a bot token, you have to prepend Bot (yes, with
the space) in front of the token. Pasting only works via your terminals normal
pasting shortcut.
YOUR PASSWORD IS NEVER SAVED LOCALLY.
If you need to find out how to retrieve your token, check the wiki.
Currently captcha-code login isn't supported.
Quick overview - Navigation (switching between boxes / containers)
| Shortcut | Action |
|---|---|
| Alt + S | Sets the focus on the servers (guilds) container |
| Alt + C | Sets the focus on the channels container |
| Alt + T | Sets the focus on the messages container |
| Alt + M | Sets the focus on the messages input field |
| Alt + U | Sets the focus on the users container |
| Alt + P | Opens the direct messages container |
| Alt + . | Toggles the internal console view |
Further shortcuts / key-bindings can be found in the manual on the internal
console with the command manual.
If any of the default commands don't work for you, open the keyboard shortcut changer via Ctrl + K.
Extending Cordless via the scripting interface
Troubleshooting
If you happen to encounter a crash or a bug, please submit a bug report via the projects GitHub issue tracker. Bugs reported via Discord will probably be forgotten or overseen.
For general problems faced by cordless users, check out the wiki at: https://github.com/Bios-Marcel/cordless/wiki/Troubleshooting
If you need help or have questions that you don't want to create an issue for, just join our Discord server: https://discord.gg/fxFqszu
FAQ
In order to find answers to common questions, check out the FAQ in the wiki:
https://github.com/Bios-Marcel/cordless/wiki/FAQ
This project isn't for you, if
- You like fancy GUI
- You want to see images, videos and whatnot inside of the application itself
- You need the voice/video calling features
- You need to manage or moderate server
Contributing
All kinds of contributions are welcome. Whether it's correcting typos, fixing
bugs, adding features or whatever else might be good for the project. If you
want to contribute code, please create a new branch and commit only changes
relevant to your planned pull request onto that branch. This will help
to isolate new changes and make merging those into master easier.
If you encounter any issues, whether it's bugs or the lack of certain features, don't hesitate to create a new GitHub issue.
If there are specific issues you want to be solved quickly, you can set a bounty on those via IssueHunt. The full 100% of the bounty goes to whoever solves the issue, no matter whether that's me or someone else.
Similar projects
Here is a list of similar projects:
Hit me up if you have a similar project, and I'll gladly add it to the list.
Credits
Big thanks to JetBrains for providing the cordless project with free licenses!
This project was mainly inspired by Southclaws Cordless, which he sadly didn't develop any further.