# Auto Grammar

## About this module

The Auto Grammar module converts players' messages to use proper capitalization, periods, and correct typos in chat and configured or all commands.

{% hint style="info" %}
To bypass this module, op or the permission: "**chatsentry.autogrammar.bypass"** is required. 

Players with this permission can join even if the joins per minute limit is reached. In addition, their joins won't count against the joins per minute counter.
{% endhint %}

## Config guide

You can access the below settings in the **auto-grammar.yml** file within the **modules** folder of the plugin's root folder.

{% hint style="success" %}
**Config excerpts taken from v3.6.0 and may not be completely up-to-date with the latest changes. To see the most up-to-date file, see below:**
{% endhint %}

{% content-ref url="../../files/files/module-configurations/auto-grammar.yml" %}
[auto-grammar.yml](https://wiki.chatsentry.xyz/files/files/module-configurations/auto-grammar.yml)
{% endcontent-ref %}

###

### capitalize

Should the first word of every sentence of players' messages be capitalized?

```yaml
capitalize: true
```

### add-periods

Should a period be added at the end of players' sentences?

```yaml
add-periods: true
```

### fix-typos

Should typos on the below list be fixed with their replacements?

```yaml
fix-typos: true
```

### corrections

These words will be corrected to the word after the " -> "
\
Case doesn't matter in the words on the left side

If one of the words on the left side is typed in all caps by the player, the right side translation will be converted to uppercase as well

```yaml
corrections:
  - "alot -> a lot"
  - "cant -> can't"
  - "wont -> won't"
  - "wouldnt -> wouldn't"
  - "shouldnt -> shouldn't"
  - "couldnt -> couldn't"
  - "youre -> you're"
  - "ill -> I'll"
  - "ive -> I've"
  - "im -> I'm"
  - "id -> I'd"
  - "its -> it's"
  - "doesnt -> doesn't"
  - "dont -> don't"
  - "shes -> she's"
  - "hes -> he's"
  - "theres -> there's"
  - "theyre -> they're"
```

### affected-commands

{% hint style="warning" %}
The below list will only work if "process-commands" is true in config.yml
{% endhint %}

The below list is which commands the module will apply to. It's recommended to only set these to your private messaging commands.

*Set the list to "affected-commands: \[]" to apply the module to ALL commands (highly not recommended!)*

Make sure to only include base commands; don't add any command arguments. (spaces)

```yaml
affected-commands:
  - "/tell"
  - "/t"
  - "/msg"
  - "/w"
  - "/r"
  - "/whisper"
  - "/w"
  - "/pm"
```