Skip to content

Latest commit

 

History

16 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🖥️ Godot Terminal

Godot Engine License Platform Discord

The ultimate built-in terminal shell for Godot 4.
Bring the full power of your native system shell directly into the Godot editor bottom panel.


✨ Features📦 Installation⌨️ Shortcuts🛠️ Building from Source🙏 Support


✨ Features

  • 🚀 Native PTY Execution: Powered by a high-performance C++ GDExtension with POSIX openpty (macOS/Linux) and Windows ConPTY support.
  • 🎨 True ANSI Terminal Emulation: Integrated with libvterm supporting standard ANSI colors, 24-bit RGB colors, bold/underline text, alternate screen buffers (vim, htop, top), and interactive TUI apps (e.g. bubbletea, lipgloss, fzf, agy).
  • 🔗 Smart Clickable Links: Automatically detects file paths and URLs in output; click to open URLs in your browser or jump straight to scripts and line numbers in the Godot script editor.
  • 📑 Multi-Tab & Splits: Open multiple shells (zsh, bash, fish, powershell, cmd), split horizontally or vertically, and rename tabs dynamically.
  • ⚡ Hotkey Toggle: Open and collapse the terminal dock instantly from anywhere in the editor with Ctrl + ` (or + ` on macOS).
  • ⚙️ Configurable: Customize font size, scrollback buffer limit, default shell, and shortcuts via the built-in settings panel.

📦 Installation

Manual Installation

  1. Download the latest release from the Releases page.
  2. Copy the addons/terminal folder into your Godot project's addons/ directory.
  3. In Godot, go to Project -> Project Settings -> Plugins and enable Godot Terminal.
  4. The Terminal tab will appear in your editor's bottom panel.

⌨️ Shortcuts

Action Shortcut Description
Toggle Terminal Ctrl + ` / + ` Toggle the terminal bottom dock open/collapsed
Copy Selection Ctrl + C / + C Copy selected text to clipboard (when text is selected)
Paste Ctrl + V / + V Paste clipboard text into the terminal
Clear Buffer Ctrl + L / + L Clear scrollback buffer and screen
Interrupt / SIGINT Ctrl + C Send interrupt signal to active process (when no text is selected)

🛠️ Building from Source

Prerequisites

  • Godot 4.x
  • C++17 compiler (GCC, Clang, or MSVC)
  • SCons build tool
  • Python 3.x

Build Instructions

  1. Clone repository with submodules:

    git clone --recursive https://github.com/poingstudios/godot-terminal.git
    cd godot-terminal
  2. Build GDExtension for your platform using the build script:

    ./scripts/build_local.sh

    Or build directly with SCons:

    # macOS
    scons -C platforms/gdextension platform=macos target=template_debug arch=x86_64
    
    # Linux
    scons -C platforms/gdextension platform=linux target=template_debug arch=x86_64
    
    # Windows
    scons -C platforms/gdextension platform=windows target=template_debug arch=x86_64
  3. Open the project in the Godot editor:

    godot -e

🙏 Support

If you find this plugin helpful, consider supporting the project:


MIT License © 2026 Poing Studios

About

Bring the terminal to your Godot project!

Resources

Security policy

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages