Enhancement: Fixes #95, Forgot READMEs for sound theme

This commit is contained in:
Rory Fewell
2022-01-25 20:04:56 +00:00
parent e957b59670
commit 5e1a83b578
2 changed files with 71 additions and 0 deletions

View File

@@ -0,0 +1,49 @@
# Sound Theme Packaging
This directory contains the sound theme packaging script for Debian and derivatives (e.g. Ubuntu).
## Usage
Simply run the script itself - it requires no arguments as there is only one sound theme in the repo, which will be packaged.
```
./packsnds.sh
```
This will build and output the package for the sound theme, which can then be installed with:
```
sudo dpkg -i wintc-sound-theme-xp.deb
```
## Post-Install
This is *only* the sound theme itself, you will still need to set up your environment to make use of it once it is installed.
Suggestion is to install the `libcanberra` library which provides a simple API for playing sound themes, including via frameworks like GTK.
Package names may vary, but on Debian you should install these packages:
```
gnome-session-canberra
libcanberra-gtk3-0
libcanberra-gtk3-module
libcanberra-pulse
libcanberra0
```
For GTK applications to make use of the library, you must enable the module by specifying it in the `GTK_MODULES` environment variable. On my machine I simply added it to system-wide environment variables by adding the following to `/etc/environment`:
```
GTK_MODULES=canberra-gtk-module
```
And finally, for XFCE, you should enable sounds by going into the *Settings Editor*, and set these values:
`xsettings/Net/EnableEventSounds` ✔️
`xsettings/Net/EnableInputFeedbackSounds` ✔️
`xsettings/Net/SoundThemeName` *"Windows XP Default"*
That should be everything - bear in mind that sound themes are a bit of an afterthought on Linux so application support may vary.
## Any Problems?
If you have problems running the script, feel free to [submit an issue](https://github.com/rozniak/xfce-winxp-tc/issues) and include the generated log file. 😁

22
sounds/README.MD Normal file
View File

@@ -0,0 +1,22 @@
# Sounds
This directory contains the source files to generate the *Windows XP Default* Freedesktop.org sound theme.
## Structure
This is just a single sound theme, the structure of this tree is as follows:
`sfx/` - contains all the sounds in their original `.wav` format (for the core XP sounds, these are the higher bitrate versions from build 2481)
`debian-control` - the `control` file used in Debian packaging to provide metadata about the package
`index.theme` - the freedesktop theme config file
`mappings` - since there are lots of sound names that map to the same sound, this file describes those mappings so that each sound name can be symlinked to the real sound files provided in `sfx/`
## Installation
See the `README.MD` under `/packaging/deb/sounds` for packaging and installation.
## Developing the sound theme
It should be obvious with the above info on how to add additional sounds or make tweaks as appropriate by dropping the sound files in `sfx/` and then providing the mappings.
## Caveats
Please note that sound theme support varies by application. Sadly XFCE does not really make any use of sounds as far as I can tell, so it's quite silent. I may see if anything can be done about this in future. Things like Firefox or GNOME-developed applications most likely should support the system sound theme.