Custom Build Environment

When building the project using the Editor's build menu ↗, Naninovel automatically executes additional pre- and post-processing procedures. Those procedures, among other things, ensure that all resources assigned via Naninovel's configuration menus (e.g., script documents, character appearances, BGM and SFX clips, etc.) are included in the build.

If you're using a custom build environment (e.g., Cloud Build ↗) or starting the build via custom scripts or from the command line, you have to manually invoke Naninovel.BuildProcessor.PreprocessBuild(BuildPlayerOptions) and Naninovel.BuildProcessor.PostprocessBuild() static methods before and after the build respectively.

Below is an example of a Cloud Build custom build processing script that invokes the required Naninovel processing methods. Consult the official service docs ↗ on how to set up the processing scripts.

public static class CustomBuildProcessor
{
	#if UNITY_CLOUD_BUILD
    public static void PreExport (BuildManifestObject manifest)
    {
        var options = new UnityEditor.BuildPlayerOptions();
        var target = manifest.GetValue<string>("target").ToString().ToLower();

        if (target.Contains("windows") && target.Contains("64"))
            options.target = UnityEditor.BuildTarget.StandaloneWindows64;
        else if (target.Contains("windows"))
            options.target = UnityEditor.BuildTarget.StandaloneWindows;
        else if (target.Contains("android"))
            options.target = UnityEditor.BuildTarget.Android;
        else if (target.Contains("webgl"))
            options.target = UnityEditor.BuildTarget.WebGL;
        else throw new System.ArgumentException($"Unhandled target: {target}");

        Naninovel.BuildProcessor.PreprocessBuild(options);
    }
	#endif

    public static void PostExport(string exportPath)
    {
        Naninovel.BuildProcessor.PostprocessBuild();
    }
}

When using assembly definitions for custom commands, the Unity Editor may start importing assets before compiling all the assemblies, leading to build errors when using Cloud Build. This can be solved by reimporting the script assets before starting the build, e.g.:

var scriptGuids = AssetDatabase.FindAssets("t:Naninovel.script");
foreach (var scriptGuid in scriptGuids)
{
    var scriptPath = AssetDatabase.GUIDToAssetPath(scriptGuid);
    AssetDatabase.ImportAsset(scriptPath);
}

If you're using your own custom build handler that is supposed to be triggered with the Editor's build menu, you can disable Naninovel's handler by turning off the Enable Build Processing property in the Resource Provider configuration menu. After enabling or disabling the property, restart the Unity Editor for the change to take effect.