AndroidProjectFiles

Description

Stores C# representations of Gradle project files associated with custom modules or plug-ins(libraries).

Use this class to pass Gradle configuration file objects to the AndroidProjectFilesModifier.OnModifyAndroidProjectFiles callback, allowing modifications to Gradle files during the build process. This class does not support modifying Unity's default Gradle and manifest files.

using System.IO;
using UnityEngine;
using Unity.Android.Gradle;
using UnityEditor.Android;

public class AndroidProjectFilesExample : AndroidProjectFilesModifier
{
    // Define the path to the Gradle file
    private string _myLibBuildGradle = Path.Combine("unityLibrary", "customPlugin", "build.gradle");
    
    // Configure the required settings/outputs to modify the Android project files
    public override AndroidProjectFilesModifierContext Setup()
    {
        // Initialize the context for modifying project files
        AndroidProjectFilesModifierContext projectFilesContext = new AndroidProjectFilesModifierContext();

        // Add the Gradle file to the output
        projectFilesContext.Outputs.AddBuildGradleFile(_myLibBuildGradle);

        // Add a custom file to the output
        projectFilesContext.Outputs.AddFileWithContents("CustomOutput/Config.txt");

        return projectFilesContext;
    }

    //  Modify the Android project files
    public override void OnModifyAndroidProjectFiles(AndroidProjectFiles projectFiles)
    {
        // Create a build.gradle file
        var buildGradleFile = new ModuleBuildGradleFile();
        projectFiles.SetBuildGradleFile(_myLibBuildGradle, buildGradleFile);

        // Add contents to the build.gradle file       
        buildGradleFile.Android.DefaultConfig.VersionName.Set("Example Version Name");

        // Check if the Gradle file exists in the project
        if (projectFiles.AdditionalLibrariesBuildGradleFiles.ContainsKey(_myLibBuildGradle))
        {
            // Log a message indicating the Gradle file was found
            Debug.Log($"Gradle file found: {_myLibBuildGradle}");
        }
        else
        {
            Debug.LogWarning($"Gradle file not found: {_myLibBuildGradle}");
        }

        // Use the SetFileContents method to create a custom file
        string customFileContent = "This is a custom configuration file created during the build process.";
        projectFiles.SetFileContents("CustomOutput/Config.txt", customFileContent);

        Debug.Log("Custom file created successfully.");
    }
}

Properties

Public Methods