discord-cli

command module
v0.3.0-alpha Latest Latest
Warning

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

Go to latest
Published: Mar 3, 2016 License: GPL-2.0 Imports: 13 Imported by: 0

README

discord-cli

Minimalistic Command-Line Interface for Discord

Master (Semi-Stable): Build Status, Develop (Default Git Branch): Build Status

Join our Discord Chat! https://discord.gg/0pXWCo5RQbVuFHDM

I suck at English, while 256 colors is enough for everyone

Disclaimer: Currently only tested on Linux. It also looks pretty bad in its current state.

How to Install the Master branch?

Currently the easiest working way to install is to use the Go tools. I'm looking at using GCCGO and makefiles to reduce installation steps, and make setting PATHS unnecessary.

  • Install the Go Tools and setup the $GOPATH (There are loads of tutorial for this part)
  • $ go get -u github.com/Rivalo/discord-cli
  • Go to the bin folder inside your $GOPATH
  • ./discord-cli

For trying the develop branch, do a git checkout and reinstall the application.

(Master) Configuration Settings

Configuration files are being stored in JSON format and are automatically created when you first run discord-cli. Do not change the 'key' value inside {"key":"value"}, this is the part that discord-cli uses for parsing, missing keys will definitely return errors.

Setting Function
username Discord Username (emailaddress)
password Discord Password
guild Default Discord Server (Currently null because this function does not work yet)
channel Default Discord Text Channel (Currently null because this function does not work yet)

NOTE: The Configuration settings are likely to change. Breaking updates are stated in the release section. To solve problems, delete ~/.config/discord-cli/config.json and restart discord-cli.

(Master) Chat Commands

When inside a text channel, the following commands are available:

Command Function
:q Quits discord-cli
:d 'Disconnect' Guild and go back to selection menu
:c Change listening Channel inside Guild

Documentation

Overview

This file provides a basic "quick start" example of using the Discordgo package to connect to Discord using the New() helper function.

Directories

Path Synopsis
Package DiscordState is an abstraction layer that gives proper structs and functions to get and set the current state of the cli server
Package DiscordState is an abstraction layer that gives proper structs and functions to get and set the current state of the cli server

Jump to

Keyboard shortcuts

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