Skip to content

Commit 598c822

Browse files
authored
Merge pull request #9 from jwittner/dev/improveDocs
Improve documentation of functionality
2 parents dbd77a7 + e203738 commit 598c822

File tree

2 files changed

+28
-2
lines changed

2 files changed

+28
-2
lines changed

README.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Unity Setup Powershell Module
22

3-
This PowerShell module contains cmdlets to query installed instances of Unity3D and easily launch the Unity Editor for the correct instances for Unity projects.
3+
This PowerShell module contains tools for managing and automating your Unity installs and projects.
44

55
## Builds
66
[![Build status](https://ci.appveyor.com/api/projects/status/m7ykg9s8gw23fn6h?svg=true)](https://ci.appveyor.com/project/jwittner/unitysetup-powershell)
@@ -16,18 +16,44 @@ PS C:\> Install-Module UnitySetup -Scope CurrentUser
1616

1717
## Using
1818

19+
Find all of your Unity installs:
1920
```powershell
2021
PS C:\> Get-UnitySetupInstance
22+
23+
InstallationVersion InstallationPath
24+
------------------- ----------------
25+
2017.2.1f1 C:\Program Files\Unity-2017.2.1f1\Editor\
26+
2017.1.0p5 C:\Program Files\Unity.2017.1.0p5\Editor\
27+
2017.1.1f1 C:\Program Files\Unity.2017.1.1f1\Editor\
28+
2017.1.1p3 C:\Program Files\Unity.2017.1.1p3\Editor\
29+
2017.2.0f3 C:\Program Files\Unity.2017.2.0f3\Editor\
30+
2017.3.0f3 C:\Program Files\Unity.2017.3.0f3\Editor\
31+
5.5.4p3 C:\Program Files (x86)\Unity.5.5.4p3\Editor\
2132
```
2233

34+
Select the Unity installs that you want:
2335
```powershell
2436
PS C:\> Get-UnitySetupInstance | Select-UnitySetupInstance -Latest
2537
PS C:\> Get-UnitySetupInstance | Select-UnitySetupInstance -Version '2017.1.1f1'
2638
PS C:\> Get-UnitySetupInstance | Select-UnitySetupInstance -Project '.\MyUnityProject'
2739
```
2840

41+
Launch the right Unity editor for a project:
2942
```powershell
3043
PS C:\MyUnityProject> Start-UnityEditor
44+
PS C:\> Start-UnityEditor -Project .\MyUnityProject
45+
```
46+
47+
Find all the Unity projects recursively
48+
```powershell
49+
PS C:\Projects> Get-UnityProjectInstance -Recurse
50+
51+
ProjectPath UnityInstanceVersion
52+
----------- --------------------
53+
C:\Projects\Project1\OneUnity\ 2017.2.0f3
54+
C:\Projects\Project1\TwoUnity\ 2017.3.0f3
55+
C:\Projects\Project2\ 2017.1.1p1
56+
C:\Projects\Project3\App.Unity\ 2017.1.2f1
3157
```
3258

3359
# Feedback

UnitySetup/UnitySetup.psd1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ CompanyName = 'Microsoft'
3232
Copyright = 'Copyright (c) Microsoft Corporation. All rights reserved.'
3333

3434
# Description of the functionality provided by this module
35-
Description = 'Support finding and selecting installs of Unity'
35+
Description = 'Tools for managing and automating your Unity installs and projects.'
3636

3737
# Minimum version of the Windows PowerShell engine required by this module
3838
# PowerShellVersion = ''

0 commit comments

Comments
 (0)