~kris/9p

disco

61492f46cf90e21bac4fbd22540dfe72c9933117 — Sean Hinchee 7 years ago 1fd35b9
clean up
1 files changed, 0 insertions(+), 55 deletions(-)

D README.theboxmage.md
D README.theboxmage.md => README.theboxmage.md +0 -55
@@ 1,55 0,0 @@
 # discord-cli
Minimalistic Command-Line Interface for Discord

I haven't tried to mess with the AUR yet, if I ever will, so it is unlikely that anyone has found this.

Regardless, most of this isn't my work. Most of it was done by a github user that goes by Rivalo.
All I have done is implemented private messaging, and while I plan to do more, that does not change
how little work done here that is mine.

Questions can be answered at my discord server, which at the time of editing is empty:

https://discord.gg/qp2Q8jB

## Current build status
[![build status](https://gitlab.com/chamunks/discordcli/badges/master/build.svg)](https://gitlab.com/chamunks/discordcli/commits/master)


## Screenshots

What does chat look like with 256 color sweg.
![ChatExample](screenshots/screenshotChat.png)

Pressing ```:G + ENTER``` opens the guild[Server] selector.
![GuildsExample](screenshots/screenshotGuilds.png)

Pressing ```:C + ENTER``` opens the Channel selector.
![ChannelsExample](screenshots/screenshotChannels.png)

### 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/theboxmage/discordcli`
* Go to the `bin` folder inside your `$GOPATH`
* `./discord-cli`

### (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 |
| messagedefault| (true or false) Display messages automatically|
| messages   | Amount of Messages kept in memory |

### (Master) Chat Commands
When inside a text channel, the following commands are available:

| Command       | Function         |
| ------------- |-------------|
| :q      | Quits discord-cli |
| :g      | Change listening Guild|
| :c      | Change listening Channel inside Guild |
| :m [n]      | Display last [n] messages: ex. `:m 2` displays last two messages |
| :p      | Pulls up the private channel menu |