Skip to content

Add unity accelerator parameters #235

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Derek (derekfreed) merged 2 commits into from
Jun 10, 2022
Merged

Add unity accelerator parameters #235

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7aaee15
Add unity accelerator parameters
Jun 9, 2022
4d1487c
Adding some docs and examples
Jun 10, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,14 @@ Start-UnityEditor -Project .\MyUnityProject
Start-UnityEditor -Project .\MyUnityProject -Latest
Start-UnityEditor -Project .\MyUnityProject -Version '2017.3.0f3'
```

Using the [Unity Accelerator](https://docs.unity3d.com/2019.3/Documentation/Manual/UnityAccelerator.html):
```powershell
Start-UnityEditor -Project .\MyUnityProject -CacheServerEndpoint 192.168.0.23
Start-UnityEditor -Project .\MyUnityProject -CacheServerEndpoint 192.168.0.23:2523 -CacheServerNamespacePrefix "dev"
Start-UnityEditor -Project .\MyUnityProject -CacheServerEndpoint 192.168.0.23 -CacheServerNamespacePrefix "dev" -CacheServerDisableDownload
Start-UnityEditor -Project .\MyUnityProject -CacheServerEndpoint 192.168.0.23 -CacheServerDisableUpload
```
Launch many projects at the same time:
```powershell
Get-UnityProjectInstance -Recurse | Start-UnityEditor
Expand Down
26 changes: 25 additions & 1 deletion UnitySetup/UnitySetup.psm1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1678,6 +1678,14 @@ function Test-UnityProjectInstanceMetaFileIntegrity {
Should the Unity Editor quit after it's done?
.PARAMETER Wait
Should the command wait for the Unity Editor to exit?
.PARAMETER CacheServerEndpoint
If included, the editor will attempt to use a Unity Accelerator hosted in the provided IP. The endpoint should be in the format of [IP]:[Port]. If the default Accelerator port is used, at the time of writing this, the port should be ommited.
.PARAMETER CacheServerNamespacePrefix
Set the namespace prefix. Used to group data together on the cache server.
.PARAMETER CacheServerDisableDownload
Disable downloading from the cache server. If ommited, the default value is true (download enabled)
.PARAMETER CacheServerDisableUpload
Disable uploading to the cache server. If ommited, the default value is true (upload enabled)
.EXAMPLE
Start-UnityEditor
.EXAMPLE
Expand Down Expand Up @@ -1761,7 +1769,15 @@ function Start-UnityEditor {
[parameter(Mandatory = $false)]
[switch]$Wait,
[parameter(Mandatory = $false)]
[switch]$PassThru
[switch]$PassThru,
[parameter(Mandatory = $false)]
[string]$CacheServerEndpoint,
[parameter(Mandatory = $false)]
[string]$CacheServerNamespacePrefix,
[parameter(Mandatory = $false)]
[switch]$CacheServerDisableDownload,
[parameter(Mandatory = $false)]
[switch]$CacheServerDisableUpload
Comment on lines +1773 to +1780

@derekfreed Derek (derekfreed) Jun 9, 2022

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you add a description of these parameters in the function header comment? perhaps even example?

@jwittner Josh Wittner (jwittner) Jun 9, 2022

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

An example in the readme would be great!

@santanor Jose Antonio (santanor) Jun 10, 2022

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the suggestions, I agree it's much clearer now with the examples.

)
process {
switch -wildcard ( $PSCmdlet.ParameterSetName ) {
Expand Down Expand Up @@ -1855,6 +1871,14 @@ function Start-UnityEditor {
if ( $RunTests ) { $sharedArgs += '-runTests' }
if ( $ForceFree) { $sharedArgs += '-force-free' }
if ( $AdditionalArguments) { $sharedArgs += $AdditionalArguments }
if ( $CacheServerEndpoint) {
$sharedArgs += "-cacheServerEndpoint", $CacheServerEndpoint
$sharedArgs += "-adb2"
$sharedArgs += "-enableCacheServer"
if ( $CacheServerNamespacePrefix) { $sharedArgs += "-cacheServerNamespacePrefix", $CacheServerNamespacePrefix}
$sharedArgs += "-cacheServerEnableDownload", $(If ($CacheServerDisableDownload) {"false"} Else {"true"})
$sharedArgs += "-cacheServerEnableUpload", $(If ($CacheServerDisableUpload) {"false"} Else {"true"})
}

[string[][]]$instanceArgs = @()
foreach ( $p in $projectInstances ) {
Expand Down