62 lines
2.3 KiB
Markdown
62 lines
2.3 KiB
Markdown
# Trigger Spawn
|
|
|
|
A Spigot 26.2 plugin providing progression-gated, safe teleportation to each world's spawn area.
|
|
|
|
Players unlock `/spawn` by killing a Warden, Ender Dragon, or Wither after the plugin is installed. Their first, second, and third unique kills give default cooldowns of 8 hours, 4 hours, and 1 hour respectively. Each new unique kill clears the current cooldown immediately; repeated kills of the same boss do not count.
|
|
|
|
`/spawn` uses real elapsed cooldown time, including time offline. An accepted request displays a three-second countdown. Walking to another block, jumping, falling, teleporting, changing worlds, or disconnecting cancels it; looking around does not. The plugin samples a safe destination in the current world's circular spawn area, and failures do not consume the cooldown.
|
|
|
|
The behavior under development 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/`.
|
|
|
|
On first startup, the plugin creates `plugins/TriggerSpawn/config.yml`. Its cooldown defaults are:
|
|
|
|
```yaml
|
|
cooldowns:
|
|
one-kill-seconds: 28800
|
|
two-kill-seconds: 14400
|
|
three-kill-seconds: 3600
|
|
```
|
|
|
|
Durable player and per-world state is stored in `plugins/TriggerSpawn/state.yml`.
|
|
|
|
Each world initially uses its native spawn and a 20-block circular radius. An operator can configure the current world with:
|
|
|
|
```text
|
|
/spawnadmin set
|
|
/spawnadmin distance <blocks>
|
|
/spawnadmin info
|
|
/spawnadmin grant <player> <duration>
|
|
/spawnadmin remove <player>
|
|
/spawnadmin access [page]
|
|
/spawnadmin ban <player>
|
|
/spawnadmin unban <player>
|
|
/spawnadmin bans [page]
|
|
```
|
|
|
|
Grant durations support friendly units and combinations such as `30m`, `2h`, `1d`, or `1h30m`.
|
|
|
|
For a local versioned build:
|
|
|
|
```bash
|
|
./gradlew clean check jar -PreleaseVersion=1.2.3
|
|
```
|
|
|
|
## Releases
|
|
|
|
Gitea Actions checks every push and pull request and stores a development JAR as a workflow artifact. Pull requests also validate conventional commits.
|
|
|
|
Pushes to `main` run semantic-release. A release-causing conventional commit builds a versioned JAR and attaches it to the corresponding public Gitea release. The repository must define a `RELEASE_TOKEN` secret with repository contents write permission.
|