Skip to content

Latest commit

 

History

History
61 lines (38 loc) · 3.27 KB

README.md

File metadata and controls

61 lines (38 loc) · 3.27 KB
Raw
Soundeffect.Checklist.Demo.mp4

Checkbox-Soundeffect Obsidian Plugin

Checkbox-Soundeffect is an Obsidian plugin that enhances your checkbox experience by playing a sound whenever you click a checkbox or toggle an inline boolean field. Make your note-taking and task management more interactive and engaging with sound effects.

Supported Checklist Formats

The Checkbox-Soundeffect plugin currently supports the following checklist formats:

  • Standard checkboxes
  • Checkboxes in a numbered list
  • Inline boolean values & checklists when combined with the Better Inline Fields plugin

Setup

To use the Checkbox-Soundeffect plugin, follow these steps:

  1. Upload Your Audio File

    Before you start, make sure you have an MP3 audio file that you want to use as the sound effect. To upload the audio file, we recommend using Discord, but Telegram can also work. Local files also work by providing the path in the audio link fields.

    • Discord:
      • Join a server or create a new one if you don't have any.
      • Navigate to the text channel where you want to upload the audio file.
      • Drag and drop your MP3 audio file into the text channel.
      • Right-click the name of the uploaded MP3 (it will be a blue link).
      • Select "Copy Link" from the context menu.

  2. Change the Audio File URL in Plugin Settings

    • Go to the Obsidian settings and navigate to the "Plugins" section.
    • Find the "Checkbox-Soundeffect" plugin and click on it to access its settings.
    • There will be a field to input the audio file URL. Paste the URL that you copied from Discord into this field.
    • Save the changes.

Now you're all set! Every time you click a checkbox in your Obsidian notes, you'll hear the sound effect you selected.

Plugin Integration: Better Inline Fields

The Checkbox-Soundeffect plugin can integrate with the "Better Inline Fields" plugin to provide an even more immersive note-taking experience. Specifically, the checklists option in this plugin can have its own audio file and sound setup. How to Enable Integration

  1. Make sure both the Checkbox-Soundeffect and Better Inline Fields plugins are installed and enabled.
  2. Update your audio file link for Inline Toggle Audio in the plugin settings.

Credits

I would like to give a special thanks to Martindev (@naarikdev) from Fiverr, who assisted in developing the Checkbox-Soundeffect plugin and contributed to making this project possible.

Support and Funding

If you find this plugin helpful and would like to support further development and improvements, you can contribute to the project by providing financial support. We accept various forms of payment to accommodate different preferences. You can contribute through the following methods:

  • Bitcoin: 38j6KSoptdWFreEtmbo6APVLXWkfd6BWgu
  • Ethereum: 0x5325Fc057bbdD48d6722a176EBB9A0ebdF060EAD

ko-fi

Your contributions will help us continue to enhance the plugin, fix bugs, and add more exciting features in the future.

Thank you for using Checkbox-Soundeffect! Happy note-taking and task management with a touch of fun!