Reference

Sound-Manager allows you to easily manage sounds in your Roblox-TS Project. This page documents the core Sound-Manager APIs.

Sound-Manager provides these top-level exports:

• createSoundRegistry(definitions: Record<string, SoundOptions>)
• createSoundCategoryRegistry(definitions: Record<string, CategoryOptions>)

See the source code on GitHub →

---

Sound-Registry

Sound-Registry is the core of Sound-Manager. It allows you to define, create, and manage sounds in your Roblox-TS Project.

Explore how to use Sound-Registry to manage your game:

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);

---

Sound-Categories

If your projects contains many sounds, you can organize them by using Sound-Categories . Sound-Categories allow you to group sounds together and manage them as a single unit.

const categories = {
    music: {
        category: "Music",
        sounds: {
            backgroundMusic: {
                id: "rbxassetid://1234567890",
                volume: 0.5,
                looped: true,
            },
        },
    }
} as const;

export const soundCategoryRegistry = createSoundCategoryRegistry(categories);

---