Jasima/godot-xterm
1
0
Fork 0
mirror of https://github.com/lihop/godot-xterm.git synced 2024-11-10 04:40:25 +01:00
Code Issues Projects Releases Packages Wiki Activity
godot-xterm/README.md
Leroy Hopson c66e478484 Update documentation and LICENSE
2020-10-05 18:04:41 +07:00

4.2 KiB
Raw Blame History

GodotXterm

Version Godot Version License Build Status

Terminal emulator for Godot using GDNative and libtsm.

Note: If you are looking for the purely gdscript version of this plugin which was based on Xterm.js, it turned out to be too buggy and slow so is no longer being developed or maintained but can still be found in the gdscript-unmaintaned branch.

Screenshot of Main Menu Scene

Building

All Operating Systems

Important: The main dependencies of this project are included as git submodules. You can install them in this repo after cloning with:

git submodule update --init --recursive

In addition to these, you will need some other dependencies including:

  • a C++ compiler (e.g. gcc)
  • ar (part of GNU Binutils)
  • CMake
  • Python
  • SCons

Operating System Specific

NixOS

On NixOS you can simply run the build.sh script in the addons/godot_xterm/native directory:

cd addons/godot_xterm/native
./build.sh

All dependencies will be pulled in by nix-shell and the build steps will run.

Arch Linux and Ubuntu

See the Arch Linux Dockerfile and Ubuntu Dockerfile for a list of packages that need to be installed. Once installed, run the build.sh script from the addons/godot_xterm/native directory:

cd addons/godot_xterm/native
bash ./build.sh

Make sure you use bash to run the script as the default interpreter is set to nix-shell.

Other

Other operating systems will probably be similar to the above. When in doubt check the documentation in the submodule repos, the build.sh script, and the SConstruct file.

Usage

  • Terminal

    The main node provided by this plugin.

  • Pseudoterminal

    A node that can be used to connect the Terminal to a shell. Currently Linux only.

    An example of how to use this node with a Terminal can be found in the terminal scene.

  • TPut

    An incomplete helper class based on the tput utility.

    Example: On the command line you can use tput cup 5 5 to position the cursor at row 5 col 5. In GDScript this utility can be used to similar effect by doing:

    tput.cup(5, 5)

    Other commands include tput setaf to set a foreground color, tput setab to set a background color, and many more. But only a few of these have been implemented.

    Its usage is demonstrated in the script for the menu scene.

  • Asciicast (.cast) file importer plugin

    Asciinema recordings saved with the .cast extension will be automatically imported as animations. They can then be added to AnimationPlayer which is a child of a Terminal node. Playing the animation will play the terminal session recording in the parent Terminal.

    See the asciicast scene for an example.

Examples

There are three example scenes included in this project which you can study to learn more.

  • menu.tscn
  • terminal.tscn
  • asciicast.tscn

License

If you contribute code to this project, you are implicitly allowing your code to be distributed under the MIT license. You are also implicitly verifying that all code is your original work, or unoriginal work which is published under a compatible license or waiver.

Copyright (c) 2020 The GodotXterm authors (MIT License)

The fonts used in this project are published under a seperate license. See the various license files in the subdirectories for each font.