Skip to content

Commit

Permalink
Merge pull request #222 from YoYoGames/develop.gurpreet.prefabs
Browse files Browse the repository at this point in the history 
Initial documentation for the Prefab Library - 2024.11 betas - also contains CE2
  • Loading branch information
@gurpreetsinghmatharoo
gurpreetsinghmatharoo authored Dec 6, 2024
2 parents db130af + 5e6d161 commit e1a644b
Show file tree
Hide file tree
Showing 26 changed files with 208 additions and 226 deletions.
176 changes: 16 additions & 160 deletions Manual/contents/Content.htm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,172 +33,28 @@
<p> </p>
<h1 id="h">Getting Started</h1>
<p>This section is the obligatory first stop for using <span data-keyref="GameMaker Name">GameMaker</span> and getting to grips with the contents of the IDE and how it works. You&#39;ll find that <span data-keyref="GameMaker Name">GameMaker</span> is intuitive and simple to use, and even if you&#39;ve never used any tools like this before you shouldn&#39;t have any problems getting started and making games after reading through the <strong>Introduction</strong> and completing the <strong>Quick Start Guide </strong>(below). Once you have got to grips with the basics you can then move on to the more in-depth look at the components of <span data-keyref="GameMaker Name">GameMaker</span> in the <strong>IDE </strong>sections below.</p>
<p><a class="dropspot" data-rhwidget="DropSpot" data-target="drop_down11" href="../Content.htm#">Introduction to <span data-keyref="GameMaker Name">GameMaker</span></a></p>
<div class="droptext" data-targetname="drop_down11">
<ul class="colour">
<li><a href="Introduction/Introduction_To_GameMaker_Studio_2.htm">Introduction</a></li>
<li><a href="Introduction/The_Start_Page.htm">The Start Page</a></li>
<li><a href="Introduction/The_Asset_Browser.htm">The Asset Browser</a></li>
<li><a data-xref="{title}" href="Introduction/Workspaces.htm">Workspaces</a></li>
<li><a href="Introduction/Compiling.htm">Compiling</a></li>
<li><a href="Introduction/Debugging.htm">Debugging</a></li>
<li><a href="Introduction/The_Output_Window.htm">The Output Window</a></li>
<li><a href="Introduction/Our_Knowledge_Base.htm">Our Knowledge Base</a></li>
<li><a href="Introduction/Our_Social_Links.htm">Our Social Links</a></li>
</ul>
<p> </p>
<ul class="colour">
</ul>
</div>
<p><a class="dropspot" data-rhwidget="DropSpot" data-target="drop_down12" href="../Content.htm#">Quick Start Guide</a></p>
<div class="droptext" data-targetname="drop_down12">
<ul class="colour">
<li><a href="Quick_Start_Guide/Quick_Start_Guide.htm">Making A Game Using <span data-keyref="GameMaker Name">GameMaker</span></a></li>
<li><a href="Quick_Start_Guide/What_Is_Programming_.htm">What Is Programming?</a></li>
<li><a href="Quick_Start_Guide/Creating_Sprites.htm">Sprites</a></li>
<li><a href="Quick_Start_Guide/Creating_Tile_Sets.htm">Tilesets</a></li>
<li><a href="Quick_Start_Guide/Creating_Sound_Effects.htm">Sound Effects</a></li>
<li><a href="Quick_Start_Guide/Objects_And_Instances.htm">Objects And Instances</a></li>
<li><a href="Quick_Start_Guide/Sequences.htm">Sequences</a></li>
<li><a href="Quick_Start_Guide/Rooms.htm">Rooms</a></li>
<li><a href="Quick_Start_Guide/Drawing.htm">Drawing</a></li>
<li><a href="Quick_Start_Guide/Movement_And_Controls.htm">Movement And Controls</a></li>
<li><a href="Quick_Start_Guide/Summary.htm">Summary</a></li>
</ul>
<p> </p>
<ul class="colour">
</ul>
</div>
<p><a class="dropspot" data-rhwidget="DropSpot" data-target="drop_down13" href="../Content.htm#">Setting Up And Version Information</a></p>
<div class="droptext" data-targetname="drop_down13">
<ul class="colour">
<li><a href="Setting_Up_And_Version_Information/GMS2_Version_Information.htm"><span data-keyref="GameMaker Name">GameMaker</span> Version Information</a></li>
<li><a href="Setting_Up_And_Version_Information/Installation_Guide.htm">Installation Guide</a></li>
<li><a data-xref="{title}" href="Setting_Up_And_Version_Information/Licencing_Information.htm">Licencing &amp; Logging In</a></li>
<li><a href="Setting_Up_And_Version_Information/Updating_Guide.htm">Updating Guide</a></li>
<li><a data-xref="{title}" href="Setting_Up_And_Version_Information/Release_Notes.htm">GameMaker Changelog</a></li>
<li><a href="Setting_Up_And_Version_Information/Required_SDKs.htm">Required SDKs</a></li>
</ul>
</div>
<ul class="colour">
<li><a data-xref="{title}" href="Introduction/Introduction_To_GameMaker_Studio_2.htm">Introduction To GameMaker</a></li>
<li><a data-xref="{text}" href="Quick_Start_Guide/Quick_Start_Guide.htm#h">Quick Start Guide</a></li>
<li><a data-xref="{title}" href="Setting_Up_And_Version_Information/GMS2_Version_Information.htm">Licencing &amp; Version Information</a></li>
</ul>
<p> </p>
<p> </p>
<h1>IDE Reference</h1>
<p>In this section we cover each part of the <span data-keyref="GameMaker Name">GameMaker</span> <a class="glossterm" data-glossterm="IDE" href="#">IDE</a>, explaining in detail what each and every window, button and menu does and how it should be used.</p>
<p><a class="dropspot" data-rhwidget="DropSpot" data-target="drop-down" href="#">IDE Preferences &amp; Features</a></p>
<div class="droptext" data-targetname="drop-down">
<ul class="colour">
<li><a data-xref="{title}" href="Setting_Up_And_Version_Information/IDE_Preferences.htm">IDE Preferences</a></li>
<li><a data-xref="{title}" href="Setting_Up_And_Version_Information/Platform_Preferences.htm">Platform Preferences</a></li>
<li><a data-xref="{title}" href="Setting_Up_And_Version_Information/The_Device_Manager.htm">The Device Manager</a></li>
<li><a data-xref="{title}" href="Setting_Up_And_Version_Information/Error_Reporting.htm">Reporting Errors</a></li>
</ul>
<p> </p>
</div>
<p><a class="dropspot" data-rhwidget="DropSpot" data-target="drop_down4" href="../Content.htm#">IDE Navigation</a></p>
<div class="droptext" data-targetname="drop_down4">
<ul class="colour">
<li><a href="IDE_Navigation/IDE_Input.htm">IDE Input And Navigation</a> </li>
<li><a href="IDE_Navigation/Bookmarks.htm">Bookmarks</a></li>
<li><a href="IDE_Navigation/Recent_Windows.htm">Recent Windows</a></li>
<li><a data-xref="{title}" href="IDE_Tools/The_Inspector.htm">The Inspector</a></li>
<li><a href="IDE_Navigation/Menus.htm">Menus</a></li>
<li><a href="IDE_Navigation/Keyboard_Shortcuts.htm">Keyboard Shortcuts</a></li>
</ul>
<p> </p>
<ul class="colour">
</ul>
</div>
<p><a class="dropspot" data-rhwidget="DropSpot" data-target="drop_down5" href="../Content.htm#">Asset Editors</a></p>
<div class="droptext" data-targetname="drop_down5">
<ul class="colour">
<li><a href="The_Asset_Editors/Sprites.htm">Sprites</a></li>
<li><a href="The_Asset_Editors/Image_Editor.htm">Images</a></li>
<li><a href="The_Asset_Editors/Tile_Sets.htm">Tile Sets</a></li>
<li><a href="The_Asset_Editors/Animation_Curves.htm">Animation Curves</a></li>
<li><a href="The_Asset_Editors/Sounds.htm">Sounds</a></li>
<li><a href="The_Asset_Editors/Paths.htm">Paths</a></li>
<li><a href="The_Asset_Editors/Scripts.htm">Scripts</a></li>
<li><a href="The_Asset_Editors/Shaders.htm">Shaders</a></li>
<li><a href="The_Asset_Editors/Fonts.htm">Fonts</a></li>
<li><a href="The_Asset_Editors/Timelines.htm">Timelines</a></li>
<li><a href="The_Asset_Editors/Objects.htm">Objects</a></li>
<li><a href="The_Asset_Editors/Sequences.htm">Sequences</a></li>
<li><a href="The_Asset_Editors/Rooms.htm">Rooms</a></li>
<li><a href="The_Asset_Editors/Extensions.htm">Extensions</a></li>
<li><a href="The_Asset_Editors/Notes.htm">Notes</a></li>
<li><a href="The_Asset_Editors/Particle_Systems.htm">The Particle System Editor</a></li>
</ul>
<p> </p>
<ul class="colour">
</ul>
</div>
<p><a class="dropspot" data-rhwidget="DropSpot" data-target="drop_down6" href="../Content.htm#">GameMaker Runner</a></p>
<div class="droptext" data-targetname="drop_down6">
<ul class="colour">
<li><a href="Settings/Game_Options.htm">Game Options</a></li>
<li><a href="Settings/The_Room_Manager.htm">The Room Manager</a></li>
<li><a href="Settings/Included_Files.htm">Included Files</a></li>
<li><a data-xref="{title}" href="Additional_Information/The_File_System.htm">The File System</a></li>
<li><a href="Settings/Audio_Groups.htm">Audio Groups</a></li>
<li><a href="Settings/Texture_Groups.htm">Texture Groups</a></li>
<li><a href="Settings/Configurations.htm">Configurations</a></li>
<li><a data-xref="{title}" href="Additional_Information/Error_Reporting.htm">Error Reporting</a></li>
<li><a data-xref="{title}" href="Settings/Runner_Details/Runner_Details.htm">Runner &amp; Compiler</a></li>
</ul>
<p> </p>
<ul class="colour">
</ul>
</div>
<p><a class="dropspot" data-rhwidget="DropSpot" data-target="drop_down7" href="../Content.htm#">Additional IDE Tools</a></p>
<div class="droptext" data-targetname="drop_down7">
<ul class="colour">
<li><a href="IDE_Tools/The_Debugger.htm">The Debugger</a></li>
<li><a href="IDE_Tools/The_Micro_Web_Server.htm">The Micro Web Server</a></li>
<li><a href="IDE_Tools/Local_Asset_Packages.htm">Local Asset Packages</a></li>
<li><a href="IDE_Tools/Project_Image_Generator.htm">Project Image Generator</a></li>
<li><a href="IDE_Tools/Sound_Mixer.htm">Sound Mixer</a></li>
<li><a href="IDE_Tools/Source_Control.htm">Source Control</a></li>
<li><a data-xref="{title}" href="IDE_Tools/Project_Tool.htm">Project Tool</a></li>
</ul>
</div>
<p>The following sections cover the tools available to you in the IDE for setting preferences, editing your project and assets, and configuring the <span data-keyref="GameMaker Name">GameMaker</span> runner:</p>
<ul class="colour">
<li><a data-xref="{title}" href="The_IDE/The_IDE.htm">GameMaker IDE</a></li>
<li><a data-xref="{title}" href="Settings/Game_Settings.htm">GameMaker Runner</a></li>
<li><a data-xref="{title}" href="The_Asset_Editors/The_Asset_Editors.htm">The Asset Editors</a></li>
</ul>
<p> </p>
<p> </p>
<h1>Scripting Reference</h1>
<p><a class="dropspot" data-rhwidget="DropSpot" data-target="drop-down1" href="#">GameMaker Language</a></p>
<div class="droptext" data-targetname="drop-down1">
<p class="dropspot">This section covers an overview to GameMaker Language, and its two programming methods: Visual and Code.</p>
<ul class="colour">
<li class="dropspot"><a data-xref="{title}" href="GameMaker_Language.htm">GameMaker Language</a>
<ul>
<li class="dropspot"><a data-xref="{title}" href="Drag_And_Drop/Drag_And_Drop_Index.htm">GML Visual</a></li>
<li class="dropspot"><a data-xref="{title}" href="GameMaker_Language/GameMaker_Language_Index.htm">GML Code</a></li>
</ul>
</li>
</ul>
</div>
<p><a class="dropspot" data-rhwidget="DropSpot" data-target="drop_down10" href="../Content.htm#">Additional Information</a></p>
<div class="droptext" data-targetname="drop_down10">
<p class="dropspot">We also have a few extra pages with information on certain aspects of programming and using the GameMaker Language:</p>
<ul class="colour">
<li><a href="Additional_Information/Best_Practices_When_Programming.htm">Best Practices When Programming</a></li>
<li><a href="Additional_Information/Bitwise_Operators.htm">Bitwise Operators</a></li>
<li><a href="Additional_Information/Type_Tables.htm">Type Tables</a></li>
<li><a data-xref="{title}" href="Additional_Information/Whitespace_Characters.htm">White-space Characters</a></li>
<li><a href="Additional_Information/Vectors.htm">Vectors</a></li>
<li><a href="Additional_Information/Guide_To_Using_Buffers.htm">Guide To Using Buffers</a></li>
<li><a href="Additional_Information/Guide_To_Using_Particles.htm">Guide To Using Particles</a></li>
<li><a href="Additional_Information/Guide_To_Using_Shaders.htm">Guide To Using Shaders</a></li>
<li><a href="Additional_Information/Guide_To_Primitives_And_Vertex_Building.htm">Guide To Primitives And Vertex Building</a></li>
<li><a data-xref="{title}" href="Additional_Information/Guide_To_Using_Blendmodes.htm">Guide To Using Blendmodes</a></li>
<li><a data-xref="{title}" href="Additional_Information/Guide_To_Using_JSON.htm">Guide To Using JSON</a></li>
<li><a data-xref="{title}" href="Additional_Information/Project_Format.htm">Project Format</a></li>
<li><a href="Additional_Information/Compatibility_Functions.htm">Compatibility Functions</a></li>
<li><a href="Additional_Information/Compatibility_Scripts.htm">Compatibility Scripts</a></li>
<li><a href="Additional_Information/Obsolete_Functions.htm">Obsolete Functions</a></li>
<li><a data-xref="{title}" href="Introduction/The_Marketplace.htm">The Marketplace</a></li>
</ul>
</div>
<p> </p>
<p>The following sections cover information about the <span data-keyref="GameMaker Name">GameMaker</span> visual and scripting languages, and additional guides on using runtime features:</p>
<ul class="colour">
<li><a data-xref="{title}" href="GameMaker_Language.htm">GameMaker Language</a></li>
<li><a data-xref="{title}" href="Additional_Information/Additional_Information.htm">Additional Information</a></li>
</ul>
<p> </p>
<p> </p>
<!--</div>-->
Expand Down
2 changes: 1 addition & 1 deletion Manual/contents/IDE_Navigation/IDE_Input.htm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ <h2 id="related_topics">Related Topics</h2>
<div class="buttons">
<div class="clear">
<div style="float:left">Back: <a data-xref="{title}" href="../The_IDE/The_IDE.htm">GameMaker IDE</a></div>
<div style="float:right">Next: <a data-xref="{title}" href="../IDE_Tools/Additional_IDE_Tools.htm">Additional IDE Tools</a></div>
<div style="float:right">Next: <a data-xref="{title}" href="../The_IDE/General_Asset_Editors.htm">General Asset Editors</a></div>
</div>
</div>
<h5><span data-keyref="Copyright Notice">© Copyright YoYo Games Ltd. 2024 All Rights Reserved</span></h5>
Expand Down
5 changes: 3 additions & 2 deletions Manual/contents/IDE_Navigation/Menus/The_Windows_Menu.htm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@ <h1>The Windows Menu</h1>
<p>This menu is for opening the general docked IDE windows. Since docks can be rearranged and the contents can be removed as stand-alone windows or even closed entirely, this window permits you to re-open them if you find that you need them for anything. The windows that can be opened from here are <a data-xref="{title}" href="../../Introduction/The_Asset_Browser.htm">The Asset Browser</a> window and all the different <a href="../../Introduction/The_Output_Window.htm">Output</a> windows (Output, Search, Source Control, Breakpoints and Compile/Syntax Errors). Note that Feather Messages is shown instead of Syntax Errors if you&#39;ve <a href="../../Setting_Up_And_Version_Information/IDE_Preferences/Feather_Settings.htm#enable_feather">enabled Feather</a>.</p>
<p>Next you can open <a data-xref="{title}" href="../../IDE_Tools/The_Inspector.htm">The Inspector</a> window. This window is used to inspect the properties of the currently selected IDE element, and these properties can then be edited as required.</p>
<p>After the Inspector option you have the <a data-xref="{title}" href="../Recent_Windows.htm">Recent Windows</a> list, and there is also the option to open the <strong>Environment Variables</strong> window where you can see the different paths that the various environment variables used in the <a href="../../Setting_Up_And_Version_Information/IDE_Preferences.htm">Preferences</a> point to. These variables cannot be edited (neither their name nor their path/setting) but you can select and copy/paste any of them for use elsewhere.</p>
<p><img alt="Environment Variables" class="center" src="../../assets/Images/IDE_Input/Environment_Variables.png" />Finally you have an option to open the <strong>Project Tool Output</strong> window. This windows shows the output of the <a data-xref="{title}" href="../../IDE_Tools/Project_Tool.htm">ProjectTool</a>.</p>
<p><img alt="Environment Variables" class="center" src="../../assets/Images/IDE_Input/Environment_Variables.png" /><span data-condition="Export:Beta">In beta versions you can open the <a data-xref="{title}" href="../../IDE_Tools/Prefab_Library.htm">Prefab Library</a> from here.</span></p>
<p>Finally you have an option to open the <strong>Project Tool Output</strong> window. This windows shows the output of the <a data-xref="{title}" href="../../IDE_Tools/Project_Tool.htm">Project Tool</a>.</p>
<p> </p>
<p> </p>
<p> </p>
Expand All @@ -30,7 +31,7 @@ <h1>The Windows Menu</h1>
<div style="float:right">Next: <a href="The_Tools_Menu.htm">The Tools 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 Windows Menu
Expand Down
25 changes: 12 additions & 13 deletions Manual/contents/IDE_Tools/Additional_IDE_Tools.htm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,45 +3,44 @@
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Additional IDE Tools</title>
<title>Project &amp; Assets</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="Mark Alexander" />
<meta name="topic-comment" content="Section that covers the rest of the IDE tools that other sections don&#39;t cover" />
<meta name="rh-index-keywords" content="Additional IDE Tools" />
<meta name="search-keywords" content="IDE Tools,Additional Tools" />
<meta name="topic-comment" content="Section that covers IDE tools related to projects and assets" />
<meta name="rh-index-keywords" content="Project and Assets IDE Tools" />
<meta name="search-keywords" content="Project and Assets IDE Tools" />
</head>
<body>
<!--<div class="body-scroll" style="top: 150px;">-->
<h1><span data-field="title" data-format="default">Additional IDE Tools</span></h1>
<p>This section of the manual outlines additional IDE tools that are available to help you make your games and which aren&#39;t covered in other parts of the manual, as well as those tools that are helpful accessories to the other sections of the IDE. </p>
<h1><span data-field="title" data-format="default">Project &amp; Assets</span></h1>
<p>This section covers the IDE tools that help manage your projects and the assets within them.</p>
<ul class="colour">
<li><a data-xref="{title}" href="The_Debugger.htm">The Debugger</a></li>
<li><a data-xref="{title}" href="The_Micro_Web_Server.htm">The Micro Web Server</a></li>
<li><a data-xref="{title}" href="Project_Tool.htm">Project Tool</a></li>
<li><a data-xref="{title}" href="Package_Manager.htm">Package Manager</a></li>
<li><a data-xref="{title}" href="Local_Asset_Packages.htm">Local Asset Packages</a></li>
<li><a data-xref="{title}" href="Project_Image_Generator.htm">Project Image Generator</a></li>
<li><a data-xref="{title}" href="Sound_Mixer.htm">Sound Mixer</a></li>
<li><a data-xref="{title}" href="Source_Control.htm">Source Control</a></li>
<li><a data-xref="{title}" href="Project_Tool.htm">Project Tool</a></li>
<li><a data-xref="{title}" href="Package_Manager.htm">Package Manager</a></li>
</ul>
<p><span data-condition="Export:Beta">Beta versions also include the <a data-xref="{title}" href="Prefab_Library.htm">Prefab Library</a>.</span></p>
<p> </p>
<p> </p>
<div class="footer">
<div class="buttons">
<div class="clear">
<div style="float:left">Back: <a href="../The_IDE/The_IDE.htm">The IDE</a></div>
<div style="float:right">Next: <a data-xref="{title}" href="../The_IDE/General_Asset_Editors.htm">General Asset Editors</a></div>
<div style="float:right">Next: <a data-xref="{title}" href="../Setting_Up_And_Version_Information/IDE_Preferences.htm">IDE Preferences</a></div>
</div>
</div>
<h5><span data-keyref="Copyright Notice">© Copyright YoYo Games Ltd. 2024 All Rights Reserved</span></h5>
</div>
<!-- KEYWORDS
Additional IDE Tools
Project and Assets IDE Tools
-->
<!-- TAGS
ide_tools
project_ide_tools
-->
</body>
</html>
Loading

0 comments on commit e1a644b

Please sign in to comment.