mirror of
https://github.com/lihop/godot-xterm.git
synced 2024-11-14 22:30:26 +01:00
38 lines
2.2 KiB
Markdown
38 lines
2.2 KiB
Markdown
<img align="left" width="64" height="64" src="icon.png">
|
|
|
|
# GodotXterm (Unmaintained GDScript version!)
|
|
|
|
[](https://travis-ci.org/lihop/godot-xterm)
|
|
|
|
|
|
|
|
|
|
|
|
**WARNING: The GDScript version of this project turned out to be very buggy and performed poorly. Therefore, it is no longer being developed or mantained. I have had much more success with a gdnative implementation using [libtsm](https://github.com/Aetf/libtsm) which can be viewed in the [master branch](https://github.com/lihop/godot-xterm/tree/) of this repo. You should use that instead.**
|
|
|
|
Xterm for Godot. This is still very much a work in progress.
|
|
Most of the credit goes to the authors of [xterm.js](https://github.com/xtermjs/xterm.js) as most of this code was taken from that project and translated to GDScript.
|
|
|
|
## Demo
|
|
|
|
If you are running Linux and have `which`, `bash` and `socat` installed you can run the main scene (`demo.tscn`) and it will try
|
|
to connect the Terminal node to your system.
|
|
|
|
Otherwise you can check out the gif below:
|
|
|
|
<img src="demo.gif">
|
|
|
|
## Testing
|
|
|
|
This project uses the awesome [Gut](https://github.com/bitwes/Gut) (Godot Unit Testing) plugin for testing.
|
|
You can run the tests by playing the test scene at `res://test/test.tscn` and clicking run.
|
|
|
|
## 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](https://github.com/lihop/godot-xterm/graphs/contributors) (MIT License)<br>
|
|
Copyright (c) 2017-2019, [The xterm.js authors](https://github.com/xtermjs/xterm.js/graphs/contributors) (MIT License)<br>
|
|
Copyright (c) 2014-2017, SourceLair, Private Company ([www.sourcelair.com](https://www.sourcelair.com/home)) (MIT License)<br>
|
|
Copyright (c) 2012-2013, Christopher Jeffrey (MIT License)
|