v9.6.0 - LabApi 1.1.7

.github/FUNDING.yml

@@ -0,0 +1,15 @@
+# These are supported funding model platforms
+
+github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+patreon: # Replace with a single Patreon username
+open_collective: ucs
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
+polar: # Replace with a single Polar username
+buy_me_a_coffee: # Replace with a single Buy Me a Coffee username
+thanks_dev: # Replace with a single thanks.dev username
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

README.md

@@ -1,4 +1,4 @@
-<div align="center"><a href="https://github.com/UncomplicatedCustomServer/UncomplicatedCustomRoles/releases/latest"><img src="https://img.shields.io/github/v/release/UncomplicatedCustomServer/UncomplicatedCustomRoles"></a> <a href="https://github.com/UncomplicatedCustomServer/UncomplicatedCustomRoles/releases/latest"><img src="https://img.shields.io/github/downloads/UncomplicatedCustomServer/UncomplicatedCustomRoles/total"></a> <a href="https://github.com/UncomplicatedCustomServer/UncomplicatedCustomRoles/pulls"><img src="https://img.shields.io/github/issues-pr/UncomplicatedCustomServer/UncomplicatedCustomRoles"></a> <a href="https://github.com/UncomplicatedCustomServer/UncomplicatedCustomRoles/pulls"><img src="https://img.shields.io/github/issues-pr-closed/UncomplicatedCustomServer/UncomplicatedCustomRoles"></a> <a href="https://github.com/UncomplicatedCustomServer/UncomplicatedCustomRoles/commits/main/"><img src="https://badgen.net/github/commits/UncomplicatedCustomServer/UncomplicatedCustomRoles/main"></a> <img src="https://img.shields.io/badge/Verified_Exiled_Plugin-ss">
+<div align="center"><a href="https://github.com/UncomplicatedCustomServer/UncomplicatedCustomRoles/releases/latest"><img src="https://img.shields.io/github/v/release/UncomplicatedCustomServer/UncomplicatedCustomRoles"></a> <a href="https://github.com/UncomplicatedCustomServer/UncomplicatedCustomRoles/releases/latest"><img src="https://img.shields.io/github/downloads/UncomplicatedCustomServer/UncomplicatedCustomRoles/total"></a> <a href="https://github.com/UncomplicatedCustomServer/UncomplicatedCustomRoles/pulls"><img src="https://img.shields.io/github/issues-pr/UncomplicatedCustomServer/UncomplicatedCustomRoles"></a> <a href="https://github.com/UncomplicatedCustomServer/UncomplicatedCustomRoles/pulls"><img src="https://img.shields.io/github/issues-pr-closed/UncomplicatedCustomServer/UncomplicatedCustomRoles"></a> <a href="https://github.com/UncomplicatedCustomServer/UncomplicatedCustomRoles/commits/main/"><img src="https://badgen.net/github/commits/UncomplicatedCustomServer/UncomplicatedCustomRoles/main"></a> <a href="https://opencollective.com/ucs"><img src="https://img.shields.io/opencollective/all/ucs?label=OpenCollective%20backers&color=7FADF2"></a>
 
   <img src="https://raw.githubusercontent.com/UncomplicatedCustomServer/UncomplicatedCustomRoles/refs/heads/resources/ucr_promo_banner.png">
   <i>Easy, fully configurable and customizable custom roles for your SCP:SL Server!</i>
@@ -9,8 +9,11 @@
   <br><br>
 </div>
 
-**LabAPI** >= `v1.x`
-<br><br>
+## Requirements
+- **LabAPI** >= `v1.x`
+- **Harmony** (`0Harmony.dll`) >= `v2.x`
+
+<br>
 
 ## Localized READMEs
 - [&#127467;&#127479; Français](https://github.com/UncomplicatedCustomServer/UncomplicatedCustomRoles/blob/main/Localization/README-FR.md)
@@ -20,26 +23,42 @@
 - [&#127477;&#127473; Polski](https://github.com/UncomplicatedCustomServer/UncomplicatedCustomRoles/blob/main/Localization/README-PL.md)
 - [🇨🇳 简体中文](https://github.com/UncomplicatedCustomServer/UncomplicatedCustomRoles/blob/main/Localization/README-CN.md)
 
+> [!NOTE]
+> The localized READMEs are written and updated by volunteers from the community, so they can fall behind this one.
+> If a translation is missing something, or says something different, **this English README is the one that is up to date**.
+
 ## What's UncomplicatedCustomRoles
-**UncomplicatedCustomRoles** or **UCR** is a plugin for **LabAPI** that allow you to create fully configurable and customizable custom role with YAML.\
+**UncomplicatedCustomRoles** or **UCR** is a plugin for **LabAPI** that lets you create fully configurable and customizable custom roles with YAML.\
+A custom role starts from a normal SCP:SL role and changes whatever you want about it: health, items, effects, spawn point, team, custom info and much more.\
 With UCR, you can fully customize your Custom Roles by modifying almost every setting, allowing you to create whatever you can imagine: the only limit is your imagination
 
 ## Features
 ### 🖥️ Fully customizable Custom Roles
-Let your imagination run wild with virtually complete customization of the basic roles.\
-Health, tags, role, name, special mechanics: make your SCP:SL server one-of-a-kind!
-### 🫂 Active community on Discord
-Join our Discord community to chat with other users and even the developers!\
-Interact, ask for help, share your knowledge and your roles: we’d love to have you!
-### 📑 Exaustive documentation
-Check out the [official UCR documentation](https://docs.ucr.ucserver.it/), where you'll find everything you need to use the plugin: from getting started to advanced settings!
+Health, AHP, hume shield, stamina, scale, nickname, badge, role name, custom info, effects, damage multiplier, inventory, ammo, item limits and custom items: make your SCP:SL server one-of-a-kind!
+### 🎯 Spawns exactly where and when you want
+Pick how every role spawns: a random room, a whole zone, specific rooms, a spawn point you saved in-game, the position of another role, the Class-D cells, or simply wherever the player already is.\
+Then tune when it happens: spawn chance, spawn delay, how many can be alive at the same time, the minimum amount of players, which vanilla roles it may replace and the permission a player needs to get it.
+### 🧩 More than 25 built-in modules
+Add extra mechanics to a role with a single line of config: damage resistance, life stealing, custom keycard permissions, item bans, pacifism until the role takes damage, silent footsteps, tesla gates and SCP-096 that ignore the role, a fake team, a custom custom info layout, a schematic attached to the player, and many more.
+### 🚪 Escape system
+Decide whether a role can escape and which role it becomes afterwards — with a different outcome depending on whether it escaped free or cuffed, and by whom — and let it keep its inventory on the way out.
+### 🔗 Plays well with your other plugins
+UCR integrates out of the box with **UncomplicatedCustomItems**, **UncomplicatedCustomTeams**, **Exiled CustomItems**, **ScriptedEvents**, **SLWardrobe**, **RespawnTimer** and **LabApiExtensions**.
+### 🧪 Built-in role validator
+Every role is checked while it is being loaded, and UCR tells you in the console what is wrong with it, so a typo in a config does not turn into a broken round.
+### ⌨️ In-game commands
+Manage your custom roles using the many built-in commands provided by UCR:\
+`ucr list`, `ucr info`, `ucr role`, `ucr spawn`, `ucr cinfo`, `ucr reload`, `ucr spawnpoint`, `ucr percentages`, `ucr errors`, `ucr generate`, `ucr update`, `ucr version` and more.
 ### 🗂️ YAML based
 You don't need to know how to code to use UCR: custom roles are created using `yml` ([YAML](https://en.wikipedia.org/wiki/YAML)) files, an extremely easy and intuitive serialization language!
+### 📑 Exhaustive documentation
+Check out the [official UCR documentation](https://docs.ucr.ucserver.it/), where you'll find everything you need to use the plugin: from getting started to advanced settings!
 ### 🔌 Designed for developers
 UCR was also designed to make life easier for developers: integrating with the plugin is simple, intuitive, and well-documented!\
 [Check it out!](https://docs.ucr.ucserver.it/developers/intro)
-### ⌨️ In-game commands
-Manage your custom roles using the many built-in commands provided by UCR.
+### 🫂 Active community on Discord
+Join our Discord community to chat with other users and even the developers!\
+Interact, ask for help, share your knowledge and your roles: we’d love to have you!
 
 ## Bugs and plan
 To track bugs and UCR planning, UCSC has made a FlySpray instance available.\
@@ -50,12 +69,14 @@ Check the [documentation](https://docs.ucr.ucserver.it/getting-started/installat
 
 ## If you use UCR, please consider making a donation
 UCR is a plugin made by **UCS Collective**.\
-Every plugin we create is **free** and **open-source**.\
-Please consider donating something to support our work through **OpenCollective**: 
+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 UCR is running on your server, **please consider donating something through OpenCollective** — every contribution, however small, goes straight back into the plugins you are using:
+
 <a href="https://opencollective.com/ucs"><img height="15" src="https://raw.githubusercontent.com/UncomplicatedCustomServer/UncomplicatedCustomRoles/refs/heads/resources/oc_icon.png">&nbsp;&nbsp;Donate</a>
 
 ## Contacts
-### UncomplicatedCustomRoles
+### UCS - UncomplicatedCustomServer
   **Discord:** [https://discord.gg/5StRGu8EJV](https://discord.gg/5StRGu8EJV)
 
 ### FoxWorn3365
@@ -67,9 +88,9 @@ Please consider donating something to support our work through **OpenCollective*
   **Discord:** `dr.agenda`
 
 ## Translation Credits
-**French:** `@robocnop`\
-**Italian:** `@foxworn`\
-**Russian:** `@naxefir`\
+**Français:** `@robocnop`\
+**Italiano:** `@foxworn`\
+**Русский:** `@naxefir`\
 **Deutsch:** `@seekedstroy`\
-**Polish:** `@.piwnica2137`\
-**Simplified Chinese** `@Raiden-Yayi`
+**Polski:** `@.piwnica2137`\
+**简体中文:** `@Raiden-Yayi`

UncomplicatedCustomRoles/API/Attributes/PluginCustomRole.cs

@@ -1,17 +1,18 @@
 /*
  * This file is a part of the UncomplicatedCustomRoles project.
- * 
+ *
  * Copyright (c) 2023-present FoxWorn3365 (Federico Cosma) <me@fcosma.it>
- * 
+ *
  * This file is licensed under the GNU Affero General Public License v3.0.
  * You should have received a copy of the AGPL license along with this file.
  * If not, see <https://www.gnu.org/licenses/>.
  */
 
 using System;
 
-namespace UncomplicatedCustomRoles.API.Attributes
+namespace UncomplicatedCustomRoles.API.Attributes;
+
+[AttributeUsage(AttributeTargets.Class)]
+public class PluginCustomRole : Attribute
 {
-    [AttributeUsage(AttributeTargets.Class)]
-    public class PluginCustomRole : Attribute { }
-}
+}

UncomplicatedCustomRoles/API/Enums/CustomFlags.cs

@@ -1,40 +1,39 @@
 /*
  * This file is a part of the UncomplicatedCustomRoles project.
- * 
+ *
  * Copyright (c) 2023-present FoxWorn3365 (Federico Cosma) <me@fcosma.it>
- * 
+ *
  * This file is licensed under the GNU Affero General Public License v3.0.
  * You should have received a copy of the AGPL license along with this file.
  * If not, see <https://www.gnu.org/licenses/>.
  */
 
 using System;
 
-namespace UncomplicatedCustomRoles.API.Enums
+namespace UncomplicatedCustomRoles.API.Enums;
+
+[Flags]
+public enum CustomFlags
 {
-    [Flags]
-    public enum CustomFlags
-    {
-        NotExecutable = -1,
-        None = 0,
-        DoNotTriggerTeslaGates = 1 << 0,
-        LifeStealer = 1 << 1,
-        HalfLifeStealer = 1 << 2,
-        NotAffectedByAppearance = 1 << 3,
-        PacifismUntilDamage = 1 << 4,
-        CustomScpAnnouncer = 1 << 5,
-        ShowOnlyCustomInfo = 1 << 6,
-        SilentWalker = 1 << 7,
-        SilentAnnouncer = 1 << 8,
-        TutorialRagdoll = 1 << 9,
-        DoNotTrigger096 = 1 << 10,
-        BanKeycards = 1 << 11,
-        BanMedicals = 1 << 12,
-        BanRadios = 1 << 13,
-        BanFirearms = 1 << 14,
-        BanGrenades = 1 << 15,
-        BanSCPItems = 1 << 16,
-        BanMicroHID = 1 << 17,
-        BanArmors = 1 << 18,
-    }
+    NotExecutable = -1,
+    None = 0,
+    DoNotTriggerTeslaGates = 1 << 0,
+    LifeStealer = 1 << 1,
+    HalfLifeStealer = 1 << 2,
+    NotAffectedByAppearance = 1 << 3,
+    PacifismUntilDamage = 1 << 4,
+    CustomScpAnnouncer = 1 << 5,
+    ShowOnlyCustomInfo = 1 << 6,
+    SilentWalker = 1 << 7,
+    SilentAnnouncer = 1 << 8,
+    TutorialRagdoll = 1 << 9,
+    DoNotTrigger096 = 1 << 10,
+    BanKeycards = 1 << 11,
+    BanMedicals = 1 << 12,
+    BanRadios = 1 << 13,
+    BanFirearms = 1 << 14,
+    BanGrenades = 1 << 15,
+    BanSCPItems = 1 << 16,
+    BanMicroHID = 1 << 17,
+    BanArmors = 1 << 18
 }

UncomplicatedCustomRoles/API/Enums/DamageType.cs

@@ -8,63 +8,62 @@
  * If not, see <https://www.gnu.org/licenses/>.
  */
 
-namespace UncomplicatedCustomRoles.API.Enums
+namespace UncomplicatedCustomRoles.API.Enums;
+
+public enum DamageType
 {
-    public enum DamageType
-    {
-        Unknown,
-        Falldown,
-        Warhead,
-        Decontamination,
-        Asphyxiation,
-        Poison,
-        Bleeding,
-        Firearm,
-        MicroHid,
-        Tesla,
-        Scp,
-        Explosion,
-        Scp018,
-        Scp207,
-        Recontainment,
-        Crushed,
-        FemurBreaker,
-        PocketDimension,
-        FriendlyFireDetector,
-        SeveredHands,
-        SeveredEyes,
-        Custom,
-        Scp049,
-        Scp096,
-        Scp173,
-        Scp939,
-        Scp0492,
-        Scp106,
-        Crossvec,
-        Logicer,
-        Revolver,
-        Shotgun,
-        AK,
-        Com15,
-        Com18,
-        Fsp9,
-        E11Sr,
-        Hypothermia,
-        ParticleDisruptor,
-        CardiacArrest,
-        Com45,
-        Jailbird,
-        Frmg0,
-        A7,
-        Scp3114,
-        Strangled,
-        Marshmallow,
-        Scp1507,
-        Scp956,
-        SnowBall,
-        Scp127,
-        Silent,
-        GrayCandy,
-        Scp1509,
-    }
+    Unknown,
+    Falldown,
+    Warhead,
+    Decontamination,
+    Asphyxiation,
+    Poison,
+    Bleeding,
+    Firearm,
+    MicroHid,
+    Tesla,
+    Scp,
+    Explosion,
+    Scp018,
+    Scp207,
+    Recontainment,
+    Crushed,
+    FemurBreaker,
+    PocketDimension,
+    FriendlyFireDetector,
+    SeveredHands,
+    SeveredEyes,
+    Custom,
+    Scp049,
+    Scp096,
+    Scp173,
+    Scp939,
+    Scp0492,
+    Scp106,
+    Crossvec,
+    Logicer,
+    Revolver,
+    Shotgun,
+    AK,
+    Com15,
+    Com18,
+    Fsp9,
+    E11Sr,
+    Hypothermia,
+    ParticleDisruptor,
+    CardiacArrest,
+    Com45,
+    Jailbird,
+    Frmg0,
+    A7,
+    Scp3114,
+    Strangled,
+    Marshmallow,
+    Scp1507,
+    Scp956,
+    SnowBall,
+    Scp127,
+    Silent,
+    GrayCandy,
+    Scp1509
 }

UncomplicatedCustomRoles/API/Enums/LoadStatusType.cs

@@ -1,19 +1,19 @@
 /*
  * This file is a part of the UncomplicatedCustomRoles project.
- * 
+ *
  * Copyright (c) 2023-present FoxWorn3365 (Federico Cosma) <me@fcosma.it>
- * 
+ *
  * This file is licensed under the GNU Affero General Public License v3.0.
  * You should have received a copy of the AGPL license along with this file.
  * If not, see <https://www.gnu.org/licenses/>.
  */
 
-namespace UncomplicatedCustomRoles.API.Enums
+namespace UncomplicatedCustomRoles.API.Enums;
+
+public enum LoadStatusType
 {
-    public enum LoadStatusType
-    {
-        Success,
-        ValidatorError,
-        SameId
-    }
-}
+    Success,
+    ValidatorError,
+    SameId,
+    Denied
+}