📝 Add or Update a Config

[marceloams]

📝 Add or Update a Config

Contribute a new keybind configuration or improve an existing one!

What to do

Option A: Create a new config

1. Create a themed config file in src/configs/
2. Update src/configs/README.md with your config info
3. Submit a PR

Option B: Update an existing config

1. Improve an existing config in src/configs/
2. Update src/configs/README.md if needed
3. Submit a PR

Config themes

• Gaming
• Streaming
• Memes
• Work/Productivity
• Music Production
• Podcasting

Quick steps

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

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

# Create your config file
touch src/configs/your-config.yaml

# Edit the file with your keybinds
# Update src/configs/README.md

# Commit and push
git add src/configs/
git commit -m "Add your-config-name config"
git push origin add-config-your-config-name

Examples to follow

• src/configs/default.yaml - Basic example
• src/configs/template.yaml - Complete reference with all options
• src/configs/README.md - See how configs are documented
• Read CONTRIBUTING.md for guidelines

Config file structure

profile:
  name: "Your Config Name"
  description: "Brief description"

audio:
  player: "play"
  maxConcurrent: 5

keybinds:
  - key: "F1"
    sound: "../../assets/sounds/your-sound.mp3"
    description: "Sound description"

settings:
  hotReload: true
  preloadSounds: true

logging:
  level: "info"
  fileEnabled: true
  filePath: "logs"

Need help?

Check CONTRIBUTING.md, template.yaml, or comment here!

---

Branch name format examples: add-config-name-of-the-config update-config-name-of-the-config improvement-config-name-of-the-config

[aaryaparadkar]

hey Marcel, I think I would be able to contribute to this. Let me know what do you think about it cheers!

[marceloams]

@aaryaparadkar Just open a PR adding/updating a config, that's all! You can check template.yaml or default.yaml for examples. Don't forget to add any new sounds you use in your config!

[rishaan007]

@marceloams can you assign me this issue?

[vibhorjoshi]

can you assign this task to me

[marceloams]

@vibhorjoshi Just open a PR adding/updating a config, that's all! Don't forget to add any new sounds you use in your config!