https://github.com/revery-ui/revery-terminal

Barebones terminal emulator built with ReasonML + Revery + libvterm
https://github.com/revery-ui/revery-terminal

libvterm pty reason reason-native reasonml revery terminal

Last synced: 3 months ago
JSON representation

Barebones terminal emulator built with ReasonML + Revery + libvterm

• Host: GitHub
• URL: https://github.com/revery-ui/revery-terminal
• Owner: revery-ui
• License: mit
• Created: 2020-02-15T23:50:25.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2021-05-06T00:23:01.000Z (over 3 years ago)
• Last Synced: 2024-04-12T13:07:29.404Z (7 months ago)
• Topics: libvterm, pty, reason, reason-native, reasonml, revery, terminal
• Language: Reason
• Homepage:
• Size: 687 KB
• Stars: 81
• Watchers: 7
• Forks: 6
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-list - revery-terminal - ui | 77 | (Reason)

README

        
# revery-terminal

[![Build Status](https://dev.azure.com/revery-ui/revery/_apis/build/status/revery-ui.revery-terminal?branchName=master)](https://dev.azure.com/revery-ui/revery/_build/latest?definitionId=25&branchName=master)

A terminal emulator built with Revery.

This is a barebones terminal emulator factored out from the work to include a terminal emulator in [Onivim 2](https://github.com/onivim/oni2).

It's also a fun exploration in leveraging an Elm-style architecture in a natively compiled application.

![image](https://user-images.githubusercontent.com/13532591/74748975-3fbbf300-521e-11ea-8583-9ae1d4a18c35.png)

## Pre-requisites

- Make sure to install the [dependencies needed for Revery](https://github.com/microsoft/node-pty)

- __OSX:__ You'll also need `glibtool` (`brew install libtool`)

## Building

- `npm install -g [email protected]`

- `esy install`

- `esy build`

## Running

- `esy run`

## Limitations

This is just meant as an exploration, and isn't production-ready. In particular, there are some pieces missing:

- No Unicode support at the moment - assumes ASCII rendering

- No ligatures or text shaping

- No Windows support at the moment - we use the `openpty` API which is not available on Windows

- Minimal keys are handled

These would all be great contribution opportunities, though!

## Source Overview

### Main modules

- [`src/bin/App.re`](src/bin/App.re) - this is the entry point for the application (where we start the window, wire up our store).

- [`src/bin/Model.re`](src/bin/Model.re) - this is the heart of our application - that provides the definition of `Model.t` as well as how it changes over time (by providing an `updater` function).

### Supporting modules

- [`src/lib/ReveryTerminal.rei`](src/lib/ReveryTerminal.rei) - contains cross-platform utilities for working with a terminal.

- [`src/pty`](src/pty) - small OCaml binding to the `openpty` system call, to create a pseudoterminal.

## Technologies Used

- [Revery](https://github.com/revery-ui/revery) to provide the window management and drawing functionality.

- [reason-libvterm](https://github.com/revery-ui/reason-libvterm) bindings for [libvterm](http://www.leonerd.org.uk/code/libvterm)

- [isolinear](https://github.com/bryphe/isolinear) as an Elm-like applicatiion management framework.

We also use the [JetBrains Mono](https://www.jetbrains.com/lp/mono/) font.

## License

MIT