Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/m-pilia/plasma-applet-ambientnoise
Ambient noise player applet (plasmoid) for KDE Plasma 6
https://github.com/m-pilia/plasma-applet-ambientnoise
ambient-noise kde-plasma-6 plasmoid
Last synced: about 2 months ago
JSON representation
Ambient noise player applet (plasmoid) for KDE Plasma 6
- Host: GitHub
- URL: https://github.com/m-pilia/plasma-applet-ambientnoise
- Owner: m-pilia
- License: gpl-3.0
- Created: 2017-06-16T15:38:14.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-03-10T18:33:01.000Z (10 months ago)
- Last Synced: 2024-03-10T19:35:46.452Z (10 months ago)
- Topics: ambient-noise, kde-plasma-6, plasmoid
- Language: QML
- Homepage:
- Size: 82 KB
- Stars: 16
- Watchers: 5
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Ambient noise applet for Plasma 6
[](https://github.com/m-pilia/plasma-applet-ambientnoise/actions/workflows/checks.yml)
This applet for the KDE Plasma desktop allows to reproduce ambient noise.
Multiple noise components can be combined, controlling their individual volume.
The applet reads noise files and their icons from a given, customisable folder.
The noise and the icon must be in the same folder and share the same name,
except for the file extension.
The plasmoid remembers its state across reboots, including play/pause status,
volume, and active noise components. To prevent it from playing sound at
start-up, even if it was still playing at the time of the last shutdown, go to
the plasmoid settings and tick "Paused at start-up".
Free noises in a ready-to-use format for this plasmoid can be found in the
[anoise project](http://anoise.tuxfamily.org/).
# Build and install
The applet can be installed locally with
```bash
git clone https://github.com/m-pilia/plasma-applet-ambientnoise
cd plasma-applet-ambientnoise/
kpackagetool6 -t Plasma/Applet --install plasmoid
```
or globally with
```bash
git clone https://github.com/m-pilia/plasma-applet-ambientnoise
cd plasma-applet-ambientnoise/
mkdir build
cmake . -B build
cmake --build build
sudo cmake --install build
```
To see the plasmoid, you may need to restart plasmashell
```bash
kquitapp6 plasmashell
kstart plasmashell
```
# Contribute
Questions, bug reports, and feature requests are welcome. Feel free to open an
[issue on
GitHub](https://github.com/m-pilia/plasma-applet-ambientnoise/issues).
New translations are welcome. Translation files are located in the
[translations folder](translations). To add a new translation:
+ Copy the template
file `plasma_applet_org.kde.plasma.ambientnoise.pot` to
`plasma_applet_org.kde.plasma.ambientnoise_XX.po` (where `XX` is the [ISO 639-1
code](http://www.loc.gov/standards/iso639-2/php/English_list.php) for the
language you are adding).
+ Fill all the fields inside the file.
+ Add two lines to
[`plasmoid/metadata.desktop`](https://github.com/m-pilia/plasma-applet-ambientnoise/blob/master/plasmoid/metadata.desktop)
as follows, next to the corresponding pre-existing lines (once again, `XX`
represents the ISO code of the new language):
+ `Name[XX]=...` filled with a translation of the name;
+ `Comment[XX]=...` filled with a translation of the comment.
+ Commit and open a [pull
request on
GitHub](https://github.com/m-pilia/plasma-applet-ambientnoise/pulls).
# Troubleshooting
In case something seems not to be working, launch the plasmoid in debug mode
from a console, with `plasmoidviewer -a org.kde.plasma.ambientnoise` or
`plasmawindowed org.kde.plasma.ambientnoise`, and look for relevant log
messages. Especially when it comes to audio playback, most of the troubles come
from bad configuration of the multimedia back-end.
# License
The project is licensed under GPL 3. See [LICENSE](./LICENSE)
file for the full license.