-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge remote-tracking branch 'upstream/develop' into develop
- Loading branch information
Showing
9 changed files
with
184 additions
and
0 deletions.
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| <?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>Package Manager</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" /> | ||
| <meta name="rh-authors" content="Gurpreet S. Matharoo" /> | ||
| <meta name="topic-comment" content="Page explaining the Package Manager" /> | ||
| <meta name="condition-tags" content="Export:Beta" /> | ||
| </head> | ||
| <body> | ||
| <h1><span data-field="title" data-format="default">Package Manager</span></h1> | ||
| <p><img class="center" src="../assets/Images/IDE Tools/PackageManager_Main.png" /></p> | ||
| <p>The Package Manager lets you install packages that <span data-keyref="GameMaker Name">GameMaker</span> can use during your game's compilation. This is currently used for packages required for <a data-xref="{title}" href="../Settings/Runner_Details/GMRT_(GameMaker_Runtime).htm">GMRT (GameMaker Runtime)</a>.</p> | ||
| <p>The list on the left will show you all packages from the selected source, and clicking on a package will show its information on the right, where you can choose a version for the package and install it.</p> | ||
| <p>In the top-left corner you can search for a package, and in the top-right corner you can change the source for the packages from a drop-down menu.</p> | ||
| <h3>Package Sources</h3> | ||
| <p>A package source is a URL to a remote registry where packages are stored. Selecting a source will change what packages you see listed in the Package Manager, depending not only on the URL of the registry but also on the scopes of that source, which acts as a filter, so only those packages matching the scopes are shown.</p> | ||
| <p>You can click on <img class="icon" height="18" src="../assets/Images/Icons/Icon_AddArgument.png" width="18" /> next to the source drop-down to edit the list, which will show the following menu:</p> | ||
| <p><img class="center" src="../assets/Images/IDE Tools/PackageManager_Sources.png" /></p> | ||
| <p>This shows all the currently available package sources and you can click on a source to edit its details or remove it. You can click on the <img class="icon" height="18" src="../assets/Images/Icons/Icon_AddArgument.png" width="18" /> button to add a new source.</p> | ||
| <p>For each source you can define its name in the list, its URL, its scopes, a password and the install subdirectory (under the <a href="../Setting_Up_And_Version_Information/IDE_Preferences/Package_Manager_Preferences.htm">Package Manager path</a>).</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> |
55 changes: 55 additions & 0 deletions
55
Manual/contents/Setting_Up_And_Version_Information/IDE_Preferences/GMRT_Preferences.htm
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| <?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" /> | ||
| <title>GMRT Preferences</title> | ||
| <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="Gurpreet S. Matharoo" /> | ||
| <meta name="topic-comment" content="The GMRT Preferences" /> | ||
| <meta name="rh-index-keywords" content="Prefs - Splines" /> | ||
| <meta name="search-keywords" content="Spline Prefs,Spline Editor Prefs" /> | ||
| <meta name="condition-tags" content="Export:Beta" /> | ||
| </head> | ||
| <body> | ||
| <!--<div class="body-scroll" style="top: 150px;">--> | ||
| <h1><span data-field="title" data-format="default">GMRT Preferences</span></h1> | ||
| <p><img class="center" src="../../assets/Images/Setup_And_Version/Preferences/GMRT_Prefs.png" />This section contains preferences for <a data-xref="{title}" href="../../Settings/Runner_Details/GMRT_(GameMaker_Runtime).htm">GMRT (GameMaker Runtime)</a>:</p> | ||
| <ul class="colour"> | ||
| <li><strong>Path to GMRT</strong>: This should be where the GMRT <a href="Package_Manager_Preferences.htm">packages</a> are installed.</li> | ||
| <li><strong>Path to ...</strong>: The rest of the path options are optional and provided in case you want to use your own tools for GMRT compilation. GMRT packages should already include all of this and you will not need to change these options unless you specifically want to. | ||
| <ul> | ||
| <li><strong>Path to the GMRT Asset Compiler</strong>: Path to a custom asset compiler for compiling your game WADs.</li> | ||
| <li><strong>Path to Clang executable</strong>: Path to your own installed Clang binary. Also accepts executable name if executable directory is in PATH.</li> | ||
| <li><strong>Path to Windows SDK + VC Tools root</strong>: Path to your own Windows SDK/VC Tools root directory.</li> | ||
| <li><strong>Path to Windows SDK</strong>: Path to only the Windows SDK, previous combined option overrides this if set.</li> | ||
| <li><strong>Path to VC Tools</strong>: Path to only the VC Tools root, previous combined option overrides this if set.</li> | ||
| <li><strong>Path to CMake executable</strong>: Path to custom CMake installation. Also accepts executable name if executable directory is in PATH.</li> | ||
| <li><strong>CMake generator</strong>: Specifies which CMake generator should be used when building a project. By default this is set to Ninja, but can be changed to "Visual Studio 17" to build a VS 2022 project.</li> | ||
| <li><strong>Path to CMake generator</strong>: Path to a custom CMake generator if a non-default CMake Generator is needed.</li> | ||
| </ul> | ||
| </li> | ||
| <li><strong>Compile with verbose output</strong>: This enables detailed logging for the compiler output which can help debug issues when submitting reports. This may slow down compilation.</li> | ||
| <li><strong>Build Type</strong>: The build of GMRT to use.</li> | ||
| </ul> | ||
| <p> </p> | ||
| <p> </p> | ||
| <div class="footer"> | ||
| <div class="buttons"> | ||
| <div class="clear"> | ||
| <div style="float:left">Back: <a href="../IDE_Preferences.htm">IDE Preferences</a></div> | ||
| <div style="float:right">Next: <a data-xref="{title}" href="Package_Manager_Preferences.htm">Package Manager Preferences</a></div> | ||
| </div> | ||
| </div> | ||
| <h5><span data-keyref="Copyright Notice">© Copyright YoYo Games Ltd. 2024 All Rights Reserved</span></h5> | ||
| </div> | ||
| <!-- KEYWORDS | ||
| Preferences - GMRT | ||
| --> | ||
| <!-- TAGS | ||
| prefs_gmrt | ||
| --> | ||
| </body> | ||
| </html> |
49 changes: 49 additions & 0 deletions
49
...ntents/Setting_Up_And_Version_Information/IDE_Preferences/Package_Manager_Preferences.htm
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| <?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" /> | ||
| <title>Package Manager Preferences</title> | ||
| <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="Gurpreet S. Matharoo" /> | ||
| <meta name="topic-comment" content="The Package Manager Preferences" /> | ||
| <meta name="rh-index-keywords" content="Prefs - Splines" /> | ||
| <meta name="search-keywords" content="Spline Prefs,Spline Editor Prefs" /> | ||
| <meta name="condition-tags" content="Export:Beta" /> | ||
| </head> | ||
| <body> | ||
| <!--<div class="body-scroll" style="top: 150px;">--> | ||
| <h1><span data-field="title" data-format="default">Package Manager Preferences</span></h1> | ||
| <p><img class="center" src="../../assets/Images/Setup_And_Version/Preferences/PackageManager_Prefs.png" /></p> | ||
| <p>This contains preferences for the <a data-xref="{title}" href="../../IDE_Tools/Package_Manager.htm">Package Manager</a>:</p> | ||
| <ul class="colour"> | ||
| <li><strong>Packages Install Directory</strong>: The directory where packages are installed. The <a data-xref="{title}" href="GMRT_Preferences.htm">GMRT Preferences</a> should be set to look in this directory.</li> | ||
| <li><strong>Default Source URL</strong>: The default package source.</li> | ||
| <li><strong>NPM Path</strong>: Optional, if you want to use your own version of NPM.</li> | ||
| <li><strong>Node Path</strong>: Optional, if you want to use your own version of Node.js.</li> | ||
| <li><strong>Build Type</strong>: The build of the Package Manager to use.</li> | ||
| <li><strong>Target Triple</strong>: The build combination to get packages for, when using GMRT.</li> | ||
| <li><strong>Platform</strong>: The build platform to get packages for, when using GMRT.</li> | ||
| </ul> | ||
| <p> </p> | ||
| <p> </p> | ||
| <p> </p> | ||
| <div class="footer"> | ||
| <div class="buttons"> | ||
| <div class="clear"> | ||
| <div style="float:left">Back: <a href="../IDE_Preferences.htm">IDE Preferences</a></div> | ||
| <div style="float:right">Next: <a data-xref="{title}" href="General_Preferences.htm">General Preferences</a></div> | ||
| </div> | ||
| </div> | ||
| <h5><span data-keyref="Copyright Notice">© Copyright YoYo Games Ltd. 2024 All Rights Reserved</span></h5> | ||
| </div> | ||
| <!-- KEYWORDS | ||
| Preferences - Package Manager | ||
| --> | ||
| <!-- TAGS | ||
| prefs_package_manager | ||
| --> | ||
| </body> | ||
| </html> |
35 changes: 35 additions & 0 deletions
35
Manual/contents/Settings/Runner_Details/GMRT_(GameMaker_Runtime).htm
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| <?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>GMRT (GameMaker Runtime)</title> | ||
| <meta name="topic-status" content="Draft" /> | ||
| <link rel="stylesheet" type="text/css" href="../../assets/css/default.css" /> | ||
| <meta name="condition-tags" content="Export:Beta" /> | ||
| </head> | ||
| <body> | ||
| <h1>GMRT (GameMaker Runtime)</h1> | ||
| <p>The GameMaker Runtime or GMRT is a new runtime for <span data-keyref="GameMaker Name">GameMaker</span> that has been built from the ground up. In contrast, the current default runner is known as the GMS2 runner (both VM and YYC), as it originates from the GameMaker Studio 2 versions of <span data-keyref="GameMaker Name">GameMaker</span>.</p> | ||
| <p>GMRT aims for increased performance and compatibility with newer tools allowing the runtime to be expanded beyond the limits of the old GMS2 runtime. It is currently available only in beta versions of <span data-keyref="GameMaker Name">GameMaker</span> and is at an early stage of development.</p> | ||
| <p>Please refer to <a href="https://gamemaker.io/en/blog/gmrt-open-beta">this page</a> for information on the GMRT beta and setting it up. As this is currently experimental, we do not recommend moving your active projects to GMRT yet, however we encourage you to try it with experimental projects and <a href="../../Setting_Up_And_Version_Information/Error_Reporting.htm">report any issues</a> so we can improve GMRT.</p> | ||
| <p>Also see the following pages:</p> | ||
| <ul class="colour"> | ||
| <li><a data-xref="{title}" href="../../IDE_Tools/Package_Manager.htm">Package Manager</a></li> | ||
| <li><a data-xref="{title}" href="../../Setting_Up_And_Version_Information/IDE_Preferences/GMRT_Preferences.htm">GMRT Preferences</a></li> | ||
| <li><a data-xref="{title}" href="../../Setting_Up_And_Version_Information/IDE_Preferences/Package_Manager_Preferences.htm">Package Manager Preferences</a></li> | ||
| </ul> | ||
| <p> </p> | ||
| <p> </p> | ||
| <div class="footer"> | ||
| <div class="buttons"> | ||
| <div class="clear"> | ||
| <div style="float:left">Back: <a data-xref="{title}" href="Runner_Details.htm">Runner & Compiler</a></div> | ||
| <div style="float:right">Next: <a data-xref="{title}" href="Compiler_Optimisations.htm">Compiler Optimisations</a></div> | ||
| </div> | ||
| </div> | ||
| <h5><span data-keyref="Copyright Notice">© Copyright YoYo Games Ltd. 2024 All Rights Reserved</span></h5> | ||
| </div> | ||
| </body> | ||
| </html> |
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.
Binary file added
BIN
+62.8 KB
Manual/contents/assets/Images/Setup_And_Version/Preferences/GMRT_Prefs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+60.1 KB
...l/contents/assets/Images/Setup_And_Version/Preferences/PackageManager_Prefs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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