discord-term-ng

⚠️ In active development!

✨ Discord Terminal

Discord Term next-generation (ng) is a cross-platform Discord terminal client written in Typescript that aims to deliver an alternative take of the Discord user experience. It uses blessed for rendering in the terminal. The project is currently being worked on. Support for viewing media in the client, among other features, are planned.

The project is looking for maintainers. Please see CONTRIBUTING.md and # Development for more information. Any help would be greatly appreciated!

[[TOC]]

Disclaimer

• It is important to note that "self-bots" are against Discord's Terms of Service and therefore discouraged to use. We are 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.

• It can currently only be used with bot tokens. User tokens don't work at all. Discord.js blocks self-botting, however we are looking into patching user tokens back in. Any help in this endeavour would be much appreciated.

New home

Discord Term Is forked from the original project on github. Alliegaytor/discord-term has the most recent source tree on github. It has since moved home to this gitlab repo, where all of the core development is taking place.

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:

(Recommended) With NPM:

git clone https://gitlab.com/Alliegaytor/discord-term.git
cd discord-term
npm i
npm run start

(Experimental) With Bun:

git clone https://gitlab.com/Alliegaytor/discord-term.git
cd discord-term
bun i
bun 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

And then run

dterm

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 on Linux, using Node.js 20 and Typescript ^5.2.2

It is also tested and confirmed working with bun ^1.0.2

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 guild 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 /tc command toggles the visibility of the channel picker, allowing you to quickly switch between channels. Similarly, the /tg command toggles the guild picker. By default, only the channel picker is visible.

The /tip command displays some tips in the headerbar, which can be toggled with /toggleheader. Discord Term will store your preference.

If you ever experience any graphical bugs, /reset should fix almost all visual problems. Resizing the window and using the /clear command have shown to sometimes fix ui issues as well. Disabling emojis with the /emoji command may also help.

You can also customise the location of the /themes by editing the state.json file which should either be in your home directory or the directory you installed discord-term to.

Planned Features

• [ ] Re-write & expand codebase

• [ ] Use blessed-contrib with blessed (or a maintained blessed fork)

• [ ] Improved documentation

• [ ] Support threads

• [ ] Userbot

• [ ] Message logging (with file-based or database support)

• [ ] Better, powerful plugin API

• [ ] Visual settings editor

• [ ] Tested codebase (unit testing)

• [ ] SSH support

---

Tricks & Tips

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

   Example:

    For a channel:
   
    $ /tag ch 437051394592210944
    $ /c $ch
   
    Or for a guild:
   
    $ /tag guild 286352649610199052
    $ /g $guild
   
    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?

   On Linux, you can also just click the channels for navigation ;)

2. Change message format style Customizability is what this project is heading for. There are plans for adding plugin support 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

   They are also easy to create! Just look at how the themes are made, it's all (hopefully) simple JSON!

   Feel free to send a merge request submitting your awesome theme so that everyone can use it!

4. Pasting in the terminal You can use the CTRL + SHIFT + V keybind to paste text in most terminal emulators.

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 "". You can cycle through your message history on that particular channel.
   5. Pressing the DOWN arrow key will decrement your editing command to more recent messages (if there are any).
   6. Pressing ESCAPE clears your current input.
   7. Tab autocompletion. Pressing the TAB key autocompletes your / command if it can. E.g /he autocompletes to /help, while /c informs you of the clear and c commands instead of autocompleting to something.

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. You can also edit encrypted messages seamlessly.

   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, and if you lose your password you won't be able to decrypt your previous messages!

   Spaces in the password are not currently supported.

   ⚠ This feature has not been properly audited. Do not rely on the encryption (or anything else in this project) for anything important. Don't expect it to work and be pleasantly surprised if it does.

   

7. Administration-tools There is currently only one admin tool, but there are more administration features in the works.

   1. The /deletechannel command deletes the current channel provided that the bot has the right permissions to do so.

Development

After cloning discord-term and installing using either npm or bun, you can use the build and testing scripts as seen in the package.json file.

For example, the project can be built with the build script. (In this example bun and npm can be used interchangeably.)

bun run build

It can be started afterwards by running the dist/index.js file. (Here bun can be in place of node.)

node dist/index.js

To build and immediately start the project:

npm run start

Whenever you edit the source code (located in ./src as *.ts files) you will need to rebuild the project to transpile the Typescript code to executable Javascript code (located in ./dist).

To build, immediately start, and restart the project on subsequent builds: (Note: bun is required here. npm users must manually restart the program after building it.)

bun run dev
# whenever you want to reload
bun run build

License

The project is licensed under the ISC license; and as such, it comes with no warranty of any kind.

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 (Github: @Alliegaytor)