AntiRedstoneClock-Remastered

AntiRedstoneClock-Remastered

A Paper plugin to detect and prevent harmful redstone clocks that waste server performance.

This plugin monitors for redstone clock activity, reports it to staff or console, and can optionally disable or remove the clocks. It is designed for administrators who want to keep their Minecraft servers stable and responsive without constant manual checks.

---

✨ Features

• Detects active redstone clocks
• Notifies staff and/or console of clock activity
• Optionally disables or removes clocks
• Support for PlotSquared v6 / v7
• Support for WorldGuard v7
• Sculk block detection included
• Works on Paper (not forks)
• Config reload and migration support (in progress)
• Prevents duplicate loading with other anti-clock plugins

❌ Not included / out of scope

• No guaranteed support for Spigot or Paper forks
• Not a generic performance booster (it prevents one specific lag cause only)
• No support for Minecraft < 1.19
• Backward-compatibility with old APIs or outdated forks

---

📦 Compatibility

• Minecraft: Only the latest two minor releases of each major version are supported.
  • Example: for 1.20 → 1.20.5 & 1.20.6, for 1.21 → 1.21.1 & 1.21.2
• Server software: Paper only
• Java: 21+
• Soft dependencies:
  • PlotSquared v7
  • WorldGuard v7

Unsupported: Purpur, Spigot, Bukkit, Folia, and forks.

---

⚙️ Installation & Configuration

1. Download the latest release:
   • 📥 Modrinth
   • 📥 Hangar
   • 📥 GitHub Releases
2. Place the .jar file into your server’s /plugins folder.
3. Restart your server.
4. Edit the generated config.yml to adjust detection thresholds and actions.
5. Run /arcm reload to apply changes.

By default, the world named world is ignored. Adjust the config if necessary.

---

🛠 Usage

Commands

• /arcm reload — reloads the configuration
• /arcm help — shows available commands
• /arcm display — lists currently cached clocks

Permissions

• antiredstoneclockremastered.notify.admin — receive clock notifications
• Other permissions are documented in plugin.yml and visible via LuckPerms.

---

📑 Support Policy

We provide support for:

• Verified bugs on Paper with supported Minecraft versions
• Configuration issues not covered by the FAQ

We do not provide support for:

• Outdated Minecraft versions
• Spigot, Purpur, Folia, or Paper forks
• Custom builds or modified code
• Requests for unrelated performance tuning

Check the FAQ before opening an issue. If your case is unsupported, issues may be closed without response.

---

❓ FAQ / Troubleshooting

Q: The plugin does nothing on my Spigot/Purpur server.
A: Unsupported. Use Paper.

Q: My server is on 1.20.1, will this work?
A: No. Only the latest two minor releases are supported, e.g. 1.20.5 & 1.20.6.

Q: Can I contribute translations?
A: Yes! We manage translations via Crowdin. Anyone can join and help improve language coverage.

Q: I still see lag after installing.
A: This plugin only prevents redstone clocks from running unchecked. It is not a general performance plugin.

---

📅 Versioning & Release Cycle

• Follows Semantic Versioning: MAJOR.MINOR.PATCH
• Releases automated with semantic-release
• Breaking changes increment MAJOR, new features increment MINOR, fixes increment PATCH

See: semver.org

---

🤝 Contributing

• Report bugs and request features via GitHub Issues
• Submit pull requests with clear commit messages (we use Conventional Commits)
• Join our Discord for discussions

---

📜 License

Released under the AGPL-3.0 License.

Commercial servers must comply with AGPL terms.

---