Unity provides Player Settings and Build settings to configure your application. When Unity builds your project, it takes these configuration options and uses them to generate Gradle project files. However, sometimes you might need more control over the Gradle project files.
Learn about the available methods that you can use to modify the contents of Gradle project files. Not every method is compatible with every Gradle project file. The following table shows which methods you can use to modify each Gradle project file.
Gradle プロジェクトファイル | Gradle template | Android Project Configuration Manager | Android Studio |
---|---|---|---|
Main Manifest | サポートあり | サポートあり | サポートあり |
Android Launcher Manifest | サポートあり | サポートあり | サポートあり |
Main Gradle | サポートあり | サポートあり | サポートあり |
Launcher Gradle | サポートあり | サポートあり | サポートあり |
Base Gradle | サポートあり | サポートあり | サポートあり |
Gradle Properties Template | サポートあり | サポートあり | サポートあり |
Proguard File | サポートあり | サポートなし | サポートあり |
Unity uses templates to produce the final Gradle project files. You can override these templates to control how Unity produces the final files. Gradle merges the manifests from your Android libraries into a final main manifest and makes sure that the final configuration is correct.
Important: If you use custom Gradle template files, be aware that if you upgrade your Unity project to a version of Unity that uses different default template files, you must rewrite your custom Gradle template files.
For information on how to use this method to modify Gradle project files, refer to Modify Gradle project files with Gradle template files.
The Android Project Configuration Manager is a set of classes that represent Gradle project files in C#. You can use the API to modify properties and other values in the supported Gradle project files. Unity applies the modifications during the build post-process, so you can check what values the Unity Editor sets and change them if you want. The entry point for the Android Project Configuration Manager is the OnModifyAndroidProjectFiles method in the AndroidProjectFilesModifier interface.
The Android Project Configuration Manager is a replacement for Gradle files templates and its benefits are:
OnModifyAndroidProjectFiles
when its dependencies change which makes it compatible with the incremental build pipeline. If any Gradle project file modifications you make depend on the content of a file, for example, if you read from a text file to determine whether to set a particular Gradle project file attribute, you should declare the file as a dependency of the build. This makes the build system track the file and re-run OnModifyAndroidProjectFiles
if you change the content of the file. For more information, refer to AndroidProjectFilesModifier.Setup.For information on how to use this method to modify Gradle project files, refer to Modify Gradle project files with the Android Project Configuration Manager.
For information on how to upgrade Gradle template files to the Android Project Configuration Manager, refer to Android Templates Upgrader window reference.
Important: You can use both Gradle template files and the Android Project Configuration Manager API to modify the Gradle project files for your application. However, you can’t use both methods to modify the same Gradle project file. If you do, Unity throws an error.
If you export a Unity project for Android, Unity generates Gradle project files and places them in the exported project. If you open the exported project in Android Studio, you can view the Gradle project files. This can be useful to verify modifications you made using Gradle templates or the Android Project Configuration Manager, and also useful to directly edit the files themselves.
Tip: To make sure you don’t need to re-modify the Gradle project files each time you export or build your Unity project, it’s best practice to perform the Gradle project file modifications that you want within Unity (using either Gradle template files or the Android Project Configuration Manager).
For information on how to use this method to modify Gradle project files, refer to Modify Gradle project files with Android Studio.
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.