Decky Terminal

A Missing Terminal plugin that turns your Steam Deck into Portable Linux Battlestation.

Why do I need it?

Here are the cases that Decky Terminal can help you out!

• Quickly run some command-line application in game-mode
• Show off your "31337" Linux command line skills to public on the go
• Edit simple file with vim/emacs without exiting to KDE jumping all the hoops
  ^{(GNU/Emacs installed seperately)}
• Use it as your dumb terminal for your ssh
  ^{(phone hotspot data plan sold seperately)}
• Manage your network infrastructure with GNU/Screen
  ^{(GNU/Screen installed seperately, RS232 to USB converter sold seperately)}
• Decide NPC's fate
• Play BadApple
• Fix broken IME inputs

TODO

• PROPERLY implement on-screen keyboard support (currently implemented via workaround)
• ~~Gamepad support (up/down/left/right for arrow keys, etc.)~~ Need to remove some bug
• ~~multi-instance support (implemented on backend, but not on frontend. yet.)~~

Want some features to be implemented? Please make an issue on issues page!

Build Instructions

Prerequisites

• Linux Installation ^{(for prebuilt Decky Loader CLI)} or Rust NIGHTLY installation on POSIX Compliant OS ^{(e.g. macOS)}
• Latest LTS version of NodeJS
• pnpm
• docker installation

If you are not using Linux

If you are using something other POSIX compliant OS (or has docker user-rights properly configured), Please modify .vscode/build.sh or .vscode/deploy.sh not to use sudo, since Docker doesn't require sudo to run on macOS platform (running in Linux virtual machine).

How to Build

1. Resolve pnpm dependencies with pnpm i command
2. Create cli directory on repository root (mkdir cli)
3. Put compiled CLI binary (Precompiled Linux binary) at ./cli/decky
   • If you are using other POSIX compliant OS, clone the repo and compile with cargo build.
   • If you are using Windows, Use WSL2 (Arch Linux preferred) and setup all of prerequisites.
4. run pnpm build-zip
5. Enter sudo password if requested.
   (Required for compiling for holo-iso environment)
6. Your bundle is now available at ./out/decky-terminal.zip. Enjoy!

Footnote

Valve, If you are reading this. PLEASE integrate proper command line console on game mode.
This should be included in the Steam client's developer option.

License

Distributed under BSD-3-Clause License
(./src/common/xterm_css.tsx is exempt from BSD-3-Clause License and distributed under MIT License)