Agassiz Games

FixMyGrammar documentation

FixMyGrammar checks spelling and grammar in every FText property in the Unreal Editor details panel.

  1. Install and enable
  2. Where it checks
  3. The issue button
  4. Issue feedback
  5. Fix an issue
  6. The project word list
  7. Ignore a grammar issue
  8. What it does not check
  9. Localization
  10. Turn it off
  11. Licences
  12. Support

Install and enable

  1. In the Epic Games Launcher, open Fab Library, find FixMyGrammar and click Install to Engine. Pick your engine version.
  2. Open your project. Select Edit > Plugins, search for FixMyGrammar and tick Enabled.
  3. Restart the editor when it asks.

FixMyGrammar supports Unreal Engine 5.4 to 5.8 on Windows, macOS and Linux. It is an editor-only plugin, so it adds nothing to a packaged game.

The FixMyGrammar entry in the Plugins window, ticked

Where it checks

FixMyGrammar replaces the editor's own FText field in every details panel. It checks any FText property that a details panel shows: actors, components, data assets, data tables, widget Blueprints and class defaults.

It checks American English. It runs in the editor process, with no network calls and no account.

FixMyGrammar's FText field will appear identical to the default field if no issue is detected.

A clean Text field with no issue button

The issue button

When a field has issues, a button beside it shows the count for each category. A clean field has no button.

Button showsMeaning
S:2Two spelling issues.
G:1One grammar issue.
S:2 G:1Both kinds of issue.

Click the button to open the fix menu.

A Text field with two spelling issues and the S:2 button

Issue feedback

When a field has issues, a read-only copy of the text appears under it, with each issue underlined: red for spelling, orange for grammar. Click an underlined span to open the menu for that issue only.

The copy is hidden when the text has no issues. Edit the text in the field above it, not in the copy.

A grammar issue underlined in orange under the field, with the G:1 button

Fix an issue

  1. Click the issue button. The menu lists the first two issues, spelling issues first, each with its suggestions under it. The next issues appear as you fix these.
  2. Click a suggestion. FixMyGrammar replaces the text span and checks the field again.

Some grammar issues suggest (remove), which deletes the span, for example a repeated word. An issue with No suggestions needs a manual edit.

A fix is a normal property edit. Edit > Undo reverts it.

The fix menu with two spelling issues, each with its suggestions and Add to dictionary
After choosing Hello, one spelling issue is left and the button shows S:1

The project word list

Character names, places and game terms are not in the dictionary. Add them to the project word list, so the check accepts them in every field.

  1. Open the menu on a spelling issue.
  2. Click Add "word" to dictionary.

FixMyGrammar writes the word to Config/ProjectWords.txt in your project and loads it immediately. If source control is on, the editor checks out the file, or marks it for add. Submit the file so that your team gets the same words.

For a possessive such as Mira's, the list gets the stem Mira. The possessive then passes too.

Edit > Undo removes the word again, and Edit > Redo adds it back.

You can edit the file by hand: one word per line. The editor reads a hand edit at startup, or the next time you add a word, ignore an issue, undo or redo. Undo removes only the one word it added, so your hand edits stay.

Mira
Brambleton
Voidstone
The word Helo with a red squiggle and the S:1 button
The fix menu for Helo, with Add "Helo" to dictionary selected
Config/ProjectWords.txt open in a text editor, with the word Helo

Ignore a grammar issue

To keep a grammar issue that is correct for your game, for example dialogue that breaks a rule on purpose, click Ignore under it. FixMyGrammar saves the ignore to Config/IgnoredIssues.txt, as the issue and up to two words on each side of it. The ignore applies to those words in any field. If you edit them, the issue comes back. Submit the file so that your team gets the same ignores.

Each line of the file shows what it ignores. Delete a line to stop that ignore.

Agreement: I [has] a quest
Repetition: at [the the] door

Edit > Undo brings the issue back, and Edit > Redo ignores it again.

The fix menu for a grammar issue, with one suggestion and Ignore

What it does not check

FixMyGrammar finds common mistakes, not all of them. Read your text too.

Localization

A fix changes only the source string. The text keeps its localization namespace and key, so your translations stay linked to it. It also keeps culture invariance and, in Unreal Engine 5.8, its comment for translators.

After you fix source text, gather text again to mark the translations for review, as for any source text edit.

Turn it off

Select Edit > Plugins, clear Enabled on FixMyGrammar and restart the editor. The details panel returns to the editor's own FText field. Config/ProjectWords.txt stays in your project.

Licences

FixMyGrammar checks text with Harper by Automattic, under the Apache License 2.0. The plugin folder holds the full terms:

FixMyGrammar is not affiliated with or endorsed by Automattic.

Support

Email support@agassiz.games. Include: