Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://docs.unity3d.com/Manual/EditorCommandLineArguments.html below:

Manual: Unity Editor command line arguments

Unity Standalone Player command line arguments

You can launch the Unity Editor from the command line and pass in arguments to change how the Editor launches. You can also use the command line to execute specific methods from your project’s C# scriptsA piece of code that allows you to create your own Components, trigger game events, modify Component properties over time and respond to user input in any way you like. More info
See in Glossary at launch. Check the example script for executing methods at launch.

Note: To use the information on this page, you need to know how to use your operating system’s command line interface to launch applications and run command line arguments.

When launching the Unity Editor, the delimiter for a command-line argument value is a single space. For example, to set the window mode to borderless, use -window-mode borderless.

To launch a Unity project via the command prompt or Terminal, enter the directory path for the Unity application, followed by -projectPath and the directory path for the target project.

The following instructions assume that the Unity Editor is installed in the default location through the Unity Hub.

On macOS, type the following into the Terminal to launch Unity:

/Applications/Unity/Hub/Editor/<version>/Unity.app/Contents/MacOS/Unity -projectPath <project path>

On Linux, type the following into the Terminal to launch Unity:

/home/<user>/Unity/Hub/Editor/<version>/Editor/Unity -projectPath <project path>

On Windows, type the following into the Command Prompt to launch Unity:

"C:\Program Files\Unity\Hub\Editor\<version>\Editor\Unity.exe" -projectPath "<project path>"

When you launch Unity like this, it receives commands and information on startup, which can be useful for test suites, automated builds and other production tasks.

Notes:

• Adjust the path in the command if you use Unity Editor installed in a different location. For more information about how to find your Editor’s location path, refer to Install and uninstall Editor versions.

• When passing arguments on the Windows platform, make sure the directory path doesn’t end with a single backslash to prevent syntax errors. Use either double backslashes (\\) or no backslash. For example,

  • "C:\Program Files\Unity\Hub\Editor\<version>\Editor\Unity.exe" -projectPath "C:\MyUnityProjects\MyProject"
  • "C:\Program Files\Unity\Hub\Editor\<version>\Editor\Unity.exe" -createProject "C:\MyUnityProjects\MyProject\\"

You can run the Unity Editor and build Unity applications with additional commands and information on startup. This page lists the command line arguments you can use to launch and configure Unity Editor and Unity Player instances.

Note: Consistency checking mode disables uploads to Unity Accelerator and is intended to be used to test that importer output is deterministic. For more information, refer to the description for -consistencyCheckSourceMode.

• local: Forces a reimport of all assets locally and checks if the import differs from the previous import.
• cacheserver: If you have enabled Unity Accelerator, this option gets the metadata for the assets from the cache server and compares if the results locally match what is on the cache server. This option only reimports those assets which have a presence on the cache server. If the consistency check succeeds then the original import result is kept, and no upload is required because the result is consistent and already cached. If the check fails, then an Editor log message is logged detailing which imports failed. The inconsistent result is not uploaded, to prevent cache poisoning.

The space-separated list of assembly names is optional: pass the command line options without any assembly names to ignore all assemblies, as in example 1.

Example 1

Example 2

Example 2 has two assembly names, one with a pathname. Example 2 ignores A1.dll, no matter what folder it is stored in, and ignores A2.dll only if it is stored under subfolder folder:

If you list an assembly in the -disable-assembly-updater command line parameter (or if you don’t specify assemblies), Unity logs the following message to Editor.log:

[Assembly Updater] warning: Ignoring assembly [assembly_path] as requested by command line parameter.”).

Use this to avoid unnecessary API Updater overhead when you import assemblies.

This argument is useful if you want to import assemblies that access a Unity API which doesn’t need updating. It’s also useful when you import assemblies that don’t access any Unity APIs (for example, if you have built some or all of your source code outside of Unity, and you want to import the resulting assemblies into your Unity project).

Notes:

• If you disable the update of any assembly that needs updating, you might get errors at compile time, run time, or both, that are hard to track.
• This argument only disables the AssemblyUpdater component of the API Updater. The ScriptUpdater component of the API Updater still runs for the code in your project, including packages, unless you run the Editor in batch mode without the -accept-apiupdate argument. For more information, refer to Batch mode arguments.

This argument is useful for preventing Unity from generating platform-specific metadata for untargeted platforms, removing the need to uninstall build modules for the same outcome.

This argument doesn’t have a limit to the number of passed parameters. Parameters must match the name of the build module’s install directory and are case-sensitive.

Example

To return an error from the command line process, either throw an exception which causes Unity to exit with return code 1, or call EditorApplication.Exit with a non-zero return code.

To pass parameters, add them to the command line and retrieve them inside the function using System.Environment.GetCommandLineArgs. To use -executeMethod, you need to place the enclosing script in an Editor folder. The method you execute must be defined as static.

• If the Editor is connected to the Accelerator Cache Server, then the additional argument -cacheServerWaitForUploadCompletion is required to prevent Unity quitting before pending cache uploads can complete.
• If the Editor is running tests with the -runTests argument, then -quit causes the Editor to quit immediately, before in-progress tests have chance to complete.
• If the Editor is running asynchronous code, then -quit can cause the application to hang and become unresponsive.

Note: <mode> arguments that contain spaces must be wrapped in double quotes (“).| |-vcsModeSession <mode>|Set the version control mode for this session. Available modes are "Visible Meta Files", "Hidden Meta Files", Perforce, and PlasticSCM. You can use additional flags to fill out the configuration fields for the given version control mode. These flags are based on the Provider.GetActiveConfigFields method. For example, you can use the -vcPerforceUsername, -vcPerforcePassword, -vcPerforceWorkspace and -vcPerforceServer to set the Perforce username, workspace and server fields.

Note: <mode> arguments that contain spaces must be wrapped in double quotes (”).

Use the following arguments to configure Unity’s batch mode. Batch mode enables Unity to run predefined tasks without user input, which makes batch mode useful for automated tasks like testing. For more information, see Batch mode and built-in coroutine compatibility.

Important: Unless subject to separate Commercial Terms with Unity, using Unity in batch mode is subject to Unity’s Terms of Service, including applicable Additional Terms. For more information, refer to the latest version of the Unity Terms of Service and the Additional Terms, including the Unity Editor Software Terms.

Example:

The APIUpdater doesn’t run if you omit this command line argument when you launch Unity in batch mode. This might lead to compiler errors.

When an exception occurs during execution of the script code, the Asset server updates fail, or other operations fail, Unity immediately exits with return code 1.

In batch mode, Unity sends a minimal version of its log output to the console. However, the Log Files still contain the full log information. You can’t open a project in batch mode while the Editor has the same project open; only a single instance of Unity can run at a time.

To check whether the Editor or Standalone Player is running in batch mode, use the Application.isBatchMode operator.

If the project has not yet been imported when using -batchmode, the target platform is the default one. To force a different platform, use the -buildTarget option.

Use the following arguments to build players for various platforms from the command line. For more information about building players with command line arguments, refer to Unity Standalone Player command line arguments.

Note: -activeBuildProfile <pathname> applies custom scripting defines found in the Build data section of the active build profile before compilation. These scripting defines are additive and don’t override other scripting defines in your project.

• win64

If you are a developer with access to Closed platforms, you might have other -buildTarget options available. For details, see the documentation for your target platform.

• Player

Use the following arguments to configure Unity’s use of the Unity Accelerator cache server. These arguments override any corresponding configuration stored in the Editor Preferences.

Example:

Example:

Example:

Example:

Example:

Use the following arguments to force the Unity Editor to use a specific graphics API.

Use the following arguments to process a Unity license or run the Unity Editor with different license options.

Note: When you use the -serial argument, you must also use the -batchmode argument. It’s also good practice to specify the -quit argument.

Use the following arguments to configure Unity’s use of the Metal graphics API for Apple devices.

Use the following arguments to configure Unity’s use of the ProfilerA window that helps you to optimize your game. It shows how much time is spent in the various areas of your game. For example, it can report the percentage of time spent rendering, animating, or in your game logic. More info
See in Glossary.

When you use this argument with the Editor, it starts collecting and displaying Profiler information in the Profiler window on start-up of the Editor.

You should only use these under special circumstances, or when directed by Unity Support.

Note: This procedure is unsupported and highly risky, and should only be used as a last resort.

You should only use these under special circumstances, or when directed by Unity Support. These arguments are used in versions of the Unity Editor that do not use the Unity Hub by default.

In all supported versions of the Unity Editor, these arguments are already set by default.

Additional Editor command line arguments are available when these packages are installed.

You can use the command line to execute specific methods from your project’s C# scripts at launch. The following examples demonstrate a C# script, and the command line arguments that execute methods from that script at launch.

An example C# script in the project:

using UnityEditor;
class MyEditorScript
{
     static void PerformBuild ()
     {
        BuildPlayerOptions buildPlayerOptions = new BuildPlayerOptions();
        buildPlayerOptions.scenes = new[] { "Assets/Scene1.unity", "Assets/Scene2.unity" };
        BuildPipeline.BuildPlayer(buildPlayerOptions);
     }
}

The following command executes Unity in batch mode, executes the MyEditorScript.PerformBuild method from the above script, and then quits upon completion.

Windows:

"C:\Program Files\Unity\Hub\Editor\<version>\Editor\Unity.exe" -quit -batchmode -projectPath "C:\Users\UserName\Documents\MyProject" -executeMethod
MyEditorScript.PerformBuild

macOS:

/Applications/Unity/Hub/Editor/<version>/Unity.app/Contents/MacOS/Unity -quit -batchmode -projectPath ~/UnityProjects/MyProject -executeMethod
MyEditorScript.PerformBuild

Note: In the Editor path, replace <version> with the version of Unity you want to launch, or replace the path entirely if your Unity Editor path is not the default.

Unity Standalone Player command line arguments

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4