Skip to content

Jsamson33/endex

 
 

Repository files navigation


Logo




Endex

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

Fork Notice

This project is a fork of eDEX-UI by GitSquared. The original eDEX-UI project was archived on October 18th, 2021. This fork continues development and maintenance of the codebase.


Demo on YouTube

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

While keeping a futuristic look and feel, Endex 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 with the default "tron" theme & QWERTY keyboard

Blade screenshot

Checking out available themes with ranger using the "blade" theme

Disrupted screenshot

cmatrix with the experimental "tron-disrupted" theme, and the user-contributed DVORAK keyboard

Horizon screenshot

Editing source code with nvim using the custom horizon-full theme

Q&A

How do I get it?

Build from source using the instructions in the "Useful commands for the nerds" section below.

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.

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, Endex 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?

ARM64 builds can be created from source. See the building instructions below.

Development & Building

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.

Credits

This project is a fork of eDEX-UI by Squared.

Original eDEX-UI Credits

Key Dependencies

License

Licensed under the GPLv3.0.

About

fork of edx-ui

Resources

License

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 87.8%
  • CSS 11.5%
  • HTML 0.7%