⚠️ In active development!

Discord Term Is forked from the original project on github. Alliegaytor/discord-term has the most up to date source tree on github.

The project needs active maintainers. Any help would be greatly appreciated!

[[TOC]]

✨ Discord Terminal

A cross platform extensible Discord terminal client written in Typescript using blessed. It can currently only be used with bot tokens. User tokens don't work at all as discord.js blocks them from being used. This is unwanted behaviour, however. We are trying to patch user tokens back in, and any help in this endeavour would be much appreciated.

Disclaimer: So-called "self-bots" are against Discord's Terms of Service and therefore discouraged to use. We am not responsible for any bans whatsoever caused by this software as described in the project's license. This program is intended to be used with a bot token which is compliant with Discord's Terms of Service.

Screenshots

Linux preview

{width=100%}

Windows 10 preview

{width=100%}

Get Started

Setting up is extremely easy. Just issue the following commands to install and run Discord Term locally:

git clone https://gitlab.com/P-90-For-Retail/discord-term.git
cd discord-term
npm install
npm run start

Help! My colors look weird!

If you are having issues with the colors or fonts try running with these env vars

LANG=en_US.utf8 TERM=xterm-256color npm run start

Windows users should try the Windows Terminal first before reporting any issues.

Installation

To install on your system globally:

sudo npm install -g

That's it! Although keep in mind that since the project is unfinished and WIP, you might encounter some bugs here and there. Please report them if you do find them!

This project is tested and developed under Linux, using Alacritty terminal with Node.js 16 and typescript 4.9.4

Pst. Consider starring the repository if you like it! <3

Usage

Once you've started the program, use /login <token> to connect to Discord. Alternatively you can use the environmental variable DTERM_TOKEN or have your token in the clipboard to login.

See the links below for information on retrieving login tokens:

• Retrieve a bot token

You can issue the /help command to display all available commands.

Discord Terminal will show you the first channel in the first server that the Discord API is set to find. The channels are on the left hand side and you can click on them to navigate through them.

The command /tc toggles the visibility of the channel picker, and /tg toggles the server (guild) picker. By default only the channel picker is visible.

You can use /tip to give you some tips in the headerbar (the top bar on the screen). These are currently being worked on and are incomplete.

The headerbar can be disabled with /toggleheader and Discord Term will remember your preference.

If anything bugs out use /reset. It should fix almost all visual problems. Resizing the window and /clear have shown to sometimes fix ui issues as well.

Tricks & Tips

1. Get moving quickly! You can easily switch between servers and channels using the /tag command.

   Example:

    For a channel:
   
    $ /tag dev 437051394592210944
    $ /c $dev
   
    Or for a guild:
   
    $ /tag gamingcorner 286352649610199052
    $ /g $gamingcorner
   
    Or for a user:
   
    $ /tag cloudrex 285578743324606482
    $ /dm $cloudrex hello
   
    You can even use them for normal messages!
   
    $ <@$cloudrex> => Would send the message: <@285578743324606482>

   Easy right?

   In Linux, you can also just click the channels ;)

2. Change message format style Customizability is what this project is heading for. I'm planning on adding support for plugins in the future! As of now, you can edit your message format and theme.

   Example:

    $ /format {sender} ~> {message}
   
    Or even more fancy:
   
    $ /format [{sender}] => {message}

   Try it out and match your style. Shiny!

3. Change themes Changing themes is easy. You can switch between themes using the /themes command.

   Example:

    $ /theme dark-red

   Themes included:

   • default
   • dark
   • dark-red
   • dark-blue
   • rose
   • ruby
   • rovel
   • discord
   • purple-glory

   Want more? Make your own! Checkout how those themes were made under the themes directory (Psst. It's easy!).

   Don't forget to create a merge request submitting your awesome theme so everyone can use it!

4. Pasting in the terminal You can use CTRL + SHIFT + V to paste data in most terminals.

5. Neat details There's some cool magic behind the scenes that you might not know about:

   1. Just have your token in your clipboard before starting the application, it will automatically detect it and login.
   2. Alternatively, you can set the DTERM_TOKEN environment variable and it will use it to automatically login.
   3. If you ever need to force a re-render because the UI might be buggy or so, use the /reset command.
   4. Pressing the UP arrow key after sending a message will allow you to edit it (similar functionality to Discord) or delete it if the edit is an empty string "".
   5. Pressing the DOWN arrow key will clear your input (if there was any). ESCAPE does the same.

6. Super-secret mode Discord Terminal has this cool security feature that allows you to send + receive encrypted messages, and all you need to do is set a password.

   1. /encrypt secret_password_here_no_spaces This will set your decryption/encryption password
   2. /doencrypt Toggle automatic encryption of messages

   From now on, your messages will be sent encrypted, preventing anyone (including Discord) from deciphering them unless they have set the same password as you. This way, you can give your friends the secret password and both talk in an encrypted, safe manner.

   Any encrypted messages sent by other users using Discord Terminal will be intercepted and attempted to be decrypted with the currently set decryption key.

   Note: Your friend(s) must have set the same password in order to view your messages!

   Keep in mind that your password cannot contain spaces.

   ⚠ This feature has not been properly tested since code refractor. Do not rely on it (or anything in this project) for anything important.

License

The project is licensed under the ISC license. The code was, at one point in time, released into public domain with the Unlicense license by the original owner of the repo (see 361b603d). If, in your jurisdiction, the Unlicense license cannot legally release code into the public domain, the project is to be considered to be licensed with the Unlicense license up to and including commit 2a36c2c7. Either way, this software comes with no warranty of any kind and we cannot be held liable for any damages caused by it.

Contributors

Here are all the lovely people who have contributed to the project. It wouldn't be where it is at without you!

• @AL1L
• @anirudhbs
• @jellz
• @JustCaptcha
• @Alliegaytor