Hey, so I know this is somewhat of a bummer, but I got banned because of ToS violation today. As that's basically a confirmation for what we've believed would never be enforced, I decided to not work on the cordless project anymore. I'll be taking down cordless in package managers in hope that no new users will install it anymore, especially less illiterate ones. I believe that if you manage to build it yourself, you've probably read the README and are aware of the risks. I'll keep the repository up for now and see what I'll do with it. Might archive it, might delete it, I am unsure. Either way, thanks for sticking around everyone :)
- 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. There have already been cordless users that got banned, including me (Bios-Marcel, the maker and maintainer)
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.
If you don't want to build the application yourself or use some kind of package management system, you can get the latest binaries for the three major systems in the release overview:
https://github.com/Bios-Marcel/cordless/releases/latest
In order to execute the following commands, you need to install go 1.13 or higher. You can find golang packages at https://golang.org/doc/install. On top of that, you need to have git installed. It can be fund at https://git-scm.com/downloads.
UPDATES HAVE TO BE INSTALLED MANUALLY
Open a command line and execute the following commands:
git clone https://github.com/Bios-Marcel/cordless.git
cd cordless
go build
This will create an executable file called cordless
or cordless.exe
depending on whether you are on Windows or not. Move that file anywhere
that your terminal can find it. I recommend adding a bin
folder to your
user home and adding it to your systems PATH
variable. Please search the
internet, using your favourite search engine, for
how to set an environment variable in XXX
in order to update your PATH
variable correctly.
For updateing you simply have to delete the folder you downloaded last time and repeat the instructions.
Note:
- X11 users need
xclip
in order to copy and paste. - Wayland users need
wl-clipboard
in order to copy and paste. - Mac OS users need
pngpaste
in order to copy and paste images.
YOUR PASSWORD IS NEVER SAVED LOCALLY.
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
in front of
the token.
If you need to find out how to retrieve your token, check the wiki.
Currently captcha-code login isn't supported. Thanks for your SHIT-API, Google
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.
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
In order to find answers to common questions, check out the FAQ in the wiki:
https://github.com/Bios-Marcel/cordless/wiki/FAQ
- 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 servers
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.
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.
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.