Merge remote-tracking branch 'upstream/develop' into develop

YoYoGames · Feb 28, 2024 · 7093f2b · 7093f2b
2 parents 2e87a9a + 7abf5ce
commit 7093f2b
Show file tree

Hide file tree

Showing 8 changed files with 55 additions and 0 deletions.
diff --git a/Manual/contents/IDE_Tools/Project_Tool.htm b/Manual/contents/IDE_Tools/Project_Tool.htm
@@ -0,0 +1,54 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<!DOCTYPE html>
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <meta name="generator" content="Adobe RoboHelp 2022" />
+  <title>ProjectTool</title>
+  <meta name="topic-status" content="Draft" />
+  <link rel="stylesheet" type="text/css" href="../assets/css/default.css" />
+  <meta name="template" content="../assets/masterpages/Manual_Page.htt" />
+  <meta name="search-keywords" content="project,tool,project tool" />
+  <meta name="rh-index-keywords" content="Project Tool" />
+</head>
+<body>
+  <h1><span data-field="title" data-format="default">ProjectTool</span></h1>
+  <p><span data-field="title" data-format="default">ProjectTool</span> is a built-in tool to convert projects between different versions of <span data-keyref="GameMaker Name">GameMaker</span>.</p>
+  <p>It is used by the IDE internally to convert projects from older project formats to the current format and the other way round.</p>
+  <p>It is accessible from the IDE through <a data-xref="{title}" href="../IDE_Navigation/Menus/The_Tools_Menu.htm">The Tools Menu</a> &gt; <strong>Project Tool</strong> option.</p>
+  <p class="note"><span data-conref="../assets/snippets/Tag_note.hts"> </span> See the <a data-xref="{title}" href="../Additional_Information/Project_Format.htm">Project Format</a> page for details on the current project format.</p>
+  <p><img alt="Project Tool" class="center" height="263" src="../assets/Images/IDE Tools/Project_Tool.png" style="cursor: nesw-resize;" width="550" /></p>
+  <p>The tool window contains the following fields:</p>
+  <ul class="colour">
+    <li><strong>Source</strong> - This field contains the path to the source project or package file to convert. Paste a valid file path here or click the <img class="icon" height="24" src="../assets/Images/IDE Tools/Project_Tool_Select_File.png" width="24" /> button to bring up a file selector.</li>
+    <li><strong>Destination</strong> - This field contains the path to the destination project to create. Paste a valid path here or click the <img class="icon" height="24" src="../assets/Images/IDE Tools/Project_Tool_Select_File.png" width="24" /> button to bring up a file selector. This field can be empty when the source project is a <span data-keyref="Const_Ext_Project">.yyp</span> file, in which case <span data-field="title" data-format="default">ProjectTool</span> does an in-place conversion (i.e. it converts the project in the source directory). It must be filled out, however, when the source project is a package file. <span data-field="title" data-format="default">ProjectTool</span> shows the following message if you attempt to convert a package with an empty destination path: <img alt="No Destination Project Selected" class="center" src="../assets/Images/IDE Tools/Project_Tool_No_Destination_Selected.png" /></li>
+    <li><strong>Project Format</strong> - This drop-down list contains the available project formats that you can convert to. The following formats are available: 
+      <ul>
+        <li><strong>LTS22</strong> - This is the project format used by the 2022.0 LTS release.</li>
+        <li><strong>NOV23</strong> - This is the project format used by the 2023.11 release.</li>
+        <li><strong>DEFAULT</strong> - This is the current default, versioned project format.</li>
+      </ul>
+    </li>
+    <li><strong>Force VERS0 Conversion if required</strong> - When this checkbox is enabled, <span data-field="title" data-format="default">ProjectTool</span> forces a conversion to the intermediary base version 0 format in a last attempt to fix any issues with your project. The VERS0 format is a format to facilitate conversion between the NOV23 format and the versioned DEFAULT format.<br />
+      <br />
+      <span data-conref="../assets/snippets/Tag_warning.hts"> </span> You should be very careful with enabling this option, as it will make a best guess to missing fields and strip out any unknown data.
+    </li>
+    <li><strong>Clean Conversion Folders</strong> - When this checkbox is ticked, <span data-field="title" data-format="default">ProjectTool</span> cleans up the conversion folders after conversion. This is enabled by default.</li>
+  </ul>
+  <h2 id="h"><span data-field="title" data-format="default">ProjectTool</span> Output</h2>
+  <p>All <span data-field="title" data-format="default">ProjectTool</span> output is shown in the Project Tool Window that you can open manually through the <strong>Project Tool Output</strong> option of <a data-xref="{title}" href="../IDE_Navigation/Menus/The_Windows_Menu.htm">The Windows Menu</a>. It can also automatically be shown when <span data-field="title" data-format="default">ProjectTool</span> runs by enabling <strong>Show Project Tool Output</strong> in the <a data-xref="{title}" href="../Setting_Up_And_Version_Information/IDE_Preferences/General_Preferences.htm">General Preferences</a>.</p>
+  <p><img alt="Project Tool Output" class="center" src="../assets/Images/IDE Tools/Project_Tool_Output.png" /></p>
+  <p> </p>
+  <p> </p>
+  <p> </p>
+  <div class="footer">
+    <div class="buttons">
+      <div class="clear">
+        <div>Back: <a data-xref="{title}" href="Additional_IDE_Tools.htm">Additional IDE Tools</a></div>
+        <div>Next: <a data-xref="{title}" href="The_Debugger.htm">The Debugger</a></div>
+      </div>
+    </div>
+    <h5><span data-conref="../assets/snippets/Copyright_Notice_AutoUpdate.hts"> </span></h5>
+  </div>
+</body>
+</html>
diff --git a/Manual/contents/assets/Images/IDE Tools/Project_Tool.png b/Manual/contents/assets/Images/IDE Tools/Project_Tool.png
diff --git a/Manual/contents/assets/Images/IDE Tools/Project_Tool_No_Destination_Selected.png b/Manual/contents/assets/Images/IDE Tools/Project_Tool_No_Destination_Selected.png
diff --git a/Manual/contents/assets/Images/IDE Tools/Project_Tool_Output.png b/Manual/contents/assets/Images/IDE Tools/Project_Tool_Output.png
diff --git a/Manual/contents/assets/Images/IDE Tools/Project_Tool_Select_File.png b/Manual/contents/assets/Images/IDE Tools/Project_Tool_Select_File.png
diff --git a/Manual/contents/assets/Images/IDE_Input/Tools_Menu.png b/Manual/contents/assets/Images/IDE_Input/Tools_Menu.png
diff --git a/Manual/contents/assets/Images/IDE_Input/Window_Menu.png b/Manual/contents/assets/Images/IDE_Input/Window_Menu.png
diff --git a/Manual/toc/Default.toc b/Manual/toc/Default.toc
@@ -133,6 +133,7 @@
       <page href="../contents/IDE_Tools/Source_Control/Conflicts.htm" format="html" processing-role="normal"></page>
       <page href="../contents/IDE_Tools/Source_Control/External_Merge_Diff_Tools.htm" format="html" processing-role="normal"></page>
     </book>
+    <page href="../contents/IDE_Tools/Project_Tool.htm" format="html" processing-role="normal"></page>
   </book>
 </book>
 <book href="../contents/Settings/Game_Settings.htm" format="html" processing-role="normal">