godot-xterm/README.md

<img align="left" width="64" height="64" src="icon.png">

# Godot Xterm Native

![Version](https://img.shields.io/badge/version-0.1.0-orange.svg)
![Godot Version](https://img.shields.io/badge/godot-3.2+-blue.svg)
![License](https://img.shields.io/badge/license-MIT-green.svg)

Native implementation of Godot Xterm using GDNative with [libtsm](https://github.com/Aetf/libtsm).

Terminal emulator for Godot using GDNative and [libtsm](https://github.com/Aetf/libtsm).

**Note**: If you are looking for the purely gdscript version of this plugin it was too buggy and slow so is no longer being developed or maintained but can found [here](https://github.com/lihop/godot-xterm/tree/gdscript-unmaintained).

## Demo

Click the thumbnail to watch a demo video on youtube:

[![Demo video thumbnail](https://img.youtube.com/vi/_Tt4eQEBybo/0.jpg)](https://www.youtube.com/watch?v=_Tt4eQEBybo)

## Usage

### Asciicast (.cast) file importer
[Asciinema](https://asciinema.org) recordings saved with the `.cast` extension will be automatically imported as animations. They can then be added to AnimationPlayer which is a child of the Terminal node. Playing the animation will play the terminal session recording in the parent Terminal.

For an example, see the scene in [/examples/asciicast](/examples/asciicast).

## 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 Leroy Hopson (MIT License)

The fonts used in this project are published under a seperate license.
See the various license files in the [subdirectories](addons/godot_xterm/themes/fonts/) for each font.
Add all the files 2020-05-09 19:07:31 +02:00			`<img align="left" width="64" height="64" src="icon.png">`

Basics working, added pseudoterminal Former-commit-id: 1187c9b7a36859169d05b503699f01183e3d645c 2020-07-11 12:45:21 +02:00			`# Godot Xterm Native`
Add all the files 2020-05-09 19:07:31 +02:00
Add more badges 2020-05-10 05:47:44 +02:00			`![Version](https://img.shields.io/badge/version-0.1.0-orange.svg)`
			`![Godot Version](https://img.shields.io/badge/godot-3.2+-blue.svg)`
			`![License](https://img.shields.io/badge/license-MIT-green.svg)`

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			`Native implementation of Godot Xterm using GDNative with [libtsm](https://github.com/Aetf/libtsm).`

Remove gdscript version and replace with native Former-commit-id: f9474fe533daed999208eb66d2fcaf4de4761741 2020-09-17 10:14:04 +02:00			`Terminal emulator for Godot using GDNative and [libtsm](https://github.com/Aetf/libtsm).`

			`Note: If you are looking for the purely gdscript version of this plugin it was too buggy and slow so is no longer being developed or maintained but can found [here](https://github.com/lihop/godot-xterm/tree/gdscript-unmaintained).`

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			`## Demo`

			`Click the thumbnail to watch a demo video on youtube:`

			`[![Demo video thumbnail](https://img.youtube.com/vi/_Tt4eQEBybo/0.jpg)](https://www.youtube.com/watch?v=_Tt4eQEBybo)`

Add asciicast importer Former-commit-id: ffa85618659024515cdde252c56c7be34a245446 2020-09-22 10:31:46 +02:00			`## Usage`

			`### Asciicast (.cast) file importer`
			[Asciinema](https://asciinema.org) recordings saved with the `.cast` extension will be automatically imported as animations. They can then be added to AnimationPlayer which is a child of the Terminal node. Playing the animation will play the terminal session recording in the parent Terminal.

			`For an example, see the scene in [/examples/asciicast](/examples/asciicast).`

Update the README 2020-05-09 21:33:54 +02:00			`## 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.`

Basics working, added pseudoterminal Former-commit-id: 1187c9b7a36859169d05b503699f01183e3d645c 2020-07-11 12:45:21 +02:00			`Copyright (c) 2020 Leroy Hopson (MIT License)`

			`The fonts used in this project are published under a seperate license.`
Refactor file structure Former-commit-id: 3eecf504cf3bbda3cc17dab11dfb190e0b881ef3 2020-09-17 11:23:01 +02:00			`See the various license files in the [subdirectories](addons/godot_xterm/themes/fonts/) for each font.`