mirror of
https://github.com/lihop/godot-xterm.git
synced 2024-09-20 00:26:18 +02:00
d75c26cec6
- Remove contributor license agreement: The terms are same as the standard "inbound=outbound" norm for open source projects which is covered by GitHub's terms of service which every GitHub user has already agreed to: https://docs.github.com/en/github/site-policy/github-terms-of-service#6-contributions-under-repository-license - Add wiki as submodule and move documentation to it. - Update README and replace screenshot with video
90 lines
6.1 KiB
Markdown
90 lines
6.1 KiB
Markdown
<img align="left" width="64" height="64" src="icon.png">
|
|
|
|
# GodotXterm
|
|
|
|
|
|
|
|
[](https://github.com/lihop/godot-xterm/actions?query=branch%3Amaster)
|
|
|
|
GDNative terminal for Godot.
|
|
Built using [libtsm](https://www.freedesktop.org/wiki/Software/libtsm/), [libuv](https://github.com/libuv/libuv), and [node-pty](https://github.com/microsoft/node-pty).
|
|
Primarily developed and tested on Linux, it also supports macOS with partial support for Windows and HTML5. See the [Features](#features) section for more detail.
|
|
|
|
https://user-images.githubusercontent.com/3696783/126894061-a69eb6ad-9979-4723-ade7-829494a9fc87.mp4
|
|
|
|
## [Documentation](https://github.com/lihop/godot-xterm/wiki)
|
|
|
|
Documentation is available in [the wiki](https://github.com/lihop/godot-xterm/wiki).
|
|
If you have a question not answered by the docs, or would like more support, feel free to open a new discussion in the [discussions](https://github.com/lihop/godot-xterm/discussions) section of this project.
|
|
|
|
## Features
|
|
|
|
- ### [Terminal](https://github.com/lihop/godot-xterm/wiki/Terminal)
|
|
A Terminal emulator Control node.
|
|
|
|
Supports ANSI and (some) XTerm Control Sequences which can be used to do things such as clear the screen, move the cursor, change printed text color, ring a bell, and so on.
|
|
For an exhaustive list of terminal control sequences (not all of which are supported by GodotXterm) see <https://invisible-island.net/xterm/ctlseqs/ctlseqs.html>.
|
|
|
|
- ### [PTY](https://github.com/lihop/godot-xterm/wiki/PTY)
|
|
*Linux and macOS only.*
|
|
|
|
Node for forking processes (e.g. bash, nodejs, python) with pseudoterminal file descriptors.
|
|
Can be used with the Terminal node to get an actual shell.
|
|
|
|
Not currently supported on Windows, but it could be in the future using [ConPTY](https://docs.microsoft.com/en-us/windows/console) or [WinPTY](https://github.com/rprichard/winpty).
|
|
See issue [\#25](https://github.com/lihop/godot-xterm/issues/25).
|
|
|
|
- ### Terminal Editor Plugin
|
|
*Linux and macOS only.*
|
|
|
|
Adds a panel to the Editor's bottom panel that can be used to spawn terminals in the editor.
|
|
Similar to VSCode's integrated terminal and IntelliJ's embedded terminal.
|
|
|
|
- ### Asciicast Import Plugin
|
|
Adds support for importing asciinema v2 `.cast` files as animations that can be played by an AnimationPlayer that is a child of a Terminal node.
|
|
Example `.cast` files can be downloaded from the [asciinema website](https://asciinema.org).
|
|
|
|
- ### Xresources Import Plugin
|
|
Adds support for importing color schemes from `.xrdb` or `.Xresources` files.
|
|
Example xresources files can be exported from [terminal.sexy](https://terminal.sexy).
|
|
The [iTerm2-Color-Schemes repo](https://github.com/mbadolato/iTerm2-Color-Schemes) also has many example color scheme files in [xrdb](https://github.com/mbadolato/iTerm2-Color-Schemes/tree/master/xrdb) and [Xresources](https://github.com/mbadolato/iTerm2-Color-Schemes) format.
|
|
|
|
## Demos
|
|
|
|
- [Online demo](https://demo.godot-xterm.nix.nz) of an HTML5 export of this repo (using the GDNative export type, available since Godot 3.3).
|
|
Make sure you click the screen at least once after loading.
|
|
|
|
- [Xterminate](https://lihop.itch.io/xterminate). A Linux, macOS, and Windows demo, which uses an older version GodotXterm in conjunction with [Godot Python](https://github.com/touilleMan/godot-python).
|
|
|
|
- This repository also contains a number of demo scenes in the [`examples`](/examples) directory. The easiest way to run these scenes is to clone this repo and then download the `libgodot-xterm-release.zip` archive from the [Releases](https://github.com/lihop/godot-xterm/releases) section and extract its contents (`.so`, `.wasm`, `.dll`, and `.dylib` files) into the `addons/godot_xterm/native/bin` directory.
|
|
|
|
|
|
## [License](/LICENSE.md)
|
|
|
|
Copyright (c) 2020-2021, Leroy Hopson and [contributors](https://github.com/lihop/godot-xterm/graphs/contributors) (MIT License).
|
|
|
|
### Third-party components
|
|
|
|
The GDNative source code incorporates code snippets and source code from many third-party libraries. The licenses of these components can be found in the various sub-directories of this project (provided git submodules have been cloned). Many of these licenses must be distributed with source and binary distributions of this software. For convenience, the texts of these licenses have been bundled together (but clearly demarcated) in the [THIRDPARTY_NOTICES.txt](/addons/godot_xterm/THIRDPARTY_NOTICES.txt) file.
|
|
|
|
**Note:** On platforms where the PTY node is not supported or if the library has been compiled with the option `disable_pty=yes` then only the licenses bundled in [THIRDPARTY_NOTICES_nopty.txt](/addons/godot_xterm/THIRDPARTY_NOTICES_nopty.txt) are applicable.
|
|
|
|
### Fonts
|
|
|
|
- The Hack regular font is bundled with GodotXterm as the default Terminal font. This is also the default monospace font of the Godot editor. See the [full license](/addons/godot_xterm/themes/fonts/hack/LICENSE.md).
|
|
|
|
|
|
### Nonbundled Resources
|
|
The following resources are not bundled with GodotXterm (i.e. are not included in the `addons/godot_xterm` directory) but are included in this repository for demo and testing purposes. They are:
|
|
|
|
|
|
#### Sounds
|
|
|
|
- [bell.wav](/themes/audio/bell.wav) by InspectorJ (<https://www.jshaw.co.uk>), downloaded from [freesound.org](https://freesound.org/people/InspectorJ/sounds/484344/), released under [CC-BY-3.0](https://creativecommons.org/licenses/by/3.0/).
|
|
|
|
#### Fonts
|
|
|
|
- The **bold**, *italic*, and ***bold italic*** styles of the Hack font which are covered by the same license as above.
|
|
- Nerd Fonts. Combines symbols from a multitude of other fonts. See [license information](/themes/fonts/nerd_fonts/README.md).
|
|
- Noto Color Emoji. Released under the [SIL Open Font License](/themes/fonts/noto_color_emoji/LICENSE_OFL.txt).
|
|
- Unifont. Dual-licensed (since version 13.0.04) under the GNU GPL 2+ with the GNU font embedding exception and the SIL Open Font License (OFL) version 1.1. This project uses it under the terms of the [SIL Open Font License](/themes/fonts/unifont/LICENSE_OFL-1.1.txt).
|