🎵 Add a New Sound

[marceloams]

🎵 Add a New Sound

Help build our sound collection! This is a perfect first contribution.

What to do

1. Add an MP3 sound file to assets/sounds/
2. Update assets/sounds/README.md with your sound info
3. (Optional but encouraged) Add your sound to an existing config or create a new one
4. Submit a PR

Requirements

• Format: MP3 only
• Size: Under 500KB
• Naming: kebab-case (example: epic-victory.mp3)

Quick steps

Basic (sound only):

# Fork and clone the repo
git clone https://github.com/YOUR-USERNAME/soundbind.git
cd soundbind

# Create branch
git checkout -b add-sound-your-sound-name

# Add your sound file
cp your-sound.mp3 assets/sounds/

# Update README.md
# Add your sound to the list in assets/sounds/README.md

# Commit and push
git add assets/sounds/
git commit -m "Add your-sound-name sound"
git push origin add-sound-your-sound-name

Advanced (sound + config - two separate PRs):

1. First, follow the basic steps above to create a PR for your sound
2. Then, create a separate PR to add your sound to a config by following the Add or Update a Config issue

Why two PRs? For Hacktoberfest contributors, this counts as 2 contributions! 🎉

Advanced (sound + config - single PR):

If you prefer to submit everything together:

# After adding your sound (basic steps above)

# Option A: Add to existing config
# Edit a file like src/configs/default.yaml or src/configs/gaming.yaml
# Add a new keybind that uses your sound

# Option B: Create a new config
# Create src/configs/your-theme.yaml
# See template.yaml for structure
# Update src/configs/README.md

# Commit everything together
git add assets/sounds/ src/configs/
git commit -m "Add your-sound-name sound and include in config"
git push origin add-sound-your-sound-name

Examples to follow

For sounds:

• Check existing sounds in assets/sounds/
• See assets/sounds/README.md for format

For configs (if adding to one):

• src/configs/default.yaml - Basic example
• src/configs/template.yaml - Complete reference
• src/configs/README.md - Config documentation

General guidelines:

• Read CONTRIBUTING.md for detailed guidelines

Where to find sounds

• Freesound.org
• Zapsplat
• Create your own

Need help?

Check CONTRIBUTING.md or comment here!

---

Branch name format: add-sound-name-of-the-sound

[hparihar-07]

Hey I would like to do this can you assign me

[marceloams]

@hparihar-07 Just open a PR adding the new sound, that's all! Don't forget to add it to a config, you can update or create one in the same PR, or do it in a separate one. > Hey I would like to do this can you assign me

[ImalKesara]

@marceloams can i use any sound effects from other existing projects without copyright issues?

[marceloams]

@ImalKesara It depends on that project's license! If the project uses a permissive license (ex: MIT), you can usually use their sounds.

[PrathmeshDesai]

assign these to me if not yet done

[marceloams]

@PrathmeshDesai Just open a PR adding the new sound and update/create a config with it. That's it! 🚀