> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kyos.bot/llms.txt
> Use this file to discover all available pages before exploring further.

# Filtering

<Card title="Module: Filtering" icon="message-slash" horizontal="True">
  Filter images, words, links or lock channels to image only!
</Card>

## What does this do?

Filtering allows you to filter out **unwanted terms**, **spam**, **mass mentions** and more! Along with the ability to create **image only**, or **image filtered** channels.

### Adding a filtered word

<Tabs />

Users that trigger the filtered word receive a **60 second** timeout.
<Tip>**Word filtering** whitelisted channels will be unaffected, run `filter whitelisted` to view them</Tip>

<CodeGroup>
  ```javascript syntax theme={null}
  ,filter add (word)
  ```

  ```javascript example theme={null}
  ,filter add reddit
  ```
</CodeGroup>

### Setting an image locked channel

<Tabs />

By setting an image locked channel, this will permit **only** media to be sent inside that channel.

<CodeGroup>
  ```javascript syntax theme={null}
  ,filter imagelock (channel)
  ```

  ```javascript example theme={null}
  ,filter imagelock #media
  ```
</CodeGroup>

## Filtering mass mentions

<Tabs />

Filter out unwanted mention spamming

<CodeGroup>
  ```javascript syntax theme={null}
  ,filter mention (channel/all) (on/off) (parameters)
  ```

  ```javascript example theme={null}
  ,filter mention all on --threshold 3 --do mute
  ```
</CodeGroup>

### Exempt a role from mass mentions

<Tabs />

Exempt a role from being affected by mass mention filtering
<Tip> To **view** the exempt list, run `,filter mention exempt list`</Tip>

<CodeGroup>
  ```javascript syntax theme={null}
  ,filter mention exempt (role)
  ```

  ```javascript example theme={null}
  ,filter mention exempt @Moderator
  ```
</CodeGroup>

## Filtering spam

<Tabs />

Filter out message spamming inside your server

<CodeGroup>
  ```javascript syntax theme={null}
  ,filter spam (channel/all) (on/off) (parameters)
  ```

  ```javascript example theme={null}
  ,filter spam all on --threshold 3 --do mute
  ```
</CodeGroup>

### Exempt a role from spam

<Tabs />

Exempt a role from being affected by spam filtering
<Tip> To **view** the exempt list, run `,filter spam exempt list`</Tip>

<CodeGroup>
  ```javascript syntax theme={null}
  ,filter spam exempt (role)
  ```

  ```javascript example theme={null}
  ,filter spam exempt @Moderator
  ```
</CodeGroup>

## Miscellaneous Filters

### Filtering images

<Tabs />

Filter images from being sent inside a channel

<CodeGroup>
  ```javascript syntax theme={null}
  ,filter images (channel)
  ```

  ```javascript example theme={null}
  ,filter images #general
  ```
</CodeGroup>

### Filtering invites

<Tabs />

<Tip>**Invite filtering** whitelisted channels will be exempt, run `filter invites whitelisted` to view them</Tip>

<CodeGroup>
  ```javascript syntax theme={null}
  ,filter invites (on/off)
  ```

  ```javascript example theme={null}
  ,filter invites on
  ```
</CodeGroup>

### Removing a filtered word

<Tabs />

Remove an existing filtered word

<CodeGroup>
  ```javascript syntax theme={null}
  ,filter remove (word)
  ```

  ```javascript example theme={null}
  ,filter remove reddit
  ```
</CodeGroup>

### Viewing lists

<Tabs />

<AccordionGroup>
  <Accordion title="Image locked channels">
    `,imagelocked`
  </Accordion>

  <Accordion title="Image Filtered Channels">
    `,imgfiltered`
  </Accordion>

  <Accordion title="Filtered Words List">
    `,filter list`
  </Accordion>
</AccordionGroup>

### Excluding/Whitelisting Channels from Filters

<Tabs />

<AccordionGroup>
  <Accordion title="Whitelisting from invite filtering">
    `,filter invites wl (channel)`, to **unwhitelist** simply re-run the command
  </Accordion>

  <Accordion title="Viewing word filtered exempted">
    `,filter whitelisted`
  </Accordion>

  <Accordion title="Viewing invite filtered exempted">
    `,filter invites whitelisted`
  </Accordion>
</AccordionGroup>