Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jbyuki/instant.nvim

collaborative editing in Neovim using built-in capabilities
https://github.com/jbyuki/instant.nvim

collaborative-editing lua neovim neovim-plugin realtime-collaboration websocket

Last synced: 7 days ago
JSON representation

collaborative editing in Neovim using built-in capabilities

Host: GitHub
URL: https://github.com/jbyuki/instant.nvim
Owner: jbyuki
License: mit
Created: 2020-09-03T05:41:48.000Z (about 4 years ago)
Default Branch: master
Last Pushed: 2022-12-31T22:59:34.000Z (almost 2 years ago)
Last Synced: 2024-10-12T22:54:40.233Z (27 days ago)
Topics: collaborative-editing, lua, neovim, neovim-plugin, realtime-collaboration, websocket
Language: Lua
Homepage:
Size: 695 KB
Stars: 1,271
Watchers: 16
Forks: 24
Open Issues: 8
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome-neovim - jbyuki/instant.nvim - A collaborative editing plugin written in Lua with no dependencies. (Utility / Cursorline)

README

instant.nvim
============

**instant.nvim** is a **collaborative editing** plugin for **Neovim** written in **Lua** with no dependencies.

* [Design document](https://github.com/jbyuki/instant.nvim/wiki/Design-Document)
* [Protocol](https://github.com/jbyuki/instant.nvim/wiki/Protocol)
* [Deploy a server](https://github.com/jbyuki/instant.nvim/wiki/Deploy-a-server)
* [API](https://github.com/jbyuki/instant.nvim/wiki/API)
* [Commands](https://github.com/jbyuki/instant.nvim/wiki/Commands)
* [Technical Overview](https://github.com/jbyuki/instant.nvim/wiki/Technical-Overview)

[![Untitled-Project.gif](https://i.postimg.cc/50vfZ6Wr/Untitled-Project.gif)](https://postimg.cc/yg1qR6dh)

Features
--------

* Powerful collaborative editing algorithm

* UTF-8 Support

* Single or multiple buffer sharing

* Virtual cursors with username of other clients

* Spectate actions of a user

* Built-in localhost server

* Separated undo/redo for each user

* Persistent data on server

Requirements
------------

* Neovim 0.4.4 or above

Install
-------

Install using a plugin manager such as [vim-plug](https://github.com/junegunn/vim-plug).

```
Plug 'jbyuki/instant.nvim'
```

Configurations
--------------

* Set your username in `init.vim`:

```
let g:instant_username = "USERNAME"
```

See [here](https://github.com/jbyuki/instant.nvim/wiki/Customization) for more customization options.

Usage
-----

The collaborative editing plugin works with a server which connects together the clients. Thus, a server must be running which must be reachable by all clients.

### Server (Neovim or node.js)

For a localhost or LAN network, you can simple use the built-in server included in the plugin.

* Start it with `:InstantStartServer [host] [port]`
* When done stop it with `:InstantStopServer`

The default is to serve localhost only, on port 8080. For a more advanced (remote server) overview see [Deploy a server](https://github.com/jbyuki/instant.nvim/wiki/Deploy-a-server)

### Client (Neovim)

To start the client, the first user to connect to the server must initiates the share with a special commands with has the form `InstantStart...`. Subsequent joining clients, use a different command `InstantJoin...`. Having distinct commands to start and join a server ensures that files are not overwritten by accident on connection.

There are essentially two modes of sharing at the moment.

* **Single buffer sharing**: This will only share the current buffer.
* **Session sharing**: This will share all opened (and newly opened) buffers with the other clients. This can be thought of directory sharing without implicit writing on the file system.

For single buffer sharing use:
* `:InstantStartSingle [host] [port]` : Host is the URL or IP address. Port is 80 by default. Use this command if you're the first client to connect.
* `:InstantJoinSingle [host] [port]` : Use this command if another client already initiated a single share.
* `:InstantStop` : This will stop the client

For session sharing:

* `:InstantStartSession [host] [port]` : If you're the first client to connect.
* `:InstantJoinSession [host] [port]` : Use this command if another client already initiated a session share
* `:InstantStop`

Additional useful sharing commands are:

* `:InstantStatus` : Display the current connected clients as well as their locations
* `:InstantFollow [user]`
* `:InstantStopFollow`
* `:InstantOpenAll` : Open all files in buffers in the current directory. Useful to share the whole directory in session sharing.
* `:InstantSaveAll` : Save all opened buffers automatically. This will also create missing subdirectories.
* `:InstantMark` : Visually mark a region
* `:InstantMarkClear`

### Tips and Tricks

* If there is an issue, you can resync by stopping and reconnecting.
* In session sharing, view all the available buffers with `:ls`.

### Help

* If you encounter any problem, please don't hesitate to open an [Issue](https://github.com/jbyuki/instant.nvim/issues)
### Contributions

See [here](https://github.com/jbyuki/ntangle.nvim/wiki/How-to-use-ntangle.nvim).

* All contributions are welcome