folfcoder/plasma-sharkle
1
0
Fork 0
mirror of https://github.com/folfcoder/plasma-sharkle.git synced 2025-04-05 13:41:37 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Create README.md

Browse source
This commit is contained in:
Kai Folf 2023-04-07 20:16:51 +07:00 • committed by GitHub
parent 5c01b363c0
commit 82d77e77ee
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 30 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
README.md Normal file
View file

@ -0,0 +1,30 @@
# 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.
(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
```bash
$ 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-do
- [ ] Fix missing icon
- [ ] Fix margin when the widget is resized
- [ ] Add settings to support both dark/light background
- [ ] Upload to KDE Store??
## License
This project is licensed under MIT license, 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).