Skip to main content

Create and manage custom profanity filters

Last updated on June 27, 2024

Overview

You can create custom profanity filters on the AccelByte Gaming Services (AGS) Admin Portal and use an Extend App you've configured or your own custom server.

Prerequisite

You have created and configured a designated profanity filter Extend App or set up your own custom server.

Add a custom filter

  1. In the AGS Admin Portal, go to your game namespace.

  2. On the sidebar menu, click on Game Setup and go to Profanity Filter > Customizations.

  3. On the Customizations page, click on the Add Custom Filter button.

  4. On the Add Custom Filter form, type in a name for the new custom filter and add a description (optional) for the new custom filter.

  5. In the Hosting section, do one of the following:

    • Select AccelByte Hosted to use an Extend app you've configured. From the Extend app dropdown, select the Extend app you have configured as your profanity filter.
    • Select Locally Hosted to use your own custom server. Then, add the address of your custom server into the Host/Port text box.

    Image shows the Add Custom Filter form

    tip

    If you selected an Extend app, click on the View methods option below the dropdown to display the app's exposed methods and supported features.

  6. Click Add to finish creating your new custom filter. It will be added to the Customization

View and edit a custom filter

You can edit the description and hosting method of a custom filter. To do so, follow these steps:

  1. From the Custom Filters list on the Customizations page, find the custom filter you want to edit and remove.

  2. On the corresponding Action column of the filter, click on View. The details page of the filter appears.

  3. Click on Edit.

  4. Edit the custom filter as needed.

  5. Click Save.

Delete a custom filter

  1. From the Custom Filters list on the Customizations page, find the custom filter you want to edit and remove.

  2. You can delete a custom filter in two ways:

    • Click on the filter's corresponding Delete option. Type DELETE on the confirmation message that appears and click on Confirm.
    • Click on the filter's corresponding View option. On the top-right side of the filter's details page, click on the Delete button.

    A confirmation message appears.

  3. Type DELETE on the confirmation message and click on Confirm. The custom filter is immediately deleted from the list.

Next step

After creating custom profanity filters, you can activate the profanity filter feature in your namespace to use for validation. See Activate profanity filter for validation.