interesting
/
aminal
mirror of https://github.com/liamg/aminal.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
171 Commits 4 Branches 11 Tags 47 MiB
Go 99.9%
Go to file
Liam Galvin d1fecb4f89
Update README.md 		2018-10-24 14:04:15 +01:00
.circleci rename 2018-10-21 15:11:10 +01:00
.github/ISSUE_TEMPLATE Update bug_report.md 2018-10-23 15:01:15 +01:00
buffer text selection and copy/paste 2018-10-24 12:15:43 +01:00
config text selection and copy/paste 2018-10-24 12:15:43 +01:00
demo progress toward vim support 2018-10-23 14:22:27 +01:00
glfont remove comments/debug 2018-10-21 13:30:32 +01:00
gui text selection and copy/paste 2018-10-24 12:15:43 +01:00
terminal text selection and copy/paste 2018-10-24 12:15:43 +01:00
vendor Downgrade to stable GLFW (3.2) 2018-10-23 15:58:13 +01:00
.gitignore rename 2018-10-21 15:11:10 +01:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2018-10-21 15:41:47 +01:00
CONTRIBUTING.md fix scrollable region in htop 2018-10-23 10:39:23 +01:00
Gopkg.lock Downgrade to stable GLFW (3.2) 2018-10-23 15:58:13 +01:00
Gopkg.toml Downgrade to stable GLFW (3.2) 2018-10-23 15:58:13 +01:00
LICENSE Create LICENSE 2018-10-21 11:54:58 +01:00
PULL_REQUEST_TEMPLATE.md Create PULL_REQUEST_TEMPLATE.md 2018-10-21 15:57:21 +01:00
README.md Update README.md 2018-10-24 14:04:15 +01:00
config.go tidy up main package 2018-10-23 15:31:47 +01:00
demo.gif added gif to readme 2018-10-24 09:58:45 +01:00
logger.go tidy up main package 2018-10-23 15:31:47 +01:00
main.go tidy up main package 2018-10-23 15:31:47 +01:00

README.md

Aminal - A Modern Terminal Emulator

CircleCI

Aminal is a modern terminal emulator implemented in Golang and utilising OpenGL.

Example screenshot

The project is experimental at the moment, so you probably won't want to rely on Aminal 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

What isn't supported?

  • Suspend/Continue (^S, ^Q). This is archaic bullshit that annoys more people than it helps. Basically:

Overheating

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 ✔
OpenGL rendering ✔
8-bit (256) colour ✔
24-bit (true) colour ✔
Resizing/content reordering ✔
ANSI escape codes ✔
UTF-8 input ✔
UTF-8 output ✔
Copy/paste ✔
Customisable colour schemes ✔
Config file ✔
Scrolling ✔
Mouse interaction ✔
Sweet render effects

Keyboard Shortcuts

Operation Key(s)
Copy ctrl + shift + c
Paste ctrl + shift + v
Toggle slomo ctrl + shift + ;
Interrupt (SIGINT) ctrl + c

Configuration

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

You can ignore the config and use defaults 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.