ForcedGrammar
This page should be comprehensive documentation of ForcedGrammar. It is currently correct for v1.8.3+
Spelling and grammar
ForcedGrammar currently has three main ways of improving the quality of chat: correcting capitalisation; appending full-stops to sentences and correcting spelling.
Capitalisation works by identifying sentences in messages then capitalising the first letter of each. Simple.
Full-stopping is even more simple. If a message does not end with some kind of valid ending punctuation (full-stop, question mark, exclaimation mark, et cetera) and also doesn't end with something that would be messed up by a full-stop (a link or a smily) then a full-stop is added onto the end.
Spelling correction, while being responsible for the most work - both on my part and that of the user - is again pretty simple in its goals. It uses a list of corrections (spellings.yml in ForcedGrammar’s folder) to do a search and replace on messages.
Commands
There are 5 distinct commands made available by ForcedGrammar. They are used to get information and to change the spelling dictionary. By default, only the info command can be used without the editDictpermission. Arguments enclosed with <> are necessary, while those enclosed with [] are optional.
/fg info
Give plugin version and available commands
/fg reload
Reload spelling dictionary (if you've been editing the file manually)
/fg add <from>:<to>
Add a correction to the spelling dictionary
/fg remove <from>
remove a correction from the spelling dictionary
/fg list [page]
print a paged list of spelling corrections
Permissions
There are two permission nodes provided by ForcedGrammar.
fg.editDict
Allows use of dictionary editing commands. Operators have it by default.
fg.exempt
Players with this permission will not have their chat changed. Nobody has it by default.
The spelling dictionary
Although I am about to talk at length about it, I would not recommend editing the file directly. Please use the commands to modify the dictionary unless you want to do some bulk editing. If you do edit it directly, be aware that some characters may need to be escaped. Putting quotation marks around the string will probably fix it, but you can be sure of it working if done through the add command.
Below is an example dictionary.
search: replace
wth: with
cat: evil feline
your mum: my mum
In fact, this is (pretty much) the default one that you'll get with a fresh install. Lines begining with # are comments that do not effect the dictionary. These can be added and removed without anything going wrong. Corrections are set up in pairs of words: the from and the to. These are seperated by a colon. Hopefully the above example is pretty self explanitory.
The configuration file
In ForcedGrammar's folder lies a file called config.yml. In here you can turn on or off all of ForcedGrammar's features. Seriously, if you turn them all off then it will do nothing.
correct_spelling
Enables/disables spelling correction. true by default.
default_list
When turned on, places a list of common misspellings in the plugin folder. It will keep doing so until you turn it off. false by default
capitalise
Enables/disables capitalision. true by default
full-stop
Enables/disables full-stop appending. true by default
allow_escape
Enables/disables players' ability to escape their messages by beginning them with a backslash '\', see below true by default
update_notify
Enables/disables update notification. true by default
Other nice things
These bits didn't really justify sections of their own.
The update notifier
Like many other plugins, ForcedGrammar is able to notify you via the console of newly released updates to itself. This is done through Curse's API and can be toggled on or off in the configuration file.
Message escaping
If you don't want a particular message to be messed with by the plugin, begin it with a backslash \. This escapes the message, leaving it untouched (the backslash will not be shown). If you don't want your players to be able to do this then - again - you can turn it off in the configuration file.
This page should be comprehensive documentation of ForcedGrammar. It is currently correct for v1.8.3+
Spelling and grammar
ForcedGrammar currently has three main ways of improving the quality of chat: correcting capitalisation; appending full-stops to sentences and correcting spelling.
Capitalisation works by identifying sentences in messages then capitalising the first letter of each. Simple.
Full-stopping is even more simple. If a message does not end with some kind of valid ending punctuation (full-stop, question mark, exclaimation mark, et cetera) and also doesn't end with something that would be messed up by a full-stop (a link or a smily) then a full-stop is added onto the end.
Spelling correction, while being responsible for the most work - both on my part and that of the user - is again pretty simple in its goals. It uses a list of corrections (spellings.yml in ForcedGrammar’s folder) to do a search and replace on messages.
Commands
There are 5 distinct commands made available by ForcedGrammar. They are used to get information and to change the spelling dictionary. By default, only the info command can be used without the editDictpermission. Arguments enclosed with <> are necessary, while those enclosed with [] are optional.
/fg info
Give plugin version and available commands
/fg reload
Reload spelling dictionary (if you've been editing the file manually)
/fg add <from>:<to>
Add a correction to the spelling dictionary
/fg remove <from>
remove a correction from the spelling dictionary
/fg list [page]
print a paged list of spelling corrections
Permissions
There are two permission nodes provided by ForcedGrammar.
fg.editDict
Allows use of dictionary editing commands. Operators have it by default.
fg.exempt
Players with this permission will not have their chat changed. Nobody has it by default.
The spelling dictionary
Although I am about to talk at length about it, I would not recommend editing the file directly. Please use the commands to modify the dictionary unless you want to do some bulk editing. If you do edit it directly, be aware that some characters may need to be escaped. Putting quotation marks around the string will probably fix it, but you can be sure of it working if done through the add command.
Below is an example dictionary.
search: replace
wth: with
cat: evil feline
your mum: my mum
In fact, this is (pretty much) the default one that you'll get with a fresh install. Lines begining with # are comments that do not effect the dictionary. These can be added and removed without anything going wrong. Corrections are set up in pairs of words: the from and the to. These are seperated by a colon. Hopefully the above example is pretty self explanitory.
The configuration file
In ForcedGrammar's folder lies a file called config.yml. In here you can turn on or off all of ForcedGrammar's features. Seriously, if you turn them all off then it will do nothing.
correct_spelling
Enables/disables spelling correction. true by default.
default_list
When turned on, places a list of common misspellings in the plugin folder. It will keep doing so until you turn it off. false by default
capitalise
Enables/disables capitalision. true by default
full-stop
Enables/disables full-stop appending. true by default
allow_escape
Enables/disables players' ability to escape their messages by beginning them with a backslash '\', see below true by default
update_notify
Enables/disables update notification. true by default
Other nice things
These bits didn't really justify sections of their own.
The update notifier
Like many other plugins, ForcedGrammar is able to notify you via the console of newly released updates to itself. This is done through Curse's API and can be toggled on or off in the configuration file.
Message escaping
If you don't want a particular message to be messed with by the plugin, begin it with a backslash \. This escapes the message, leaving it untouched (the backslash will not be shown). If you don't want your players to be able to do this then - again - you can turn it off in the configuration file.
Quick facts
- Edition: Minecraft Java
- File type: .jar
- How to install: Install the matching mod loader (Forge, Fabric or NeoForge) for your Minecraft version. → Download the .jar. → Put it in the .minecraft/mods folder and launch that loader profile.
- Where to get it: Opens on Spigot — not every file is mirrored on our own servers.
Install steps are the general flow for this file type — How to install Minecraft Java mods & modpacks walks through it step by step.
ForcedGrammar is a free Minecraft Java mod. Downloaded 1,596 times (via Spigot). Download it and open it directly in the game.