/VSCode

Unity Visual Studio Code Integration

Primary LanguageC#MIT LicenseMIT

VSCode

Seamless Visual Studio Code Integration in Unity - As seen in the Visual Studio Code documentation!

Requirements

Unity 4.6+

I am not sure exactly where in the 4.x cycle some of the features I'm using were introduced, but I'm guessing its around the 4.6+ mark.

#####Visual Studio Code 0.8+ In version 0.8.0, a directory structure change was made that moved where configuration files were stored by Visual Studio Code. Thusly, the plugin was updated to handle the new structure, however this means that people using versions of Visual Studio Code below 0.8.0 need to go back to a previous release of the plugin, or they can update Visual Studio Code.

######Mono A good number of people have needed to install Mono in order for many of the issues with OmniSharp to be resolved. I would suggest installing the latest package available at the Mono Project. Don't worry it will not mess with Unity.

Installation

It is important to make sure that the VSCode.cs file is placed under an Editor folder in the project. An example of this arrangement would be placing the file in /Assets/Plugins/Editor/VSCode.cs. By default it has its own folder structure which does this for you.

Unity Asset Store Package

A UAS packaged version of the plugin is available for your consumption.

Usage

Once the VSCode file is in place, simply navigate your way to the Unity Preferences and select VSCode and check the Enable Integration option.

That's it! Your ready to go!

OK, so maybe some people need a little video explaining some of the finer details of how to use the plugin. So I shot a quick video that highlights the ups and the downs (like Unity hanging after debugging sometimes) for people to watch. Please note this video is from a previous version of the plugin where things are in the menu, this has changed.

Platform Support

I use the plugin every day on a Mac (so it's battle tested there), and occasionally test it on a Windows VM. As for the recently announced Linux support, it should work just like the Mac version. I'll get around to installing the Linux editor sometime in the near future.

The Windows version of Visual Studio Code currently does not support debugging Mono, and will just throw a warning if you try to do it. The "Code" team is aware of this limitation, and we'll leave it at that.

Automatic Update

With version 2.0 of the plugin, I've introduced a feature where it will auto-update itself if allowed. This should make things a lot easier in the future.

Support

Please provide feedback through the GitHub Issue system.