Files
spigot-leaf/README.md
T

42 lines
1.1 KiB
Markdown

# Leaf
Leaf is a Spigot 26.2 plugin that lets non-aggressive players opt into visible Resistance protection.
The approved behavior is specified in the [OKF design bundle](design/index.md).
## Requirements
- Spigot 26.2
- Java 17 or newer
## Build
```bash
./gradlew clean check jar
```
The plugin JAR is written to `build/libs/`.
## Commands
```text
/leaf on
/leaf off
/leaf status
/leaf enabled <on|off>
/leaf strength <1-5>
/leaf player <name|uuid> status
/leaf player <name|uuid> enabled <on|off>
/leaf player <name|uuid> locked <on|off>
```
Administrative commands require `leaf.admin`, granted to server operators by default.
## Compatibility
Leaf will use standard Spigot facilities for tab-list, overhead-name, and chat prefixes. Scoreboard or chat-management plugins may override those facilities; unsupported integrations must not affect protection state.
## Releases
Gitea Actions checks pushes and pull requests and stores a development JAR. Pull requests validate conventional commits. Main-branch conventional commits drive semantic releases after the repository defines a `RELEASE_TOKEN` with contents-write permission.