{"id":"egomoose/character-sounds","name":"character-sounds","scope":"egomoose","platform":"roblox","description":"https://github.com/EgoMoose/character-sounds","version":"0.2.1","latest":"0.2.1","versions":["0.1.0","0.2.0","0.2.1"],"license":"MIT","licenseRating":"safe","licenseCaveats":[],"licenseVerified":true,"dependencies":{"stravant/goodsignal":{"version":"^0.2.1","alias":"Signal"}},"integrity":"c406a9415151ef71d71cf0d76c0f1439ca8f919100927a2008c8f1694b8c8579","likes":0,"downloads":0,"install":"forest install egomoose/character-sounds","url":"https://forest.dev/p/roblox/egomoose/character-sounds","files":"https://api.forest.dev/ai/package/roblox/egomoose/character-sounds/files","readme":"# Character Sounds\nA replacement implementation of the `RbxCharacterSounds` script that is typically loaded into players by default.\n\nGet it here:\n\n* [Wally](https://wally.run/package/egomoose/character-sounds)\n* [Releases](https://github.com/EgoMoose/character-sounds/releases)\n\n## API\n\n```Lua\n--[=[\nCreates a new sound listener\n\n@param director Model -- The character model used to track state for playing sounds\n@param performer Model? -- The character model the sounds will play on. Defaults to `director` if nil\n@return SoundController: {\n\tcleanup: () -> (), -- stops sounds from playing and cleans them up\n}\n--]=]\nfunction module.listen(director: Model, performer: Model?): SoundController\n\n--[=[\nCreates a new sound listener\n\n@param performer Model -- The character model the sounds will play on\n@return ManualSoundController: {\n\tcleanup: () -> (), -- stops sounds from playing and cleans them up\n\tfireState: (Enum.HumanoidStateType, ...any) -> (), -- fire a humanoid state for a reactive sound transition\n\tsetVelocity: (Vector3) -> (), -- set the root part velocity\n\tsetMoveDirection: (Vector3) -> (), -- set the humanoid's move direction\n}\n--]=]\nfunction module.manual(performer: Model): ManualSoundController\n```\n\nAn example of using this package to replicate the standard `RbxCharacterSounds` script can be found [here.](test/RbxCharacterSounds.client.lua)","readmeTruncated":false}