Skip to content

Commit 66c721e

Browse files
committed
restore godot editor tweaks section to gmc installation guide
1 parent a059de7 commit 66c721e

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

docs/gmc/installation.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,28 @@ Finally, in your game project folder create a new folder called *addons*.
3333

3434
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/*).
3535

36+
37+
## Setup Godot Editor
38+
39+
The Godot Editor includes some default configuration options that may cause headaches for users, so the following tweaks are recommended:
40+
41+
### Indentation Setup
42+
43+
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.
44+
45+
From the *Editor* menu select *Editor Settings > Text Editor > Behavior*.
46+
* In the *Indent* section change `Tabs` to `Spaces`.
47+
* In the *Files* section **disable** the `Convert Indent on Save` option.
48+
49+
![image](./images/editor-settings-indentation.png)
50+
51+
### Other Good Things
52+
53+
Also in the *Editor Settings > Text Editor > Behavior* menu:
54+
55+
* In the *Files* section, **enable** the `Trim Trailing Whitespace on Save` option, because it's just good practice.
56+
* 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`.
57+
3658
## Install the GMC Plugin
3759

3860
### Simplest Installation: Godot Asset Library (Coming Soon!)

0 commit comments

Comments
 (0)