cordless

command module
v0.0.0-...-4e52b7f Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 1, 2019 License: BSD-3-Clause Imports: 1 Imported by: 0

README

Cordless

OS Build-Status
linux CircleCI
darwin Build Status
windows Build status

Overview

Cordless is supposed to be a custom Discord client that aims to have a low memory footprint and be aimed at powerusers.

This project was mainly inspired by Southclaws Cordless, which he sadly didn't develop any further.

The application only uses the official Discord API and doesn't send data to any third party.

This application is currently a WIP and will change rather fast.

Cordless 26th January 2019

How to install it

Using pre-built binaries

Currently every commit triggers a build for windows and linux, those builds each produce ready to use binaries. The builds can be found at the top, by clicking on the respective builds badges.

Building it from source

First you have to grab the code via:

go get github.com/Bios-Marcel/cordless

In order to execute this command you need to have go installed.

In order to execute the application, simply run 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.

Configuration

You have got two login choice, either you use your username and password or you use your current authentication token. Using your password only works if your account does not have Two-Factor authentication, which is you should use!

Besides your login data / token, cordless doesn't need anything else. The application will ask you to input the token in case it can't be found.

In order to retrieve your token, simply follow the steps in the graphic below:

Steps to retrieve discord token - by ripcord

After retrieving the token, you have to insert it into the input prompt.

Alternative, you can manually insert it into your configuration file. In order to find the location of the configuration file, simply run cordless via your terminal and check the output, as it will tell you, where its configuration file lies.

The token will be saved on your machine, but it won't be encrypted, so be careful with your configuration file.

Features

  • Guilds
    • Enter channels
    • See channels
    • See members
  • Channels
    • See NSFW flag
    • See group
    • See topic
  • Members
    • See Nickname
    • See hoist group
  • Chatting
    • 1on1 conversation with a friend
    • Groupchats
    • Talk in a channel
    • Timestamps HH:MM(:SS)
  • See all your friends
  • Messages
    • Send messages
    • Mention people using their full username or nickname
    • Mention a channel
    • Edit last message
    • Delete last message
    • Multiline
    • Highlighting
      • Code
      • Mentions (Channels/Users)
    • Special highlighting when you get mentioned
    • Send Emojis with :name:
  • Custom layout to a specific point
  • Notifications
    • System notifications on mention (not considering muted servers and such)
    • Mark channels read when unread messages in the current session exist
    • Prefix channel with (@You) if you got mentioned

Troubleshooting

If you happen to encounter a crash or a bug, please submit a bug request.

In case that you simply can't use any shortcuts that the application has, this might be due to your terminal emulator accepting those instead of letting cordless handle them.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
ui

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL