mirror of
https://github.com/lihop/godot-xterm.git
synced 2024-11-13 22:10:25 +01:00
36 lines
1.8 KiB
Markdown
36 lines
1.8 KiB
Markdown
<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.
|