---
# System prepended metadata

title: ChatMod

---

# ChatMod


<!-- ### Commands
#### /chatmod help
- [ ] Permission nodes listed
#### /chatmod filtertype
- [ ] Permission nodes listed
#### /chatmod filtertype 
- [ ] Permission nodes listed
#### /chatmod prefix
- [ ] Permission nodes listed
#### /chatmod help
- [ ] Permission nodes listed
#### /chatmod help
- [ ] Permission nodes listed
#### /chatmod help
- [ ] Permission nodes listed
 -->


### /chatmod - Brings up a description of the script and relavent commands. If the player does not have permission to use a command listed, it will not show on the list of runnable commands.
    - Required base permission node: chatmod.command
    - Aliases: /cm, /cm help, /chatmod help
    - Arguments: None

### /chatmod help <command> - Gives a description of what the command does, basic usage, and parameters usable for each command. 
    - Required base permission node: chatmod.help
    - Required extending permission node: chatmod.help.<command>
    - Arguments: 1

### /chatmod disable - Disables ChatMod.
    - Required base permission node: chatmod.disable
    - Aliases: /cm d, /chatmod d, /cm disable
    - Arguments: None

### /chatmod enable - Enables ChatMod.
    - Required base permission node: chatmod.enable
    - Aliases: /cm e, /chatmod e, /cm enable
    - Arguments: None

### /chatmod add <keywords> - Adds the specified keywords to the list of unallowed words.
    - Required base permission node: chatmod.add
    - Aliases: /cm a, /chatmod a, /cm add
    - Arguments: >=1

### /chatmod remove <keywords> - Removes the specified keywords from the list of unallowed words.
    - Required base permission node: chatmod.remove
    - Aliases: /cm r, /chatmod r, /cm remove
    - Arguments: >=1

### /chatmod list - Returns a list of current keywords ChatMod is looking out for in the words.yml file.
    - Required base permission node: chatmod.list
    - Aliases: /cm l, /chatmod l, /cm list
    - Arguments: None

### /chatmod filtertype - Change how ChatMod blocks filtered messages.
    - Required base permission node: chatmod.filtertype
    - Aliases: /cm ft, /chatmod ft, /cm ft
    - Arguments: None

### /chatmod filtertype stars - Replaces ONLY incoming keywords caught by the filter with stars instead of listed phrases or words.
      - Required base permission node: chatmod.filtertype.stars
      - Aliases: /cm ft s, /chatmod ft s, /cm ft s
      - Arguments: None

### /chatmod filtertype phrases - Replaces the ENTIRE incoming message caught by the filter with listed phrases or words instead of keywords with stars.
      - Required base permission node: chatmod.filtertype.phrases
      - Aliases: /cm ft p, /chatmod ft p, /cm ft p
      - Arguments: None

### /chatmod filtertype delete - Deletes the ENTIRE incoming message caught by the filter.
      - Required base permission node: chatmod.filtertype.delete
      - Aliases: /cm ft p, /chatmod ft p, /cm ft p
      - Arguments: None

### /chatmod prefix - Changes the prefix of ChatMod messages. Can be set to "off" to completely remove prefix messages.
    - Required base permission node: chatmod.prefix
    - Aliases: /cm p, /chatmod p, /cm p
    - Arguments: >=1

### /chatmod reload - Reload and update the config and words list.
    - Required base permission node: chatmod.reload
    - Aliases: /cm r, /chatmod r, /cm r
    - Arguments: None

<!-- ~~/chatmod settings - Brings up a settings gui to modify various ChatMod settings.
    Required base permission node: chatmod.settings
    Aliases: /cm s, /chatmod s, /cm s
    Arguments: None~~ -->
    



---
# TODO List:


- [ ] **ChatMod**