Skip to content

Commit 0e52894

Browse files
authored
Merge pull request #2539 from MicrosoftDocs/master
7/19 AM Publish
2 parents 7a11a09 + 3b4c9c1 commit 0e52894

File tree

222 files changed

+2161
-2225
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

222 files changed

+2161
-2225
lines changed

.openpublishing.redirection.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5730,6 +5730,11 @@
57305730
"source_path": "mac/benefits-vsmac-over-xs.md",
57315731
"redirect_url": "/visualstudio/mac/",
57325732
"redirect_document_id": false
5733+
},
5734+
{
5735+
"source_path": "docs/cross-platform/overview-of-visual-studio-tools-for-unity.md",
5736+
"redirect_url": "/visualstudio/cross-platform/visual-studio-tools-for-unity",
5737+
"redirect_document_id": false
57335738
}
57345739

57355740
]
Lines changed: 40 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -1,112 +1,90 @@
11
---
22
title: "Getting Started with Visual Studio Tools for Unity | Microsoft Docs"
33
ms.custom: ""
4-
ms.date: "04/07/2017"
4+
ms.date: "07/03/2018"
55
ms.technology: vs-unity-tools
66
ms.topic: "conceptual"
77
ms.assetid: 66b5b4eb-13b5-4071-98d2-87fafa4598a8
8-
author: "conceptdev"
9-
ms.author: "crdun"
8+
author: "dantogno"
9+
ms.author: "v-davian"
1010
manager: crdun
1111
ms.workload:
1212
- "unity"
1313
---
1414
# Getting Started with Visual Studio Tools for Unity
15-
In this section, you'll learn how to install Visual Studio Tools for Unity and configure your Unity project to work with Visual Studio.
1615

17-
> [!IMPORTANT]
18-
> Unity 5.2 adds built-in support for Visual Studio Tools for Unity 2.1, which simplifies project setup. To take advantage of this, you'll need Unity version 5.2.0 or higher on Windows, and Visual Studio Tools for Unity version 2.1 or higher.
16+
## Install Visual Studio
1917

20-
## Prerequisites
21-
To use Visual Studio Tools for Unity, you'll need:
18+
### Unity Bundled Installation
2219

23-
- A version of **Visual Studio** that supports extensions, such as Visual Studio Community, Professional, Premium, or Enterprise. You can download Visual Studio Community for free.
20+
Starting with Unity 2018.1, Visual Studio is the default C# script editor for Unity, and is included in the Unity Download Assistant, as well as the Unity Hub installation tool.
2421

25-
[Download Visual Studio Community](https://visualstudio.microsoft.com/downloads/?utm_medium=microsoft&utm_source=docs.microsoft.com&utm_campaign=button+cta&utm_content=download+vs2017)
22+
- Download Unity from [store.unity.com](https://store.unity.com/).
2623

27-
- **Unity** version 4.0.0 or higher; **Unity** version 5.2.0 or higher to take advantage of built-in support for Visual Studio Tools for Unity version 2.1 or higher.
24+
During installation, ensure that Visual Studio is checked in the list of components to install with Unity:
2825

29-
[Download Unity](https://unity3d.com/get-unity/download)
26+
#### Unity Hub
3027

31-
## Install Visual Studio Tools for Unity
32-
Download and install Visual Studio Tools for Unity from the Visual Studio Gallery. You'll need to install the right package for your version of Visual Studio. Make sure to install Visual Studio Tools for Unity version 2.1 or higher to take advantage of built-in support for VSTU in Unity 5.2 or higher.
28+
![unity hub installation](media/vstu_unity-hub.png)
3329

34-
- For Visual Studio 2015 Community, Visual Studio 2015 Professional, or Visual Studio 2015 Enterprise:
30+
#### Unity Download Assistant
3531

36-
[Download Visual Studio 2015 Tools for Unity](https://visualstudiogallery.msdn.microsoft.com/8d26236e-4a64-4d64-8486-7df95156aba9)
32+
![unity download assistant installation](media/vstu_download-assistant.png)
3733

38-
- For Visual Studio 2013 Community, Visual Studio 2013 Professional, or Visual Studio 2013 Premium:
34+
#### Check for updates to Visual Studio
3935

40-
[Download Visual Studio 2013 Tools for Unity](https://visualstudiogallery.msdn.microsoft.com/20b80b8c-659b-45ef-96c1-437828fe7cf2)
36+
The version of Visual Studio included with your Unity installation may not be the latest. It is recommended to check for updates to ensure you have access to the latest tools and features.
4137

42-
- For Visual Studio 2012 Professional or Visual Studio 2012 Premium:
38+
- [Updating Visual Studio](../install/update-visual-studio.md)
4339

44-
[Download Visual Studio 2012 Tools for Unity](https://visualstudiogallery.msdn.microsoft.com/7ab11d2a-f413-4ed6-b3de-ff1d05157714)
40+
### Manual Installation
4541

46-
- For Visual Studio 2010 Professional or Visual Studio 2010 Premium:
42+
If you already have Visual Studio 2017 installed, or prefer to manually install, run the Visual Studio installer.
4743

48-
[Download Visual Studio 2010 Tools for Unity](https://visualstudiogallery.msdn.microsoft.com/6e536faa-ce73-494a-a746-6a14753015f1)
44+
1. [Download the Visual Studio installer](https://docs.microsoft.com/en-us/visualstudio/install/install-visual-studio), or open it if already installed.
4945

50-
> [!NOTE]
51-
> Express versions of Visual Studio don't support extensions such as Visual Studio Tools for Unity. Visual Studio Community is a free version of Visual Studio that supports Visual Studio Tools for Unity and other extensions. For most users, Visual Studio Community is a better choice than Express.
52-
53-
> [!NOTE]
54-
> For Visual Studio 2017, VSTU 3 comes with the Unity workload that you can choose from the installer.
55-
56-
## Your first Unity project with Visual Studio Tools for Unity
57-
Now that you have everything you need, you're ready for your first Unity project with Visual Studio. Setting up your Unity project is different depending on which versions of Unity and Visual Studio Tools for Unity are installed. Follow the steps below for the version of Unity and Visual Studio Tools for Unity that you have installed.
46+
1. Click **Modify** (if already installed) or **Install** (for new installations) for your desired version of Visual Studio.
5847

59-
### Unity 5.2 and higher (requires VSTU 2.1 or higher)
60-
Starting with Unity 5.2, you no longer have to import the Visual Studio Tools unitypackage into your projects. If your project imports this unitypackage, Unity 5.2 ignores it and directly loads Visual Studio Tools for Unity from its installed location.
48+
1. On the **Workloads** tab, scroll to the **Mobile & Gaming** section and select the **Game development with Unity** workload.
6149

62-
#### 1 - Create a Unity Project
63-
If you're already experienced with Unity, you can create a new project or load one of your own. If you're loading a project that imported the Visual Studio Tools unitypackage to use Visual Studio Tools for Unity with a previous version of Unity, we recommend that you remove it by deleting the UnityVS directory.
50+
![Unity workload](media/vstu_unity-workload.png)
6451

65-
Otherwise, if you're new to Unity, start small with a basic tutorial. Visit the Unity Learn page to find tutorials on example projects you can start with and lessons you can learn from to build your own game with Unity. The Unity Learn page has easy-to-follow tutorials for several different games.
52+
1. Click **Modify** (if already installed) or **Install** (for new installations) in the bottom-right corner of the installer window.
6653

67-
[Tutorials - Unity Learn page](http://unity3d.com/learn/tutorials/modules)
54+
## Configure Unity for use with Visual Studio
6855

69-
#### 2 - Configure Unity Editor to use Visual Studio Tools for Unity
70-
To enable your project to use Visual Studio Tools for Unity, just set Visual Studio as its external script editor. In the Unity Editor, on the main menu, choose **Edit, Preferences**; then, in the **Unity Preferences** dialog, choose **External Tools**. Next, set the **External Script Editor** property to the version of Visual Studio you want to use (Visual Studio Tools for Unity must be installed for this version of Visual Studio) and make sure the **Editor Attaching** property is set.
56+
Starting with Unity 2018.1, Visual Studio should be the default external script editor in Unity. You can confirm this or change the external script editor to a specific version of Visual Studio:
7157

72-
To make sure that built-in support for Visual Studio Tools for Unity is now enabled, see the **About Unity** dialog. In the Unity editor, on the main menu, choose **Help, About Unity.** If Visual Studio Tools for Unity is installed and correctly configured, you'll see a message displayed in the lower left-hand corner of the **About Unity** dialog.
58+
1. Select **Preferences** from the **Edit** menu.
7359

74-
Finally, make sure you've set a build target through the **Build Settings** page and that **Script Debugging** is enabled.
60+
![Select Preferences](media/vstu_unity-preferences.png)
7561

76-
![Configure the Unity build settings for debugging.](../cross-platform/media/vstu_debugging_build_settings.png "vstu_debugging_build_settings")
62+
1. In the Preferences dialog, select the **External Tools** tab.
7763

78-
#### 3 - Launch Visual Studio from the Unity Editor
79-
Starting with Unity 5.2, the **Visual Studio Tools** extension menu is no longer needed to launch Visual Studio or to configure Visual Studio Tools for Unity. Instead, once Visual Studio is configured as your external script editor, just choose the script file from the Unity editor and your code will be opened in Visual Studio.
64+
1. From the **External Script Editor** dropdown list, choose your desired version of Visual Studio if it is listed, otherwise select **Browse...**.
8065

81-
### Previous versions of Unity (pre-5.2)
82-
Before Unity 5.2, there was no built-in support for Visual Studio Tools for Unity. Instead, each project had to import the Visual Studio Tools unitypackage and configure other project settings in order to use Visual Studio Tools for Unity.
66+
![Select Visual Studio](media/vstu_unity-external-tools.png)
8367

84-
#### 1 - Create a Unity Project
85-
If you're already experienced with Unity, you can create a new project or load one of your own. If you're starting a new project, import the Visual Studio Tools unitypackage when you create it.
68+
1. If **Browse...** was selected, navigate to the **Common7/IDE** directory inside your Visual Studio installation directory and select **devenv.exe**. Then click **Open**.
8669

87-
Otherwise, if you're new to Unity, start small with a basic tutorial. Visit the Unity Learn page to find tutorials on example projects you can start with and lessons you can learn from to build your own game with Unity. The Unity Learn page has easy-to-follow tutorials for several different games.
70+
![Select Open](media/vstu_browse-for-application.png)
8871

89-
[Tutorials - Unity Learn page](http://unity3d.com/learn/tutorials/modules)
72+
1. Once Visual Studio is selected in the **External Script Editor** list, confirm that the **Editor Attaching** checkbox is selected.
9073

91-
#### 2 - Configure Unity Editor to use Visual Studio Tools for Unity
92-
If you're starting from an existing Unity project or you didn't import the Visual Studio Tools unitypackage when you created the project, you need to import the unitypackage now. In the Unity editor, on the main menu, choose **Assets, Import Package, Visual Studio 2015 Tools** (you should see an option for the version of Visual Studio you have installed).
74+
1. Close the Preferences dialog to complete the configuration process.
9375

94-
![Import the VSTU package into your Unity project.](../cross-platform/media/vstu_configure_unity_import_vstu.png "vstu_configure_unity_import_vstu")
76+
## Support for older versions
9577

96-
Finally, make sure you've set a build target through the **Build Settings** page and that **Script Debugging** is enabled.
78+
Download and install Visual Studio Tools for Unity from the Visual Studio Marketplace. You'll need to install the right package for your version of Visual Studio.
9779

98-
![Configure the Unity build settings for debugging.](../cross-platform/media/vstu_debugging_build_settings.png "vstu_debugging_build_settings")
80+
- For Visual Studio 2015 Community, Visual Studio 2015 Professional, or Visual Studio 2015 Enterprise:
9981

100-
#### 3 - Launch Visual Studio from Unity Editor
101-
The final step is to start Visual Studio from Unity. This creates a Visual Studio Solution for your project, and then opens it in Visual Studio.
82+
[Download Visual Studio 2015 Tools for Unity](https://visualstudiogallery.msdn.microsoft.com/8d26236e-4a64-4d64-8486-7df95156aba9)
10283

103-
In the Unity Editor, on the main menu, choose **Visual Studio Tools, Open in Visual Studio**.
104-
105-
![Open your unity project in Visual Studio.](../cross-platform/media/vstu_configure_open_in_visual_studio.png "vstu_configure_open_in_visual_studio")
84+
> [!NOTE]
85+
> Visual Studio Tools for Unity requires Unity 5.2 and above, as well as a version of Visual Studio that supports extensions, such as Visual Studio Community, Professional, Premium, or Enterprise. To verify that Visual Studio Tools for Unity are enabled in your installation of Unity, select **About Unity** from the **Help** menu and look for the text "Microsoft Visual Studio Tools for Unity enabled" in the bottom-left of the dialog.
86+
> ![about Unity](media/vstu_about-unity.png)
10687
10788
## Next steps
10889

10990
To learn how to work with and debug your Unity project in Visual Studio, see [Using Visual Studio Tools for Unity](../cross-platform/using-visual-studio-tools-for-unity.md).
110-
111-
## See Also
112-
[Unity Homepage](http://unity3d.com)
86.6 KB
Loading
Loading
Loading
Loading
Binary file not shown.
Loading
Loading
75.5 KB
Loading
31.5 KB
Loading
12.6 KB
Loading
Loading
24.4 KB
Loading
21.4 KB
Loading
Loading
42.2 KB
Loading
Loading
Loading
Loading

docs/cross-platform/overview-of-visual-studio-tools-for-unity.md

Lines changed: 0 additions & 64 deletions
This file was deleted.

docs/cross-platform/toc.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,6 @@
2222
- name: Visual Studio Tools for Unity
2323
href: visual-studio-tools-for-unity.md
2424
items:
25-
- name: Overview of Visual Studio Tools for Unity
26-
href: overview-of-visual-studio-tools-for-unity.md
2725
- name: Getting Started with Visual Studio Tools for Unity
2826
href: getting-started-with-visual-studio-tools-for-unity.md
2927
- name: Using Visual Studio Tools for Unity

0 commit comments

Comments
 (0)