Skip to content

akiyosi/goneovim

Repository files navigation

Goneovim

CI Go Report Card GitHub Releases Join the chat at https://gitter.im/goneovim/community

Goneovim (pronounced like "go-neovim") is a Neovim GUI written in Go, using a Qt binding for Go. This repository forked from the original Gonvim for the purpose of maintenance and enhancement.

Why Neovim GUI

Traditionally, Neovim (and even Vim) has been optimized for working with Terminal, and some Terminal-based workflows cannot be achieved with a GUI. Therefore, for some people, a GUI would be an unnecessary additional stuff. On the other hand, in my opinion, there are some attractive features of GUI as follows.

  • More meta keys can be used
    • Since Neovim performs all of its operations with the keyboard, having more meta keys available is a simple advantage.
  • Terminal is also available in Neovim GUI
    • Neovim has an embedded terminal emulator that can be run in :terminal, so you can run basic terminal workflows using :terminal with bash or zsh in Neovim GUI. It is also possible to use remote control tools such as nvr to avoid nvim in nvim in Neovim GUI.
  • Experience the rich drawing expressions of GUI
    • For example, it is possible to scroll based on pixels, to set different font families and point sizes for each window.

If you are interested in these GUI attractions, try goneovim.

Features

All of the features are optional. You can use it like a plain nvim or as a nvim with a rich UI.

  • Fast
  • Cross-platform
  • Modern Text Editor Features
    • Smooth pixel scroll (Support for both touchpad and Vim scroll command reactions.)
    • Animated Cursor
    • Ligatures
    • Built-in Indent guide
    • Scrollbar
    • Workspace feature which manages multiple nvim
  • Features as neovim GUI
    • Externalizable tabline, popupmenu, wildmenu, cmdline, messages
    • Support gui option: guifont, guifontwide, guifont=*, linespace, guicursor. You don't need neovim-gui-shim
    • Supports per character font fallback feature
    • Support mouse
    • Independent font settings per window (experimental)
    • Attach/Connect feature to a remote nvim
    • WSL integration (for Windows)
    • Own clipboard provider
  • Basic feature as a Text Editor
    • Multi byte character
    • Drag and Drop files
    • InputMethod Editor (for east asian users)
  • Miscellaneous
    • Supports application window transparency
    • Desktop Notification of the messages emitted nvim

Requirements

See Installing Neovim

Getting Started

Pre-built packages for Windows, MacOS, Linux are found at the Releases page.

Or you can get the latest binary from Github Actions CI. See Actions page.

Windows users can install using scoop:

scoop bucket add extras
scoop install goneovim

or

scoop bucket add versions
scoop install goneovim-nightly

MacOS users can install using homebrew:

brew install --cask goneovim

Usage

See :h goneovim or wiki

Development

  1. Clone this repo and cd into the repo
  2. make qt_bindings
  3. make deps
  4. make app

For more information, see Development

Similar projects

Credits

Screenshots

Workspaces

Smooth Scroll with touchpad

Smooth Scroll for neovim scroll commands

External Float Window, Minimap(experimental)