Skip to content

FaithBreak — Overview

Version: 1.4.0
Minecraft Version: Paper 1.21+
Developer: CiscoCodes (Modrinth)


Introduction

FaithBreak is a Minecraft Paper 1.21+ plugin that helps Muslim players take prayer breaks by detecting their location and providing customizable prayer time notifications or kicks. The plugin respects player choice with multiple participation modes and supports 8 languages.

The plugin uses IP geolocation to detect a player's country and calculate accurate prayer times based on their timezone. Players can choose to be kicked during prayer times or receive chat reminders, and non-Muslim players can opt out completely.


Features

Core Features

  • IP Geolocation — Automatically detects player location on join
  • Prayer Time Calculation — Calculates accurate prayer times based on location/timezone
  • Multiple Participation Modes — Kick Mode, Reminder Mode, or Opt-Out
  • Player Choice — Commands to explicitly opt in or out
  • Automatic Country Detection — Uses Middle Eastern country heuristics for defaults
  • 12-Minute Break Duration — Players are blocked from rejoining for 12 minutes after being kicked
  • Multi-Language Support — 8 built-in languages
  • Clickable Links — Kick message includes link to plugin page
  • Debug Mode — Extensive logging for troubleshooting

Player Modes

Mode Behavior
Kick Mode (default) Player is kicked during prayer times, blocked from rejoining for 12 minutes
Reminder Mode Player receives chat notifications instead of being kicked
Opt-Out Player completely exempt from all prayer time actions

Default Behavior

  • Players from Middle Eastern countries default to Kick Mode
  • Players from other countries default to Reminder Mode
  • Players can change their mode at any time using commands
  • Choices are persistent and survive server restarts

Supported Languages

8 built-in languages are supported:

Code Language
en_US English
es_ES Spanish
fr_FR French
de_DE German
pl_PL Polish
nl_NL Dutch
hi_IN Hindi
ur_PK Urdu

Language is automatically detected from the player's client on join, or can be manually changed with /fb lang <code>.


Middle Eastern Countries

The plugin automatically detects the following countries as Middle Eastern for default mode assignment:

  • Saudi Arabia
  • United Arab Emirates
  • Qatar
  • Kuwait
  • Bahrain
  • Oman
  • Yemen
  • Iraq
  • Iran
  • Syria
  • Lebanon
  • Jordan
  • Palestine
  • Egypt

Dependencies

  • None — FaithBreak is a standalone plugin
  • Optional: PlaceholderAPI for enhanced message formatting

Support & Credits

  • Modrinth: modrinth.com/plugin/faithbreak
  • Discord: Join for bug reports, suggestions, and community discussion
  • Privacy: No data collection — plugin operates entirely offline except for IP geolocation
  • License: All Rights Reserved