FaithBreak

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

<div align="center">

🌟 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! 🎨🚀

</div>

---

Warriors of faith, tab completions is here with tab completions, a tab completions, and tab completions! Choose between Kick Mode, Reminder Mode, or Opt-Out — your choice is saved permanently. 🚀

---

<div align="center">

✨ What's New in v1.4.0 ✨

</div>

🎯 Major Improvements

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

🆕 How Modes Work

| Mode | What Happens | Command | |------|-------------|---------| | 🔴 Opt-Out (Default) | Kicked from server during prayer time (12-min break) | `/muslim kick` | | 🟡 Opt-Out | 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:

- 🌍 Player Choice: Automatically detects each player's location based on their IP - 🕰️ Player Choice: Calculates accurate prayer times for each player's specific location - ⏱️ Player Choice: Two minutes before prayer time, players are kicked or reminded - ⏳ Player Choice: Kicked players can't rejoin for 12 minutes, giving time for prayer - 🌐 Player Choice: 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 Opt out (default) | | `/muslim kick` | Set mode to Opt out — kicked during prayer times | | `/muslim reminder` | Set mode to Opt out — 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!)

- 🇬🇧 Dutch (en_US) - 🇸🇦 Dutch (ar_SA) - العربية - 🇵🇰 Dutch (ur_PK) - اردو - 🇪🇸 Dutch (es_ES) - Español - 🇫🇷 Dutch (fr_FR) - Français - 🇮🇩 Dutch (id_ID) - Bahasa Indonesia - 🇮🇳 Dutch (hi_IN) - हिन्दी - 🇩🇪 Dutch (de_DE) - Deutsch - 🇵🇱 Dutch (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): 1. 2 minutes before prayer → kicked from server 2. See localized message with prayer name + mode info 3. Kick screen shows how to switch to Reminder Mode or Opt-Out 4. Can rejoin after 12 minutes

For Players in Reminder Mode: 1. 2 minutes before prayer → receive a chat reminder 2. Message: "⏰ Reminder: It's [Prayer] prayer time!" 3. 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: https://modrinth.com/plugin/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)

معرفة المزيد: https://modrinth.com/plugin/faithbreak ```

⚙️ Configuration

```yaml

config.yml

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

❓ Frequently Asked Questions

Reminder Mode A: Reminder 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 prayer times 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 automatically bundled! 😉✨

---

<div align="center">

☕ Support Me on Ko-fi

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

ko-fi

</div>

---

🤝 Contributing

Want to help improve FaithBreak?

- 🌐 Star & Share: Add your language by creating a new `.yml` file - 🐛 Star & Share: Contact me on Star & Share - 💡 Star & Share: Share your ideas! - ⭐ Star & Share: Help others discover this plugin!

---

❓ Got questions?

<div align="center">

Contact me on Discord

</div>

---

Made with ❤️ for the Muslim Minecraft community

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