CoVim

Collaborative Editing for Vim (One of Vim's most requested features) is finally here! Think Google Docs for Vim.

By: Fred Schott, Sam Haney
Follow @FredKSchott for development news and updates!

Features

Allows multiple users to connect to the same document online
Displays collaborators with uniquely colored cursors
Works with your existing configuration
Easy to set up & use
And More!

Installation

CoVim requires a version of Vim compiled with python 2.5+. Visit Troubleshooting if you're having trouble starting Vim. Also note that the Twisted & Argparse libraries can also be installed via apt-get & yum.

Install With Pathogen:

pip install twisted argparse service_identity
cd ~/.vim/bundle
git clone git://github.com/FredKSchott/CoVim.git

Install With Vundle:

pip install twisted argparse service_identity
Add Plugin 'FredKSchott/CoVim' to your ~/.vimrc
vim +PluginInstall +qall

Install Manually:

pip install twisted argparse service_identity
Add CoVimClient.vim & CoVimServer.py to ~/.vim/plugin/

If Vim is having trouble finding modules (twisted, argparse, etc) do the following:

run pip show MODULE_NAME and get the Location: path

add the following line to your .vimrc: python import sys; sys.path.append("/module/location/path/") using the module path found in step 1.

Repeat until all modules are included in your path

If you're still having trouble, visit the wiki for additional troubleshooting & FAQ

Usage

To start a new CoVim server: :CoVim start [port] [name] (or, from the command line: ./CoVimServer.py [port])
To connect to a running server: :CoVim connect [host address / 'localhost'] [port] [name]
To disconnect: :CoVim disconnect
To quit Vim while CoVim is connected: :CoVim quit or :qall!

Customization

Add any the following to your .vimrc to customize CoVim:

let CoVim_default_name = "YOURNAME"
let CoVim_default_port = "YOURPORT"

Links

Announcement Post
FAQ
Troubleshooting

Special Thanks

Tufts Professor Ming Chow for leading the Senior Capstone Project that CoVim was born in.

FredKSchott / CoVim