godot-xterm/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.0.0...HEAD)
### Added
- Automatic download of missing gdnative libraries from GitHub releases using the version defined in `addons/godot_xterm/plugin.cfg`.
- `--docker` option to `build.sh` script, in order to build Linux binaries inside a docker container with an older GLIBC version.

### Changed
- Target Godot version from 3.3.2-stable -> 3.4.4-stable.
- GitHub Actions workflow to build Linux debug/release binaries inside docker container in order to target older GLIBC versions.

### Fixed
- Registered `pipe.close()` method, so `kill()` can be called when using unix PTY node.


## [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
Move CHANGELOG links inline This is so they don't get forgotten when updating the CHANGELOG. 2022-05-15 05:42:42 +02:00			`## [Unreleased](https://github.com/lihop/godot-xterm/compare/v2.0.0...HEAD)`
Add option to build inside docker container This allows us to target older versions of GLIBC. 2022-05-03 07:44:40 +02:00			`### Added`
Automatically download missing native libraries If gdnative libraries are missing from `addons/godot_xterm/native/bin`, they will be automatically downloaded from GitHub releases using the plugin version defined in `plugin.cfg`. 2022-05-22 08:18:01 +02:00			- Automatic download of missing gdnative libraries from GitHub releases using the version defined in `addons/godot_xterm/plugin.cfg`.
Add option to build inside docker container This allows us to target older versions of GLIBC. 2022-05-03 07:44:40 +02:00			- `--docker` option to `build.sh` script, in order to build Linux binaries inside a docker container with an older GLIBC version.

			`### Changed`
Update target Godot version: 3.3.2-stable -> 3.4.4-stable 2022-05-22 06:37:22 +02:00			`- Target Godot version from 3.3.2-stable -> 3.4.4-stable.`
Add option to build inside docker container This allows us to target older versions of GLIBC. 2022-05-03 07:44:40 +02:00			`- GitHub Actions workflow to build Linux debug/release binaries inside docker container in order to target older GLIBC versions.`
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
Register pipe.close() method 2022-04-30 13:31:24 +02:00			`### Fixed`
			- Registered `pipe.close()` method, so `kill()` can be called when using unix PTY node.

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
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.