SweetLocks

# SweetLocks A nostalgic recreation of an old-fashion paid iron door plugin. > Default configurations are in Chinese. Check (https://github.com/mcio-dev/localization) repository for English or other language. ## Introduction Back when I played on a 1.6 server around the 1.8 era, there was a feature called **Paid Door**. You simply placed a sign on the block above an iron door: - First line: `` (something like that, similar to the `` lock sign in Lockette) - Second line: `Vault money price`, e.g. `100` - Third line: empty - Fourth line: flag - `I`, `O`, `E`, `NM`, `NP` mean: - `I` = Allow entry - `O` = Allow exit - `E` = Require empty inventory - `NM` = Require 0 Vault money - `NP` = Require no potion effects This creates a paid door. Players pay Vault money to teleport to the other side, perfect for lottery machines, security gates, etc. As far as I know, the original paid door plugin has been abandoned for a long time, so I decided to reimplement and improve it. The logic is actually quite simple. ## Legacy Version Compatibility Note Versions **below 1.14** only receive **limited support**. They are more likely to conflict with other plugins, and it is hard to identify which plugin causes the conflict. If any plugin runs `block.getState().update();` on a sign, the paid door will stop working. This is due to Bukkit's old API. Older versions only use the deprecated `§` color code for formatting, which erases text components the plugin uses to store data. ## Commands Root command: `/sweetlocks` Aliases: `/slocks`, `/locks`, `/sl` | Command | Description | Permission | |---------|-------------|------------| | `/locks` | Show help | None | | `/locks reload` | Reload config | OP/Console | ## Permissions - `sweet.locks.create` — Allow creating paid doors - `sweet.locks.bypass.tax` — Bypass tax on Vault money collected by the door creator - `sweet.locks.bypass.distance` — Bypass distance limit for using paid doors (default: within 2.6 blocks) ## Usage Just write `$lock` (or your custom keyword in config) on the **first line of a sign**. Once you finish placing the sign, a paid door with price `0 money` and allow entry/exit will be created, and the edit menu will open. The creator can **Shift + Right-click** the sign to open the edit menu, where they can set the price and flags for the door. When a player **right-clicks** the door, it shows: "Costs X coins to enter. Hold Shift + Right-click to enter/exit." Right-click the sign to view door info. ## Mechanism All paid door data is saved to the sign block using `item-nbt-api` which embedded into plugin. Transaction notifications are stored in a local data file and sent/cleared when the player logs in. - For **1.14+**: Data is stored in the block's **PersistentDataContainer**. - For versions **below 1.14**: Data is stored in the `insertion` field of the first sign line.