godot-xterm/README.md

37 lines
1.8 KiB
Markdown
Raw Normal View History

2020-05-09 19:07:31 +02:00
<img align="left" width="64" height="64" src="icon.png">
2020-07-11 12:45:21 +02:00
# Godot Xterm Native
2020-05-09 19:07:31 +02:00
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)
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)
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).
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.
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.
2020-09-17 11:23:01 +02:00
See the various license files in the [subdirectories](addons/godot_xterm/themes/fonts/) for each font.