interesting
/
aminal
mirror of https://github.com/liamg/aminal.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
63 Commits 4 Branches 11 Tags 47 MiB
Go 99.9%
Go to file
Liam Galvin 8f1efd822e nice colour scheme by default 2018-08-09 15:29:27 +01:00
buffer fix deletion on wrapped line 2018-08-09 14:59:19 +01:00
config nice colour scheme by default 2018-08-09 15:29:27 +01:00
demo more scape codes 2018-07-04 17:39:50 +01:00
fonts fix deletion on wrapped line 2018-08-09 14:59:19 +01:00
gui nice colour scheme by default 2018-08-09 15:29:27 +01:00
pty tidied up deps and added login shell detection 2018-08-08 17:37:32 +01:00
terminal nice colour scheme by default 2018-08-09 15:29:27 +01:00
vendor fix deletion on wrapped line 2018-08-09 14:59:19 +01:00
.gitignore fix ignore 2018-07-01 10:44:53 +01:00
Gopkg.lock fix deletion on wrapped line 2018-08-09 14:59:19 +01:00
Gopkg.toml tidied up deps and added login shell detection 2018-08-08 17:37:32 +01:00
README.md things 2018-08-09 13:30:16 +01:00
cover.out tests 2018-08-07 21:00:34 +01:00
main.go things 2018-08-09 13:30:16 +01:00
top.log fixed top 2018-07-04 22:31:52 +01:00

README.md

Raft is a modern terminal emulator utilising OpenGL.

The project is experimental at the moment, so you probably won't want to rely on Raft as your main terminal for a while.

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

Aims

  • Full unicode support
  • OpenGL rendering
  • Full customisation options
  • True colour support
  • Support for commmon ANSI escape sequences a la xterm
  • Scrollback buffer
  • Clipboard access
  • Clickable URLs
  • Resize logic that wraps/unwraps lines correctly
  • Bullshit graphical effects
  • Multi platform support

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.

Platform Support

Platform Supported
Linux ✔
MacOSX ⏳
Windows ⏳

Planned Features

Feature Done Notes
Pty allocation ✔ Needs work for OSX + Windows
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

Keyboard Shortcuts

Operation Key(s)
Paste ctrl + shift + v
Interrupt (SIGINT) ctrl + c
Suspend ctrl + s
Resume ctrl + q

Configuration

Raft looks for a config file in ~/.raft.toml, and will write one there the first time it runs, if it doesn't already exist.

You can ignore the config and use defauls by specifying --ignore-config as a CLI flag.

Config Options/CLI Flags

CLI Flag Config Section Config Name Type Default Description
--debug root debug boolean false Enable debug mode, with debug logging and debug info terminal overlay.
--slomo root slomo boolean false Enable slomo mode, delay the handling of each incoming byte (or escape sequence) from the pty by 100ms. Useful for debugging.
--always-repaint rendering always_repaint boolean false Redraw the terminal GUI constantly, even when no changes have occurred.