Skip to content

Commit

Permalink
Merge pull request #550 from bosh/patch12
Browse files Browse the repository at this point in the history
restore godot editor tweaks section to gmc installation guide
  • Loading branch information
avanwinkle authored Jan 1, 2025
2 parents a059de7 + 4c5443f commit d13254f
Showing 1 changed file with 25 additions and 3 deletions.
28 changes: 25 additions & 3 deletions docs/gmc/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,13 +33,35 @@ 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 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 *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)

### 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!)
### 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

Expand Down

0 comments on commit d13254f

Please sign in to comment.