@rbxts/sound-manager 1.0.0

package/README.md

@@ -0,0 +1,17 @@
+# Sound Manager
+
+A Roblox sound management library built with Roblox-TS
+
+## Getting Started
+To use the Sound Manager library in your Roblox-TS project install it via npm:
+```bash
+   npm install @rbxts/sound-manager
+   ```
+
+Example usage:
+```typescript
+import { Sounds } from "@rbxts/sound-manager";
+
+Sounds.load("TestSound", "rbxassetid://4714389545", { volume: 1, loop: false });     
+Sounds.play("TestSound")
+```

package/out/core/options.d.ts

@@ -0,0 +1,4 @@
+export interface SoundOptions {
+    volume?: number;
+    loop?: boolean;
+}

package/out/core/options.luau

@@ -0,0 +1,2 @@
+-- Compiled with roblox-ts v3.0.0
+return nil

package/out/index.d.ts

@@ -0,0 +1,7 @@
+import { SoundOptions } from "./core/options";
+export declare namespace Sounds {
+    /** * * @param sound Define the Sound to play */
+    function play(soundName: string): void;
+    /** * * @param soundname Define the name of the Sound * @param soundid Define the SoundID of the Sound * @param options Define the options for the Sound (e.g. volume) */
+    function load(soundName: string, soundId: string, options?: SoundOptions): void;
+}

package/out/init.luau

@@ -0,0 +1,55 @@
+-- Compiled with roblox-ts v3.0.0
+local Sounds = {}
+do
+	local _container = Sounds
+	--* * * @param sound Define the Sound to play 
+	local function play(soundName)
+		local soundFolder = game:GetService("ReplicatedStorage"):FindFirstChild("Sounds")
+		if not soundFolder then
+			warn("Sound folder not found in ReplicatedStorage.")
+			return nil
+		end
+		local _sound = soundFolder:FindFirstChild(soundName)
+		if _sound then
+			_sound:Play()
+		else
+			warn(`Sound: {soundName} not found! Make sure to load it first.`)
+		end
+	end
+	_container.play = play
+	--* * * @param soundname Define the name of the Sound * @param soundid Define the SoundID of the Sound * @param options Define the options for the Sound (e.g. volume) 
+	local function load(soundName, soundId, options)
+		local soundFolder = game:GetService("ReplicatedStorage"):FindFirstChild("Sounds")
+		if not soundFolder then
+			soundFolder = Instance.new("Folder")
+			soundFolder.Name = "Sounds"
+			soundFolder.Parent = game:GetService("ReplicatedStorage")
+		end
+		if soundFolder:FindFirstChild(soundName) then
+			warn(`Sound: {soundName} already exists.`)
+			return nil
+		end
+		local newSound = Instance.new("Sound")
+		newSound.Name = soundName
+		newSound.SoundId = soundId
+		newSound.Parent = soundFolder
+		local _result = options
+		if _result ~= nil then
+			_result = _result.volume
+		end
+		if _result ~= nil then
+			newSound.Volume = options.volume
+		end
+		local _result_1 = options
+		if _result_1 ~= nil then
+			_result_1 = _result_1.loop
+		end
+		if _result_1 ~= nil then
+			newSound.Looped = options.loop
+		end
+	end
+	_container.load = load
+end
+return {
+	Sounds = Sounds,
+}

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@rbxts/sound-manager",
+  "version": "1.0.0",
+  "description": "A sound manager for Roblox-Typescript projects.",
+  "main": "out/init.lua",
+  "scripts": {
+    "build": "rbxtsc",
+    "watch": "rbxtsc -w",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [],
+  "author": "Easy-Build-Studio",
+  "license": "ISC",
+  "type": "commonjs",
+  "types": "out/index.d.ts",
+  "files": [
+    "out",
+    "!**/*.tsbuildinfo"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@rbxts/compiler-types": "^3.0.0-types.0",
+    "@rbxts/types": "^1.0.896",
+    "@typescript-eslint/eslint-plugin": "^8.49.0",
+    "@typescript-eslint/parser": "^8.49.0",
+    "eslint": "^9.39.2",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-prettier": "^5.5.4",
+    "eslint-plugin-roblox-ts": "^1.3.1",
+    "prettier": "^3.7.4",
+    "roblox-ts": "^3.0.0",
+    "typescript": "^5.9.3"
+  },
+  "dependencies": {
+    "@rbxts/testez": "^0.4.2-ts.0"
+  }
+}