@quenty/ugcsanitize 1.0.1-canary.522.1d2faf4.0

package/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+## 1.0.1-canary.522.1d2faf4.0 (2024-12-03)
+
+
+### Features
+
+* Add UGCSanitize to FirstPersonTransparency ([c07db09](https://github.com/Quenty/NevermoreEngine/commit/c07db0937e56055ead6cd4332e2fa19f4ab4259e))

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2014-2024 James Onnen (Quenty)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,23 @@
+## UGCSanitize
+
+<div align="center">
+  <a href="http://quenty.github.io/NevermoreEngine/">
+    <img src="https://github.com/Quenty/NevermoreEngine/actions/workflows/docs.yml/badge.svg" alt="Documentation status" />
+  </a>
+  <a href="https://discord.gg/mhtGUS8">
+    <img src="https://img.shields.io/discord/385151591524597761?color=5865F2&label=discord&logo=discord&logoColor=white" alt="Discord" />
+  </a>
+  <a href="https://github.com/Quenty/NevermoreEngine/actions">
+    <img src="https://github.com/Quenty/NevermoreEngine/actions/workflows/build.yml/badge.svg" alt="Build and release status" />
+  </a>
+</div>
+
+Sanitizes UGC hats and other items
+
+<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/UGCSanitizeUtils">View docs →</a></div>
+
+## Installation
+
+```
+npm install @quenty/ugcsanitize --save
+```

package/default.project.json

@@ -0,0 +1,7 @@
+{
+  "name": "ugcsanitize",
+  "globIgnorePaths": [ "**/.package-lock.json" ],
+  "tree": {
+    "$path": "src"
+  }
+}

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@quenty/ugcsanitize",
+  "version": "1.0.1-canary.522.1d2faf4.0",
+  "description": "Sanitizes UGC hats and other items",
+  "keywords": [
+    "Roblox",
+    "Nevermore",
+    "Lua",
+    "ugcsanitize"
+  ],
+  "bugs": {
+    "url": "https://github.com/Quenty/NevermoreEngine/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Quenty/NevermoreEngine.git",
+    "directory": "src/ugcsanitize/"
+  },
+  "funding": {
+    "type": "patreon",
+    "url": "https://www.patreon.com/quenty"
+  },
+  "license": "MIT",
+  "contributors": [
+    "Quenty"
+  ],
+  "dependencies": {
+    "@quenty/baseobject": "10.7.1",
+    "@quenty/instanceutils": "13.13.1-canary.522.1d2faf4.0",
+    "@quenty/loader": "10.7.1",
+    "@quenty/maid": "3.4.0",
+    "@quenty/string": "3.3.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "1d2faf48e778ada6f57aecb8000c7c6c76ac33cd"
+}

package/src/Shared/DisableHatParticles.lua

@@ -0,0 +1,101 @@
+--[=[
+	@class DisableHatParticles
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local BaseObject = require("BaseObject")
+local RxInstanceUtils = require("RxInstanceUtils")
+local String = require("String")
+
+local DisableHatParticles = setmetatable({}, BaseObject)
+DisableHatParticles.ClassName = "DisableHatParticles"
+DisableHatParticles.__index = DisableHatParticles
+
+function DisableHatParticles.new(character)
+	local self = setmetatable(BaseObject.new(character), DisableHatParticles)
+
+	self._maid:GiveTask(RxInstanceUtils.observeChildrenOfClassBrio(self._obj, "Accessory"):Subscribe(function(brio)
+		if brio:IsDead() then
+			return
+		end
+
+		local maid, accessory = brio:ToMaidAndValue()
+		self:_handleAccessory(maid, accessory)
+	end))
+
+	return self
+end
+
+function DisableHatParticles:_handleAccessory(maid, accessory)
+	maid:GiveTask(accessory.DescendantAdded:Connect(function(descendant)
+		self:_handleAccessoryDescendant(maid, descendant)
+	end))
+	maid:GiveTask(accessory.DescendantRemoving:Connect(function(descendant)
+		maid[descendant] = nil
+	end))
+
+	for _, descendant in pairs(accessory:GetDescendants()) do
+		self:_handleAccessoryDescendant(maid, descendant)
+	end
+end
+
+function DisableHatParticles:_handleAccessoryDescendant(maid, descendant)
+	if descendant:IsA("Fire")
+		or descendant:IsA("Sparkles")
+		or descendant:IsA("Smoke")
+		or descendant:IsA("ParticleEmitter") then
+		if descendant.Enabled then
+			maid[descendant] = function()
+				descendant.Enabled = true
+			end
+
+			descendant.Enabled = false
+		end
+	end
+
+	-- TODO: This code is unsafe? Use a sound group?
+	if self:_isASoundScript(descendant) then
+		maid[descendant] = function()
+			descendant.Enabled = true
+		end
+
+		descendant.Enabled = false
+	end
+
+	if self:_isSound(descendant) then
+		local originalVolume = descendant.Volume
+		maid[descendant] = function()
+			descendant.Volume = originalVolume
+		end
+
+		descendant.Volume = 0
+	end
+end
+
+function DisableHatParticles:_isASoundScript(descendant)
+	if not descendant:IsA("LocalScript") then
+		return false
+	end
+
+	if String.endsWith(descendant.Name, "Sounds") then
+		return true
+	end
+
+	if String.endsWith(descendant.Name, "Sound") then
+		return true
+	end
+
+	if String.startsWith(descendant.Name, "Sound") then
+		return true
+	end
+
+	return false
+end
+
+function DisableHatParticles:_isSound(descendant)
+	-- Sound group check is paranoid but likely to be valid as to identify hat-sounds
+	return descendant:IsA("Sound") and descendant.SoundGroup == nil
+end
+
+return DisableHatParticles

package/src/Shared/UGCSanitizeUtils.lua

@@ -0,0 +1,9 @@
+--[=[
+	@class UGCSanitizeUtils
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local UGCSanitizeUtils = {}
+
+return UGCSanitizeUtils

package/src/node_modules.project.json

@@ -0,0 +1,7 @@
+{
+  "name": "node_modules",
+  "globIgnorePaths": [ "**/.package-lock.json" ],
+  "tree": {
+    "$path": { "optional": "../node_modules" }
+  }
+}

package/test/default.project.json

@@ -0,0 +1,12 @@
+{
+  "name": "UGCSanitizeTest",
+  "globIgnorePaths": [ "**/.package-lock.json" ],
+  "tree": {
+    "$className": "DataModel",
+    "ServerScriptService": {
+      "ugcsanitize": {
+        "$path": ".."
+      }
+    }
+  }
+}