Easy, fully configurable and customizable escape zones for your SCP:SL Server!
- LabAPI >=
v1.1.7 - UncomplicatedCustomRoles (optional) — only needed if you want to use UCR Custom Roles inside your escape zones
- UncomplicatedCustomTeams (optional) — only needed if you want to match your escape zones against UCT Custom Teams
UncomplicatedCustomEscapeZones or UCEZ is a plugin for LabAPI that lets you replace the vanilla escape zone
with as many custom ones as you want, defined with YAML.
An escape zone is just a box somewhere on the map: you decide where it is, how big it is, who is allowed to escape
through it and which role every escaping player becomes — including UCR Custom Roles.
The default SCP:SL escape zone is removed when the plugin loads, so your zones are the only way out.
A zone is a box (a center and a size) that you can either pin to a room — so it follows that room wherever the map
generator puts it — or place at absolute map coordinates. Create as many of them as you like, each one in its own yml
file.
For every team, faction, role or UCR Custom Role you can decide what happens on escape: turn into another vanilla role, turn into a UCR Custom Role, or simply be denied the escape.
The result can change depending on who disarmed the escaping player — by team, by faction, by vanilla role or by UCR Custom Role — so a cuffed Class-D can become an NTF Private while a free one becomes a Chaos Conscript.
UCEZ talks to UCR out of the box: use your UCR Custom Role Ids both as the condition (who is escaping / who cuffed
them) and as the result of the escape. The CustomTeam module is supported as well, so an entire custom team can
share one escape configuration, and a role that fakes its team is evaluated with the team it is faking.
UCT Custom Teams work the same way: match a whole team by its name or by its Id. Both plugins are soft
dependencies — they are only needed if you actually use them in a config.
Every zone folder exists both globally and per server port, so servers sharing the same config folder can have their own escape zones.
Manage your escape zones from the Remote Admin console: ucez reload, ucez outline and ucez getposition.
You don't need to know how to code to use UCEZ: escape zones are created using yml
(YAML) files, an extremely easy and intuitive serialization language!
Check out the official UCEZ documentation, where you'll find everything you need to use the plugin: from getting started to advanced settings!
- Download the latest release from the GitHub Releases.
- Place the
.dllfile into yourLabApi/plugins/globaldirectory. - Restart your server to generate the configuration files.
- Configure your custom escape zones in the generated configuration files.
The documentation walks you through the same steps in detail.
UCEZ is a plugin made by UCS Collective.
Every plugin we create is free and open-source, and it always will be.
What there is, is the time we spend writing the plugin, answering your questions on Discord and keeping everything
working after every SCP:SL update.
If UCEZ is running on your server, please consider donating something through OpenCollective — every contribution,
however small, goes straight back into the plugins you are using:
DonateDocumentation: https://docs.ucez.ucserver.it
Discord: https://discord.gg/5StRGu8EJV
Discord: @foxworn
Email: foxworn3365@gmail.com
Discord: @medvemarci