Skip to content

Commit

Permalink
docs(feature): Document new IDE updater
Browse files Browse the repository at this point in the history
  • Loading branch information
gurpreetsinghmatharoo committed Nov 7, 2024
1 parent 16c880a commit 1b5c18a
Show file tree
Hide file tree
Showing 7 changed files with 16 additions and 11 deletions.
1 change: 1 addition & 0 deletions Manual/contents/IDE_Navigation/Menus/The_Help_Menu.htm
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ <h1><span data-field="title" data-format="default">The Help Menu</span></h1>
<hr />
</li>
<li><strong>Licences</strong> - This opens a window containing licences for all the third-party libraries used in <span data-keyref="GameMaker Name">GameMaker</span>.</li>
<li><strong>Check for Updates</strong> - This will check for <a href="../../Setting_Up_And_Version_Information/Updating_Guide.htm">IDE updates</a> and let you install an update if available.</li>
<li><strong>About </strong>- This opens the &quot;About <span data-keyref="GameMaker Name">GameMaker</span>&quot; window where you can get version information on the product (essential for reporting any bugs or issues) and see the credits.</li>
</ul>
<p> </p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<h1><span data-field="title" data-format="default">Version &amp; Account Details</span></h1>
<p>The top-right section of the <span data-keyref="GameMaker Name">GameMaker</span> IDE contains details about the current version, a menu for account details and a notifications button.</p>
<p><img class="center" src="../../assets/Images/IDE_Input/Version_Menu.png" /></p>
<p>This shows you the current IDE and Runtime versions. The Runtime version can be changed from the <a data-xref="{title}" href="../../Setting_Up_And_Version_Information/IDE_Preferences/Runtime_Feed_Preferences.htm">Runtime Feeds Preferences</a>.</p>
<p>This shows you the current IDE and Runtime versions. The IDE can be updated through <a data-xref="{title}" href="The_Help_Menu.htm">The Help Menu</a> and the Runtime version can be changed from the <a data-xref="{title}" href="../../Setting_Up_And_Version_Information/IDE_Preferences/Runtime_Feed_Preferences.htm">Runtime Feeds Preferences</a>.</p>
<h2 id="account_menu">Account Menu</h2>
<p><img class="center" src="../../assets/Images/IDE_Input/Account_Menu.png" />This menu contains the following options:</p>
<ul class="colour">
Expand All @@ -40,7 +40,7 @@ <h2>Notifications</h2>
<div style="float:right">Next: <a href="The_File_Menu.htm">The File Menu</a></div>
</div>
</div>
<h5><span data-keyref="Copyright Notice">© Copyright YoYo Games Ltd. 2023 All Rights Reserved</span></h5>
<h5><span data-keyref="Copyright Notice">© Copyright YoYo Games Ltd. 2024 All Rights Reserved</span></h5>
</div>
<!-- KEYWORDS
The Help Menu
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@
<!--<div class="body-scroll" style="top: 150px;">-->
<h1><span data-field="title" data-format="default">Installation Guide</span></h1>
<p><span data-keyref="GameMaker Name">GameMaker</span> is designed for use on <strong>macOS </strong>and <strong>Windows </strong>desktop computers.</p>
<p>You can download the <span data-keyref="GameMaker Name">GameMaker</span> installer on the <a href="https://gamemaker.io/en/download">GameMaker Website</a> and install it. Once installed, the first time you run <span data-keyref="GameMaker Name">GameMaker</span> you may be prompted to update before being able to use the product. You will be shown the <a href="#h">Runtime Modules Dialog</a> which allows you to select the runtime modules that you&#39;d like to install.</p>
<p>After any updates have been installed, you will be able to use the IDE, and optionally <a href="Licencing_Information.htm">log in</a> (required for creating executables).</p>
<p>You can download the <span data-keyref="GameMaker Name">GameMaker</span> installer on the <a href="https://gamemaker.io/en/download">GameMaker Website</a> and install it. Once installed, the first time you run <span data-keyref="GameMaker Name">GameMaker</span> you may be prompted to <a href="Updating_Guide.htm">update</a> if there is a newer version. You will then be shown the <a href="#h">Runtime Modules Dialog</a> which allows you to select the runtime modules that you&#39;d like to install.</p>
<p>After the runtimes and any updates have been installed, you will be able to use the IDE, and optionally <a href="Licencing_Information.htm">log in</a> (required for creating executables).</p>
<p>It is worth noting that - depending on the licence type that you have - you may be required to install additional components or follow additional steps to set up and use <span data-keyref="GameMaker Name">GameMaker</span> for specific platforms. For full information on what each platform requires, please see this article on the GameMaker Helpdesk: <a href="https://help.gamemaker.io/hc/en-us/articles/227860547-GameMaker-Required-SDKs">Required SDKs</a>.</p>
<h2>Stable, Beta and LTS</h2>
<p>The version you download from the <a href="https://gamemaker.io/en/download">Download page</a> should be the current <strong>Stable </strong>version of <span data-keyref="GameMaker Name">GameMaker</span>. The page also has a &quot;<strong>Beta</strong>&quot; version available which is used to showcase or test new functionality before it goes into a final stable build, as well as an &quot;<strong>LTS</strong>&quot; version that gets only bug fixes.</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Updating Guide</title>
<meta name="generator" content="Adobe RoboHelp 2020" />
<meta name="generator" content="Adobe RoboHelp 2022" />
<link rel="stylesheet" href="../assets/css/default.css" type="text/css" />
<script src="../assets/scripts/main_script.js" type="module"></script>
<meta name="rh-authors" content="Mark Alexander" />
Expand All @@ -15,21 +15,25 @@
<body>
<!--<div class="body-scroll" style="top: 150px;">-->
<h1 id="h1"><span data-field="title" data-format="default">Updating Guide</span></h1>
<p>The <span data-keyref="GameMaker Name">GameMaker</span> IDE will periodically check for updates and then download them automatically. Some of these updates will be optional and you can choose not to install them if you don&#39;t wish to or think that some of the changes may break a project that you are about to publish. However there are some updates that include important fixes or improvements that cannot be skipped and <span data-keyref="GameMaker Name">GameMaker</span> will force an update in these cases.</p>
<p>The <span data-keyref="GameMaker Name">GameMaker</span> IDE will check for updates on start-up and prompt you to download the latest available update:</p>
<p><img alt="New Version Window" class="center" src="../assets/Images/Setup_And_Version/Getting_Started_New_Version.png" /></p>
<p><span data-keyref="GameMaker Name">GameMaker</span> is more than just an IDE and has a number of different runtime tools that it uses behind the scenes to build your games for the different target platforms available. These tools are mainly the different runners and compilers that each platform requires, and you can actually have several of each at any one time. What this means is that you can &quot;pick and choose&quot; which compiler version and which runner version to use should you have found any issues with the current one or are aiming at a very specific target version or platform.</p>
<p>These tools will automatically update when there is a new version available, but you can then use the <a data-xref="{title}" href="IDE_Preferences/Runtime_Feed_Preferences.htm">Runtime Feeds Preferences</a><b> </b>to select which ones you actually want to use.</p>
<p>When updating you will also get the <a data-xref="{text}" href="Installation_Guide.htm#h">Runtime Modules Dialog</a>, which allows you to select the runtime modules to install.</p>
<p>You can also open this window manually using <a data-xref="{title}" href="../IDE_Navigation/Menus/The_Help_Menu.htm">The Help Menu</a>.</p>
<p>This gives you the option of downloading the update, skipping it to be reminded the next time the IDE is started and skipping the automatic update prompt until a newer release. You can also open the Release Notes for the update to read about the changes.</p>
<p>While updates are optional, we strongly recommend updating to new available versions as they will always contain stability improvements and bug fixes, and major releases may bring new features. However you may choose to not install them if you don&#39;t wish to or think that some of the changes may break a project that you are about to publish. </p>
<p><img class="center" src="../assets/Images/Setup_And_Version/Getting_Started_New_Version_Installed.png" />Once an update is downloaded, you can click &quot;<strong>Restart Now</strong>&quot; to restart the IDE immediately to install the update or choose to install it when you manually close the IDE later.</p>
<hr />
<p><span data-keyref="GameMaker Name">GameMaker</span> is more than just an IDE and has a number of different runtime tools that it uses behind the scenes to build your games for the different target platforms available. These tools are mainly the different runners and compilers that each platform requires, and you can actually have several of each at any one time. What this means is that you can &quot;pick and choose&quot; which runner version to use should you have found any issues with the current one or are aiming at a very specific target version or platform. These tools will automatically update when there is a new version available, but you can then use the <a data-xref="{title}" href="IDE_Preferences/Runtime_Feed_Preferences.htm">Runtime Feeds Preferences</a><b> </b>to select which ones you actually want to use.</p>
<p>After an IDE update has been installed, you will get the <a data-xref="{text}" href="Installation_Guide.htm#h">Runtime Modules Dialog</a> which allows you to select the runtime modules to install.</p>
<p> </p>
<p> </p>
<div class="footer">
<div class="buttons">
<div class="clear">
<div style="float:left">Back:  <a href="GMS2_Version_Information.htm"><span data-keyref="GameMaker Name">GameMaker</span> Setup And Versions</a></div>
<div style="float:right">Next: <a data-xref="{title}" href="Release_Notes.htm">Release Notes</a></div>
<div style="float:right">Next: <a data-xref="{title}" href="Release_Notes.htm">GameMaker Changelog</a></div>
</div>
</div>
<h5><span data-keyref="Copyright Notice">© Copyright YoYo Games Ltd. 2023 All Rights Reserved</span></h5>
<h5><span data-keyref="Copyright Notice">© Copyright YoYo Games Ltd. 2024 All Rights Reserved</span></h5>
</div>
<!-- KEYWORDS
Updating
Expand Down
Binary file modified Manual/contents/assets/Images/IDE_Input/Help_Menu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 1b5c18a

Please sign in to comment.