From 66c721e8ad8280053fe0ed2cc44e173e51b975f1 Mon Sep 17 00:00:00 2001 From: Alex Lobascio Date: Mon, 9 Dec 2024 22:47:24 -0800 Subject: [PATCH 1/2] restore godot editor tweaks section to gmc installation guide --- docs/gmc/installation.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/docs/gmc/installation.md b/docs/gmc/installation.md index e2971af5c6..339158caef 100644 --- a/docs/gmc/installation.md +++ b/docs/gmc/installation.md @@ -33,6 +33,28 @@ Finally, in your game project folder create a new folder called *addons*. However, note that Godot only has access to files in its project folder and subfolders. If you choose to make a "gmc" subfolder for your Godot project, all slides, widgets, sound files, and video files will need to be in those respective subfolders in the gmc folder (e.g. */gmc/slides/*), NOT in the MPF mode subfolders (e.g. */modes/attract/slides/*). + +## Setup Godot Editor + +The Godot Editor includes some default configuration options that may cause headaches for users, so the following tweaks are recommended: + +### Indentation Setup + +The GMC code is written with space-based indentation, but Godot not only defaults to tabs but defaults to auto-convert files. You are free to use tabs if that's your preference, but at least disabling the auto-convert will spare you grief. + +From the *Editor* menu select *Editor Settings > Text Editor > Behavior*. + * In the *Indent* section change `Tabs` to `Spaces`. + * In the *Files* section **disable** the `Convert Indent on Save` option. + +![image](./images/editor-settings-indentation.png) + +### Other Good Things + +Also in the *Editor Settings > Text Editor > Behavior* menu: + + * In the *Files* section, **enable** the `Trim Trailing Whitespace on Save` option, because it's just good practice. + * If you use an external text editor like VS Code or Atom, in the *Files* section **enable** the option `Auto Reload Scripts on External Change`. + ## Install the GMC Plugin ### Simplest Installation: Godot Asset Library (Coming Soon!) From 4c5443fba572f2d596fd2cb349ab1753609b6b79 Mon Sep 17 00:00:00 2001 From: Anthony van Winkle Date: Wed, 1 Jan 2025 15:10:44 -0800 Subject: [PATCH 2/2] GMC: Default indent is tabs, asset lib is available --- docs/gmc/installation.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/gmc/installation.md b/docs/gmc/installation.md index 339158caef..c4545f5a1b 100644 --- a/docs/gmc/installation.md +++ b/docs/gmc/installation.md @@ -40,11 +40,11 @@ The Godot Editor includes some default configuration options that may cause head ### Indentation Setup -The GMC code is written with space-based indentation, but Godot not only defaults to tabs but defaults to auto-convert files. You are free to use tabs if that's your preference, but at least disabling the auto-convert will spare you grief. +The GMC code is written with tab-based indentation (per the offical Godot standards guide), and Godot not only defaults to tab-indendation but also defaults to auto-convert files. You are free to use spaces if that's your preference, but disabling the auto-convert will spare you grief. From the *Editor* menu select *Editor Settings > Text Editor > Behavior*. - * In the *Indent* section change `Tabs` to `Spaces`. * In the *Files* section **disable** the `Convert Indent on Save` option. + * If you wish to use spaces in your project and edit in the Godot editor, in the *Indent* section change `Tabs` to `Spaces`. ![image](./images/editor-settings-indentation.png) @@ -57,11 +57,11 @@ Also in the *Editor Settings > Text Editor > Behavior* menu: ## Install the GMC Plugin -### Simplest Installation: Godot Asset Library (Coming Soon!) +### Simplest Installation: Godot Asset Library -The Godot editor features a built-in library of plugins that you can download and install with a single click. Unfortunately this library is managed manually by volunteers, and updating plugins can take weeks. Because GMC is changing and improving rapidly every day, it is not yet available on the Godot Asset Library. +The Godot editor features a built-in library of plugins that you can download and install with a single click. -Until then, you will need to manually place the GMC plugin into your project addons folder using the Standard or Expert Installation steps. +In the Godot editor, select **AssetLib** from the top center selector. You may need to enable online access to the asset library when prompted. Search for "GMC" and click on the GMC asset to download and install. ### Standard Installation: Download & Copy