Skip to content

Latest commit

 

History

History

README.md

VS Code plugin for 🍃 Teamtype-compatible projects

Note: You will need to install and run a "collaboration server" like Teamtype in addition to this plugin!

Refer to the main project for documentation and usage instructions.

Configuration

A configuration for connecting to Teamtype daemons is provided as a default value.

You can also use this plugin with other collaboration servers.

To add other configurations, add a section like this to your settings.json (you can access it using F1 -> Preferences: Open User Settings (JSON)):

"teamtype.configs": {
  /* Default configuration */
  "teamtype": {
    "cmd": [ "teamtype", "client" ],
    "rootMarkers": [ ".teamtype" ]
   },

  /* Hypothetical configuration for another program */
  "http": {
    "cmd": [ "teamtype-http" ],
    "rootMarkers": [ ".teamtype-http" ]
  },
}

Available options:

  • cmd: Array of strings to specify the command to be launched to connect to the collaboration server.
  • rootMarkers: Array of strings to indicate if a directory should be considered as a collaboration project for this configuration.