ChatSentry Wiki
  • ChatSentry
  • Features
  • Compatibility details
  • Module list & info
  • FAQ
  • Perms & Cmds
    • Bypass & misc. permissions
    • Commands (and their permissions)
      • In-game view
      • In depth command usages
  • guides
  • Plugin installation & configuring guide
  • Network bridge setup guide
  • In depth Word & Phrase Filter block list setup
  • In depth Chat Executor guide & entry examples
  • Config guides
    • Main/core config guide
    • Module config guides
      • Admin Notifier
      • Anti Chat Flood
      • Anti Command Prefix
      • Anti Join Flood
      • Anti Parrot
      • Anti Statue Spambot
      • Auto Grammar
      • Auto Punisher
      • Cap Limiter
      • Chat Cooldown
      • Chat Executor
      • Command Spy
      • Link & Ad Blocker
      • Spam Blocker
      • Unicode Remover
      • Word & Phrase Filter
    • Lang file guide
  • contact
  • Get support, talk with other cs users, make suggestions, etc.
  • Plugin Files
    • Default plugin configs & other files
      • /ChatSentry
        • config.yml
        • lang.yml
        • storage.yml
        • changelog.txt
      • /ChatSentry/Modules
        • admin-notifier.yml
        • anti-chat-flood.yml
        • anti-command-prefix.yml
        • anti-join-flood.yml
        • anti-parrot.yml
        • anti-statue-spambot.yml
        • auto-grammar.yml
        • auto-punisher.yml
        • cap-limiter.yml
        • chat-cooldown.yml
        • chat-executor.yml
        • command-spy.yml
        • link-and-ad-blocker.yml
        • spam-blocker.yml
        • unicode-remover.yml
        • word-and-phrase-filter.yml
  • Misc info and resources
    • Preset word lists for the word and phrase filter
    • ChatSentry's SpigotMC Page
  • API
    • About
    • Accessing the API
    • API Documentation
      • Events
      • Methods
  • Development
    • v5 Changelog
    • Legacy Changelogs
      • v4 Changelog
      • v3 Changelog
      • v2 Changelog
      • v1 Changelog
  • legal
    • Terms of Use Agreement
Powered by GitBook
On this page
  • About this module
  • Config guide
  • capitalize
  • add-periods
  • fix-typos
  • corrections
  • affected-commands

Was this helpful?

  1. Config guides
  2. Module config guides

Auto Grammar

PreviousAnti Statue SpambotNextAuto Punisher

Last updated 4 years ago

Was this helpful?

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.

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.

Config guide

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

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:

capitalize

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

capitalize: true

add-periods

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

add-periods: true

fix-typos

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

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

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

The below list will only work if "process-commands" is true in config.yml

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)

affected-commands:
  - "/tell"
  - "/t"
  - "/msg"
  - "/w"
  - "/r"
  - "/whisper"
  - "/w"
  - "/pm"
auto-grammar.yml