Code Monkey home page Code Monkey logo

cordless's Introduction

Cordless

Overview

WARNING: Third party clients are discouraged and against the Discord TOS.

Cordless is supposed to be 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 any third party. However, this application is not a official product by Discord Inc.

Demo Screenshot

Installation

Installing on Linux

Snap

On linux the recommended way of installation is the snap.

Simply 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:

Manually:
$ git clone https://aur.archlinux.org/cordless-git.git
$ cd cordless-git
$ makepkg -sric
With AUR Helpers:
yay:
$ yay -Syu cordless-git

or

$ yay -S cordless-git
trizen:
$ trizen -S cordless-git
pacaur
$ pacaur -S cordless-git

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.

Building from source

In order to execute the following commands you need to have go 1.12 or a more recent version installed.

If you have a go version lower than 1.13, you need make sure to set the environment variable GO111MODULE to on.

UPDATES HAVE TO BE INSTALLED MANUALLY

You can either install the binary into your $GOPATH/bin by running:

go get -u github.com/Bios-Marcel/cordless

Which you can then execute by running the executable, which lies at $GOPATH/bin/cordless. In order to be able to run this from your terminal, $GOPATH/bin has to be in your PATH variable. The very same command can be used for updating.

or you manually grab the source:

git clone https://github.com/Bios-Marcel/cordless
cd cordless
go build .

If done this way, updates have to be installed via:

cd cordless
git pull
go build .

Note:

  • X11 users need xclip in order to copy and paste.
  • Wayland users need wl-clipboard in order to copy and paste.

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

Check the wiki

Troubleshooting

If you happen to encounter a crash or a bug, please submit a bug report via the projects GitHub issue tracker. It's highly likely that issues messaged via discord will be forgotten.

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

Why should or shouldn't you use this project

Reasons to use it:

  • Your PC is not very powerful
  • You're on a mobile device and value your battery life
  • You want to reduce your bandwidth usage
  • You just like terminal applications

Reasons not to use it:

  • You like fancy GUI
  • You want to see images, videos and whatnot inside of the application itself
  • You need the voice/video calling features (This might soon change!)
  • You need to administrate a server (no administration features yet)

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 isolating 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.

If none of those ways of contributing are your kind of thing, feel free to donate something via Liberapay. It may not directly have an impact on the project, but it will surely motivate me to keep working on this project, as it shows that people care about it. Also, who doesn't like money???

For those who don't want to use paypal, but still want to donate, here's my ETH wallet public key: 0x49939106563a9de8a777Cf5394149423b1dFd970

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.

cordless's People

Contributors

bios-marcel avatar avahe-kellenberger avatar 2qar avatar intexisty avatar marvinklar avatar misuto avatar pkfln avatar ndagestad avatar spacemud avatar fl4ke avatar joshiemoore avatar southclaws avatar 0xflotus avatar sacules avatar pegasusepsilon avatar polyzium avatar oneechanhax avatar torstehu avatar ariqfadlan avatar roket1428 avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.