Giter Site home page Giter Site logo

terminal-discord's Introduction

Terminal-Discord

terminal-discord

A simple terminal based client for Discord using the discord.js API.

If you have any questions feel free to join this server.

Installation

Install with npm install -g terminal-discord

Config-File

The default locations for the config file are ~/.config/terminal-discord or ~/.terminal-discord. It is however also possible to pass a path to a config file like such

$terminal-discord PATH_TO_CONFIG

All settings except Token are optional. Defaults can be found at the beginning of index.js where the config-file is parsed.

Check the example config in the repository for an example.

token

Discord has made token retrieval more difficult after recent updates. To find your token you have to navigate to the discord browser site, open the developer tools with ctrl+shift+i or similar and find the local storage as shown in the picture.

Once you reload the page the token will pop up for about a second. Copy it and paste it in the config-file.

Token

max_name_length

The maximum length of usernames. If the value is null usernames are not cut short.

allign

If set to false the seperators will be displayed right after the username instead of them being alligned with other seperators.

right_bound

If allign is set to true then this option controls whether names are leftbound or rightbound.

separator

Separator between username and message content.

history_length

Number of messages loaded at a time. If set to null will fetch as many messages as there are rows in the current terminal window.

default_guild

If not null this corresponds to the index of the guild you want selected at startup.

default_channel

If not null this corresponds to the index of the channel you want selected at startup.

To get the indices for both guild and channel navigate to your channel and use the /info command.

prompt

The prompt used.

%u is replaced by your usernmame.

%d by your nickname if present otherwise username.

%c will be replaced by the channel name.

%g is replaced by the guild name.

color_support

Wether color for usernames is enabled or not.

default_color

Default color for users without a role. If not set will default to #FFFFFF.

mention_color

What background color the message should have when you get mentioned. Only applicable when colorsupport is enabled. Setting this to null disables the feature.

repeat_name

When a user sends multiple messages in a row this controls whether their name should be displayed multiple times or be replaced with a dot.

use_nickname

Whether the nickname should be displayed when available.

show_time

Show the timestamp next to a message.

show_date

Enable date support to display DD.MM.YYYY in front of the time.

Commands

Enter a command while in a channel using /.

q or quit: exits the client

u, update, r, refresh: refreshes manually

nick: changes your nickname

d, delete: deletes the last sent message

e, edit: replace the content of your last sent message with the string after /e. Pressing tab after "/edit " fills in the previous message.

c, channel: select a different channel within the same guild

m, menu: open the channel selection menu to switch to a different channel

o, online: show a list of currently online users

g, gr, group: open group chat selection menu to switch to a different channel

dm, pm: open dm chat selection menu to switch to a different channel

i, info: display basic information about the channel including indices

Note that edit and delete only work on messages sent in the current session. If you haven't sent a message in the current session the command will do nothing.

terminal-discord's People

Contributors

xynxynxyn avatar

Watchers

James Cloos avatar  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.