# Random Fun Modules

This page documents the specific configuration settings for the auxiliary modules that provide server utility, logging, and security enhancements.

# 1. Chat Module

# Description

This module enables chat history with rank and view tracking. It also handles automated advertising and offensive language filtering using regular expressions.

# Configuration Example: Chat Filter (`chat.yml` or similar)

filter:
  advertise:
    # Regex to block URLs and IP addresses
    blocked-regex:
    - (https?:\/\/|www\.)\S+
    - '[a-zA-Z0-9.-]+\.(com|net|org)'
    - \d{1,3}(\.\d{1,3}){3}(:\d+)?
    # List of domains/IPs to ignore
    ignore-list:
    - luxcube.net
    - builtbybit.com
    - hypixel.net
    notify-in-chat: true
    # Command executed when an offense is detected
    commands:
    - mute %player% Advertising
  
  # Offensive language filter
  offensive:
    blocked-regex:
    - (f\*?u\*?c\*?k)
    - (sh\*?i\*?t)
    - (d[a@]mn)
    - (cu\*?n\*?t)
    # ... additional offensive regex patterns

# 2. Commands Module

Description This module enables commands spy functionality, allowing staff members to monitor commands executed by players.

Configuration Example: Command Spy

commands-spy:
  enabled: true
  # Format of the message that appears to staff in chat**
  format: '&#ADD8E6[SPY] %player%: &#d2e5e5%command%'
  toggle-messages:
    'true': '&#d2e5e5You''ve &#ADD8E6enabled &#d2e5e5your commands spy.'
    'false': '&#d2e5e5You''ve &#ADD8E6disabled &#d2e5e5your commands spy.'

# 3. Limiter Module

Description The Limiter module enables block placement restrictions per chunk to mitigate server lag and prevent abuse from excessive high-load blocks. This configuration is typically managed in a separate file, such as limiter.yml.

Configuration Example: Hopper Limits

limitations:
  
  '1':
    type: HOPPER
    # Represents the size of the chunk range (e.g., 6x6 area)
    chunk-size: 6
    # Maximum number of hoppers allowed within the defined area
    max-amount: 10

# 4. Restart Module

Description This module enables automated and timed server restarts to help maintain server health and performance.

Configuration Example: Automatic Restart

restart-commands:
# Commands executed before the actual restart (e.g., save-all)
- /save-all
- /restart
automatic-restart:
  
  # The server will restart automatically 86400 seconds (24 hours) after start up!
  interval: 86400
  
  broadcasts:
    
    '1':
      time-left: 10
      message: '&c&l[!] &cThe server will restart in 10 seconds!'
    
    '2':
      time-left: 5
      message: '&c&l[!] &cThe server will restart in 5 seconds!'
    '3':
      time-left: 4
      message: '&c&l[!] &cThe server will restart in 4 seconds!'
    '4':
      time-left: 3
      message: '&c&l[!] &cThe server will restart in 3 seconds!'
    '5':
      time-left: 2
      message: '&c&l[!] &cThe server will restart in 2 seconds!'
    '6':
      time-left: 1
      message: '&c&l[!] &cThe server will restart in 1 seconds!'

# 5. Shop Module

Description The Shop module integrates with external shop plugins to enable transaction logging. This logging requires a soft dependency on the specific shop plugin being used on the server.

Note: This module typically acts as a logger and may not contain further configuration options beyond the main toggle in config.yml.

# 6. Suspicious Module

Description This module focuses on security by tracking logs and punishing suspicious players who illegally obtain OP status for staff review. It enforces a strict whitelist for server operators.

Configuration Example: Operator Checking

whitelist-operators:
  enabled: true
  force-de-op: true
  commands:
  - ban %player% Having OP without being whitelisted in config!
  whitelist:
  - Steve
checking-operators:
  enabled: true
  force-de-op: true
  # Every how much time it will check in ticks.
  schedule: 20
  commands:
  - ban %player% You have not obtained OP from console.
webhook: ''

# 7. Tracker Module

Description The Tracker module is a utility feature that logs details about players upon joining, specifically tracking their join domains and countries.

Note: This module is primarily for passive logging and may not contain further configuration options beyond the main toggle in config.yml.

# 8. Whitelist Module

Description This module enables custom server whitelist management features, which is separate from the default Minecraft server whitelist.

Configuration Example: Whitelist Warning

whitelist-warning:
  enabled: true
  attempt-join-message: '&#FF474C%player% &#d2e5e5attempted to join.'
webhook: ''