Version: 2021.3
Android environment setup
Android keystores

Android Player settings

This page details the Player Settings for the Android platform. For a description of the general Player settings, see Player SettingsSettings that let you set various player-specific options for the final game built by Unity. More info
See in Glossary
.

Player Settings for Android.
Player Settings for Android.

Documentation for the properties is grouped according to their respective sections in the Player UI(User Interface) Allows a user to interact with your application. Unity currently supports three UI systems. More info
See in Glossary
:

Icon

Use the Icon section to specify icons to represent your application on the device.

Icon settings for Android.
Icon settings for Android.
Setting Description
Adaptive Specify textures of various sizes to represent your application on devices running Android 8.0 (API level 26) or higher.
Round Specify textures of various sizes to represent your application on devices running Android 7.1 (API level 25) or higher.
Legacy Specify textures of various sizes to represent your application on devices running versions earlier than Android 7.1 (API level 25).

Resolution and Presentation

Use the Resolution and Presentation section to customize aspects of the screen’s appearance.

Resolution and Presentation settings for Android.
Resolution and Presentation settings for Android.
Setting Description
Fullscreen Mode Specifies how the window appears on the device. This sets the default window mode at startup.
Fullscreen Window The application window fills the full-screen native resolution of the device. To fill the full-screen window, Unity scales the application contents. To match the aspect ratioThe relationship of an image’s proportional dimensions, such as its width and height.
See in Glossary
of the output device, Unity might add black bars to the rendered output so the content doesn’t stretch. This process is called letterboxing.In this mode, the navigation bar is always hidden.
Windowed The application uses a standard, non-full-screen, movable window. The size of the window depends on the application’s resolution. In this mode, the window is resizable by default. To disable this, disable Resizable Window.
Resizable Window Indicates whether the user can resize the application’s window.
This setting enables multi-window capabilities in your application on Android phones and tablets. For more information, see Google’s developer documentation.
Default Window Width The default width of the application window in pixelsThe smallest unit in a computer image. Pixel size depends on your screen resolution. Pixel lighting is calculated at every screen pixel. More info
See in Glossary
. This option is only available if the Fullscreen Mode is set to Windowed.
Default Window Height The default height of the application window in pixels. This option is only available if the Fullscreen Mode is set to Windowed.
Minimum Window Width The minimum width of the application window in pixels. This option is only available if the Fullscreen Mode is set to Windowed.
Minimum Window Height The minimum height of the application window in pixels. This option is only available if the Fullscreen Mode is set to Windowed.
Hide Navigation Bar Indicates whether to hide the navigation bar that appears at the top of the window.
Render outside safe area Indicates whether the application should use all available screen space to render, including areas of the display that are cut out (notched). For more information, see Android’s display cutout support documentation.
Optimized Frame Pacing Indicates whether Unity should evenly distribute frames for less variance in framerate. Enable this option to create a smoother experience.

Other Resolution and Presentation settings are grouped under the following sections:

Resolution Scaling

Use the Resolution Scaling section to customize settings relating to screen resolution scaling. Using a resolution lower than the device’s native resolution can improve performance and battery life.

Resolution Scaling settings for Android.
Resolution Scaling settings for Android.
Setting Description
Resolution Scaling Mode Specifies whether and how the application scales its resolution. You can set the scaling to be equal to or lower than the native screen resolution. Using a lower resolution can improve performance and battery life.
Disabled Doesn’t apply resolution scaling and the application renders to the device’s native screen resolution.
FixedDPI Applies resolution scaling using a target API. Use this to optimize performance and battery life or target a specific DPI setting.
Target DPI The resolution of the application. If the device’s native screen DPI is higher than this value, Unity downscales the application’s resolution to match this setting. To calculate the scale, Unity uses the following:
min(Target DPI * Factor / Screen DPI, 1)
Where Factor is the Resolution Scaling Fixed DPI Factor from Quality settings.Note: This option only appears when you set Resolution Scaling Mode to Fixed DPI.
Reset resolution on window resize Indicates whether to set the screen resolution to the new native window size when the native window size changes. If you set Resolution Scaling Mode to Fixed DPI, Unity recalculates the resolution based on Fixed DPI property.
BlitA shorthand term for “bit block transfer”. A blit operation is the process of transferring blocks of data from one place in memory to another.
See in Glossary
Type
Controls whether to use a blit to render the final image to the screen. Using a blit is compatible with most devices but is usually slower than not using a blit.
Always Unity renders to an offscreen buffer and then uses a blit to copy the contents of the buffer to the device’s framebuffer. This is compatible with most devices but is usually slower than not using blit.
Never Unity renders to the framebuffer provided by the device’s operating system. If this fails, the application prints a one-time warning to the device log. This is usually faster than using blit, but it isn’t compatible with all devices.
Auto Unity renders to the framebuffer provided by the device’s operating system if possible. If this fails, Unity prints a warning to the device console and uses a blit to render the final image to the screen.

Supported Aspect Ratio

Use the Supported Aspect Ratio section to customize settings relating to which device aspect ratios to support.

Resolution Scaling settings for Android.
Resolution Scaling settings for Android.
Setting Description
Aspect Ratio Mode Specifies the largest aspect ratio the application supports. If the device’s aspect ratio is greater than this aspect ratio, Unity uses this aspect ratio for the application and adds black bars so the application doesn’t stretch..
Legacy Wide Screen (1.86) The application supports aspect ratios up to Android’s legacy wide-screen aspect ratio.
Native Aspect Ratio The application supports aspect ratios up to Android’s native aspect ratio.
Custom The application supports aspect ratios up to the aspect ratio you set in Up To.
  Up To The custom maximum aspect ratio.

This setting only appears when you set Aspect Ratio Mode to Custom.

Orientation

Use the Orientation section to customize settings relating to the orientation of the application on the device.

Orientation settings for Android.
Orientation settings for Android.

Choose the game’s screen orientation from the Default Orientation drop-down menu:

Setting Description
Default Orientation Specifies the screen orientation the application uses.

Note: Unity shares the value you set for this setting between Android and iOS.
Portrait The application uses portrait screen orientation where the bottom of the application’s window aligns with the bottom of the device’s screen.
Portrait Upside Down The application uses portrait screen orientation where the bottom of the application’s window aligns with the top of the device’s screen.
Landscape Right The application uses landscape screen orientation where the right side of the application’s window aligns with the bottom of the device’s screen.
Landscape Left The application uses landscape screen orientation where the right side of the application’s window aligns with the top of the device’s screen.
Auto Rotation The screen can rotate to any of the orientations you specify in the Allowed Orientations for Auto Rotation section.

Allowed Orientations for Auto Rotation

Use the Allowed Orientations for Auto Rotation section to specify which orientations the application supports when you set Default Orientation to Auto Rotation. This is useful, for example, to lock the application to landscape orientation but allow the user to switch between landscape left and landscape right.

This section only appears when you set Default Orientation to Auto Rotation.

Allowed Orientations for Auto Rotation settings for Android.
Allowed Orientations for Auto Rotation settings for Android.
Setting Description
Portrait Indicates whether the application supports portrait screen orientation where the bottom of the application’s window aligns with the bottom of the device’s screen.
Portrait Upside Down Indicates whether the application supports portrait screen orientation where the bottom of the application’s window aligns with the top of the device’s screen.
Landscape Right Indicates whether the application supports landscape screen orientation where the right side of the application’s window aligns with the bottom of the device’s screen.
Landscape Left Indicates whether the application supports landscape screen orientation where the right side of the application’s window aligns with the top of the device’s screen.

Other

The Resolution and Presentation section also contains the following general settings.

Other resolution and presentation settings for Android.
Other resolution and presentation settings for Android.
Setting Description
Use 32-bit Display Buffer Indicates whether the display buffer holds 32-bit color values instead of 16-bit color values. Enable this setting if you see banding, or need alpha values in post-processing effects. Some post-processingA process that improves product visuals by applying filters and effects before the image appears on screen. You can use post-processing effects to simulate physical camera and film properties, for example Bloom and Depth of Field. More info post processing, postprocessing, postprocess
See in Glossary
effects require this because they create Render TexturesA special type of Texture that is created and updated at runtime. To use them, first create a new Render Texture and designate one of your Cameras to render into it. Then you can use the Render Texture in a Material just like a regular Texture. More info
See in Glossary
in the same format as the display buffer.
Disable Depth and Stencil Indicates whether to disable depth and stencil buffersA memory store that holds an 8-bit per-pixel value. In Unity, you can use a stencil buffer to flag pixels, and then only render to pixels that pass the stencil operation. More info
See in Glossary
.
Render Over Native UI Indicates whether to render on top of native UI on Android or iOSApple’s mobile operating system. More info
See in Glossary
. For this setting to take effect, set your CameraA component which creates an image of a particular viewpoint in your scene. The output is either drawn to the screen or captured as a texture. More info
See in Glossary
’s Clear Flags to use a solid color with an alpha value lower than 1.
Show Loading Indicator Specifies if and how the loading indicator appears.
Don’t Show The loading indicator doesn’t appear.
Large A large loading indicator appears.
Inversed Large A large loading indicator appears with inversed color.
Small A small loading indicator appears.
Inversed Small A small loading indicator appears with inversed color.

Splash Image

Use the Virtual Reality Splash Image setting to select a custom splash image for Virtual RealityA system that immerses users in an artificial 3D world of realistic images and sounds, using a headset and motion tracking. More info
See in Glossary
displays. For information on common Splash Screen settings, see Splash Screen.

Splash screen settings for virtual reality.
Splash screen settings for virtual reality.

Below the common Splash Screen settings, you can set up an Android-specific Static Splash Image.

Splash screen settings for Android.
Splash screen settings for Android.
Setting Description
Image Specifies the texture that the application uses for the Android splash screen. The standard size for the splash screen image is 320x480.
Scaling Specifies how to scale the splash image to fit the devic’es screen.
Center (only scale down Draws the image at its native size unless it’s too large, in which case Unity scales the image down to fit.
Scale to Fit (letter-boxed) Scales the image so that the longer dimension fits the screen size exactly. Unity fills in the empty space around the sides in the shorter dimension in black.
Scale to Fill (cropped) Scales the image so that the shorter dimension fits the screen size exactly. Unity crops the image in the longer dimension.

Other Settings

This section allows you to customize a range of options organized into the following groups:

Rendering

Use these settings to customize how Unity renders your game for the Android platform.

Rendering settings for the Android platform
Rendering settings for the Android platform
Property Description
Color Space Choose which color space Unity uses for rendering: Gamma or Linear. See the Linear rendering overview for an explanation of the difference between the two.
Gamma: Gamma color space is typically used for calculating lighting on older hardware restricted to 8 bits per channel for the framebuffer format. Even though monitors today are digital, they might still take a gamma-encoded signal as input.
Linear: Linear color space rendering gives more precise results. When you select to work in linear color space, the Editor defaults to using sRGB sampling. If your Textures are in linear color space, you need to work in linear color space and disable sRGB sampling for each Texture.
Auto Graphics API Disable this option to manually pick and reorder the graphics APIs. By default this option is enabled, and Unity tries to use Vulkan. If the device doesn’t support Vulkan, Unity falls back to GLES3.2, GLES3.1 or GLES3.0. There are three additional checkboxes to configure the minimum OpenGL ES 3.x minor version: Require ES3.1, Require ES3.1+AEP and Require ES3.2.
Important: Unity adds the GLES3/GLES3.1/AEP/3.2 requirement to your Android App Manifest only if GLES2 is not in the list of APIs when Auto Graphics API is disabled. In this case only, your application does not appear on unsupported devices in the Google Play Store.
Color Gamut You can add or remove color gamuts for the Android platform to use for rendering. Click the plus (+) icon to see a list of available gamuts. A color gamut defines a possible range of colors available for a given device (such as a monitor or screen). The sRGB gamut is the default (and required) gamut. When targeting devices with wide color gamut displays, use DisplayP3 to utilize full display capabilities.
Multithreaded Rendering Enable this option to move graphics API calls from Unity’s main thread to a separate worker thread. This can help to improve performance in applications that have high CPU usage on the main thread.
Static BatchingA technique Unity uses to draw GameObjects on the screen that combines static (non-moving) GameObjects into big Meshes, and renders them in a faster way. More info
See in Glossary
Enable this option to use static batching. For more information, see Draw call batching.
Dynamic BatchingAn automatic Unity process which attempts to render multiple meshes as if they were a single mesh for optimized graphics performance. The technique transforms all of the GameObject vertices on the CPU and groups many similar vertices together. More info
See in Glossary
Enable this option to use dynamic batching (enabled by default). For more information, see Draw call batching.

Note: Dynamic batching has no effect when a Scriptable Render Pipeline is active, so this setting is only visible if the Scriptable Render Pipeline Asset Graphics setting is blank.
Compute Skinning Enable this option to enable DX11/ES3 GPU compute skinning, freeing up CPU resources.
Graphics Jobs Enable this option to instruct Unity to offload graphics tasks (render loops) to worker threads running on other CPU cores. This is intended to reduce the time spent in Camera.Render on the main thread, which is often a bottleneck.
Texture compression format Choose between ASTC, ETC2 and ETC (ETC1 for RGB, ETC2 for RGBA). See texture compression format overview for more information on how to pick the right format.
See Texture compression settings for more details on how this interacts with the texture compression setting in the Build Settings.
Normal Map Encoding Choose XYZ or DXT5nm-style to set the normal map encoding. This affects the encoding scheme and compression format used for normal maps. DXT5nm-style normal maps are of higher quality, but more expensive to decode in shaders.
Lightmap Encoding Choose Low Quality, Normal Quality, or High Quality to set the lightmap encoding. This setting affects the encoding scheme and compression format of the lightmaps.
Lightmap Streaming Whether to use Mipmap Streaming for lightmaps. Unity applies this setting to all lightmaps when it generates them.
Note: To use this setting, you must enable the Texture Streaming Quality setting.
  Streaming Priority Set the priority for all lightmaps in the Mipmap Streaming system. Unity applies this setting to all lightmaps when it generates them.
Positive numbers give higher priority. Valid values range from –128 to 127.
Frame Timing Stats Enable this property to gather CPU and GPU frame time statistics. Use this together with the Dynamic ResolutionA Camera setting that allows you to dynamically scale individual render targets, to reduce workload on the GPU. More info
See in Glossary
camera setting to determine if your application is CPU or GPU bound.
Virtual Texturing Indicates whether to enable Virtual Texturing.
Note: Virtual Texturing isn’t compatible with Android.
Shader precision model Controls the default precision of samplers used in shaders. See Shader data types and precision for more details.
360 Stereo Capture Indicates whether Unity can capture stereoscopic 360 images and videos. For more information, see Stereo 360 Image and Video Capture.
Note: 360 stereoscopic capturing isn’t compatible with Android.

Vulkan Settings

Vulkan Player settings for the Android platform
Vulkan Player settings for the Android platform
Property Description
SRGB Write Mode Enable this option to allow Graphics.SetSRGBWrite() renderer to toggle the sRGB write mode during runtime. That is, if you want to temporarily turn off Linear-to-sRGB write color conversion, you can use this property to achieve that. Enabling this has a negative impact on performance on mobile tile-based GPUs; therefore, do NOT enable this for mobile.
Number of swapchain buffers Set this option to 2 for double-buffering, or 3 for triple-buffering to use with Vulkan renderer. This setting may help with latency on some platforms, but in most cases you should not change this from the default value of 3. Double-buffering might have a negative impact on performance. Do not use this setting on Android.
Acquire swapchain image late as possible If enabled, Vulkan delays acquiring the backbuffer until after it renders the frame to an offscreen image. Vulkan uses a staging image to achieve this. Enabling this setting causes an extra blit when presenting the backbuffer. This setting, in combination with double-buffering, can improve performance. However, it also can cause performance issues because the additional blit takes up bandwidth.
Recycle command buffers Indicates whether to recycle or free CommandBuffers after Unity executes them.
Apply display rotation during rendering Enable this to perform all rendering in the native orientation of the display. This has a performance benefit on many devices. For more information, see documentation on Vulkan swapchain pre-rotation.

Identification

Identification settings for the Android platform
Identification settings for the Android platform
Property Function
Override Default Package Name Indicates whether to override the default package name for your application.
Note: This setting affects macOS, iOS, tvOS, and Android.
  Package Name Set the application ID, which uniquely identifies your app on the device and in Google Play Store. The application ID must follow the convention com.YourCompanyName.YourProductName and must contain only alphanumeric and underscore characters. Each segment must start with an alphabetical character. For more information, see Set the application ID.
Important: Unity automatically removes any invalid characters you type.
To set this property, enable Override Default Package Name.
Version Enter the build version number of the bundle, which identifies an iteration (released or unreleased) of the bundle. The version is specified in the common format of a string containing numbers separated by dots (eg, 4.3.2). (Shared between iOS and Android.)
Bundle Version Code An internal version number. This number is used only to determine whether one version is more recent than another, with higher numbers indicating more recent versions. This is not the version number shown to users; that number is set by the versionName attribute. The value must be set as an integer, such as “100”. You can define it however you want, as long as each successive version has a higher number.

For example, it could be a build number. Or you could translate a version number in “x.y” format to an integer by encoding the “x” and “y” separately in the lower and upper 16 bits. Or you could simply increase the number by one each time a new version is released.

Keep this number under 100000 if Split APKs by target architecture is enabled. Each APK must have a unique version code so Unity adds 100000 to the number for ARMv7, and 200000 for ARM64.
Minimum API Level Minimum Android version (API level) required to run the application.
Target API Level Target Android version (API level) against which to compile the application.

Configuration

Configuration settings for the Android platform
Configuration settings for the Android platform
Property Description
Scripting BackendA framework that powers scripting in Unity. Unity supports three different scripting backends depending on target platform: Mono, .NET and IL2CPP. Universal Windows Platform, however, supports only two: .NET and IL2CPP. More info
See in Glossary
Choose the scripting backend you want to use. The scripting backend determines how Unity compiles and executes C# code in your Project.
Mono Compiles C# code into .NET Common Intermediate Language (CIL) and executes that CIL using a Common Language Runtime. See the Mono Project website for more information.
IL2CPP Compiles C# code into CIL, converts the CIL to C++ and then compiles that C++ into native machine code, which executes directly at run time. See IL2CPPA Unity-developed scripting back-end which you can use as an alternative to Mono when building projects for some platforms. More info
See in Glossary
for more information.
API Compatibility Level Choose which .NET APIs you can use in your project. This setting can affect compatibility with 3rd-party libraries. However, it has no effect on Editor-specific code (code in an Editor directory, or within an Editor-specific Assembly Definition).
Tip: If you are having problems with a third-party assembly, you can try the suggestion in the API Compatibility Level section below.
.Net 2.0 .Net 2.0 libraries. Maximum .net compatibility, biggest file sizes. Part of the deprecated .NET 3.5 runtime.
.Net 2.0 Subset Subset of full .net compatibility, smaller file sizes. Part of the deprecated .NET 3.5 runtime.
.Net Standard 2.0 Compatible with .NET Standard 2.0. Produces smaller builds and has full cross-platform support.
.Net 4.x Compatible with the .NET Framework 4 (which includes everything in the .NET Standard 2.0 profile as well as additional APIs). Choose this option when using libraries that access APIs not included in .NET Standard 2.0. Produces larger builds and any additional APIs available are not necessarily supported on all platforms. See Referencing additional class library assemblies for more information.
C++ Compiler Configuration Choose the C++ compiler configuration used when compiling IL2CPP generated code.
Note: This property is disabled unless Scripting Backend is set to IL2CPP.
Use incremental GC Use the incremental garbage collector, which spreads garbage collection over several frames to reduce garbage collection-related spikes in frame duration. For more information, see documentation on Automatic Memory Management.
Assembly Version Validation Indicates whether Mono validates types from a strongly-named assembly.
Mute Other Audio Sources Enable this option if you want your Unity application to stop Audio from applications running in the background. Otherwise, Audio from background applications continues to play alongside your Unity application.
Target Architectures Select which CPUs you want to allow the application to run on (32-bit ARM, 64-bit ARM, 32-bit x86, and 64-bit x86–64).
Note: Running Android apps in a 64-bit environment has performance benefits and 64-bit apps can address more than 4 GB of memory space.
Split APKs by target architecture (Experimental) Enable this option to create a separate APK for each CPU architecture selected in Target Architectures. This makes download size smaller for Google Play Store users. This is primarily a Google Play store feature and may not work in other stores. For more details, refer to Multiple APK Support.
Target Devices Specifies the target devices on which the APK is allowed to run.
All Devices The APK is allowed to run on all Android and Chrome OS devices.
Phones and Tablets Only The APK is allowed to run on Android phones and tablets, but not on Chrome OS devices.
Chrome OS Devices Only The APK is allowed to run on Chrome OS devices, but not on Android phones or tablets.
Install Location Specifies application install location on the device (for detailed information, refer to Android Developer documentation on install locations.
Automatic Let the operating system decide. User will be able to move the app back and forth.
Prefer External Install the application to external storage (SD card) if possible. The operating system doesn’t guarantee it; if not possible, the app will be installed to internal memory.
Force Internal Force the application to be installed to internal memory. The user will be unable to move the app to external storage.
Internet Access Choose whether to always add the networking (INTERNET) permission to the Android App Manifest, even if you are not using any networking APIs. Set to Require by default for development builds.
Auto Only add the internet access permission if you are using a networking API.
Require Always add the internet access permission.
Write Permission Choose whether to enable write access to the external storage (such as the SD card) and add a corresponding permission to the Android App Manifest. Set to External(SDCard) by default for development builds.
Internal Only grant write permission to internal storage.
External(SDCard) Enable write permission to external storage.
Filter Touches When Obscured Enable this option to discard touches received when another visible window is covering the Unity application. This is to prevent tapjacking.
Sustained Performance Mode Enable this option to set a predictable and consistent level of device performance over longer periods of time, without thermal throttling. Overall performance might be lower when this setting is enabled. Based on the Android Sustained Performance API.
Maximum Java Heap Size Set the maximum Java heap size to user for building (in megabytes). Defaults to 4096.
Low Accuracy Location Enable this option to use low accuracy values with Android location APIs instead.
Chrome OS Input Emulation Chrome OS’s default behaviour is to convert mouse and touchpad input events into touchscreen input events. Un-check this setting to disable the default behavior.
Android TV Compatibility Enable this option to mark the application as Android TV compatible.
  Android Game Enable this option to mark the output package (APK) as a game rather than a regular application.
  Android Gamepad Support Level Choose the level of support your application offers for a gamepad. The options are Works with D-Pad, Supports Gamepad, and Requires Gamepad.
Warn about App Bundle size Enable this option to receive a warning when the size of the Android App Bundle exceeds a certain threshold. This option is selected by default and you can only configure it if you enable the Build App Bundle (Google Play) option in the Build settings.
  App Bundle size threshold Enter a size in Mb. When your App Bundle exceeds this size, Unity will display a warning.
Active Input Handling Choose how you want to handle input from users.
Input Manager (old) Use the default Input window.
Input System (Preview) Use the newer Input system. The Input System is provided as a preview package for this release. To try a preview of the Input System, install the InputSystem package.
Both Use both systems side by side.

API Compatibility Level

You can choose your mono API compatibility level for all targets. Sometimes a 3rd-party .NET library uses functionality that’s outside of your .NET compatibility level. To understand what’s going on in such cases, and how to best fix it, try following these suggestions:

  1. Install ILSpy for Windows.
  2. Drag the .NET assemblies for the API compatibility level that you are having issues with into ILSpy. You can find these under Frameworks/Mono/lib/mono/YOURSUBSET/.
  3. Drag in your 3rd-party assembly.
  4. Right-click your 3rd-party assembly and select Analyze.
  5. In the analysis report, inspect the Depends on section. The report highlights anything that the 3rd-party assembly depends on, but that is not available in the .NET compatibility level of your choice in red.

Script Compilation

Script compilation settings for the Android platform
Script compilation settings for the Android platform
Setting Function
Scripting Define Symbols Set custom compilation flags. For more details, see the documentation on Platform dependent compilation.
Additional Compiler Arguments Add entries to this list to pass additional arguments to the Roslyn compiler. Use one new entry for each additional argument.
To create a new entry, press the ‘+’ button. To remove an entry, press the ‘-’ button.
When you have added all desired arguments, click the Apply button to include your additional arguments in future compilations.The Revert button resets this list to the most recent applied state.
Suppress Common Warnings Disable this setting to display the C# warnings CS0169 and CS0649.
Allow ‘unsafe’ Code Enable support for compiling ‘unsafe’ C# code in a pre-defined assembly (for example, Assembly-CSharp.dll).
For Assembly Definition Files (.asmdef), click on one of your .asmdef files and enable the option in the Inspector window that appears.
Use Deterministic Compilation Disable this setting to prevent compilation with the -deterministic C# flag. With this setting enabled, compiled assemblies are byte-for-byte identical each time they are compiled.
For more information, see Microsoft’s deterministic compiler option documentation.
Enable Roslyn Analyzers Disable this setting to compile user-written 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
without Roslyn analyzer DLLs that might be present in your project.
Use Roslyn Reference Assemblies Disable this setting to the compiler not to skip compilation reference assemblies when the metadata of the assembly does not change.

Optimization

Optimization settings for the Android platform
Optimization settings for the Android platform
Property Description
Prebake Collision Meshes Enable this option to add collision data to Meshes at build time.
Keep Loaded Shaders Alive When enabled, you cannot unload a shader. See Shader Loading for more information.
Preloaded Assets Set an array of Assets for the player to load on startup.
To add new Assets, increase the value of the Size property, then set a reference to the Asset to load in the new Element box that appears.
AOT compilation options Additional options for Ahead of Time (AOT) compilation. This helps optimize the size of the built iOS player.
Strip Engine Code Enable this option if you want the Unity Linker tool to remove code for Unity Engine features that your Project doesn’t use. This setting is only available with the IL2CPP scripting backend.

Most apps don’t use every available DLL. This option strips out DLLs that your app doesn’t use to reduce the size of the built Player. If your app is using one or more classes that would normally be stripped out under your current settings, Unity displays a debug message when you try to build the app.
Managed Stripping Level Choose how Unity strips unused managed (C#) code.The options are Disabled Low, Medium, and High.

When Unity builds your app, the Unity Linker process can strip unused code from the managed DLLs your Project uses. Stripping code can make the resulting executable significantly smaller, but can sometimes accidentally remove code that is in use. For more information about these options, see documentation on Managed code stripping.

For information about bytecode stripping with IL2CPP, see documentation on Managed bytecode stripping with IL2CPP.
Enable Internal profiler (Deprecated) Enable this option to get the profiler data from your device in the Android SDK’s adblogcat output while testing your projects. This is only available in development builds.
Vertex Compression Choose the channel that you want to set for compressing meshes under the vertex compression method, which by default, is set to Mixed. This affects all the meshes in your project. Typically, Vertex Compression is used to reduce the size of mesh data in memory, reduce file size, and improve GPU performance. For information on how to configure vertex compression and limitations of this setting, see [compressing meshes].
Optimize Mesh Data Selecting this option enables stripping of unused vertex attributes from the mesh used in a build.
This reduces the amount of data in the mesh, which might help reduce build size, loading times, and runtime memory usage. However, you must remember to not change material or shader settings at runtime, if you have this setting enabled. See PlayerSettings.stripUnusedMeshComponents for more information.
Texture MipMap Stripping Enable this option to enable mipmap stripping for all platforms, which strips unused mipmaps from Textures at build time. Unity determines unused mipmaps by comparing the value of the mipmap against the Quality Settings for the current platform. If a mipmap value is excluded from every Quality Setting for the current platform, then Unity strips those mipmaps from the build at build time. If QualitySettings.masterTextureLimit is set to a mipmap value that has been stripped, Unity will set the value to the closest mipmap value that has not been stripped.

Logging

Select what type of logging to allow in specific contexts.

Logging settings for Android platform
Logging settings for Android platform
  • Select your preferred logging method from the available options.

  • Check a box that corresponds to each Log Type (Error, Assert, Warning, Log, and Exception) based on the type of logging you require. For example:
    • ScriptOnly: Logs only when running scripts.
    • Full: Logs all the time.
    • None: No logs are ever recorded.

    See stack trace logging for more information.

Legacy

Enable the Clamp BlendShapes (Deprecated) option to clamp the range of blend shape weights in SkinnedMeshRenderers.

Legacy settings for the Android platform
Legacy settings for the Android platform

Publishing Settings

Use the Publishing Settings to configure how Unity builds your Android app. To open the Publishing Settings, go to Edit > Project Settings, select Player, select the Android icon, and open the Publishing Settings panel.

This section describes the different parts of the Publishing Settings panel and what they do. These include:

Android publishing panel
Android publishing panel

Note: For security reasons, Unity doesn’t save your KeystoreAn Android system that lets you store cryptographic key entries for enhanced device security. More info
See in Glossary
or Project Key passwords.

Use the Keystore Manager window to create, configure and load your keys and keystores. You can load existing keystores and keys from either the Keystore Manager or the main Android Publishing panel. If you choose to load these from inside the Keystore Manager, Unity automatically fills the Project Keystore and Project Key fields.
For further information see documentation on the Keystore Manager.

Project Keystore

A keystore is a container that holds signing keys for application security. For details, see Android developer documentation: Android keystore system.

Use the Project Keystore settings to choose which keystore to use for the open project. When you load a keystore, Unity loads all of the keys in that keystore. To load and use an existing keystore in your open project:

  1. Enable Custom Keystore.
  2. Open the Select dropdown, select Browse, and choose a keystore from your file system.
  3. Enter your Keystore password.

If you don’t have an existing keystore, leave Custom Keystore disabled.

Unity uses a debug keystore to sign your application. A debug keystore is a working keystore. It allows you to sign the application and to test it locally. However, the app store will decline apps signed in this way. This is because the app store is unable to verify the validity and ownership of the application using a debug keystore.

Property Description
Custom Keystore Enable Custom Keystore to load and use an existing Keystore.
Select When Custom Keystore is enabled, use this to select the keystore you want to use. The keystores below the partition in the Select dropdown are stored in a predefined dedicated location. For more details, see Choosing your keystore location.
Path You do not need to enter your keystore path. Unity provides this based on the keystore you choose.
Password Enter your keystore password to load your chosen keystore.

Project Key

When you load a keystore, Unity loads all of the keys in that keystore. Use the Project Key settings to choose one key from that keystore to use as the active key for the open project.

Property Description
Alias Select the key you want to use for the open project.
Password Enter your key Password.

Build

By default, Unity builds your application with the manifest files, GradleAn Android build system that automates several build processes. This automation means that many common build errors are less likely to occur. More info
See in Glossary
templates and Proguard files provided with the Unity installation. Use the Build section of the Android Publishing Settings to change these.

To use a custom manifest file, Gradle template or Proguard file:

  1. Enable the appropriate checkbox. Unity creates a default file in your project, and the file location appears below the checkbox.
  2. Open the new file and make your changes.
  3. Save your changes to this file. Unity automatically uses the changes saved to this file next time it builds the application.

The settings in the Build section only apply to the build process for the current project.

Property Description
Custom Main Manifest Customizable version of the Android LibraryManifest.xml file. This file contains important metadata about your Android application. For more information about the responsibilities of the Main/Unity Library Manifest see Unity Library Manifest.
Custom Unity Launcher Manifest Customizable version of the Android LauncherManifest.xml file. This file contains important metadata about your Android application’s launcher. For more information about the responsibilities of the Unity Launcher Manifest see Unity Launcher Manifest.
Custom Main Gradle Template Customizable version of the mainTemplate.gradle file. This file contains information on how to build your Android application as a library. For more information see documentation on Providing a custom Gradle Template.
Custom Launcher Gradle Template Customizable version of the launcherTemplate.gradle_ file. This file contains instructions on how to build your Android application. For more information see documentation on build.gradle templates.
Custom Base Gradle Template Customizable version of the baseProjectTemplate.gradle file. This file contains configuration that is shared between all other templates and Gradle projects. For more information see documentation on build.gradle templates.
Custom Gradle Properties Template Customizable version of the gradle.properties file. This file contains configuration settings for the Gradle build environment. This includes:
- The JVM (Java Virtual Machine) memory configuration.
- A property to allow Gradle to build using multiple JVMs.
- A property for choosing the tool to do the minification.
- A property to not compress native libs when building an app bundle.
Custom Proguard File Customizable version of the proguard.txt file. This file contains configuration settings for the minification process. If minification removes some Java code which should be kept, you should add a rule to keep that code in this file. For more information see documentation on Minification.

Minify

Minification is a process which shrinks, obfuscates and optimises the code in your application. It can reduce the code size and make the code harder to disassemble. Use the Minify settings to define when and how Unity should apply minification to your build.

In most cases, it’s good practice to only apply minification to release builds, and not debug builds. This is because minification takes time, and can make the builds slower. It can also make debugging more complicated due to the optimisation that the code undergoes.

The settings in the Minify section only apply to the build process for the current project.

Property Description
Use R8 By default, Unity uses Proguard for minification. Enable this checkbox to use R8 instead.
Release Enable this checkbox if you want Unity to minify your application’s code in release builds.
Debug Enable this checkbox if you want Unity to minify your application’s code in debug builds.

Split Application Binary

Enable the Split Application Binary option to split your output package into main (APK) and expansion (OBB) packages. The Google Play Store requires this if you want to publish applications larger than 100 MB.



  • Updated features in 5.5
  • Sustained Performance Mode added in 2017.3
  • .NET 4.x runtime added in 2018.1
  • Android Multiple APK features added in 2018.2
  • OpenGL ES 3.2 support for Android added in 2019.1 NewIn20191
  • Input System preview added in Unity 2019.1
  • Render outside safe area added in Unity 2019.1
  • Warn about App Bundle size option added in Unity 2019.2
  • GPU Skinning renamed to Compute Skinning in Unity 2019.3
  • Vuforia removed in Unity 2019.3
  • Support for built-in XR SDKs deprecated in Unity 2019.3.NewIn20193
  • Updated for Texture compression format
Android environment setup
Android keystores