A cross-platform “virtual terminal” (VT) manipulation library.
Termina works on Windows as well as *NIX, but Windows requires some extra thought to choose the preferred way of handling input.
Termina is a cross between Crossterm and TermWiz with a lower level API which exposes escape codes to consuming applications. The aim is to scale well in the long run as terminals introduce VT extensions like the Kitty Keyboard Protocol or Contour's Dark/Light mode detection - requiring minimal changes in Termina and also allowing flexibility in how applications detect and handle these extensions. See examples/event-read.rs for a look at a basic API.
Termina is able to “speak text/VT” on Windows. This is made possible by Microsoft's investment into ConPTY. This means that this input mode requires 64-bit Windows 10.0.17763 (released around Fall 2018) or later (same as WezTerm). However, using VT mode on Windows means the terminal you use needs to support the Kitty Keyboard Protocol in order to handle some complex key combinations. Windows Terminal supports the protocol as of Preview v1.25.622.0, so VT mode is a good default there, and it also unlocks newer features such as bracketed paste. Not every terminal implements the protocol, though, so there is no single answer for which mode to use - it depends on your terminal and use case.
See feature comparison below.
| VTE Mode | Legacy Console Mode | |
|---|---|---|
| Kitty Keyboard Protocol | ✓ | ✕ |
| Extended key events | terminal-dependent* | ✓ |
| Bracketed paste | ✓ | ✕ |
| AltGr Support | ✓ | ✕ |
The legacy input reader can be used by enabling the windows-legacy feature. See the event-read example for usage.
Termina contains significant code sourced and/or modified from other projects, especially Crossterm and TermWiz. Credits for various implementations are marked in implementation notes sections. Since all copied code is licensed under MIT, Termina is offered under the MIT license as well at your option.
MIT License Copyright (c) 2019 Timon Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
MIT License Copyright (c) 2018 Wez Furlong Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Licensed under either of:
at your option.