Merge pull request #70 from UncomplicatedCustomServer/dev-main

UCR v9.0.0 for EXILED - Release Candidate I

Author: FoxWorn3365

CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+contact@ucserver.it.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

CONTRIBUTING.md

@@ -0,0 +1,45 @@
+# Contributing
+
+Thank you for your interest in contributing to UncomplicatedCustomServer! We develop Open Source plugins for EXILED and LabAPI.
+
+## Getting Started
+
+1. Fork the repository
+2. Clone your fork: `git clone https://github.com/yourusername/repository-name.git`
+3. Create a new branch: `git checkout -b feature/your-feature-name`
+4. Make your changes
+5. Commit your changes: `git commit -m "feat: add new feature"`
+6. Push to your fork: `git push origin feature/your-feature-name`
+7. Create a Pull Request
+
+## Requirements
+
+- .NET 8.0 SDK or higher
+- Visual Studio 2022 or JetBrains Rider (recommended)
+- Basic knowledge of C# and EXILED/LabAPI
+
+## Coding Standards
+
+- Follow C# naming conventions
+- Add XML documentation for public APIs
+- Use proper exception handling
+- Test your changes on an actual SCP:SL server when possible
+
+## Pull Requests
+
+- Use clear, descriptive titles
+- Describe what your changes do
+- Ensure the project builds successfully
+- Test functionality when possible
+- Link related issues
+
+## Issues
+
+- Check existing issues before creating new ones
+- Use clear titles and detailed descriptions
+- Include steps to reproduce bugs
+- Mention your environment details
+
+---
+
+Thank you for contributing!

UncomplicatedCustomRoles/API/Features/CustomModules/ColorfulNickname.cs

@@ -0,0 +1,34 @@
+/*
+ * 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.Collections.Generic;
+
+namespace UncomplicatedCustomRoles.API.Features.CustomModules
+{
+    public class ColorfulNickname : CustomModule
+    {
+        public override List<string> RequiredArgs => new()
+        {
+            "color"
+        };
+
+        internal string Color => TryGetStringValue("color", string.Empty);
+
+        public override void OnAdded()
+        {
+            if (Color == string.Empty)
+                return;
+
+            string nick = CustomRole.Player.DisplayNickname.Replace("<color=#855439>*</color>", "");
+            string color = Color.StartsWith("#") ? Color : $"#{Color}";
+            CustomRole.Player.CustomInfo = CustomRole.Player.CustomInfo.Replace(nick, $"<color={color}>{nick}</color>");
+        }
+    }
+}

UncomplicatedCustomRoles/API/Features/CustomModules/CustomModule.cs

@@ -12,6 +12,7 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
+using UncomplicatedCustomRoles.Extensions;
 using UncomplicatedCustomRoles.Manager;
 
 namespace UncomplicatedCustomRoles.API.Features.CustomModules
@@ -45,14 +46,19 @@ public virtual string Name
         /// Gets the args of the current <see cref="CustomModule"/>
         /// </summary>
         /// <remarks>Every value is a <see cref="string"/></remarks>
-        public Dictionary<string, string> Args { get; private set; }
+        public Dictionary<string, object> Args { get; private set; }
+
+        /// <summary>
+        /// Gets the args of the current <see cref="CustomModule"/> with the value converted as string
+        /// </summary>
+        public Dictionary<string, string> StringArgs => Args.ConvertToString();
 
         /// <summary>
         /// Gets the instance of the <see cref="SummonedCustomRole"/> in which the current <see cref="CustomModule"/> is embedded
         /// </summary>
         public SummonedCustomRole CustomRole { get; private set; }
 
-        internal void Initialize(SummonedCustomRole summonedCustomRole, Dictionary<string, string> args)
+        internal void Initialize(SummonedCustomRole summonedCustomRole, Dictionary<string, object> args)
         {
             CustomRole = summonedCustomRole;
             Args = args;
@@ -87,24 +93,32 @@ public virtual void OnRemoved()
         public virtual void Execute()
         { }
 
+        /// <summary>
+        /// Try to get a generic <see cref="object"/> value from the <see cref="Args"/> and if not present just return a default value.
+        /// </summary>
+        /// <param name="param"></param>
+        /// <param name="def"></param>
+        /// <returns></returns>
+        public object TryGetValue(string param, object def = null) => Args.TryGetValue(param, out object value) ? value : def;
+
         /// <summary>
         /// Try to get a value from the <see cref="Args"/> and if not present just return a default value.
         /// </summary>
         /// <param name="param"></param>
         /// <param name="def"></param>
         /// <returns></returns>
-        public string TryGetValue(string param, string def = null) => Args.TryGetValue(param, out string value) ? value : def;
+        public string TryGetStringValue(string param, string def = null) => StringArgs.TryGetValue(param, out string value) ? value : def;
 
 #nullable enable
         internal static List<CustomModule> Load(List<object> modules, SummonedCustomRole summonedCustomRole)
         {
             LogManager.Silent($"[CM Loader] Initialize loading for {summonedCustomRole}\nPreloaded {YamlFlagsHandler.Modules.Length} modules...");
 
-            Dictionary<string, Dictionary<string, string>?> data = YamlFlagsHandler.Decode(modules) ?? new();
+            Dictionary<string, Dictionary<string, object>?> data = YamlFlagsHandler.Decode(modules) ?? new();
 
             List<CustomModule> mods = new();
 
-            foreach (KeyValuePair<string, Dictionary<string, string>?> module in data)
+            foreach (KeyValuePair<string, Dictionary<string, object>?> module in data)
                 if (InitializeCustomModule(module.Key, module.Value, YamlFlagsHandler.Modules, summonedCustomRole) is CustomModule mod)
                     mods.Add(mod);
 
@@ -113,7 +127,7 @@ internal static List<CustomModule> Load(List<object> modules, SummonedCustomRole
             return mods;
         }
 
-        internal static CustomModule? FastAdd(Type type, SummonedCustomRole role, Dictionary<string, string>? args = null)
+        internal static CustomModule? FastAdd(Type type, SummonedCustomRole role, Dictionary<string, object>? args = null)
         {
             if (Activator.CreateInstance(type) is not CustomModule module)
             {
@@ -127,7 +141,7 @@ internal static List<CustomModule> Load(List<object> modules, SummonedCustomRole
             return module;
         }
 
-        private static CustomModule? InitializeCustomModule(string name, Dictionary<string, string>? args, Type[] types, SummonedCustomRole summonedCustomRole)
+        private static CustomModule? InitializeCustomModule(string name, Dictionary<string, object>? args, Type[] types, SummonedCustomRole summonedCustomRole)
         {
             try
             {

UncomplicatedCustomRoles/API/Features/CustomModules/CustomPermissions.cs

@@ -19,6 +19,6 @@ public class CustomPermissions : CustomModule
             "permissions"
         };
 
-        internal string[] Permissions => Args.TryGetValue("permissions", out string permissions) ? permissions.Replace(" ", string.Empty).Split(',') : new string[] { };
+        internal string[] Permissions => StringArgs.TryGetValue("permissions", out string permissions) ? permissions.Replace(" ", string.Empty).Split(',') : new string[] { };
     }
 }

UncomplicatedCustomRoles/API/Features/CustomModules/CustomScpAnnouncer.cs

@@ -19,6 +19,6 @@ public class CustomScpAnnouncer : CustomModule
             "name"
         };
 
-        internal string RoleName => TryGetValue("name", "SCP 404");
+        internal string RoleName => TryGetStringValue("name", "SCP 404");
     }
 }

UncomplicatedCustomRoles/API/Features/CustomModules/DropItemOnDeath.cs

@@ -12,7 +12,7 @@ public class DropItemOnDeath : CustomModule
             "item"
         };
 
-        public ItemType? Item => Args.TryGetValue("item", out string rawItem) && Enum.TryParse(rawItem, out ItemType item) && item is not ItemType.None ? item : null;
+        public ItemType? Item => StringArgs.TryGetValue("item", out string rawItem) && Enum.TryParse(rawItem, out ItemType item) && item is not ItemType.None ? item : null;
 
         public override void OnRemoved()
         {

UncomplicatedCustomRoles/API/Features/CustomModules/FullCandyBag.cs

@@ -0,0 +1,31 @@
+/*
+ * 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 InventorySystem.Items.Usables.Scp330;
+using System.Collections.Generic;
+
+namespace UncomplicatedCustomRoles.API.Features.CustomModules
+{
+    public class FullCandyBag : CustomModule
+    {
+        public override List<string> RequiredArgs => new()
+        {
+            "candies"
+        };
+
+        internal List<CandyKindID> Kinds => Args.TryGetValue("candies", out object kinds) ? kinds as List<CandyKindID> : new();
+
+        public override void OnAdded()
+        {
+            foreach (CandyKindID kind in Kinds)
+                CustomRole.Player.TryAddCandy(kind);
+        }
+    }
+}

UncomplicatedCustomRoles/API/Features/CustomModules/ItemBan.cs

@@ -21,7 +21,7 @@ public class ItemBan : CustomModule
             "item_type"
         };
 
-        public ItemType? Type => Args.TryGetValue("item_type", out string itemType) && Enum.TryParse(itemType, out ItemType type) ? type : null;
+        public ItemType? Type => StringArgs.TryGetValue("item_type", out string itemType) && Enum.TryParse(itemType, out ItemType type) ? type : null;
 
         public static bool ValidatePickup(SummonedCustomRole role, Pickup pickup)
         {

UncomplicatedCustomRoles/API/Features/CustomModules/LifeStealer.cs

@@ -19,6 +19,6 @@ public class LifeStealer : CustomModule
             "percentage"
         };
 
-        public int Percentage => Args.TryGetValue("percentage", out string perc) && int.TryParse(perc, out int numPerc) ? numPerc : 0; // NOTE: Percentage MUST be an int so like 75 is 75% (0.75)
+        public int Percentage => StringArgs.TryGetValue("percentage", out string perc) && int.TryParse(perc, out int numPerc) ? numPerc : 0; // NOTE: Percentage MUST be an int so like 75 is 75% (0.75)
     }
 }