https://github.com/hexedtech/codemp-nvim
neovim codemp plugin -- code multiplexer
https://github.com/hexedtech/codemp-nvim
codemp collaborative lua nvim
Last synced: 8 months ago
JSON representation
neovim codemp plugin -- code multiplexer
- Host: GitHub
- URL: https://github.com/hexedtech/codemp-nvim
- Owner: hexedtech
- License: gpl-3.0
- Created: 2024-08-03T13:04:07.000Z (over 1 year ago)
- Default Branch: dev
- Last Pushed: 2024-10-10T11:08:25.000Z (over 1 year ago)
- Last Synced: 2024-10-11T22:42:41.729Z (over 1 year ago)
- Topics: codemp, collaborative, lua, nvim
- Language: Lua
- Homepage: https://code.mp
- Size: 560 KB
- Stars: 4
- Watchers: 0
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://code.mp)
[](https://github.com/hexedtech/codemp-nvim)
[](https://luarocks.org/modules/alemi/codemp)
[](https://gitter.im/hexedtech/codemp)
> `codemp` is a **collaborative** text editing solution to work remotely.
It seamlessly integrates in your editor providing remote cursors and instant text synchronization,
as well as a remote virtual workspace for you and your team.
# codemp-nvim
This is the reference codemp [neovim](https://neovim.io) plugin maintained by [hexedtech](https://hexed.technology)
> compare development status with our [feature comparison matrix](https://github.com/orgs/hexedtech/projects/3)
# installation
Just add `hexedtech/codemp-nvim` to your plugin spec.
If you're using [`lazy.nvim`](https://github.com/folke/lazy.nvim), everything will be configured automatically!
If you're using something else to load `codemp-nvim`, you need to also do the following:
* run `build.lua` during installation and every update
* invoke `require('codemp-nvim').setup({ ... })` after loading, pass your config
Note that the native codemp lua library will be downloaded automatically on each update.
## neo-tree integration
`codemp-nvim` integrates with [neo-tree](https://github.com/nvim-neo-tree/neo-tree.nvim) to provide a rich and intuitive file tree.
To enable this integration, add `neo_tree = true` in plugin `opts` and add `codemp` as a neo-tree source:
```lua
{
"hexedtech/codemp-nvim",
opts = { neo_tree = true },
},
{
"nvim-neo-tree/neo-tree.nvim",
dependencies = { "hexedtech/codemp-nvim" },
config = function ()
require('neo-tree').setup({
sources = {
-- your other sources
"codemp.neo-tree",
},
})
end,
}
```
# usage
Interact with this plugin using the `:MP` command.
Most actions can be performed from the side tree: toggle it with `:MP toggle`.
| command | description |
| --- | --- |
| `:MP toggle` | toggles the codemp sidebar |
| `:MP connect [host] [username] [password]` | to connect to server, user and pwd will be prompted if not given |
once connected, more commands become available:
| command | description |
| --- | --- |
| `:MP disconnect` | disconnects from server |
| `:MP id` | shows current client id |
| `:MP start ` | will create a new workspace with given name |
| `:MP invite ` | invite given user to workspace |
| `:MP available` | list all workspaces available to join |
| `:MP join ` | will join requested workspace; starts processing cursors, users and filetree |
after a workspace is joined, more commands become available:
| command | description |
| --- | --- |
| `:MP leave ` | disconnect from a joined workspace |
| `:MP attach ` | will attach to requested buffer if it exists (opens a new local buffer and uses current window) |
| `:MP detach ` | detach from a buffer and stop receiving changes |
| `:MP share` | shares current file: creates a new buffer with local file's content, and attach to it |
| `:MP sync` | forces resynchronization of current buffer |
| `:MP create ` | will create a new empty buffer in workspace |
| `:MP delete ` | will delete a buffer from workspace |
### quick start
* first connect to server with `:MP connect`
* then join a workspace with `:MP join `
* either attach directly to a buffer with `:MP attach ` or browse available buffers with `:MP toggle`
MP command autocompletes available options for current state, so cycle if you forget any name
## configuration
`codemp-nvim` gets most of its configuration from `setup()` options. If you're using `lazy.nvim`, just place these in the `opts` table in your spec, otherwise be sure to `require('codemp').setup({...})`.
```lua
opts = {
neo_tree = false, -- enable neo-tree integration
timer_interval = 100, -- poll for codemp callbacks every __ ms
debug = false, -- print text operations as they happen
}
```
`codemp-nvim` reads some global vim variables for configuration:
* `vim.g.codemp_username` will be used when connecting instead of prompting for username
* `vim.g.codemp_password` will be used when connecting instead of prompting for password
## building
this plugin relies on the native codemp lua bindings: just compile the main `codemp` project with `lua` feature enabled, rename the
output library into `native.so` (or `.dll` or `.dylib`) and place it together with the plugin lua files while bundling
```
.config/
|-nvim/
: |-lua/
: : |-codemp/
: : : |- native.(so|dll|dylib)
: : : |- init.lua
: : : : ...
```