# Delightful for Obsidian

_A little delight goes a long way. Too much delight ruins the fun._

Delightful will brighten your day with delights when you complete a task (check any checkbox). You can control which animations to use and how often it randomly happens.

This plugin is based on the original and awesome<sup>[01](#endnotes)</sup> [Delightful browser extension](https://chromewebstore.google.com/detail/delightful/lcpnconeejbcokkmdmlkhenjnkdcioji), which works for a range of project management software.

## Delights

- All of the things - SVG and animation by [Paul Groth](https://github.com/paulMrG2), (original image by Allie Brosh (2010))
- Grogu (AKA Baby Yoda) by Unknown - Animation by [Paul Groth](https://github.com/paulMrG2)
- Badger Badger Badger - SVG and animation by [Paul Groth](https://github.com/paulMrG2), (original [Badger animation](https://www.youtube.com/watch?v=EIyixC9NsLI) by Jonti Picking A.K.A Mr Weebl)
- [Confetti](https://github.com/catdad/canvas-confetti) by [Kiril Vatev](https://github.com/catdad)
- Fallout Vault Boy by unknown at [SeekLogo](https://seeklogo.com/vector-logo/284917/vault-boy)) animation by [Paul Groth](https://github.com/paulMrG2)
- [Nyan Cat](https://github.com/Gowee/nyancat-svg) by [Hung-I Wang](https://github.com/Gowee)
- [Party Parrot](https://codepen.io/nathangath/pen/RgvzVY/) by [@nathangath](https://codepen.io/nathangath)
- Smug Thug Pew Pew - SVG and animation by [Paul Groth](https://github.com/paulMrG2), (inspired by Pew Pew emoji on Slack)
- Success Kid - SVG and animation by [Paul Groth](https://github.com/paulMrG2), (original image by Laney Griner (2007))

## Usage

Check any task checkbox in standard Markdown. That's it.

Works in Reading View and Live Preview.

## Settings

Open `Settings > Delightful`

- Chance of delight - control how often an animation plays, from every time down to rarely
- Delights - enable/disable individual animations

## Installation

1. In Obsidian, go to `Settings > Community plugins > Browse`
2. Search for `Delightful`
3. Click `Install`, then `Enable`

### Manual installation

1. Download `main.js`, `manifest.json`, and `styles.css` from the [latest release](https://github.com/paulMrG2/delightful-obsidian/releases/latest)
2. Copy them into `<vault>/.obsidian/plugins/delightful-obsidian/`
3. Enable the plugin in `Settings > Community plugins > Installed plugins > Delightful`

## Endnotes

[01]: I don't know why you're questioning this? It just. Is. Awesome. If you don't agree, you obviously haven't tried it and are dismissing it without any legitimate evidence. There is one exception though... you might not think it's awesome because you don't like fun things, and joyous delights like cute animals doing funny things make you angry. If that's the case, I apologise for attempting to convince you of something that you're not capable of understanding, but also, please seek help from a professional. If you become enlightened at some stage and want to give it a try, you're welcome back any time.