RUST Better Chat Filter Plugin (How to Install, Configure & Use)

What is the Better Chat Filter plugin?

Better Chat Filter (BCF) is a free RUST plugin that enables server admins to have unwanted words, phrases, and characters to be automatically filtered out when players type into global or team chat within RUST.

This plugin is currently updated and supported by NooBlet. BCF is a free-to-use plugin available for download on uMod. It relies directly on the Better Chat plugin to function, simply adding a derogatory word filter function to the original mod when detected.

Potential reasons to use Better Chat Filter

While the Better Chat plugin replaces the original in-game chat feature in RUST, the Better Chat Filter plugin would replace the automated profanity filter. 

This addon plugin was developed so players spamming text communications with all manner of filth could adequately be dealt with, using specified metrics to determine punishment for certain words or phrases.  Unlike the default RUST filter, BCF has features to allow for automated muting, kicking, or banning.

How to install the Better Chat Filter plugin

As with all uMod plugins, the server you intend to install them on requires uMod (Oxide) to be installed to facilitate their function. For a step-by-step perspective on how to install this plugin, please reference the following list:

  1. First, you must have uMod/Oxide installed on your server. Use our Installing uMod (Oxide) on Your RUST server guide if you need help; otherwise, if you use a third-party hosting, their user interface will have instructions on how to get started. It may be tooled explicitly to their platform, so contact your host for details.
  2. Acquire the latest plugin version from uMod’s Better Chat Filter plugin page, or download the CS file directly.
  3. Ensure you have the Better Chat plugin installed; otherwise, BCF will NOT work.
  4. Locate the downloaded BetterChatFilter.cs file and install the plugin on your RUST server, or follow your host-specific instructions.
  5. Once Better Chat Filter is installed in the plugins folder, and if the server is actively running, uMod will immediately create an alternate BetterChatFilter.json file in your config folder. It is essential to differentiate these files and not mistake them, as you must make configuration changes in the .json file in the config folder.  

Additional dependencies

Better Chat Filter is not a standalone mod and must install the Better Chat plugin first.

It can also work in conjunction with the following:

Permissions

As with all uMod plugins, they will each have a small list of plugin-specific permissions. Make sure you reference our uMod Permissions Guide to better understand the oxide.grant permission system.

Specific permission command lines for Better Chat Filter include:

CommandDescription
betterchatfilter.adminGrants player the ability  to use the filter admin commands

Activation steps

Simply install both BC and BCF to use this mod.  Certain permissions in both are required. 

Chat or console commands are as follows:

CommandDescription
clearfiltersClear all players online offenses (admin only)
filterCheck number of offenses for your own account
filter check‘player name or steam id’ – check number of offenses for specified player (admin only)
filter clear‘player name or steam id’ – clear offenses for specified player (admin only)

By default, the configuration of the BetterChatFilter.json file should be adequate for most server owners’ purposes. While lacking much in the way of customization, the following is a default configuration, prefaced by our own warning disclaimer:

Alteration of any below values could drastically increase the chance of mod failure if not properly done. Only those with considerable knowledge of RUST mods are recommended to alter them.

{  
  "Advanced - Regex to use": "", - Regex to trigger replacement
  "Advanced - Use REGEX": false,
  "Clear Offense After (0 - Disabled, 1 - Both Kick/Mute, 2 - Kick,  3 - Mute": 0,
  "Exclude Team Chat": false,
 
  "Offenses - Broadcast Ban": true, - gives chat report when ban issued
 
  "Offenses - Broadcast kick": true, - gives chat report when kick issued
 
  "Offenses - Count To Ban": 20, (0 -disabled) - # of offenses before ban
 
  "Offenses - Count To Kick": 3, (0 -disabled) - # of offenses before kick
 
  "Offenses - Count To Mute": 3, (0 -disabled) - # of offenses before mute
 
  "Offenses - Time To Mute": 300, - 
 
  "Time to Ban in Minutes": 30,                (0 -Perma)
 
  "Warn Players with offense amount": false,
 
  "Word Filter - Custom Replacement": "Dumbdumb", - word to be substituted in place of the offending word.
 
  "Word Filter - Enabled": true,
 
  "Whole Message Filter - Enabled": false, - Blocks entire message outgoing 
 
  "Word Filter List": [ ],  - list of bad words that triggers replacement 
  "Word To White List": [ ],   - list of exact words to exclude from being filtered
 
  "Word Filter - Replacement": "*", - symbol used to censor offending words
  "Word Filter - Use Custom Replacement": false - set to true to substitute   word instead of symbol.
}

Manual Filtered Word Alterations

Using this mod based on default settings is highly recommended, with minor alterations made by only those experienced in the programming language used.  

With the above considered, to alter the list of filtered words manually, administrators need to access code lines 82-91 of oxide/plugins/BetterChatFilter.cs. These words are those preselected for filter or whitelisting.  

Alterations here should be done in a manner consistent with the existing code and saved afterward.  Oxide.reload BetterChatFilter should be run before changes are expected.

How to update the Better Chat Filter plugin

Updating the RUST Better Chat Filter plugin is simple and quick:

  1. Visit the uMod Better Chat Filter plugin page
  2. Download the latest version of the Better Chat Filter plugin
  3. Overwrite the existing BetterChatFilter.cs file in your Oxide plugins folder.

It is best practice not to uninstall the mod, as you do not need to alter the JSON file. It will remain with your existing settings (unless the developer otherwise suggests a complete reinstall).

How to remove the Better Chat Filter plugin

As the RUST Better Chat Filter plugin doesn’t impact player experience or game features necessary to run processes in the game itself, removing the plugin is as simple as deleting BetterChatFilter.cs from your plugins folder.

A more thorough approach for removing Better Chat Filter is to:

  1. Prepare and properly shut down the RUST server
  2. Open the Oxide plugins folder in your server directory
  3. Locate and delete the BetterChatFilter.cs file
  4. Open the Oxide config folder in your server directory
  5. Locate and delete the BetterChatFilter.json configuration file
  6. Restart the RUST server

Suppose you want to disable the Better Chat Filter plugin temporarily. You can use the oxide.unload BetterChatFilter command, which you may also run in the F1 console, RCON, or Web Console. 

Disclaimer and seeking assistance

Corrosion Hour does not maintain the RUST Better Chat Filter plugin, nor do we assist with modifying the plugin outside the config scope. Visit the plugin’s uMod page to support the plugin creators, report bugs, or propose feature requests. Please contact an admin in our Discord community for help with the steps and instructions in this guide.

Tempest Hosting
No Limit Llama's avatar

About No Limit Llama

An aspiring woodworker and web designer. Father, husband, and Rust veteran. Llama has written op-eds and official game documents for over two decades. The earliest writings were on Asheron’s Call, followed by World of Warcraft and eventually Rust. The vast majority of his indoor time is spent running Rust servers or helping friends with their Rust-related projects. He enjoys working around the house, continuing his education when time permits, and creating new processes to simplify activities of daily living for his friends and family. He has an incredible wife, a dog, three children, and one granddaughter.

View all posts by No Limit Llama →