Skip to main content

Quick Start

Sound-Manager is a sound management library that lets create and manage sounds.

Installation​

Sound-Manager is available on npm

Terminal
npm install @rbxts/sound-manager
Terminal
yarn add @rbxts/sound-manager

Start using Sound-Manager​

You're now ready to use Sound-Manager! Create a SoundRegistry to start managing sounds in your project.

import { createSoundRegistry } from "@rbxts/sound-manager";

const sounds = {
    backgroundMusic: {
        id: "rbxassetid://1234567890",
        volume: 0.5,
        looped: true,
    },
    jumpSound: {
        id: "rbxassetid://0987654321",
        volume: 1.0,
        looped: false,
    },
} as const;

export const soundRegistry = createSoundRegistry(sounds);

Use your Sound-Registry anywhere​

With Sound-Manager, you can easily play, stop, etc. sounds from your SoundRegistry anywhere in your project.

soundRegistry.play("backgroundMusic"); // Plays the background music