⚠️ Main Repo: Alliegaytor/discord-term
This one is not setup as a mirror yet; and as such, won't be up to date.
Discord Terminal is an extensible cross-platform Discord terminal client written in Typescript using blessed that aims to deliver an alternative take of the Discord user experience. The project is being worked on, and preliminary file upload support was just added. Support for viewing media in the client, among other features, are planned.
The project is looking for active maintainers. Please see CONTRIBUTING.md for more information. Any help would be greatly appreciated!
[[TOC]]
-
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.
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.
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 startIf you are having issues with the colors or fonts try running with these env vars
LANG=en_US.utf8 TERM=xterm-256color npm run startWindows users should try the Windows Terminal first before reporting any issues.
To install on your system globally:
sudo npm install -gAnd then run
dtermThat'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 5.0.4
It is also tested and confirmed working with bun
Pst. Consider starring the repository if you like it! <3
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:
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 /tc command toggles the visibility of the channel picker, allowing you to quickly switch between channels. Similarly, the /tg command toggles the server (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.
-
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
-
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 ;)
-
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!
-
Change themes Changing themes is easy. You can switch between themes using the /themes command.
Example:
$ /theme dark-redThemes 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. It's all simple JSON!
Don't forget to create a merge request submitting your awesome theme so everyone can use it!
-
Pasting in the terminal You can use CTRL + SHIFT + V to paste data in most terminals.
-
Neat details There's some cool magic behind the scenes that you might not know about:
- Just have your token in your clipboard before starting the application, it will automatically detect it and login.
- Alternatively, you can set the DTERM_TOKEN environment variable and it will use it to automatically login.
- If you ever need to force a re-render because the UI might be buggy or so, use the /reset command.
- 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.
- Pressing the DOWN arrow key will decrement your editing command to more recent messages (if there are any).
- Pressing ESCAPE clears your current input.
-
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.
- /encrypt secret_password_here_no_spaces This will set your decryption/encryption password
- /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.
-
Administration-tools There is currently only one admin tool, but there are more administration features in the works.
- The
/deletechannelcommand deletes the current channel provided that the bot has the right permissions to do so.
- The
The project is licensed under the ISC license; and as such, it comes with no warranty of any kind.
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)