Go to file
Liam Galvin bd2fcde4d3 Update README.md 2018-07-02 07:55:00 +00:00
config lots of unicode work 2018-07-01 21:57:25 +01:00
fonts initial gui base 2018-06-28 12:26:48 +01:00
gui lots of unicode work 2018-07-01 21:57:25 +01:00
pty basic terminal package 2018-06-28 15:00:16 +01:00
terminal lots of unicode work 2018-07-01 21:57:25 +01:00
vendor basic terminal package 2018-06-28 15:00:16 +01:00
.gitignore fix ignore 2018-07-01 10:44:53 +01:00
Gopkg.lock basic terminal package 2018-06-28 15:00:16 +01:00
Gopkg.toml basic terminal package 2018-06-28 15:00:16 +01:00
README.md Update README.md 2018-07-02 07:55:00 +00:00
main.go lots of unicode work 2018-07-01 21:57:25 +01:00
md lots of unicode work 2018-07-01 21:57:25 +01:00
shit lots of unicode work 2018-07-01 21:57:25 +01:00

README.md

Raft is a terminal emulator utilising OpenGL v4.1.

The project is purely a learning exercise right now.

Ensure you have your latest graphics card drivers installed before use.

Build Dependencies

  • Go 1.10.3+
  • On macOS, you need Xcode or Command Line Tools for Xcode (xcode-select --install) for required headers and libraries.
  • On Ubuntu/Debian-like Linux distributions, you need libgl1-mesa-dev xorg-dev.
  • On CentOS/Fedora-like Linux distributions, you need libX11-devel libXcursor-devel libXrandr-devel libXinerama-devel mesa-libGL-devel libXi-devel.

Planned Features

Feature Done Notes
Pty allocation Needs work for other platforms
OpenGL rendering
Resizing/content reordering
ANSI escape codes ~ Most of these are handled now
UTF-8 input
UTF-8 output Works as long as the font in use supports the relevant characters.
Copy/paste ~ Paste working, no mouse interaction for copy
Customisable colour schemes Complete, but the config file has no entry for this yet
Config file ~ Minimal options atm
Scrolling Infinite buffer implemented, need GUI scrollbar & render updates
Mouse interaction
Sweet render effects

Platform Support

Platform Supported
Linux
MacOSX ✘ (nearly)
Windows

Configuration

Raft looks for a config file in the following places: ~/.raft.yml, ~/.raft/config.yml, ~/.config/raft/config.yml (earlier in the list prioritised).

Example config:

debug: False

The following options are available:

Name Type Description
debug bool Enables debug logging

Keyboard Shortcuts

Operation Key(s)
Paste ctrl + alt + v