Git Product home page Git Product logo

covim-neovim's Introduction

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!

Demo Gif

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 3.0+. 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:

  1. pip3 install twisted argparse service_identity
  2. cd ~/.vim/bundle
  3. git clone git://github.com/FredKSchott/CoVim.git

Install With Vundle:

  1. pip3 install twisted argparse service_identity
  2. Add Plugin 'FredKSchott/CoVim' to your ~/.vimrc
  3. vim +PluginInstall +qall

Install Manually:

  1. pip3 install twisted argparse service_identity
  2. Add CoVimClient.vim & CoVimServer.py to ~/.vim/plugin/

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

  1. run pip3 show MODULE_NAME and get the Location: path
  2. add the following line to your .vimrc: python3 import sys; sys.path.append("/module/location/path/") using the module path found in step 1.
  3. 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.

Analytics

covim-neovim's People

Contributors

andrewradev avatar bilalq avatar bradleyjones avatar drahflow avatar fredkschott avatar gbataille avatar jasonszhao avatar lekv avatar lencioni avatar mjbrownie avatar nicolaiskogheim avatar oliveruv avatar rogdham avatar saschagrunert avatar serverwentdown avatar tejanium avatar tomislater avatar tsfoster avatar unsignedzero avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.