Skip to content

Commit

Permalink
Merge pull request #371 from Belphemur/feature/UpdatedReadme
Browse files Browse the repository at this point in the history
Fresh new look for README
  • Loading branch information
Belphemur authored Nov 24, 2019
2 parents f0e1598 + efc5afe commit c234487
Show file tree
Hide file tree
Showing 3 changed files with 51 additions and 61 deletions.
112 changes: 51 additions & 61 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,114 +1,105 @@
<a href="https://soundswitch.aaflalo.me" title="SoundSwitch website"><img src="https://soundswitch.aaflalo.me/img/Main-Logo-Blue.svg" alt="logo SoundSwitch" height="180px" style="margin-left:auto;margin-right:auto;display:block;"></a>
<a href="https://soundswitch.aaflalo.me" title="SoundSwitch Website"><img src="https://soundswitch.aaflalo.me/img/Main-Logo-Blue.svg" alt="SoundSwitch Logo" height="180px"></a>

[![Last Release](https://img.shields.io/github/release/Belphemur/SoundSwitch.svg)](https://soundswitch.aaflalo.me) [![Downloads for last Release](https://img.shields.io/github/downloads/Belphemur/SoundSwitch/total.svg)](https://soundswitch.aaflalo.me/) [![Donate](https://img.shields.io/badge/Donate-paypal%2Fcc-blue.svg)](https://soundswitch.aaflalo.me) [![Translate](https://hosted.weblate.org/widgets/soundswitch/-/svg-badge.svg)](https://hosted.weblate.org/projects/soundswitch/)
[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2FBelphemur%2FSoundSwitch.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2FBelphemur%2FSoundSwitch?ref=badge_shield)
[![Last Release](https://img.shields.io/github/release/Belphemur/SoundSwitch.svg)](https://soundswitch.aaflalo.me) [![Downloads for last Release](https://img.shields.io/github/downloads/Belphemur/SoundSwitch/total.svg)](https://soundswitch.aaflalo.me/) [![Translate](https://hosted.weblate.org/widgets/soundswitch/-/svg-badge.svg)](https://hosted.weblate.org/projects/soundswitch/) [![Donate](https://img.shields.io/badge/Donate-paypal%2Fcc-blue.svg)](https://soundswitch.aaflalo.me)

**SoundSwitch** offers you the opportunity to switch your playback devices and/or recording devices using simple hotkeys.
**SoundSwitch** offers you the opportunity to switch your playback and recording devices using simple **hotkeys**.

**No more** navigating througth several menus and screens. Just configure SoundSwitch **once** - and you are able to switch between your devices as fast as never before!
**No more** navigating througth several menus and screens. Just configure SoundSwitch **once** and you are able to switch between your devices as fast as never before!

## Preview image
![preview](https://soundswitch.aaflalo.me/img/preview.gif)
## ✨ Preview
![Preview](img/preview.gif)

## Dependencies
The following components are required to run SoundSwitch on your Windows device:
- [Microsoft .NET Framework 4.7 (Web Installer)](https://www.microsoft.com/en-us/download/details.aspx?id=55170)
## Requirements
- ⚠ Operating System: Windows 7 or newer
- [Microsoft .NET Framework 4.7 (Web Installer)](https://www.microsoft.com/en-us/download/details.aspx?id=55170)

## Donations
If you want to donate for the development don't hesite [to do it here](https://soundswitch.aaflalo.me/#donate).
If you'd like to support the development, we would love to see you [here](https://soundswitch.aaflalo.me/#donate).

## Configuration
``Right click`` the SoundSwitch icon in your system tray and choose `Settings`. Now select the devices between which you want to toggle. Optionally you can also change the keyboard combination. If you want the application to start automatically when your PC boots up, check the box `Start automatically with Windows`.
_Right click_ the SoundSwitch icon in your system tray and choose _Settings_. Now select the devices between which you want to toggle. Optionally you can also change the keyboard combination. If you want the application to start automatically when your PC boots up, check the box _Start automatically with Windows_.

## Usage

First set up your devices you want to cycle through, using `right click` onto the `System Tray Icon` of SoundSwitch.
First set up your devices you want to cycle through, using _right click_ onto the _System Tray Icon_ of SoundSwitch.

**After you configured** SoundSwitch you can use the following Hotkeys.
**After you configured** SoundSwitch you can use the following hotkeys:

- To cycle through the **playback devices** press:
- `Ctrl` + `Alt` + `F11` (default) **OR**
- 🔊 To cycle through the **playback devices** press:
- `Ctrl` + `Alt` + `F11` (default) **or**
- Double click onto the `System Tray Icon` of SoundSwitch.

- To cycle through the **recording devices** press:
- 🎙 To cycle through the **recording devices** press:
- `Ctrl` + `Alt` + `F7` (default)

---
## _Switched_ Notification

## Features
SoundSwitch provides five types of notification when a device was changed:

### Recording Devices
SoundSwitch can also take care of your recording devices. You can set specifics hotkeys as for the playback devices.

### Notifications
SoundSwitch provides five types of notification when a device was changed.

- #### Banner
- #### 🎟 Banner
Uses a custom always-on-top frame, useful for in-game usage. This is the recommended default display style.

- #### Windows Notification
- #### 🗨 Windows Notification
Uses the balloon tip of Windows. In the case of Windows 7, it's the little balloon that opens next to the systray icon. For Windows 10, it's the notification system that slides from the right corner of the screen.

- #### Sound Notification
- #### 🎵 Sound Notification
This notification is a sound played on the switched device. This way when you are switching devices, the new device will 'chime' to tell you it's selected.

- #### Customized Sound Notification
- #### 🎶 Customized Sound Notification
The same as a Sound Notification but you can specify the sound which is played.

If you want to return to a silent Toast Notification, open the file selector, and just do Cancel. Doing that will remove the set sound.

---

## Advanced

### Communications
### 🎙 Communications
SoundSwitch can also change the **Default Communication Device** when asked in the Settings. Windows makes a differentiation between Multimedia and Communication; it means if an application asks to have access to communications audio device, it will receive the Default Communication Device. By default SoundSwitch only changes the multimedia device and not the communication. Now if the checkbox is checked in the settings, it will also change the Communication Device.

### Auto-Updater
This is one of the interesting feature, the auto-updater. Every 24h SoundSwitch will check the GitHub repository (thanks to the GitHub API) for a new release. If a new one is available the user will get a notification and the 'No update available' in the context menu will change to 'Update Available (X.X.X)' where X.X.X represent the new version number. When the user clicks on it, a new window opens with a progress bar (see screenshots). The new version gets automatically downloaded in the temp folder of the user. When the download is finished, the user can install the Update by just clicking the install button. A changelog is also provided by getting the information set in the release on GitHub.
### 📥 Auto-Updater
Every 24 hours SoundSwitch checks the GitHub repository (thanks to the GitHub API) for a new release. If a new one is available you will get a notification and the 'No update available' in the context menu will change to 'Update Available'. The new version gets automatically downloaded and installed, depeding on your _Update Mode_. We also provide a changelog with the latest improvements of SoundSwitch.

#### Update Modes
There are three different options available: **Silent**, means the program updates itself in the background without any prompts. **Notify**, you will be notified when there's an update available. **Never**, well this is self-explained.
#### 🚥 Update Modes
There are three different options available on how updates are installed:
- **Silent**, means the program updates itself in the background without any prompts.
- **Notify**, you will be notified when there's an update available.
- **Never**, well this is self-explained.

### Multi-Language Support
There are five languages available: **English**, **French**, **German**, **Spanish**, **Italian** and **Portuguese(Brazil)**.
### 🌎 Multi-Language Support
There are five languages available: **English**, **French**, **German**, **Spanish**, **Italian** and **Portuguese (Brazilian)**.

Would you like to help us with the localization? Great! See [Add or modify another language](https://github.com/Belphemur/SoundSwitch/wiki/Add-or-modify-another-language) for further informations.
Improve an existing or add another language? Translations are online editable [right here](https://hosted.weblate.org/projects/soundswitch/#languages)!

## Awards

<a href="http://www.giga.de/downloads/soundswitch/" target="_blank"><img src="https://i.imgur.com/19GaPLQ.png" alt="Giga 5 stars" height="100" hspace="10"/></a><a href="http://www.softpedia.com/get/Multimedia/Audio/Other-AUDIO-Tools/SoundSwitch.shtml#status" target="_blank"><img src="http://s1.softpedia-static.com/_img/sp100free.png" alt="Softpedia" height="100" hspace="10"/></a><a href="http://www.chip.de/downloads/SoundSwitch_94258571.html" target="_blank"><img src="https://i.imgur.com/Nedw1su.png" alt="Chip Online de" height="100" hspace="10"/></a><a href="https://www.netzwelt.de/download/24278-soundswitch.html" target="_blank"><img src="https://i.imgur.com/VaMTnxV.png" alt="netzwelt GmbH" height="100" hspace="10"/></a>
<a href="http://www.giga.de/downloads/soundswitch/"><img src="https://i.imgur.com/19GaPLQ.png" alt="Giga 5 stars" height="100" hspace="10"/></a><a href="http://www.softpedia.com/get/Multimedia/Audio/Other-AUDIO-Tools/SoundSwitch.shtml#status"><img src="http://s1.softpedia-static.com/_img/sp100free.png" alt="Softpedia" height="100" hspace="10"/></a><a href="http://www.chip.de/downloads/SoundSwitch_94258571.html"><img src="https://i.imgur.com/Nedw1su.png" alt="Chip Online de" height="100" hspace="10"/></a><a href="https://www.netzwelt.de/download/24278-soundswitch.html"><img src="https://i.imgur.com/VaMTnxV.png" alt="netzwelt GmbH" height="100" hspace="10"/></a>

## Contributors
## Thanks

### 🐱‍💻 Credits

- Original Developer: [Jeroen Pelgrims](http://jeroenpelgrims.be)
- Disabling Notification [#33](https://github.com/Belphemur/SoundSwitch/pull/33) [@adamblackburn](https://github.com/adamblackburn)
- Localization and German language [#157](https://github.com/Belphemur/SoundSwitch/pull/157) [@FireEmerald](https://github.com/FireEmerald)
- Localization and german translation [#157](https://github.com/Belphemur/SoundSwitch/pull/157) [@FireEmerald](https://github.com/FireEmerald)
- Banner Notification [#186](https://github.com/Belphemur/SoundSwitch/pull/186) [@ramon18](https://github.com/ramon18)
- Keyboard hook, [Christian Liensberger](http://www.liensberger.it/web/blog/?p=207).
- Changing default sound device, [EreTIk](http://eretik.omegahg.com/).
- Notification Sound, [Music box notification sound by Robinhood76](https://www.freesound.org/people/Robinhood76/sounds/216676/).
- Spanish Language [#244](https://github.com/Belphemur/SoundSwitch/pull/244) [@plextoriano](https://github.com/plextoriano)
- Portuguese (Brazilian) [#258](https://github.com/Belphemur/SoundSwitch/pull/258) [@aleczk](https://github.com/aleczk)
- Awesome Logo [#278](https://github.com/Belphemur/SoundSwitch/pull/278) [@linadesteem](https://github.com/linadesteem)

## Thanks

### JetBrains

Thanks for their Open-Source licence to their amazing IDEs and addons like ReSharper for Visual Studio.
- Keyboard hook, [Christian Liensberger](http://www.liensberger.it/web/blog/?p=207)
- Changing default sound device, [EreTIk](http://eretik.omegahg.com/)
- Notification Sound, [Music box notification sound by Robinhood76](https://www.freesound.org/people/Robinhood76/sounds/216676/)
- Spanish translation [#244](https://github.com/Belphemur/SoundSwitch/pull/244) [@plextoriano](https://github.com/plextoriano)
- Portuguese (Brazilian) translation [#258](https://github.com/Belphemur/SoundSwitch/pull/258) [@aleczk](https://github.com/aleczk)
- Awesome Logo [#278](https://github.com/Belphemur/SoundSwitch/pull/278) [@linadesteem](https://github.com/linadesteem)
- Icons [Pastel SVG icon set](https://codefisher.org/pastel-svg/), by Michael Buckley ([CC BY-NC-SA 4.0](http://creativecommons.org/licenses/by-nc-sa/4.0/))

<a href="https://www.jetbrains.com" target="_blank"><img src="https://i.imgur.com/opT9XBj.png" alt="JetBrain Tooling" height="100" hspace="10"/></a>
### 🤝 JetBrains ![JetBrain Tooling](https://i.imgur.com/SN2qAuL.png "JetBrain Tooling")

## Credits

**Icons**, the [Pastel SVG icon set](https://codefisher.org/pastel-svg/). Created by Michael Buckley. ([CC BY-NC-SA 4.0](http://creativecommons.org/licenses/by-nc-sa/4.0/ ))
Thanks for their Open-Source licence to their amazing IDEs and addons like [ReSharper](https://www.jetbrains.com/resharper) for Visual Studio.

## License: GPLv2

<a href="https://app.fossa.io/projects/git%2Bgithub.com%2FBelphemur%2FSoundSwitch?ref=badge_large"><img alt="FOSSA Status" align="right" src="https://app.fossa.io/api/projects/git%2Bgithub.com%2FBelphemur%2FSoundSwitch.svg?type=large"></a>

Copyright (C) 2015 Jeroen Pelgrims

Copyright (C) 2015-2018 Antoine Aflalo
Copyright (C) 2015-2020 Antoine Aflalo

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
Expand All @@ -120,5 +111,4 @@ but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.


[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2FBelphemur%2FSoundSwitch.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2FBelphemur%2FSoundSwitch?ref=badge_large)
The complete GPLv2 license file is located [here](https://github.com/Belphemur/SoundSwitch/blob/master/LICENSE.txt).
Binary file added img/preview-dark.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified img/preview.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit c234487

Please sign in to comment.