Last active
July 22, 2024 19:52
-
-
Save phosphoer/5ab999db7b3da3a26ac2ecbe5136e488 to your computer and use it in GitHub Desktop.
Create build definition assets in Unity and build multiple platforms / builds with different scenes at once with the click of a button!
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
// The MIT License (MIT) | |
// Copyright (c) 2024 David Evans @festivevector | |
// Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: | |
// The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. | |
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. | |
#if UNITY_EDITOR | |
using UnityEditor; | |
using UnityEngine; | |
using System.Collections.Generic; | |
[CreateAssetMenu(fileName = "new-build-definition", menuName = "Build Definition")] | |
public class BuildDefinition : ScriptableObject | |
{ | |
public string LocationPathName = "relative/path/build.exe"; | |
public string ProductNameOverride; | |
public string CompanyNameOverride; | |
public BuildTarget BuildTarget; | |
public BuildTargetGroup BuildTargetGroup; | |
public string[] Defines; | |
public SceneField[] Scenes; | |
public bool WriteBuildInfo = true; | |
public string BuildInfoFile = "BuildInfo.cs"; | |
public string BuildName = "Main"; | |
private const string kBuildVersionText = "public static class BuildInfo {{ public static string Name = \"{0}\"; public static string Date = \"{1}\"; }}"; | |
[ContextMenu("Build")] | |
public void Build() | |
{ | |
BuildPipeline.BuildPlayer(ApplyBuildSettings()); | |
} | |
[ContextMenu("Copy Scenes From Build Settings")] | |
public void CopySceneListFromBuild() | |
{ | |
Scenes = new SceneField[EditorBuildSettings.scenes.Length]; | |
for (int i = 0; i < EditorBuildSettings.scenes.Length; ++i) | |
{ | |
var sceneBuildSetting = EditorBuildSettings.scenes[i]; | |
SceneAsset sceneAsset = (SceneAsset)AssetDatabase.LoadAssetAtPath(sceneBuildSetting.path, typeof(SceneAsset)); | |
Scenes[i] = new SceneField(); | |
Scenes[i].sceneAsset = sceneAsset; | |
} | |
} | |
[ContextMenu("Apply Build Settings")] | |
public BuildPlayerOptions ApplyBuildSettings() | |
{ | |
if (WriteBuildInfo) | |
{ | |
string pathToBuildAsset = System.IO.Path.GetDirectoryName(AssetDatabase.GetAssetPath(this)); | |
string versionFileText = string.Format(kBuildVersionText, BuildName, System.DateTime.Now.ToString()); | |
System.IO.File.WriteAllText(System.IO.Path.Combine(pathToBuildAsset, BuildInfoFile), versionFileText); | |
AssetDatabase.Refresh(); | |
} | |
string defineList = string.Join(";", Defines); | |
PlayerSettings.SetScriptingDefineSymbolsForGroup(BuildTargetGroup, defineList); | |
// Set basic options | |
BuildPlayerOptions buildOptions = new BuildPlayerOptions(); | |
buildOptions.targetGroup = BuildTargetGroup; | |
buildOptions.target = BuildTarget; | |
buildOptions.locationPathName = LocationPathName; | |
if (!string.IsNullOrEmpty(ProductNameOverride)) PlayerSettings.productName = ProductNameOverride; | |
if (!string.IsNullOrEmpty(CompanyNameOverride)) PlayerSettings.companyName = CompanyNameOverride; | |
// Build scene list | |
List<string> sceneList = new List<string>(); | |
List<EditorBuildSettingsScene> editorScenes = new List<EditorBuildSettingsScene>(); | |
foreach (SceneField scene in Scenes) | |
{ | |
var sceneAsset = AssetDatabase.GetAssetPath(scene.sceneAsset); | |
sceneList.Add(sceneAsset); | |
editorScenes.Add(new EditorBuildSettingsScene(sceneAsset, true)); | |
} | |
buildOptions.scenes = sceneList.ToArray(); | |
EditorBuildSettings.scenes = editorScenes.ToArray(); | |
return buildOptions; | |
} | |
} | |
#endif |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
// The MIT License (MIT) | |
// Copyright (c) 2024 David Evans @festivevector | |
// Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: | |
// The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. | |
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. | |
#if UNITY_EDITOR | |
using UnityEditor; | |
using UnityEngine; | |
[CustomEditor(typeof(BuildDefinition))] | |
[CanEditMultipleObjects] | |
public class BuildDefinitionEditor : Editor | |
{ | |
public override void OnInspectorGUI() | |
{ | |
DrawDefaultInspector(); | |
// This creates an error in the inspector after build about the GUI stack | |
// being in an invalid state, presumably Unity doesn't appreciate being told to | |
// do a build mid-inspector rendering. Not sure how to fix but seems relatively harmless. | |
if (GUILayout.Button("Build")) | |
{ | |
foreach (Object obj in targets) | |
{ | |
BuildDefinition buildDef = obj as BuildDefinition; | |
if (buildDef != null) | |
{ | |
buildDef.Build(); | |
} | |
} | |
} | |
if (GUILayout.Button("Apply Settings")) | |
{ | |
foreach (Object obj in targets) | |
{ | |
BuildDefinition buildDef = obj as BuildDefinition; | |
if (buildDef != null) | |
{ | |
buildDef.ApplyBuildSettings(); | |
} | |
} | |
} | |
} | |
} | |
#endif |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
// Taken from http://wiki.unity3d.com/index.php/SceneField | |
using UnityEngine; | |
[System.Serializable] | |
public class SceneField : ISerializationCallbackReceiver | |
{ | |
#if UNITY_EDITOR | |
public UnityEditor.SceneAsset sceneAsset; | |
#endif | |
#pragma warning disable 414 | |
[SerializeField, HideInInspector] | |
private string sceneName = ""; | |
#pragma warning restore 414 | |
// Makes it work with the existing Unity methods (LoadLevel/LoadScene) | |
public static implicit operator string(SceneField sceneField) | |
{ | |
#if UNITY_EDITOR | |
return System.IO.Path.GetFileNameWithoutExtension(UnityEditor.AssetDatabase.GetAssetPath(sceneField.sceneAsset)); | |
#else | |
return sceneField.sceneName; | |
#endif | |
} | |
public void OnBeforeSerialize() | |
{ | |
#if UNITY_EDITOR | |
sceneName = this; | |
#endif | |
} | |
public void OnAfterDeserialize() { } | |
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment