tweaks724/README.md

This is alpha software, so it's likely something won't work properly. \
Please report all suspicious behavior. You can do so on any of those:
- https://git.m724.eu/Minecon724/tweaks724/issues
- https://discord.gg/86X4Z5JUeq
- https://www.spigotmc.org/threads/tweaks724.670906/

---

# tweaks724

Stuff no<sub><sup>t many</sup></sub> other plugins do.

Dependencies:
- **1.21.1** this is mandatory as the plugin uses NMS for some stuff\
  The focus is on [a widely used version](https://bstats.org/global/bukkit) that has [good mod support](https://modrinth.com/modpack/fabulously-optimized/versions?c=release) 
- [ProtocolLib](https://www.spigotmc.org/resources/protocollib.1997/) (optional, but you lose a lot)

# Features

Those with <sup>P</sup> need ProtocolLib

### Expand world border
Expands the world border to 30,000,000 (from 29,999,984)

### Hide world border <sup><sup><sub>P</sub></sup></sup>
Hides the world border. It's still there, just invisible.

### Server brand <sup><sup><sub>P</sub></sup></sup>
Modify the F3 brand, optionally include player's ping and server performance

### Doors
Open two doors with one click. Knock on doors.

### MOTD <sup><sup><sub>P</sub></sup></sup>
Random MOTD for every ping

### Chat rooms
Chat rooms players can freely create and join. Alerts like death and join messages are only within the player's chat room.

### Compass
Holding a compass shows a bar with 4 directions and stuff like beds, lodestones, death pos (TODO) etc.

### Pomodoro
Self-discipline with a pomodoro timer that's actually forced

### Updater
Updates ALL* your plugins \
<sub>*Those on SpigotMC and that release updates there</sub>

### Hardcore <sup><sup><sub>P</sub></sup></sup>
Hardcore hearts by chance

### Sleep
Sleeping doesn't skip night, but speeds it up. The more players, the faster it goes.

### Instant sleep
One can instantly skip, but only a part of the night. \
There's 5 players on the server. A night is 10 minutes long. \
Each player can instantly skip 2 minutes of the night at any time, even if others aren't sleeping

### Authentication
Players are given a unique subdomain like "<key>.example.com" and they must use it to join \
It can be enabled that new players can't join the server without a key

# Commands
### /chat
Changes chatroom

### /chatmanage
`tweaks724.chatmanage` \
Manages chatroom, like create, delete etc.

### /ping
Displays your ping. \
**Ping is calculated by the plugin**. \
That allows for more precision (decimal places) and to get the ping immediately after a player join

### /pomodoro
`tweaks724.pomodoro` \
Manage your pomodoro
- `/pom start` to start
- `/pom stop` to stop
- `/pom` to skip stage

### /tauth
`tweaks724.tauth` \
Manages authentication keys.
- `/tauth <key>` to see who the key is bound to
- `/tauth new` to create a key
- `/tauth delete <key>` to delete a key