eDEX-UI

A cross-platform, customizable science fiction terminal emulator with advan...

README


Logo

undefined
undefined undefined undefined
undefined undefined undefined undefined undefined
(Project archived oct. 18th 2021)



eDEX-UI is a fullscreen, cross-platform terminal emulator and system monitor that looks and feels like a sci-fi computer interface.


Demo on YouTube

Heavily inspired from the TRON Legacy movie effects (especially the Board Room sequence), the eDEX-UI project was originally meant to be"DEX-UI with less « art » and more « distributable software »".

While keeping a futuristic look and feel, it strives to maintain a certain level of functionality and to be usable in real-life scenarios, with the larger goal of bringing science-fiction UXs to the mainstream.

It might or might not be a joke taken too seriously.



Jump to:
FeaturesScreenshotsQuestions & AnswersDownloadFeatured InContributor InstructionsCredits


Sponsor


Want to help support my open-source experiments and learn some cool JavaScript tricks at the same time?

Click the banner below and sign up to Bytes, the only newsletter cool enough to be recommended by eDEX-UI.
Bytes by UI.dev

Features

- Fully featured terminal emulator with tabs, colors, mouse events, and support for curses and curses-like applications.
- Real-time system (CPU, RAM, swap, processes) and network (GeoIP, active connections, transfer rates) monitoring.
- Full support for touch-enabled displays, including an on-screen keyboard.
- Directory viewer that follows the CWD (current working directory) of the terminal.
- Advanced customization using themes, on-screen keyboard layouts, CSS injections. See the wiki for more info.
- Optional sound effects made by a talented sound designer for maximum hollywood hacking vibe.

Screenshots

Default screenshot

_neofetch on eDEX-UI 2.2 with the default "tron" theme & QWERTY keyboard_

Blade screenshot

_Checking out available themes in eDEX's config dir with [ranger](https://github.com/ranger/ranger) on eDEX-UI 2.2 with the "blade" theme_

Disrupted screenshot

_cmatrix on eDEX-UI 2.2 with the experimental "tron-disrupted" theme, and the user-contributed DVORAK keyboard_

Horizon screenshot

_Editing eDEX-UI source code with nvim on eDEX-UI 2.2 with the custom [horizon-full](https://github.com/GitSquared/horizon-edex-theme) theme_

Q&A

How do I get it?

Click on the little badges under the eDEX logo at the top of this page, or go to the Releases tab, or download it through one of the available repositories (Homebrew, AUR...).

Public release binaries are unsigned (why). On Linux, you will need tochmod +x the AppImage file in order to run it.

I have a problem!

Search through the Issues to see if yours has already been reported. If you're confident it hasn't been reported yet, feel free to open up a new one. If you see your issue and it's been closed, it probably means that the fix for it will ship in the next version, and you'll have to wait a bit.

Can you disable the keyboard/the filesystem display?

You can't disable them (yet) but you can hide them. See the tron-notype theme.

Why is the file browser saying that "Tracking Failed"? (Windows only)

On Linux and macOS, eDEX tracks where you're going in your terminal tab to display the content of the current folder on-screen.
Sadly, this is technically impossible to do on Windows right now, so the file browser reverts back to a "detached" mode. You can still use it to browse files & directories and click on files to input their path in the terminal.

Can this run on a Raspberry Pi / ARM device?

We provide prebuilt arm64 builds. For other platforms, see this issue comment, and the thread on issue #818.

Is this repo actively maintained?

No, after a 3 years run, this project has been archived. See the announcement.

How did you make this?

Glad you're interested! See #272.

This is so cool.

Thanks! If you feel like it, you can follow me on Twitter to hear about new stuff I'm making.



Featured in...

- BoingBoing article - Apparently i'm a "French hacker"
- JSNation Open Source Awards 2021 (Nominee - Fun Side Project of the Year)


Useful commands for the nerds


IMPORTANT NOTE: the following instructions are meant for running eDEX from the latest unoptimized, unreleased, development version. If you'd like to get stable software instead, refer to these instructions.

Starting from source:

on *nix systems (You'll need the Xcode command line tools on macOS):
- clone the repository
- npm run install-linux
- npm run start

on Windows:
- start cmd or powershell as administrator
- clone the repository
- npm run install-windows
- npm run start

Building

Note: Due to native modules, you can only build targets for the host OS you are using.

- npm install (NOT install-linux or install-windows)
- npm run build-linux or build-windows or build-darwin

The script will minify the source code, recompile native dependencies and create distributable assets in the dist folder.

Getting the bleeding edge

If you're interested in running the latest in-development version but don't want to compile source code yourself, you can can get pre-built nightly binaries on GitHub Actions: click the latest commits, and download the artifacts bundle for your OS.

Credits

eDEX-UI's source code was primarily written by me, Squared. If you want to get in touch with me or find other projects I'm involved in, check out my website.

PixelyIon helped me get started with Windows compatibility and offered some precious advice when I started to work on this project seriously.

IceWolf composed the sound effects on v2.1.x and above. He makes really cool stuff, check out his music!

Thanks

Of course, eDEX would never have existed if I hadn't stumbled upon the amazing work of Seena on r/unixporn.

This project uses a bunch of open-source libraries, frameworks and tools, see the full dependency graph.

I want to namely thank the developers behind xterm.js, systeminformation and SmoothieCharts.

Huge thanks to Rob "Arscan" Scanlon for making the fantastic ENCOM Globe, also inspired by the TRON: Legacy movie, and distributing it freely. His work really puts the icing on the cake.

Licensing


Licensed under the GPLv3.0.