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 2b3e40d39e
Update README with note about native branch
2020-07-20 11:30:30 +07:00

2.1 KiB
Raw Blame History

GodotXterm

Build Status Version Godot Version License

NOTE: The GDScript version of this project turned out to be very buggy and performed poorly. I have had much more success with a gdnative implementation using libtsm which can be viewed in the native branch of this repo.

Xterm for Godot. This is still very much a work in progress. Most of the credit goes to the authors of 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:

Testing

This project uses the awesome 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 (MIT License)
Copyright (c) 2017-2019, The xterm.js authors (MIT License)
Copyright (c) 2014-2017, SourceLair, Private Company (www.sourcelair.com) (MIT License)
Copyright (c) 2012-2013, Christopher Jeffrey (MIT License)