Add option to disable sound

[rossnoah]

Summary by CodeRabbit

• New Features

  • Added a global setting to enable or disable all plugin sounds via the configuration file.
  • Introduced options to customize sound effects for specific plugin events, such as successes, failures, and GUI interactions.

• Documentation

  • Updated configuration documentation to include a new section detailing sound settings, with examples and descriptions for each configurable sound event.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

A global configuration toggle for plugin sounds was introduced, allowing all sounds to be enabled or disabled via a single setting. The SoundManager was updated to respect this flag, and documentation was added to describe the new configuration options, including detailed descriptions and examples for each sound event.

Changes

File(s)	Change Summary
CONFIG.md	Added documentation for new global and per-event sound configuration options with YAML examples.
src/main/resources/config.yml	Introduced sounds.enabled flag; improved comments for sound settings.
src/main/java/dev/noah/perplayerkit/util/SoundManager.java	Added check to bypass sound playback if sounds.enabled is false in config.

Sequence Diagram(s)

sequenceDiagram
    participant Plugin
    participant SoundManager
    participant Config
    participant Player

    Plugin->>SoundManager: play(Player, Sound)
    SoundManager->>Config: get("sounds.enabled", default=true)
    alt sounds enabled
        SoundManager->>Player: playSound(Sound)
    else sounds disabled
        SoundManager-->>Plugin: return (no sound)
    end

Loading

Possibly related PRs

• Add sounds to lots of things #27: Introduced the SoundManager class and initial sound effect integration, which this PR extends by adding a global enable/disable control.

Poem

A toggle for sounds, so crisp and so neat,
Now silence or music, your choice to greet.
With configs explained and comments anew,
The plugin now listens—just like rabbits do!
🐇🔊

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4a6a6f5 and bc241f9.

📒 Files selected for processing (3)

• CONFIG.md (1 hunks)
• src/main/java/dev/noah/perplayerkit/util/SoundManager.java (1 hunks)
• src/main/resources/config.yml (1 hunks)

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.