Sublime Text

The Floobit's plugin for Sublime Text is stable and works on OS X, Linux, and Windows.

Windows users must use Sublime Text 3 because the Windows version of Sublime Text 2 lacks Python’s select module.

Installation

Recommended: Installation using Sublime Package Control

  1. Go to Package Control → Install Package and search for Floobits. Select the Floobits package and hit enter.
  2. Installation is complete. Now you’re ready to configure the Sublime Text plugin.

Manual installation using git

  1. Find your Sublime Text packages path by opening the Sublime Console (Ctrl+`) and running
    sublime.packages_path()
    Floobits Sublime Packages Path
  2. cd into your Sublime Text package path and clone the Floobits Sublime plugin repository.
    $ cd ~/Library/Application\ Support/Sublime\ Text\ 3/Packages
    $ git clone https://github.com/Floobits/floobits-sublime.git Floobits

    Remember to replace the path for cd with your Sublime Text packages path. Also, most shells require that spaces be escaped with backslashes or wrapped in quotes.

    Floobits Sublime plugin git clone
  3. Restart Sublime Text. Now you’re ready to configure the Sublime Text plugin.

Configuration

The plugin will ask if you have a Floobits account. If you do, the plugin will open a browser window allowing you to link your editor to your account. If you don’t have an account, the plugin will create one for you.

If there was an error configuring the plugin, see ~/.floorc.json help for instructions on editing your configuration file manually.

At this point, you’re done!


Usage

Share your code

Floobits create workspace from directory

Collaborate

Floobits join workspace

To collaborate on local files with others, you’ll need to create a workspace. You can right-click on any directory in Sublime Text’s sidebar, then go to Floobits → Share this. Once the workspace is created, a browser window should open allowing you to change settings and permissions for the new workspace.
Floobits share directory

To join an existing workspace, go to Tools → Floobits → Join Workspace. You’ll be prompted to enter the workspace URL. These workspace URLs are the links to the web editor on your dashboard. A typical URL is https://floobits.com/myuser/workspace-name.

If you’ve never joined the workspace before, you’ll be asked for a local directory to write to. This is meant to make it easier to integrate with source control. For example: If you have a local git clone of the files in the workspace at ~/code/project_name, entering that path will cause the plugin to write all changes there. Then you can git add and git commit as you and your collaborators make changes.

If you don’t specify a directory, the files in the workspace will be saved in [share_dir]/owner/workspace-name/. If share_dir is not specified in your config, it defaults to ~/floobits/shared/.

To add a new file or directory to a workspace, right-click on it in the sidebar. Under the Floobits context menu, choose “Add to Workspace”. You need to be joined to the workspace to add files. The options will be hidden if you aren’t joined.
Floobits add to workspace

Just like in the web editor, you can follow changes. The option is in the Sublime command palette.
Floobits follow changes
It can also be toggled by the shortcut ctrl + shift + alt + A.

If you like, you can override some default behaviors. All of these changes should be made in your Floobits user settings.

log_to_console 1
Log messages to the Sublime Text console instead of a special view.
alert_on_msg 0
Stop the quick panel from showing up whenever someone says your username in chat.