From 7d1cc623731e2b9822f390f84404ec8a5ec214bb Mon Sep 17 00:00:00 2001 From: YYBartT Date: Thu, 1 Feb 2024 13:21:22 +0100 Subject: [PATCH 1/8] [General]Version Format - Expose ProjectTool to end users YoYoGames/YoYoStudio#9313 * "Feather Settings" page: * Added HTML element ID to "Enable Feather" item so it can be linked to * Updated some links to crossrefs, etc. * Reordered settings according to order in screenshot * "The Windows Menu" page: * Updated screenshot, removed "Tutorial Windows" item, added "Project Tool Output", some links changed to crossrefs * Tiny changes on other tool pages --- .../IDE_Navigation/Menus/The_Windows_Menu.htm | 8 +++---- .../IDE_Tools/Project_Image_Generator.htm | 21 ++++++------------ Manual/contents/IDE_Tools/Source_Control.htm | 10 ++++----- .../IDE_Tools/The_Micro_Web_Server.htm | 6 ++--- .../IDE_Preferences/Feather_Settings.htm | 14 ++++++------ .../assets/Images/IDE_Input/Window_Menu.png | Bin 15918 -> 13058 bytes 6 files changed, 26 insertions(+), 33 deletions(-) diff --git a/Manual/contents/IDE_Navigation/Menus/The_Windows_Menu.htm b/Manual/contents/IDE_Navigation/Menus/The_Windows_Menu.htm index 9294c9aec..ba82ca4cb 100644 --- a/Manual/contents/IDE_Navigation/Menus/The_Windows_Menu.htm +++ b/Manual/contents/IDE_Navigation/Menus/The_Windows_Menu.htm @@ -16,10 +16,10 @@

The Windows Menu

The Windows Menu

-

This menu is for opening the general docked IDE windows. Since docks can be re-arranged 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 The Asset Browser window and all the different Output windows (Output, Search, Source Control, Breakpoints and Compile/Syntax Errors).

-

Next you can open the Inspector window. This window is used to inspect the properties of the currently selected IDE element, and these properties can then be edited as required.

-

After the Inspector option you have the Recent Windows list, and there is also the option to open the Environment Variables window where you can see the different paths that the various environment variables used in the Preferences 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.

-

Environment VariablesFinally you have the option to open Tutorial Windows. This will re-open any windows that are related to a tutorial project you have opened, but only if the project is one that was created as part of a tutorial (if not, this option will be unavailable). For information on creating your own tutorial projects, please see the section on the Marketplace (as all tutorials are created, hosted and downloaded from there).

+

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 The Asset Browser window and all the different Output windows (Output, Search, Source Control, Breakpoints and Compile/Syntax Errors). Note that Feather Messages is shown instead of Syntax Errors if you've enabled Feather.

+

Next you can open The Inspector window. This window is used to inspect the properties of the currently selected IDE element, and these properties can then be edited as required.

+

After the Inspector option you have the Recent Windows list, and there is also the option to open the Environment Variables window where you can see the different paths that the various environment variables used in the Preferences 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.

+

Environment VariablesFinally you have an option to open the Project Tool Output window. This windows shows the output of the ProjectTool.

 

 

 

diff --git a/Manual/contents/IDE_Tools/Project_Image_Generator.htm b/Manual/contents/IDE_Tools/Project_Image_Generator.htm index 2b890028d..0bf95b223 100644 --- a/Manual/contents/IDE_Tools/Project_Image_Generator.htm +++ b/Manual/contents/IDE_Tools/Project_Image_Generator.htm @@ -4,7 +4,7 @@ Project Image Generator - + @@ -14,10 +14,8 @@ -

Project Image Generator

-

Generate Project ImagesThe Project Image Generator is accessed from the Tools Menu at - the top of the GameMaker IDE. This tool is designed to quickly create all the different splash screens, promo images and icons that are required by all the different target platforms from a single set of images. You supply the base image - and the base icon and then click the Generate button, and your Game Options for each platform will update with the new images.

+

Project Image Generator

+

Generate Project ImagesThe Project Image Generator is accessed from the Tools Menu at the top of the GameMaker IDE. This tool is designed to quickly create all the different splash screens, promo images and icons that are required by all the different target platforms from a single set of images. You supply the base image and the base icon and then click the Generate button, and your Game Options for each platform will update with the new images.

For this to work correctly you need to supply a high resolution splash screen and a high resolution icon image. The recommended sizes would be:

 

 

diff --git a/Manual/contents/IDE_Tools/Project_Tool.htm b/Manual/contents/IDE_Tools/Project_Tool.htm index 601998ce1..30b963a8c 100644 --- a/Manual/contents/IDE_Tools/Project_Tool.htm +++ b/Manual/contents/IDE_Tools/Project_Tool.htm @@ -14,19 +14,19 @@

ProjectTool

ProjectTool is a built-in tool to convert projects between different versions of GameMaker.

-

It is used by GameMaker internally to convert projects from older project formats to the current format and the other way round.

+

It is used by the IDE internally to convert projects from older project formats to the current format and the other way round.

It is accessible from the IDE through The Tools Menu > Project Tool option.

 See the Project Format page for details on the current project format.

Project Tool

-

The tool window contains the following fields: 

+

The tool window contains the following fields:

  • Source - This field contains the path to the source project or package file to convert. Paste a valid file path here or click the  button to bring up a file selector.
    • -
  • Destination - This field contains the path to the destination project to create. Paste a valid path here or click the  button to bring up a file selector. This- field can be empty when the source project is a .yyp file, in which case ProjectTool 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. ProjectTool shows the following message if you attempt to convert a package with an empty destination path: No Destination Project Selected
    • +
  • Destination - This field contains the path to the destination project to create. Paste a valid path here or click the  button to bring up a file selector. This field can be empty when the source project is a .yyp file, in which case ProjectTool 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. ProjectTool shows the following message if you attempt to convert a package with an empty destination path: No Destination Project Selected
  • Project Format - This drop-down list contains the available project formats that you can convert to. The following formats are available: 
      -
    • LTS22 - This is the project format used by the LTS release.
      • -
    • NOV23 - This is the project format used by the Nov23 release.
      • -
    • DEFAULT - This is the default, versioned project format.
      • +
    • LTS22 - This is the project format used by the 2022.0 LTS release.
      • +
    • NOV23 - This is the project format used by the 2023.11 release.
      • +
    • DEFAULT - This is the current default, versioned project format.
  • Force VERS0 Conversion if required - When this checkbox is enabled, ProjectTool 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.
    @@ -36,7 +36,7 @@

    ProjectTool

  • Clean Conversion Folders - When this checkbox is ticked, ProjectTool cleans up the conversion folders after conversion. This is enabled by default.

ProjectTool Output

-

All ProjectTool output is shown in the Project Tool Window, that you can open manually through the Project Tool Output option of The Windows Menu. It can also automatically be shown when ProjectTool runs by enabling Show Project Tool Output in the General Preferences.

+

All ProjectTool output is shown in the Project Tool Window that you can open manually through the Project Tool Output option of The Windows Menu. It can also automatically be shown when ProjectTool runs by enabling Show Project Tool Output in the General Preferences.

Project Tool Output

 

 

diff --git a/Manual/publish/browsesequence/MainSequence.brs b/Manual/publish/browsesequence/MainSequence.brs index f10169e33..6a078d806 100644 --- a/Manual/publish/browsesequence/MainSequence.brs +++ b/Manual/publish/browsesequence/MainSequence.brs @@ -1,2723 +1 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file + \ No newline at end of file From c975565a8de1574ea908ac8ab8d80d0112aca689 Mon Sep 17 00:00:00 2001 From: gurpreetsinghmatharoo Date: Tue, 27 Feb 2024 18:49:33 +0530 Subject: [PATCH 7/8] [General] Fixed HTML bug on Error Reporting page --- .../Setting_Up_And_Version_Information/Error_Reporting.htm | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Manual/contents/Setting_Up_And_Version_Information/Error_Reporting.htm b/Manual/contents/Setting_Up_And_Version_Information/Error_Reporting.htm index 563f5fdd0..f05cdc3bd 100644 --- a/Manual/contents/Setting_Up_And_Version_Information/Error_Reporting.htm +++ b/Manual/contents/Setting_Up_And_Version_Information/Error_Reporting.htm @@ -16,8 +16,8 @@

IDE Error Reporting

While great care has been taken when creating GameMaker to ensure that it is a stable and reliable tool, there is always the possibility that an issue could occur given the nature of the software and the multiple operating systems it runs on.

-

In most cases any errors will be caught by GameMaker and you may see an error that GameMaker has gone "unstable", which also prompts you to save your projects and then close and restart the program.

-

If this happens, then we would request that you file a bug report using theReport A Bugoption from The Help Menu. Please always give as much information as possible and ensure you fill in every field as best you can.

+

In most cases any errors will be caught by GameMaker and you may see an error that GameMaker has gone "unstable", which also prompts you to save your projects and then close and restart the program.

+

If this happens, then we would request that you file a bug report using the Report A Bug option from The Help Menu. Please always give as much information as possible and ensure you fill in every field as best you can.

Please also strongly consider allowing the bug-reporter to send us a copy of your project, as this may be essential to reproducing your problem and so we may be unable to help if you do not provide the project. Your files are always attached privately if you send them from the IDE bug reporter.

Similarly, in extreme cases where GameMaker crashes entirely, you may see on your next startup that the IDE bug reporter tells you that an earlier crash was detected and it will ask you to send us a bug report. Please do this.

Crash Report WindowIf you'd like to know exactly what data is being sent, then please see this article on the GameMaker Helpdesk.

From 85b678d7a70f35d5c876a212169afa15fff20349 Mon Sep 17 00:00:00 2001 From: gurpreetsinghmatharoo Date: Tue, 27 Feb 2024 18:49:53 +0530 Subject: [PATCH 8/8] [General] Updated Release Notes page after the FR repo was moved to the Bugs repo --- .../Setting_Up_And_Version_Information/Release_Notes.htm | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Manual/contents/Setting_Up_And_Version_Information/Release_Notes.htm b/Manual/contents/Setting_Up_And_Version_Information/Release_Notes.htm index 7534dbc64..45fa12181 100644 --- a/Manual/contents/Setting_Up_And_Version_Information/Release_Notes.htm +++ b/Manual/contents/Setting_Up_And_Version_Information/Release_Notes.htm @@ -15,8 +15,8 @@

GameMaker Changelog

-

All changes for GameMaker versions are listed on GitHub, separated by bugs and feature requests.

-

Each page linked above lists all major releases for GameMaker. There are two categories of releases: Open (in-progress or future release) and Closed (released to public).

+

All changes for GameMaker versions are listed on GitHub. The linked page lists all major releases for GameMaker.

+

There are two categories of releases: Open (in-progress or future release) and Closed (released to public).

Click on "X Closed" to see the released versions:

Click on a release to see all issues within it, which can either be Open (meaning they are in-progress for that release) or Closed (meaning they are done).

If a version is in its beta period, the Closed issues have likely made their way into the latest beta release, or will go in the next beta update.