floobits/floobits-sublime

Floobits real-time collaboration plugin for Sublime Text 2 and 3

Floobits plugin for Sublime Text 2 & 3

Real-time collaborative editing. Think Etherpad, but with native editors. This is the plugin for Sublime Text. We also have plugins for Emacs, Vim, and IntelliJ.

Development status: Reasonably stable. We dogfood it daily and rarely run into issues.

Installation instructions

• If you have Package Control, go to Package Control → Install Package and search for Floobits. Select the Floobits package and install it.

• If you don't have Package Control (or you prefer to install the plugin manually), clone this repository or download and extract this tarball.

• Rename the directory to "Floobits".

• In Sublime Text, go to Preferences -> Browse Packages.

• Drag, copy, or move the Floobits directory into your Packages directory.

If you'd rather create a symlink instead of copy/moving, run something like:

ln -s ~/code/floobits-sublime ~/Library/Application\ Support/Sublime\ Text\ 3/Packages/Floobits

Once the plugin is installed, you'll be asked whether you want to create an account or sign in. If you choose to sign in, a browser window will open allowing you to enter your Floobits credentials.

For more help, see our Sublime Text help page.

Configuration

All configuration settings are stored in ~/.floorc.json. If you don’t have a ~/.floorc.json file, the plugin will create one. It will also open a web page showing the minimal information you’ll need to put in your ~/.floorc.json. After saving the file, restart Sublime Text.

Using Floobits to Collaborate

After creating your account, you’ll want to create a workspace or two. A workspace is a collection of files and buffers that users can collaborate on.

See https://floobits.com/help/plugins/sublime/#usage for instructions on how to create workspaces and collaborate with others.

Errata

Windows

Sublime Text 2 on Windows requires Package Control 3.0 to be installed to function properly. This is due to a bug in the select module that ST2 ships by default.

Linux

On Linux, Sublime Text 2 and 3 ship without the _ssl module. Installing Package Control 3.0 will install the missing elements. Otherwise, we try to work around it by running an SSL proxy using the system Python.

OS X

Our plugin doesn't work on 10.6 and earlier. This appears to be a bug in OS X. Please upgrade to a newer version.

Help

If you have trouble setting up or using this plugin, please contact us.

floobits-sublime's Issues

Plugin breaks on Windows

    Reloading plugin C:\Users\<USERNAME>\AppData\Roaming\Sublime Text 2\Packages\Floobits\floobits.py
    Traceback (most recent call last):
      File ".\sublime_plugin.py", line 62, in reload_plugin
      File ".\floobits.py", line 15, in <module>
        from floo import api
      File ".\floo\__init__.py", line 2, in <module>
        from agent_connection import AgentConnection
      File ".\floo\agent_connection.py", line 6, in <module>
        import select
    ImportError: No module named select

Join room should create a new window/project

JSON Error in packages.json file

You have a stray pair of backticks in your packages.json file.

Log patch and buffer info if buffer contains 0x01, 0x02, 0x03

There seems to be a hard to reproduce bug where these bytes are showing up at the end of some files.

Jump to User Option

Should be a list menu thing- one per person.

Connect using TLS/SSL

Shipping code in plaintext is not cool.

Fix Scrolling in Follow Mode

The current option induces motion sickness.

ReadMe location of shared folder example incorrect

README lists the location of the shared dir as

 "share_dir": "~/.floobits/shared/"

I followed the install directions and found this

 "share_dir": "~/.floobits/share/"

No module named _ssl and greyed out menu

Hi, I would really like to use this extension but haven't be able to make it work so far.
I run Linux Mint 13 XFCE.

When ST2 loads, I can see this error in the console :
Reloading plugin /home/steven/.config/sublime-text-2/Packages/Floobits/floobits.py
Traceback (most recent call last):
File "./sublime_plugin.py", line 62, in reload_plugin
File "./floobits.py", line 14, in
from floo import AgentConnection
File "./floo/init.py", line 2, in
from agent_connection import AgentConnection
File "./floo/agent_connection.py", line 8, in
import ssl
File ".\ssl.py", line 60, in
ImportError: No module named _ssl

When i right click in ST2, the Floobits submenus are greyed out.

I know ST2 doesn't support SSL on Linux, but I would really like to know if there is still a way to make the floobit plugin work.

Thanks.

Install not working

Package Control: No updated packages
ignored packages updated to: [Vintage, Floobits]
found 1 files for base name Default.sublime-theme
Exception in thread Thread-5:
Traceback (most recent call last):
File "/System/Library/Frameworks/Python.framework/Versions/2.6/lib/python2.6/threading.py", line 532, in __bootstrap_inner
self.run()
File "./Package Control.py", line 4032, in run
File "./Package Control.py", line 3181, in install_package
File "./Package Control.py", line 2695, in download_url
File "./Package Control.py", line 1683, in download
File "./Package Control.py", line 1414, in check_certs
File "./Package Control.py", line 1451, in locate_cert
File "./Package Control.py", line 1478, in download_cert
NameError: global name 'domain' is not defined

Leave room/disconnect

Some file/directory names are not allowed

A friend and I are wanting to collaborate on a node project using Floobits. When adding the project to our room, we get the following error message in the msg.floobits.log over 100 times:

Floobits: Error! Message: create buf failed: "node_modules" is not an allowed file or directory name

We don't understand why there is a naming restriction. Could this be removed?

Symlinks on windows... oops

So... we broke the ST3 plugin on windows again. It's probably the symlinking stuff we recently added.

Prompt before deleting files on disk

Right now, "remove file from room" does what it says... and also deletes the file off the disk without prompting. That's not very nice.

Typing at the same time screws up the other person's cursor

We fixed this in the web editor but it'll be really hard to get working in sublime. view.replace() literally moves the user's cursor for a millisecond, so anything they type in that instant will go to the wrong place.

Chat

Current plan: create a view with an input box.

Closing a file without saving it sends the old version to everyone else when you re-open it

This one is super-annoying.

Send highlights whenever a user switches views

Right now, cursors don't get updated until the user moves it in the view. On view change, we should send a highlight event to fix this.

Show connection status

Right now we don't give any feedback unless you check the console. It'd be nice to let the user know what's going on.

We could call window.set_status() a few times, then clear the status when we're successfully connected.

Terminal sharing

This doesn't just belong in the ST2 plugin. We need to figure out a way to share terminals. It's not fun to keep copy-pasting output so others can see it.

Don't stomp over sidebar when joining a room.

Specific to the ST3 branch.

Instead of stomping over the current window, the plugin should open a new window. (Unless of course, the current window only contains files from a room.)

Changes aren't pushed after closing and re-opening a file

Changing credentials doesn't take effect until sublime is restarted

This is super frustrating and unintuitive.

Command/shortcut to show message buffer

Create room

It'd be nice to create a room from the currently-open project/window/whatever.

I'm working on the API to support this. Creating a room should go something like:

curl -X POST -d secret=1234 -d username=ggreer -d name=blah -d perms=2 https://floobits.com/api/room/

Then it's a matter of joining the room and sending create_buf events for all files in the current window.

Undo with multi-cursors only reverts one cursor at a time

This is because of patch_apply in Listener. We're creating one edit event for each patch.

SSL is broken on Windows

Although it finds the startssl cert, it doesn't seem to verify it. Instead of a lame workaround, I'd rather actually get cert verification to work.

Sublime text 3

Either port this plugin or start a new one.

Better reconnecting behavior

If we get disconnected for a bad api secret or something, we should stop retrying.

Clear mirrored selections

It's really annoying if someone else leaves text selected.

Better UI

We should probably allow joining a new room but prompt if the user is already in one.

Expose shortcuts in menus

user confusion

Requests from dreid:

Also, Join Room doesn't show up when I'm already in a room but Join Recent Room does. It took me a while to figure out that I couldn't be in more than one room.

I wish Ping were in the command pallet.

...the inconsistency of Join Recent Room showing up but not Join Room was more confusing.

Add support for sending/obeying ping highlights

The web editor lets you do it, but ST2 doesn't do it or obey it (of course the ST2 plugin doesn't follow mode either).

Related to #9 and #29.

Work better with git/hg/svn repos

After joining a room and changing files, you have to copy the changes back to your git checkout before you can commit. That's no fun. We should allow .git/.svn/etc in the room directory, but not sync them (since people could be on different branches or have personal information in those files/directories).

"Open messages view" is broken on ST2

It works on ST3 though.

Joining a room blanks currently-selected buffer

Hook up join previous room command.

Also, add a setting to automagically join a room on boot.

Bulk import (add directory)

There needs to be a way to bulk import directories/files in this plugin.

Obey .git/hg/svn ignore... and .flooignore or whatever

Another option would be to detect git/svn/hg repos and only add files in them.

This should reduce instances of people accidentally adding log files and node_modules.

Reconnect command/button/shortcut

It's annoying to wait for the timeout or putz around with join recent room.

Allow sharing of files from any path

Right now, shared files must be in ~/.floobits/shared/whatever. That's a big stumbling block for people trying to add files to an empty room.

Install fails on 2220

Somehow the installation seems successful but the Preferecens > Package Settings > Floobits menu never appears, including after a full restart of the app.

Worse, after a restart the app is available again in the Package Control > Install Packages list as if it was never installed in the first place.

Can anybody else reproduce this?

Follow mode

ST2 doesn't have ssl on linux

Linux users of sublime text 2 can't create rooms, since we require the POSTs to be over HTTPS. I just pushed code to stop the plugin from crashing, but it's still annoying.

Log other stuff in message buffer

In addition to chat messages, we should show connect/disconnects, create/delete/rename buffers, etc.

Location of Sublime is hardcoded to /Applications when joining workspace

When trying to join a workspace, the following error occurs because my Sublime Text 2 app does not live in /Applications.

Project path is /Users/xxx/workspace/testproject
('command:', ['/Applications/Sublime Text 2.app/Contents/SharedSupport/bin/subl', '--add', u'/Users/xxx/workspace/testproject'])
Traceback (most recent call last):
File "./sublime_plugin.py", line 337, in run_
File "./floobits.py", line 513, in run
File "./floobits.py", line 445, in open_workspace_window
File "./floobits.py", line 410, in open_workspace_window2
File "/System/Library/Frameworks/Python.framework/Versions/2.6/lib/python2.6/subprocess.py", line 623, in init
errread, errwrite)
File "/System/Library/Frameworks/Python.framework/Versions/2.6/lib/python2.6/subprocess.py", line 1141, in _execute_child
raise child_exception
OSError: [Errno 2] No such file or directory

Squelch "~/.floobits/share/msgs.floobits.log Has changed on disk. Do you want to reload it?"

It's mildly annoying. Clicking either option doesn't cause any issues.

Don't double-connect

Leaving a room and joining another causes weirdness

We're not cleaning up some things. The current workaround is to restart sublime text :(