plasma-sharkle/README.md
2023-04-08 19:48:03 +07:00

31 lines
1.5 KiB
Markdown

# Sharkle Plasmoid For KDE Plasma
![License](https://img.shields.io/github/license/folfcoder/plasma-sharkle?style=for-the-badge)
![Gregg Rulz OK!](https://img.shields.io/badge/Gregg%20rulz-OK-orange?&style=for-the-badge)
The Sharkle widget, as featured in Night in the Woods, now on KDE Plasma!
Give it a poke and it'll blast out one of eight sound effects while displaying SHARKLE.
Available in black and white versions and can be used with most wallpapers.
(Heads up: This is my first time messing around with QML stuff. Please create an issue if you encounter any bugs!)
![desktop](https://user-images.githubusercontent.com/40331046/230613204-50d5ac81-de44-4500-b885-02dc3951afe4.png)
https://user-images.githubusercontent.com/40331046/230612672-b15b9b2f-9965-4c26-abf6-8d7be0b15b59.mp4
## Installation
```sh
mkdir -p ~/.local/share/plasma/plasmoids/ && cd ~/.local/share/plasma/plasmoids/ && git clone https://github.com/folfcoder/plasma-sharkle im.fcd.sharkle
```
Then right-click on your desktop > Add widgets > Drag the Sharkle widget to your desktop
To change the color, right click on Sharkle > Configure Sharkle > Change color and hit apply
## To-do
- [ ] Fix missing icon
- [ ] Upload to KDE Store??
## License
This project is licensed under GNU GPL v3.0, except for PNGs and WAVs, which are owned by Infinite Fall/Finji.
## Credits
Big thanks to [SamusAranX](https://github.com/SamusAranX) for the WAV files, and of course, a shoutout to the incredible creators of NITW (RIP, Alec).