Jasima/godot-xterm
1
0
Fork 0
mirror of https://github.com/lihop/godot-xterm.git synced 2024-11-14 22:30:26 +01:00
Code Issues Projects Releases Packages Wiki Activity
godot-xterm/README.md

96 lines
6.4 KiB
Markdown
Raw Permalink Normal View History

Add all the files
2020-05-09 19:07:31 +02:00
<img align="left" width="64" height="64" src="icon.png">
Update documentation and LICENSE Former-commit-id: c66e47848475d39973065aee390629e2758f3e01
2020-10-05 11:25:48 +02:00
# GodotXterm
Add all the files
2020-05-09 19:07:31 +02:00
Update status badges
2021-12-17 09:44:47 +01:00
![Godot Version](https://img.shields.io/badge/Godot-3.3+-blue.svg)
![License](https://img.shields.io/badge/License-MIT-green.svg)
[![Build and Test](https://github.com/lihop/godot-xterm/actions/workflows/main.yml/badge.svg?event=schedule)](https://github.com/lihop/godot-xterm/actions/workflows/main.yml)
Make native library easier to build/use Makes libtsm a static library rather than dynamic so that it doesn't have to be installed as a system library on the user's operating system. Also updates SConstruct to work on more operating systems other than just NixOS. Adds a number of docker files for building the library on various distributions (NixOS, Arch Linux, Ubuntu). Uses a fork of godot-cpp with an updated godot_headers submodule that includes godotengine/godot_headers#76. We should go back to tracking https://github.com/godotengine/godot-cpp once the submodule has been updated in that repo. Former-commit-id: d8c8b5b27202cf11c6ce0245f0cc04136ec6fad3
2020-07-13 06:14:30 +02:00
Update documentation - 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
2021-07-25 03:07:05 +02:00
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.
Remove gdscript version and replace with native Former-commit-id: f9474fe533daed999208eb66d2fcaf4de4761741
2020-09-17 10:14:04 +02:00
Update documentation - 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
2021-07-25 03:07:05 +02:00
https://user-images.githubusercontent.com/3696783/126894061-a69eb6ad-9979-4723-ade7-829494a9fc87.mp4
Update documentation and LICENSE Former-commit-id: c66e47848475d39973065aee390629e2758f3e01
2020-10-05 11:25:48 +02:00
Update documentation - 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
2021-07-25 03:07:05 +02:00
## [Documentation](https://github.com/lihop/godot-xterm/wiki)
Update documentation and LICENSE Former-commit-id: c66e47848475d39973065aee390629e2758f3e01
2020-10-05 11:25:48 +02:00
Update documentation - 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
2021-07-25 03:07:05 +02:00
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.
Add support for Windows 64-bit Tested on NixOS, Ubuntu and Arch Linux. Not yet able to compile for Windows 32-bit on NixOS or on Windows itself. Part of #5
2020-11-05 09:42:00 +01:00
Update documentation - 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
2021-07-25 03:07:05 +02:00
## Features
Add support for Windows 64-bit Tested on NixOS, Ubuntu and Arch Linux. Not yet able to compile for Windows 32-bit on NixOS or on Windows itself. Part of #5
2020-11-05 09:42:00 +01:00
Update documentation - 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
2021-07-25 03:07:05 +02:00
- ### [Terminal](https://github.com/lihop/godot-xterm/wiki/Terminal)
A Terminal emulator Control node.
Add HTML5 support
2021-06-07 08:53:43 +02:00
Update documentation - 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
2021-07-25 03:07:05 +02:00
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>.
Add HTML5 support
2021-06-07 08:53:43 +02:00
Update documentation - 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
2021-07-25 03:07:05 +02:00
- ### [PTY](https://github.com/lihop/godot-xterm/wiki/PTY)
*Linux and macOS only.*
Add HTML5 support
2021-06-07 08:53:43 +02:00
Update documentation - 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
2021-07-25 03:07:05 +02:00
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.
Add asciicast importer Former-commit-id: ffa85618659024515cdde252c56c7be34a245446
2020-09-22 10:31:46 +02:00
Update documentation - 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
2021-07-25 03:07:05 +02:00
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).
Add support for the bell "\a" character Closes #39
2021-07-03 16:57:19 +02:00
Update documentation - 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
2021-07-25 03:07:05 +02:00
- ### Terminal Editor Plugin
*Linux and macOS only.*
Add support for the bell "\a" character Closes #39
2021-07-03 16:57:19 +02:00
Update documentation - 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
2021-07-25 03:07:05 +02:00
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.
Update the README
2020-05-09 21:33:54 +02:00
Update documentation - 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
2021-07-25 03:07:05 +02:00
- ### 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).
Update the README
2020-05-09 21:33:54 +02:00
Update documentation - 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
2021-07-25 03:07:05 +02:00
- ### 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.
Basics working, added pseudoterminal Former-commit-id: 1187c9b7a36859169d05b503699f01183e3d645c
2020-07-11 12:45:21 +02:00
Add link to the Godot Asset Library page
2021-07-26 09:28:49 +02:00
## Installation
GodotXterm is available on the Godot Asset Library: <https://godotengine.org/asset-library/asset/1007>.
For more ways to install see the [Installation](https://github.com/lihop/godot-xterm/wiki/Installation) page on the wiki.
Update documentation - 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
2021-07-25 03:07:05 +02:00
## Demos
Update documentation and LICENSE Former-commit-id: c66e47848475d39973065aee390629e2758f3e01
2020-10-05 11:25:48 +02:00
Update online demo URL
2021-07-25 20:27:29 +02:00
- [Online demo](https://lihop.github.io/godot-xterm-dist/) of an HTML5 export of this repo (using the GDNative export type, available since Godot 3.3).
Update documentation - 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
2021-07-25 03:07:05 +02:00
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)
Update license information - Renamed LICENSE -> LICENSE.md as it contains markdown, and added contact address. - Adds THIRDPARTY_NOTICES.txt and THIRDPARTY_NOTICES_nopty.txt which bundles licenses of all third-party components for versions of GodotXterm compiled with and without PTY node support. - Adds misc/gen_3rdparty_licenses.sh file to generate the above mentioned text files. - Seperated node_pty and tmux licenses. - Updated libuv submodule to use version that contains additional license information. - Updated README to reflect these changes.
2021-07-07 16:32:56 +02:00
Update documentation - 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
2021-07-25 03:07:05 +02:00
Copyright (c) 2020-2021, Leroy Hopson and [contributors](https://github.com/lihop/godot-xterm/graphs/contributors) (MIT License).
Update license information - Renamed LICENSE -> LICENSE.md as it contains markdown, and added contact address. - Adds THIRDPARTY_NOTICES.txt and THIRDPARTY_NOTICES_nopty.txt which bundles licenses of all third-party components for versions of GodotXterm compiled with and without PTY node support. - Adds misc/gen_3rdparty_licenses.sh file to generate the above mentioned text files. - Seperated node_pty and tmux licenses. - Updated libuv submodule to use version that contains additional license information. - Updated README to reflect these changes.
2021-07-07 16:32:56 +02:00
### Third-party components
Add export ignored files to .gitattributes Move THIRDPARTY_NOTICE files to addons/godot_xterm so they will be included with asset-lib downloads.
2021-07-18 19:27:25 +02:00
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.
Update license information - Renamed LICENSE -> LICENSE.md as it contains markdown, and added contact address. - Adds THIRDPARTY_NOTICES.txt and THIRDPARTY_NOTICES_nopty.txt which bundles licenses of all third-party components for versions of GodotXterm compiled with and without PTY node support. - Adds misc/gen_3rdparty_licenses.sh file to generate the above mentioned text files. - Seperated node_pty and tmux licenses. - Updated libuv submodule to use version that contains additional license information. - Updated README to reflect these changes.
2021-07-07 16:32:56 +02:00
Add export ignored files to .gitattributes Move THIRDPARTY_NOTICE files to addons/godot_xterm so they will be included with asset-lib downloads.
2021-07-18 19:27:25 +02:00
**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.
Update documentation and LICENSE Former-commit-id: c66e47848475d39973065aee390629e2758f3e01
2020-10-05 11:25:48 +02:00
Update documentation - 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
2021-07-25 03:07:05 +02:00
### 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).
Reference in a new issue Copy permalink