Updated README.md to fit current situation
This commit is contained in:
parent
089b2a9368
commit
a4eaa53b23
1 changed files with 37 additions and 0 deletions
37
README.md
Normal file
37
README.md
Normal file
|
|
@ -0,0 +1,37 @@
|
||||||
|
# QoL-tweaks
|
||||||
|
|
||||||
|
A quality-of-life SMP plugin for Paper/Folia.
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
- **Join messages** — friendly welcome messages, including a first-join message that lists the server's plugins, and a special announcement when the owner logs in.
|
||||||
|
- **`/nopvp`** — toggle no-PvP mode. While active you cannot damage other players and other players cannot damage you (direct hits and projectiles). While enabled you also glow so everyone can see you're protected. Turning no-PvP *off* starts a **1-hour cooldown** before you can enable it again, and the state persists across restarts so relogging can't bypass it.
|
||||||
|
|
||||||
|
## Commands
|
||||||
|
|
||||||
|
| Command | Description | Permission |
|
||||||
|
|----------|--------------------------------------------------------------------------|-----------------------|
|
||||||
|
| `/nopvp` | Toggle no-PvP mode (damage immunity vs. players + player glow). | `qoltweaks.nopvp` |
|
||||||
|
|
||||||
|
All permissions default to `true`.
|
||||||
|
|
||||||
|
## Data
|
||||||
|
|
||||||
|
Player no-PvP state and cooldown timestamps are stored in `plugins/qol-tweaks/nopvp.yml` so they survive restarts and reloads.
|
||||||
|
|
||||||
|
## Compatibility
|
||||||
|
|
||||||
|
- Built against the Paper API and marked `folia-supported: true`, so it runs on both Paper and Folia. Region-aware scheduling is used for persistence writes.
|
||||||
|
- Java 25 toolchain.
|
||||||
|
|
||||||
|
## Building
|
||||||
|
|
||||||
|
```bash
|
||||||
|
./gradlew build
|
||||||
|
```
|
||||||
|
|
||||||
|
The plugin jar is output to `build/libs/`.
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
See [LICENSE](LICENSE).
|
||||||
Loading…
Add table
Add a link
Reference in a new issue