Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Add contribution information and goals / not a goal
  • Loading branch information
OneLiteFeather committed Jun 12, 2024
1 parent e7f0526 commit f6161a5
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,14 @@
# AntiRedstoneClock-Remastered
This plugin is inspired by https://gitlab.com/Trafalcraft/antiRedstoneClock
We re-created the whole code and improved everything. On top, we support Plotsquared v7 and Worldguard v7.

### Goal
The goal of this plugin is to detect redstone clocks, inform staff or console about active ones and optionally destroy / disable the redstone clocks so your server can save performance for something else. Also it can prevent players doing harm with heavy clocks, but this is more of a side effect.

We re-created the whole code and improved everything. On top, we support Plotsquared v7 and Worldguard v7.
### Not a goal
It's not planned to support Paper forks or spigot directly - this plugin is developed to work on Paper, if you are using a fork of paper or spigot and it doesn't work because of your fork, you are likely on your own then.
Also this plugin is not a "performance tool", it won't make your server run better directly.
Third, support from 1.13 backwards likely won't happen.

## Features
- 1.13+ Support
Expand All @@ -19,6 +24,9 @@ We re-created the whole code and improved everything. On top, we support Plotsqu
> [!CAUTION]
> The "world" world is ignored by default
## Contribution
You want to help us? Sure go for it, we would love to see your contribution! You can look for open issues or if you have a nice idea, please open an issue or ask us on discord if you can add your feature with a PR. Communication is key.

## Dependencies (soft-depend, can be used together)
- Plotsquared v7 https://github.com/IntellectualSites/PlotSquared
- Worldguard v7 https://github.com/EngineHub/WorldGuard
Expand Down

0 comments on commit f6161a5

Please sign in to comment.