{"id":"greenviper126/vluxysf","name":"vluxysf","scope":"greenviper126","platform":"roblox","description":"Sound fetching system with a focus on simplicity!  Source: https://github.com/Vlux-Entertainment/VluxySF","version":"2.0.0","latest":"2.0.0","versions":["0.1.0","0.1.1","0.1.2","0.1.3","0.3.0","0.3.2","0.3.4","0.3.5","0.3.6","0.4.0","0.4.3","0.7.5","0.7.6","0.7.7","0.7.9","0.8.0","0.8.1","0.8.2","0.8.5","0.8.8","0.8.9","0.9.0","0.9.1","0.9.5","0.9.7","0.9.8","0.9.9","1.0.0","1.0.1","1.0.2","1.0.3","1.0.4","2.0.0"],"license":"MIT","licenseRating":"safe","licenseCaveats":[],"licenseVerified":true,"dependencies":{},"integrity":"1bc376fe9971fa8b779851c6d6d6c2120ef49cd47654b3beaf419288e05b7844","likes":0,"downloads":0,"install":"forest install greenviper126/vluxysf","url":"https://forest.dev/p/roblox/greenviper126/vluxysf","files":"https://api.forest.dev/ai/package/roblox/greenviper126/vluxysf/files","readme":"<div align=\"center\">\n\t<img src=\".moonwave/static/VluxIcon.png\" alt=\"Vlux Entertainment\" height=\"150\" />\n\t<br/>\n\t<a href=\"https://discord.gg/Ebbp9UgBUD\"><img src=\"https://img.shields.io/discord/757104089984270346.svg?label=discord\" /></a>\n\t<p><a href=\"https://Vlux-Entertainment.github.io/VluxySF/\">View Docs</a></p>\n</div>\n\n\n\n# VluxySF\n\n**Vluxy Sound Factory** is a sound management library for Roblox with a focus on simplicity.\nBuild your sounds in Studio, then fetch any of them by name from the server or the client.\n\n```lua\nlocal sound = VluxySF.Fetch(\"LoFiBeat1\")\nsound:Play()\n```\n\n## Features\n\n- **Fetch by name.** No folder searching, and no errors when a sound moves or goes missing.\n- **Automatic SoundGroups.** Your folder layout becomes your SoundGroups, with a volume for each group and a main volume.\n- **Low memory use.** Sounds are compiled into a compact schema and created only when you ask for them.\n- **Preloading and warming.** Keep the sounds that matter ready to play without a delay.\n- **Presets and jitter.** Reusable functions that set up a sound, with natural volume and pitch variation.\n\n## Installation\n\nAdd VluxySF to your `wally.toml` and run `wally install`:\n\n```toml\n[dependencies]\nVluxySF = \"greenviper126/vluxysf@^2\"\n```\n\n## Quick start\n\nPut your sounds in a `Configuration` named `SOUNDS` inside `ServerStorage`, then start the library on both sides.\n\n**Server:**\n\n```lua\nlocal ReplicatedStorage = game:GetService(\"ReplicatedStorage\")\nlocal ServerStorage = game:GetService(\"ServerStorage\")\n\nlocal VluxySF = require(ReplicatedStorage.Packages.VluxySF)\n\nVluxySF.Startup.InitServer(ServerStorage.SOUNDS)\n```\n\n**Client:**\n\n```lua\nlocal ReplicatedStorage = game:GetService(\"ReplicatedStorage\")\n\nlocal VluxySF = require(ReplicatedStorage.Packages.VluxySF)\n\nVluxySF.Startup.InitClient()\n\nVluxySF.FetchPlayOnce(\"LoFiBeat1\")\n```\n\n`InitClient` yields until the sounds tagged for preloading are ready, or 5 seconds pass.\n\nThe [docs](https://Vlux-Entertainment.github.io/VluxySF/) cover the folder setup, more examples, and the full API.\n\n## License\n\nVluxySF is available under the [MIT License](LICENSE).\n","readmeTruncated":false}