Skip to Content
KittyPaper is currently in Beta 🎉
DocsSettings

Settings

KittyPaper settings can be configured in the kittypaper.yml file located in the server’s root directory. Below are the available settings and their descriptions:

anonymize-player-listing

  • Type: Boolean
  • Default: true

When set to true, player names in the server list ping response are always anonymized to enhance player privacy. This overrides the preference set by the client if set to true. Set to false to disable this feature.

enable-dashboard

  • Type: Boolean
  • Default: true

When set to true, the KittyPaper dashboard is enabled, allowing server administrators to view blocked requests and reports. Set to false to disable the dashboard.

enable-reporting

  • Type: Boolean
  • Default: true

When set to true, the server can report requests that are likely to be scanners to help improve the blocklist for everyone. Set to false to disable reporting. Read more about this in the FAQ section of the documentation.

blocklists

  • Type: Array of Objects
  • Default:
blocklists:
- url: https://raw.githubusercontent.com/LillySchramm/KittyScanBlocklist/refs/heads/main/ips-24.txt
  refresh-interval-minutes: 1
  subnet-mask: 24

An array of blocklists to use for request blocking. Each blocklist object contains the following properties:

  • url: The URL of the blocklist.
  • refresh-interval-minutes: The interval in minutes at which the blocklist should be refreshed.
  • subnet-mask: The subnet mask to apply to the IPs in the blocklist.

The default blocklist is the KittyScanBlocklist maintained by the KittyScan project.

The blocklist has to be a plain text file with one IP address without port or subnet per line. See the KittyScanBlocklist repository  for an example.

verbose

  • Type: Boolean
  • Default: false

When set to true, KittyPaper will log additional information to the console for debugging purposes. Set to false to disable verbose logging.