🕌 FaithBreak v1.4.0 — Player Modes & Smart Kick Screen! 🛡️

🌟 Join Our Discord for Giveaways & Events! 🎮

Join our Discord Server 🔗 for monthly giveaways & events where you can win coupon codes or plugins like AstralSwords Premium or TrimBlades! 🎨🚀

Warriors of faith, v1.4.0 is here with three distinct player modes, a smarter kick screen, and tab completions! Choose between Kick Mode, Reminder Mode, or Opt-Out — your choice is saved permanently. 🚀

✨ What's New in v1.4.0 ✨

🎯 Major Improvements

feat: 🎮 THREE PLAYER MODES - Choose how prayer times affect you: Kick, Reminder, or Opt-Out!
feat: 🕌 /muslim [kick|reminder] - New command to opt in and select your preferred mode (default: Kick)
feat: 📺 SMART KICK SCREEN - Kick screen now shows your current mode and how to switch — right on the disconnect page!
feat: 🔤 TAB COMPLETIONS - All commands now have smart tab completion for faster typing
feat: 💾 PERSISTENT MODES - Your mode choice (Kick/Reminder/Opt-Out) is saved permanently to playerdata.yml
feat: 🔄 AUTO-MIGRATION - Old optout.yml data is automatically migrated to the new system

🆕 How Modes Work

Mode	What Happens	Command
🔴 Kick Mode (Default)	Kicked from server during prayer time (12-min break)	`/muslim kick`
🟡 Reminder Mode	Chat reminder only — no kick!	`/muslim reminder`
🟢 Opt-Out	Nothing happens — fully opted out	`/non-muslim`

🔍 What Does FaithBreak Do?

FaithBreak helps players take breaks during prayer times:

🌍 Smart Location Detection: Automatically detects each player's location based on their IP
🕰️ Prayer Time Awareness: Calculates accurate prayer times for each player's specific location
⏱️ Timely Reminders: Two minutes before prayer time, players are kicked or reminded
⏳ Break Duration: Kicked players can't rejoin for 12 minutes, giving time for prayer
🌐 Multi-Language Magic: Messages automatically appear in each player's Minecraft language!
🎯 Player Choice: Choose between Kick Mode, Reminder Mode, or Opt-Out — saved permanently!

💻 Commands

Player Commands

Command	Description
`/muslim`	Opt in with Kick Mode (default)
`/muslim kick`	Set mode to Kick — kicked during prayer times
`/muslim reminder`	Set mode to Reminder — chat alerts only, no kick
`/non-muslim`	Opt out of all prayer kicks and reminders (saved permanently!)
`/fb lang`	View current language and available options
`/fb lang <code>`	Change your language (e.g., `/fb lang ar_SA`)

Admin Commands (OP only)

Command	Description
`/fb kick <prayer>`	Test the kick screen without the 12-min timer

💡 Tab Completions: All commands support tab completion! Type /muslim and press Tab to see kick and reminder suggestions.

🌍 Supported Languages (10 Total!)

🇬🇧 English (en_US)
🇸🇦 Arabic (ar_SA) - العربية
🇵🇰 Urdu (ur_PK) - اردو
🇪🇸 Spanish (es_ES) - Español
🇫🇷 French (fr_FR) - Français
🇮🇩 Indonesian (id_ID) - Bahasa Indonesia
🇮🇳 Hindi (hi_IN) - हिन्दी
🇩🇪 German (de_DE) - Deutsch
🇵🇱 Polish (pl_PL) - Polski
🇳🇱 Dutch (nl_NL) - Nederlands

💡 Server Owners: Add more languages by creating [code].yml files in plugins/FaithBreak/messages/!

📋 Features in Detail

🔔 What Happens During Prayer Time?

For Players in Kick Mode (Default):

2 minutes before prayer → kicked from server
See localized message with prayer name + mode info
Kick screen shows how to switch to Reminder Mode or Opt-Out
Can rejoin after 12 minutes

For Players in Reminder Mode:

2 minutes before prayer → receive a chat reminder
Message: "⏰ Reminder: It's [Prayer] prayer time!"
No kick — keep playing!

For Opted-Out Players:

Nothing happens — fully invisible to the prayer system

🎮 Choosing Your Mode

Want to be kicked for prayer? (Strict enforcement)

/muslim kick

Want chat reminders only? (No kick)

/muslim reminder

🚫 Don't Want Prayer Notifications?

Use /non-muslim to opt out:

You won't receive kicks or reminders
Your choice is saved permanently!
Switch back anytime with /muslim

🔒 Privacy First

By default, FaithBreak does NOT log player locations to console:

No more "Player X location detected: Country, City" spam
Enable log-player-locations: true in config only if needed

🧪 Test Mode for Admins

Want to see what players see when kicked?

/fb kick Fajr

Shows the exact kick screen with mode info
No 12-minute timer - rejoin immediately!

📸 What Players See

English Player (Kick Screen)

It's Fajr prayer time! Please take a break.
You can rejoin in 12 minutes.

You are in Kick Mode. Type /muslim reminder for chat-only alerts.
Not Muslim? Type /non-muslim to opt out.
(Your choice is saved permanently and survives restarts)

Learn More: /plugins/faithbreak

English Player (Reminder Mode — Chat Message)

⏰ Reminder: It's Fajr prayer time!
(You are in Reminder Mode. Use /muslim kick to enable strict kicking)

Arabic Player (Kick Screen)

حان وقت صلاة الفجر! يرجى أخذ استراحة.
يمكنك العودة بعد 12 دقيقة.

You are in Kick Mode. Type /muslim reminder for chat-only alerts.
Not Muslim? Type /non-muslim to opt out.
(Your choice is saved permanently and survives restarts)

معرفة المزيد: /plugins/faithbreak

⚙️ Configuration

# config.yml
debug-mode: false              # Detailed debug logging
log-player-locations: false    # Log player country/city (default: OFF)

❓ Frequently Asked Questions

Q: What's the difference between Kick Mode and Reminder Mode?
A: Kick Mode removes you from the server for 12 minutes during prayer. Reminder Mode sends you a chat message but lets you keep playing.

Q: Will my mode choice be remembered after I log off?
A: Yes! Your mode (Kick/Reminder/Opt-Out) is saved permanently to playerdata.yml.

Q: I was using /non-muslim from the old version — will my data be lost?
A: No! FaithBreak automatically migrates your old optout.yml data to the new system.

Q: Is my location logged to console?
A: Not by default! Location logging is OFF unless the server admin enables log-player-locations in config.

Q: How do I test the kick screen?
A: Use /fb kick Fajr (or any prayer name) as an OP - you can rejoin immediately!

Q: I'm not Muslim, will I get kicked?
A: No! Type /non-muslim once to permanently opt out.

Q: Can I change the language?
A: Yes! Use /fb lang <code> to change manually, or let the plugin auto-detect from your Minecraft client.

Q: What if I'm on a VPN or local network?
A: The plugin detects local/private IPs and disables itself for those connections.

Q: How do I add a new language?
A: Copy any existing language file from plugins/FaithBreak/messages/, rename it, translate, and restart!

🎯 Why Update to v1.4.0?

If you've wanted:

More control over how prayer times affect you
Chat-only reminders instead of being kicked
A smarter kick screen that explains your options
Tab completions for faster command typing

v1.4.0 delivers all of this!

🙏 Why I Made This

I made this plugin to help my fellow Muslim brothers and sisters stay on track with their prayer times.
Let's be real — it's easy to get completely lost in Minecraft and forget 😅
This plugin gives a gentle nudge at the right moment 🕌⏰

Also, fun fact: this plugin is automatically bundled with every plugin I make.
Check out my other creations on Modrinth! 😉✨

☕ Support Me on Ko-fi

If you like my work, consider buying me a coffee:

🤝 Contributing

Want to help improve FaithBreak?

🌐 Translate: Add your language by creating a new .yml file
🐛 Report Bugs: Contact me on Discord
💡 Suggest Features: Share your ideas!
⭐ Star & Share: Help others discover this plugin!

❓ Got questions?

Contact me on Discord

Made with ❤️ for the Muslim Minecraft community

JazakAllahu Khairan (May Allah reward you with goodness) for using FaithBreak! 🤲

FaithBreak