godot-xterm/docs/CHANGELOG.md

# Changelog
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).


## [Unreleased](https://github.com/lihop/godot-xterm/compare/v2.1.0...HEAD)

### Fixed
Thanks to [@ConteZero](https://github.com/contezero) for reporting and providing feedback on these issues:
- [#51][i51]: Fixed issue where terminal would lose focus on Tab/Arrow key presses
  when in a scene with other input nodes.
- [#53][i53]: Fixed issue where terminal was not updating when there was no GUI
  activity.
- [#55][i55]: Fixed unicode errors that would occur when using PTY with Terminal.
- [#56][i56]: Fixed incorrect initial size of PTY when used with Terminal.


[i51]: https://github.com/lihop/godot-xterm/issues/51
[i53]: https://github.com/lihop/godot-xterm/issues/53
[i55]: https://github.com/lihop/godot-xterm/issues/55
[i56]: https://github.com/lihop/godot-xterm/issues/56


## [v2.1.0](https://github.com/lihop/godot-xterm/compare/v2.0.0...v2.1.0) - 2022-07-11
### Added
- Support for macOS universal (x86_64/arm64) binaries. The macOS binary
  `libgodot-xterm.osx.64.dylib` is now a universal binary that runs natively
  on both x86_64 and arm64.

### Changed
- Linux binaries now support systems with older GLIBC versions. By building the
  binaries inside a docker container with an older GLIBC version, the minimum
  required GLIBC version is now 2.17 which was released in 2012.
- Prevent all editor shortcuts while terminal is focused except for:
  - The shortcuts used to switch between terminal tabs (Ctrl+Page up, Ctrl+Page down).
  - Shortcuts starting with Ctrl+Shift. This includes the remaining default terminal
    panel shortcuts such as 'Copy' (Ctrl+Shift+C) and 'New Terminal' (Ctrl+Shift+T).
- Changed target Godot version from 3.3.2-stable -> 3.4.4-stable.
- Prevent scrollback buffer reset (i.e. scrolling to the bottom of terminal output) when
  pressing modifier keys in isolation or when copying text using the shortcut Ctrl+Shift+C.

### Removed
- Removed custom TerminalSettings Resource type.
  This Resource was not being used but would still appear in every resource dropdown.
  (Related issue [godotengine/godot#24643](https://github.com/godotengine/godot/issues/24643)).

### Fixed
- The `kill()` method of unix PTY node can now be called without error as the underlying
  `pipe.close()` method of the gdnative library is now registered.
- Fixed 'Condition "!obj" is true.' error that would often print to console when
  closing terminals in the Terminal panel of the editor plugin.
- Fixed leaked instances that would occur when PTY exited but child process was still
  running.
- Fixed "Resumed function after yield, but class instance is gone" error that would
  sometimes occur when closing a Terminal after calling `write()` but before VisualServer
  had finished drawing the current frame.


## [v2.0.0](https://github.com/lihop/godot-xterm/compare/v1.2.1...v2.0.0) - 2021-07-25
### Added
- Terminal editor plugin. Adds integrated terminal to Godot editor.
- Xresources import plugin.
- [#39][i39]: Support for the bell "\u0007" character.
- HTML5 Support.
- [#24][i24]: Support for Windows 32-bit (Terminal node only).

### Changed
- [#44][i44]: Default theme to match Godot's default theme.
- Supported Godot version -> 3.3.2.
- Set a default theme if no theme property has been set.
- Changed default font from Cousine to Hack, which is the same as Godot's script editor, and reduced size from 16 to 14.
- TPut no longer registered as a unique global class (i.e. removed `class_name TPut`).

### Fixed
- [#40][i40]: Vim related bugs, caused by incorrectly handled control sequences.
- Don't swap red and blue channels of theme colors.
- Use "Light Cyan" color from theme. Previously ignored.

[i24]: https://github.com/lihop/godot-xterm/issues/24
[i39]: https://github.com/lihop/godot-xterm/issues/39
[i40]: https://github.com/lihop/godot-xterm/issues/40
[i44]: https://github.com/lihop/godot-xterm/issues/44


## [v1.2.1](https://github.com/lihop/godot-xterm/compare/v1.2.0...v1.2.1) - 2020-11-23
### Changed
- GitHub Actions workflow now produces both a release and debug zip archive.

### Fixed
- Release binary for Windows 64-bit export.


## [v1.2.0](https://github.com/lihop/godot-xterm/compare/v1.0.0...v1.2.0) - 2020-11-21
### Added
- Support for macOS 64-bit including Pseudoterminal.
- Partial support for Windows 64-bit and compiling on Windows using MSVC. Pseudoterminal not yet supported. 32-bit builds might be possible but not yet built/tested.

### Changed
- Updated build script. On Linux `./build.sh` will create a debug build of the gdnative library for the current platform.
- Removed all pre-compiled binaries using BFG [Repo-Cleaner](https://rtyley.github.io/bfg-repo-cleaner/), thus re-writing git history.

### Fixed
- Fixed bug where incorrect data would sometimes be written to the terminal when passing a string to the Terminal's `write()` method.
- Positioned background rect at 0,0 so it is no longer offset if a margin is added when Terminal is a child of a Container node.
- Passed correct argv to the execvp call of Pseudoterminal. Previously argv[0] was not set to the program's name which caused the Pseudoterminal node not to work on macOS with the zsh shell.


## [v1.0.0](https://github.com/lihop/godot-xterm/releases/tag/v1.0.0) - 2020-10-05
### Added
- Changelog.
- Asciicast importer plugin. Enables the import of .cast ([asciicast files v2](https://github.com/asciinema/asciinema/blob/master/doc/asciicast-v2.md)) that can be made using the [asciinema](https://asciinema.org/) terminal session recorder. See the [asciicast scene](/examples/asciicast) for example usage.
- Pre-built binary for x11 platform.

### Changed
- Implementation of Terminal node from GDScript to GDNative using [Aetf's patched version of libtsm](https://github.com/Aetf/libtsm).
- Move input handling to the Terminal node itself, rather than handling it in a seperate Control node.
- The Terminal `write()` method now accepts both String and PoolByteArray.
Add a changelog Former-commit-id: 55544de93ed981f190e3a3287c441162c5cfee06 2020-09-22 09:58:07 +02:00			`# Changelog`
			`All notable changes to this project will be documented in this file.`

			`The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),`
			`and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).`

Update CHANGELOG, README and bump version 2020-11-21 13:26:41 +01:00
Bump version to 2.1.0 2022-07-10 23:31:34 +02:00			`## [Unreleased](https://github.com/lihop/godot-xterm/compare/v2.1.0...HEAD)`

Update CHANGELOG 2022-08-05 01:20:05 +02:00			`### Fixed`
Update CHANGELOG 2022-08-14 12:26:01 +02:00			`Thanks to [@ConteZero](https://github.com/contezero) for reporting and providing feedback on these issues:`
Update CHANGELOG 2022-08-05 01:20:05 +02:00			`- [#51][i51]: Fixed issue where terminal would lose focus on Tab/Arrow key presses`
Update CHANGELOG 2022-08-14 12:26:01 +02:00			`when in a scene with other input nodes.`
Request redraw after write if terminal visible Requests a redraw after writing to terminal if it is visible, otherwise terminal will not be updated if there are no other redraw requests. Fixes #53. 2022-08-07 05:34:57 +02:00			`- [#53][i53]: Fixed issue where terminal was not updating when there was no GUI`
Update CHANGELOG 2022-08-14 12:26:01 +02:00			`activity.`
			`- [#55][i55]: Fixed unicode errors that would occur when using PTY with Terminal.`
			`- [#56][i56]: Fixed incorrect initial size of PTY when used with Terminal.`

Bump version to 2.1.0 2022-07-10 23:31:34 +02:00
Update CHANGELOG 2022-08-05 01:20:05 +02:00			`[i51]: https://github.com/lihop/godot-xterm/issues/51`
Update CHANGELOG 2022-08-14 12:26:01 +02:00			`[i53]: https://github.com/lihop/godot-xterm/issues/53`
			`[i55]: https://github.com/lihop/godot-xterm/issues/55`
			`[i56]: https://github.com/lihop/godot-xterm/issues/56`
Update CHANGELOG 2022-08-05 01:20:05 +02:00

			`## [v2.1.0](https://github.com/lihop/godot-xterm/compare/v2.0.0...v2.1.0) - 2022-07-11`
Support universal (x86_64/arm64) builds for macOS The macOS binary (libgodot-xterm.osx.64.dylib) is now a universal binary that runs natively on both x86_64 and arm64. 2022-05-31 15:14:41 +02:00			`### Added`
			`- Support for macOS universal (x86_64/arm64) binaries. The macOS binary`
			`libgodot-xterm.osx.64.dylib` is now a universal binary that runs natively
			`on both x86_64 and arm64.`
Bump version to 2.0.0 How it started... ```gdscript extends TextEdit ``` How it's going... ```c++ ``` 2021-07-25 18:27:21 +02:00
Add Docker build for Linux Adds support for building Linux binaries inside a docker container in order to target an older version of GLIBC. Updates GitHub Actions workflow to use it. As a result the minimum version of GLIBC that Linux users need to have installed on their system is 2.17 which was released in 2012. 2022-06-01 05:26:03 +02:00			`### Changed`
			`- Linux binaries now support systems with older GLIBC versions. By building the`
			`binaries inside a docker container with an older GLIBC version, the minimum`
			`required GLIBC version is now 2.17 which was released in 2012.`
Prevent editor shortcuts while terminal is focused 2022-06-01 17:39:06 +02:00			`- Prevent all editor shortcuts while terminal is focused except for:`
			`- The shortcuts used to switch between terminal tabs (Ctrl+Page up, Ctrl+Page down).`
Bump version to 2.1.0 2022-07-10 23:31:34 +02:00			`- Shortcuts starting with Ctrl+Shift. This includes the remaining default terminal`
Prevent editor shortcuts while terminal is focused 2022-06-01 17:39:06 +02:00			`panel shortcuts such as 'Copy' (Ctrl+Shift+C) and 'New Terminal' (Ctrl+Shift+T).`
Bump version to 2.1.0 2022-07-10 23:31:34 +02:00			`- Changed target Godot version from 3.3.2-stable -> 3.4.4-stable.`
Prevent scrollback buffer reset when using copy shortcut Prevents scrollback buffer reset (i.e. scrolling to the bottom of terminal output) when pressing modifier keys in isolation or when copying text using the shortcut Ctrl+Shift+C. 2022-06-26 19:41:24 +02:00			`- Prevent scrollback buffer reset (i.e. scrolling to the bottom of terminal output) when`
			`pressing modifier keys in isolation or when copying text using the shortcut Ctrl+Shift+C.`
Add Docker build for Linux Adds support for building Linux binaries inside a docker container in order to target an older version of GLIBC. Updates GitHub Actions workflow to use it. As a result the minimum version of GLIBC that Linux users need to have installed on their system is 2.17 which was released in 2012. 2022-06-01 05:26:03 +02:00
Remove custom TerminalSettings Resource type There is no current public use for this type and it would appear in every resource dropdown. While this type is no longer exposed publically by the plugin it is still used internally by terminal_panel. 2022-06-01 06:50:34 +02:00			`### Removed`
			`- Removed custom TerminalSettings Resource type.`
			`This Resource was not being used but would still appear in every resource dropdown.`
Bump version to 2.1.0 2022-07-10 23:31:34 +02:00			`(Related issue [godotengine/godot#24643](https://github.com/godotengine/godot/issues/24643)).`
Remove custom TerminalSettings Resource type There is no current public use for this type and it would appear in every resource dropdown. While this type is no longer exposed publically by the plugin it is still used internally by terminal_panel. 2022-06-01 06:50:34 +02:00
Register pipe.close() method Allows kill() method of unix PTY node to be called without error. 2022-04-30 13:31:24 +02:00			`### Fixed`
			- The `kill()` method of unix PTY node can now be called without error as the underlying
			`pipe.close()` method of the gdnative library is now registered.
Check if baton FuncRef is valid before calling call_funcv() Often when closing a terminal in the terminal panel the error message 'Condition "!obj" is true.' would be printed to console. This was due to the call_funcv() method being called on an invalid FuncRef instance (invalid because it had already been deleted or queued for delection). Now we check the instance is valid before calling the method. 2022-06-01 12:03:42 +02:00			`- Fixed 'Condition "!obj" is true.' error that would often print to console when`
			`closing terminals in the Terminal panel of the editor plugin.`
Prevent exit callback instance leaks De-references pty_baton's exit callback after it is called so it can be automatically released, preventing leaked instances. Adds basic implementation for Pipe's get_status() method and forces PTY to wait for child process to exit to ensure exit callback is cleaned up. Adds a test to check that exit callback is still called as usual. 2022-06-23 15:30:27 +02:00			`- Fixed leaked instances that would occur when PTY exited but child process was still`
			`running.`
Fix resume after yield error Fixes error that would sometimes occur when closing the Terminal after calling write() but before the VisualServer had finished drawing the current frame. 2022-06-26 16:01:11 +02:00			`- Fixed "Resumed function after yield, but class instance is gone" error that would`
Bump version to 2.1.0 2022-07-10 23:31:34 +02:00			sometimes occur when closing a Terminal after calling `write()` but before VisualServer
Fix resume after yield error Fixes error that would sometimes occur when closing the Terminal after calling write() but before the VisualServer had finished drawing the current frame. 2022-06-26 16:01:11 +02:00			`had finished drawing the current frame.`
Register pipe.close() method Allows kill() method of unix PTY node to be called without error. 2022-04-30 13:31:24 +02:00
Remove custom TerminalSettings Resource type There is no current public use for this type and it would appear in every resource dropdown. While this type is no longer exposed publically by the plugin it is still used internally by terminal_panel. 2022-06-01 06:50:34 +02:00
Move CHANGELOG links inline This is so they don't get forgotten when updating the CHANGELOG. 2022-05-15 05:42:42 +02:00			`## [v2.0.0](https://github.com/lihop/godot-xterm/compare/v1.2.1...v2.0.0) - 2021-07-25`
Add transparency support for theme colors Closes #19. 2020-11-29 09:45:57 +01:00			`### Added`
Bump version to 2.0.0 How it started... ```gdscript extends TextEdit ``` How it's going... ```c++ ``` 2021-07-25 18:27:21 +02:00			`- Terminal editor plugin. Adds integrated terminal to Godot editor.`
			`- Xresources import plugin.`
			`- [#39][i39]: Support for the bell "\u0007" character.`
Add HTML5 support 2021-06-07 08:53:43 +02:00			`- HTML5 Support.`
Bump version to 2.0.0 How it started... ```gdscript extends TextEdit ``` How it's going... ```c++ ``` 2021-07-25 18:27:21 +02:00			`- [#24][i24]: Support for Windows 32-bit (Terminal node only).`
Add transparency support for theme colors Closes #19. 2020-11-29 09:45:57 +01:00
Set a default theme if theme property is not set This means that the terminal is no longer blank if no theme has been set. 2020-11-29 09:22:34 +01:00			`### Changed`
Bump version to 2.0.0 How it started... ```gdscript extends TextEdit ``` How it's going... ```c++ ``` 2021-07-25 18:27:21 +02:00			`- [#44][i44]: Default theme to match Godot's default theme.`
Add HTML5 support 2021-06-07 08:53:43 +02:00			`- Supported Godot version -> 3.3.2.`
Set a default theme if theme property is not set This means that the terminal is no longer blank if no theme has been set. 2020-11-29 09:22:34 +01:00			`- Set a default theme if no theme property has been set.`
Change default font and reduce size Changes default font from Cousine -> Hack which is the font used in Godot's script editor and output terminal. Also reduced the size from 16 -> 14. 2021-06-22 16:02:08 +02:00			`- Changed default font from Cousine to Hack, which is the same as Godot's script editor, and reduced size from 16 to 14.`
Don't register TPut util as a global unique class 2021-07-02 18:58:25 +02:00			- TPut no longer registered as a unique global class (i.e. removed `class_name TPut`).
Set a default theme if theme property is not set This means that the terminal is no longer blank if no theme has been set. 2020-11-29 09:22:34 +01:00
Use "Light Cyan" color from theme Previously this color was ignored. 2020-11-29 05:48:18 +01:00			`### Fixed`
Bump version to 2.0.0 How it started... ```gdscript extends TextEdit ``` How it's going... ```c++ ``` 2021-07-25 18:27:21 +02:00			`- [#40][i40]: Vim related bugs, caused by incorrectly handled control sequences.`
Don't swap red and blue channels of theme colors Fixes #18 2020-11-29 05:49:09 +01:00			`- Don't swap red and blue channels of theme colors.`
Use "Light Cyan" color from theme Previously this color was ignored. 2020-11-29 05:48:18 +01:00			`- Use "Light Cyan" color from theme. Previously ignored.`
Bump version to 1.2.1 2020-11-23 10:11:59 +01:00
Bump version to 2.0.0 How it started... ```gdscript extends TextEdit ``` How it's going... ```c++ ``` 2021-07-25 18:27:21 +02:00			`[i24]: https://github.com/lihop/godot-xterm/issues/24`
			`[i39]: https://github.com/lihop/godot-xterm/issues/39`
			`[i40]: https://github.com/lihop/godot-xterm/issues/40`
			`[i44]: https://github.com/lihop/godot-xterm/issues/44`

Bump version to 1.2.1 2020-11-23 10:11:59 +01:00
Move CHANGELOG links inline This is so they don't get forgotten when updating the CHANGELOG. 2022-05-15 05:42:42 +02:00			`## [v1.2.1](https://github.com/lihop/godot-xterm/compare/v1.2.0...v1.2.1) - 2020-11-23`
Bump version to 1.2.1 2020-11-23 10:11:59 +01:00			`### Changed`
			`- GitHub Actions workflow now produces both a release and debug zip archive.`

Build windows releases with /MT rather than /MD When making a release export of a project, binaries built with the /MD flag do not work. 2020-11-22 16:16:38 +01:00			`### Fixed`
Bump version to 1.2.1 2020-11-23 10:11:59 +01:00			`- Release binary for Windows 64-bit export.`
Update CHANGELOG, README and bump version 2020-11-21 13:26:41 +01:00

Move CHANGELOG links inline This is so they don't get forgotten when updating the CHANGELOG. 2022-05-15 05:42:42 +02:00			`## [v1.2.0](https://github.com/lihop/godot-xterm/compare/v1.0.0...v1.2.0) - 2020-11-21`
Add support for Windows 64-bit Tested on NixOS, Ubuntu and Arch Linux. Not yet able to compile for Windows 32-bit on NixOS or on Windows itself. Part of #5 2020-11-05 09:42:00 +01:00			`### Added`
Update CHANGELOG, README and bump version 2020-11-21 13:26:41 +01:00			`- Support for macOS 64-bit including Pseudoterminal.`
			`- Partial support for Windows 64-bit and compiling on Windows using MSVC. Pseudoterminal not yet supported. 32-bit builds might be possible but not yet built/tested.`
Add support for Windows 64-bit Tested on NixOS, Ubuntu and Arch Linux. Not yet able to compile for Windows 32-bit on NixOS or on Windows itself. Part of #5 2020-11-05 09:42:00 +01:00
Update build script Former-commit-id: fd39635fc5c0b7c39959d94e8dcdbebb94498e00 2020-10-13 10:20:40 +02:00			`### Changed`
Update CHANGELOG, README and bump version 2020-11-21 13:26:41 +01:00			- Updated build script. On Linux `./build.sh` will create a debug build of the gdnative library for the current platform.
Remove pre-compiled binaries from git history Closes #13 2020-11-06 09:40:29 +01:00			`- Removed all pre-compiled binaries using BFG [Repo-Cleaner](https://rtyley.github.io/bfg-repo-cleaner/), thus re-writing git history.`
Bump version to 1.0.0 Former-commit-id: 46b2d2c56f5105feb50f1db8e0e2e7001891de99 2020-10-05 12:12:15 +02:00
Use alloc_c_string() to convert String to char* Using get_data() would sometimes result in the wrong data being written. Fixes #12 2020-11-07 11:12:31 +01:00			`### Fixed`
Update CHANGELOG, README and bump version 2020-11-21 13:26:41 +01:00			- Fixed bug where incorrect data would sometimes be written to the terminal when passing a string to the Terminal's `write()` method.
			`- Positioned background rect at 0,0 so it is no longer offset if a margin is added when Terminal is a child of a Container node.`
			`- Passed correct argv to the execvp call of Pseudoterminal. Previously argv[0] was not set to the program's name which caused the Pseudoterminal node not to work on macOS with the zsh shell.`

Use alloc_c_string() to convert String to char* Using get_data() would sometimes result in the wrong data being written. Fixes #12 2020-11-07 11:12:31 +01:00
Move CHANGELOG links inline This is so they don't get forgotten when updating the CHANGELOG. 2022-05-15 05:42:42 +02:00			`## [v1.0.0](https://github.com/lihop/godot-xterm/releases/tag/v1.0.0) - 2020-10-05`
Add a changelog Former-commit-id: 55544de93ed981f190e3a3287c441162c5cfee06 2020-09-22 09:58:07 +02:00			`### Added`
			`- Changelog.`
Add asciicast importer Former-commit-id: ffa85618659024515cdde252c56c7be34a245446 2020-09-22 10:31:46 +02:00			`- Asciicast importer plugin. Enables the import of .cast ([asciicast files v2](https://github.com/asciinema/asciinema/blob/master/doc/asciicast-v2.md)) that can be made using the [asciinema](https://asciinema.org/) terminal session recorder. See the [asciicast scene](/examples/asciicast) for example usage.`
Add pre-built binary for x11 platform Former-commit-id: 293d35f5c536c45df96a3e43d5c7e2694ce27d38 2020-10-05 12:33:23 +02:00			`- Pre-built binary for x11 platform.`
Add a changelog Former-commit-id: 55544de93ed981f190e3a3287c441162c5cfee06 2020-09-22 09:58:07 +02:00
			`### Changed`
			`- Implementation of Terminal node from GDScript to GDNative using [Aetf's patched version of libtsm](https://github.com/Aetf/libtsm).`
Move input handling into the Terminal node Former-commit-id: d64800229f6ab2d6458053cfa62e12f209b1e42b 2020-09-24 12:29:19 +02:00			`- Move input handling to the Terminal node itself, rather than handling it in a seperate Control node.`
Change write method to accept both String and PoolByteArray Will print a warning if neither of these types is used as an argument. Former-commit-id: 57aed28a0ecfbbdefea2b1d27f935bf17f257e18 2020-09-25 08:12:31 +02:00			- The Terminal `write()` method now accepts both String and PoolByteArray.