> For the complete documentation index, see [llms.txt](https://chat.advancedplugins.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://chat.advancedplugins.net/features/community-submitted-filter.md).

# Community-Submitted Filter

Enhance your server's chat moderation with the Community Chat Filter, a comprehensive and continually updated collection of over 2800 vulgar words and expressions. This filter, crafted through community contributions, evolves alongside online communication trends, ensuring your moderation efforts remain effective without manual updates.

## Configuration: `swearing.yml`

{% code title="rules/swearing.yml" %}

```yaml
enabled: true
# Bypass permission: advancedchat.bypass.rule.swearing

# This uses custom words list from our GitHub repository
swearWordsDatabase:
  - https://raw.githubusercontent.com/AdvancedPlugins/Chat/main/swear%20words/en.json
  - https://raw.githubusercontent.com/AdvancedPlugins/Chat/main/swear%20words/de.json

# allow swearing in these channels
disabledChannels:
  - sc
# Should the plugin check for swear words in private messages?
inMsg: true

# Should the curse words be obfuscated? (words replaced with asterisks)
# If set to false, the message will not be sent at all.
obfuscate: true

# Message to send when a player swears
action:
  - 'warn %player% Inappropriate language'
  - 'alert %player% Inappropriate language [%message%]'
```

{% endcode %}

#### Key Settings Explained

* **enabled**: Activates the vulgar words filter on your server, ensuring real-time moderation of chat content.
* **swear-words-database**: Specifies the URL to a JSON file hosted on GitHub, containing the list of community-submitted vulgar words. This database is a live resource, regularly updated by contributors.
* **disabledChannels**: Specifies the channels where swearing is allowed.
* **swear-message**: Defines the message that is sent to a player immediately after they use a word or expression listed in the database, urging them not to swear.
* **obfuscate**: When set to `true`, any detected swear words in a player's message are replaced with asterisks, censoring the inappropriate language. If `false`, the original message is suppressed entirely, and not sent.
* **action**: Outlines the consequences for swearing on the server. In this case, the player is warned, and staff are alerted about the incident, including the message content.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://chat.advancedplugins.net/features/community-submitted-filter.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.