Changed folder structure & added Readme & License information

WispBart · Mar 4, 2021 · 6e3ad2b · 6e3ad2b
1 parent 4cb83d3
commit 6e3ad2b
Show file tree

Hide file tree

Showing 29 changed files with 208 additions and 16 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,4 @@
+#ChangeLog
+
+##[0.6.0-preview] - 2021-03-04
+* Initial Release
diff --git a/CHANGELOG.md.meta b/CHANGELOG.md.meta
diff --git a/Editor.meta b/Editor.meta
diff --git a/ButlerSettings.cs → Editor/ButlerSettings.cs b/ButlerSettings.cs → Editor/ButlerSettings.cs
@@ -12,17 +12,26 @@ public class ButlerSettings : ScriptableSingleton<ButlerSettings>
         protected override SerializationMode defaultSerializationMode => SerializationMode.Text;
 
         public SupportedBuildTarget BuildTarget = SupportedBuildTarget.WebGL;
-
+        public string GetDefaultBuildPath(SupportedBuildTarget buildTarget)
+        {
+            switch (buildTarget)
+            {
+                case SupportedBuildTarget.WebGL: return "Builds/WebGL";
+                default: return "Builds/latestBuild";
+            }
+        }
         public string Account = "";
         public string Project = "";
         public bool OverrideChannel = false;
         public string Channel = "";
         public bool OverrideVersion = false;
         public string Version = "";
-
+        public bool OverrideBuildPath;
         public string BuildPath;
 
         public string GetChannel() => OverrideChannel ? Channel : BuildTarget.ToString();
+        public string GetBuildPath() => OverrideBuildPath ? BuildPath : GetDefaultBuildPath(BuildTarget);
+
         public string GetURL() => $"https://{Account}.itch.io/{Project}";
         public string ToPushArgs()
         {

diff --git a/ButlerSettings.cs.meta → Editor/ButlerSettings.cs.meta b/ButlerSettings.cs.meta → Editor/ButlerSettings.cs.meta
diff --git a/ButlerWin64.cs → Editor/ButlerWin64.cs b/ButlerWin64.cs → Editor/ButlerWin64.cs
diff --git a/ButlerWin64.cs.meta → Editor/ButlerWin64.cs.meta b/ButlerWin64.cs.meta → Editor/ButlerWin64.cs.meta
diff --git a/ButlerWindow.cs → Editor/ButlerWindow.cs b/ButlerWindow.cs → Editor/ButlerWindow.cs
diff --git a/ButlerWindow.cs.meta → Editor/ButlerWindow.cs.meta b/ButlerWindow.cs.meta → Editor/ButlerWindow.cs.meta
diff --git a/ButlerWindow2.cs → Editor/ButlerWindow2.cs b/ButlerWindow2.cs → Editor/ButlerWindow2.cs
@@ -9,9 +9,9 @@ namespace ButlerWindow
     public class ButlerWindow2 : EditorWindow
     {
         public const string TITLE = "Upload to itch.io";
-        public readonly string ShareUXML = "Packages/com.wispfire.butlerwindow/UI/ButlerWindow_Share.uxml";
-        public readonly string DownloadUXML = "Packages/com.wispfire.butlerwindow/UI/ButlerWindow_Download.uxml";
-        public readonly string MainStyleSheet = "Packages/com.wispfire.butlerwindow/UI/ButlerWindow.uss";
+        public readonly string ShareUXML = "Packages/com.wispbart.butlerwindow/UI/ButlerWindow_Share.uxml";
+        public readonly string DownloadUXML = "Packages/com.wispbart.butlerwindow/UI/ButlerWindow_Download.uxml";
+        public readonly string MainStyleSheet = "Packages/com.wispbart.butlerwindow/UI/ButlerWindow.uss";
 
         private ButlerWin64 _butler;
         private ButlerSettings _settings => ButlerSettings.instance;
@@ -32,6 +32,7 @@ void OnEnable()
         {
             _butler = CreateInstance<ButlerWin64>();
             _butler.SetConsoleMessage = SetConsoleContents;
+
             _butler.AppendConsoleMessage = AppendConsoleMessage;
         }
 
@@ -102,7 +103,14 @@ public void CreateGUI()
             overrideVersion.BindProperty(settings.FindProperty("OverrideVersion"));
             version.visible = overrideVersion.value;
             overrideVersion.RegisterValueChangedCallback((x) => version.visible = x.newValue);
-            _sharePage.Q<TextField>("buildPath").BindProperty(settings.FindProperty("BuildPath"));
+
+            //buildPath
+            var buildPath = _sharePage.Q<TextField>("buildPath");
+            buildPath.BindProperty(settings.FindProperty("BuildPath"));
+            var overridebuildPath = _sharePage.Q<Toggle>("overrideBuildPath");
+            buildPath.visible = overridebuildPath.value;
+            overridebuildPath.RegisterValueChangedCallback((x) => buildPath.visible = x.newValue);
+
 
             _devBuildToggle = _sharePage.Q<Toggle>("devBuild");
             _devBuildToggle.SetValueWithoutNotify(EditorUserBuildSettings.development);
@@ -111,10 +119,6 @@ public void CreateGUI()
             // Build button
             var buildButton = _sharePage.Q<Button>("build");
             buildButton.clicked += Build;
-
-            var newButton = new Button();
-            newButton.text = "I am a new button";
-            _sharePage.Add(newButton);
 
             // Console
             _console = _sharePage.Q<TextField>("console");
@@ -156,12 +160,12 @@ private void Build()
             bool confirm = EditorUtility.DisplayDialog("Build WebGL Player", "This might take a while... Continue?",
                 "Confirm", "Cancel");
             if (!confirm) return;
-
+            
             var report = BuildPipeline.BuildPlayer(new BuildPlayerOptions()
             {
                 scenes = EditorBuildSettings.scenes.Select((scene) => scene.path).ToArray(),
                 target = (BuildTarget) _settings.BuildTarget,
-                locationPathName = _settings.BuildPath,
+                locationPathName = _settings.GetBuildPath(),
                 options = EditorUserBuildSettings.development ? BuildOptions.Development : BuildOptions.None,
             });
             Share();

diff --git a/ButlerWindow2.cs.meta → Editor/ButlerWindow2.cs.meta b/ButlerWindow2.cs.meta → Editor/ButlerWindow2.cs.meta
diff --git a/ConsoleWindow.cs → Editor/ConsoleWindow.cs b/ConsoleWindow.cs → Editor/ConsoleWindow.cs
diff --git a/ConsoleWindow.cs.meta → Editor/ConsoleWindow.cs.meta b/ConsoleWindow.cs.meta → Editor/ConsoleWindow.cs.meta
diff --git a/ScriptableSingleton.cs → Editor/ScriptableSingleton.cs b/ScriptableSingleton.cs → Editor/ScriptableSingleton.cs
diff --git a/ScriptableSingleton.cs.meta → Editor/ScriptableSingleton.cs.meta b/ScriptableSingleton.cs.meta → Editor/ScriptableSingleton.cs.meta
diff --git a/com.wispbart.butlerwindow.asmdef → Editor/com.wispbart.butlerwindow.asmdef b/com.wispbart.butlerwindow.asmdef → Editor/com.wispbart.butlerwindow.asmdef
diff --git a/com.wispbart.butlerwindow.asmdef.meta → Editor/com.wispbart.butlerwindow.asmdef.meta b/com.wispbart.butlerwindow.asmdef.meta → Editor/com.wispbart.butlerwindow.asmdef.meta
diff --git a/csc.rsp → Editor/csc.rsp b/csc.rsp → Editor/csc.rsp
diff --git a/csc.rsp.meta → Editor/csc.rsp.meta b/csc.rsp.meta → Editor/csc.rsp.meta
diff --git a/LICENSE.md b/LICENSE.md
@@ -0,0 +1,24 @@
+This software is covered by the MIT License. The package may download Butler when used, which may be covered by its own license.
+
+
+MIT License
+
+Copyright (c) 2021 WispBart
+
+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.
diff --git a/LICENSE.md.meta b/LICENSE.md.meta
diff --git a/README.md b/README.md
@@ -0,0 +1,15 @@
+# Butler Window for Unity
+An Unity Editor Window for uploading builds to Itch.io
+
+![itch io window](meta/itchiowindow.png)
+
+This tool downloads & wraps [Butler](https://itch.io/docs/butler/) so you can build & upload your project to itch.io with a single button. It's ideal for rapidly sharing the latest iteration of your game, prototype or other without having to leave your Editor.
+
+##Requirements
+Butler Window was tested with Unity 2019.4 and 2020.2. Butler Window currently only builds to WebGL (by choice), so you need to have the WebGl Build module installed.
+
+##Supported Platforms
+Butler Window / Upload to itch.io currently only supports the UnityEditor on Windows, although it can be safely shared with Linux/macOS machines.
+
+##Security
+Butler Window uses Butler for authentication, so no passwords are stored by the package.
diff --git a/README.md.meta b/README.md.meta
diff --git a/UI.meta b/UI.meta
diff --git a/UI/ButlerWindow_Share.uxml b/UI/ButlerWindow_Share.uxml
@@ -22,7 +22,10 @@
             <ui:Toggle label="Override Version" name="overrideVersion" />
             <ui:TextField picking-mode="Ignore" label="Version" name="version" class="channel-toggle__textfield" />
         </ui:VisualElement>
-        <ui:TextField picking-mode="Ignore" name="buildPath" label="Build Path" />
+        <ui:VisualElement name="channel" class="channel-toggle">
+            <ui:Toggle label="Override Build Path" name="overrideBuildPath" />
+            <ui:TextField picking-mode="Ignore" name="buildPath" label="Build Path" class="channel-toggle__textfield" />
+        </ui:VisualElement>
         <ui:Toggle label="Development Build" name="devBuild" />
     </ui:Box>
     <ui:VisualElement name="ShareButtons" class="sharebuttons" style="justify-content: flex-end;">

diff --git a/meta.meta b/meta.meta
diff --git a/meta/itchiowindow.png b/meta/itchiowindow.png
diff --git a/meta/itchiowindow.png.meta b/meta/itchiowindow.png.meta
diff --git a/package.json b/package.json
@@ -1,9 +1,9 @@
 {
   "name": "com.wispbart.butlerwindow",
   "displayName": "itch.io Window",
-  "version": "0.5.3-preview",
+  "version": "0.6.0-preview",
   "unity": "2019.4",
-  "description": "An editor window for quickly and easily sharing your project to itch.io as a WebGL build.",
+  "description": "An editor window for quickly and easily sharing your project to itch.io as a WebGL build.\n\nThis tool downloads & wraps Butler so you can build & upload your project to itch.io with a single button. It's ideal for rapidly sharing the latest iteration of your game, prototype or other without having to leave your Editor.\n\nPreview versions have not been exhaustively tested.",
   "dependencies": {
     "com.unity.editorcoroutines": "0.1.0-preview.1"
   },