Skip to content

Commit

Permalink
v 1.4.0 Fix the issue that make it slower while browsing the web. Fix…
Browse files Browse the repository at this point in the history
… the issue that prevent nvda from speak typed characters after disabling keyboard sound typing effects. change that default sound library to a much newer one. Edit more navigation sound effects and more keyboard sounds. added multiple languages: English, Arabic, Spanish, French, Danish, Polish, and Chinese.
  • Loading branch information
ahmedthebest31 committed Sep 30, 2023
1 parent 0a02941 commit e41c77d
Show file tree
Hide file tree
Showing 66 changed files with 569 additions and 574 deletions.
205 changes: 89 additions & 116 deletions LICENSE

Large diffs are not rendered by default.

61 changes: 24 additions & 37 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,55 +1,42 @@
# nav Sounds
This is an NVDA screen reader add-on that
providing navigation sounds and keyboard typing sounds.
You can hear different sounds based on the roles of the elements you interact with,
Also allow you to play different keyboard sound as you type.
with the ability to customize everything.


## About
# Navigation Sounds

Navigation Sounds is an NVDA screen reader add-on that provides audio feedback for navigation and keyboard typing. It allows you to hear different sounds based on the roles of the elements you interact with and customize your experience.

This add-on is inspired by the abandoned "objsounds" add-on created by Tyler Spivey. Since that add-on hasn't been updated for a long time, I decided to create this add-on to continue providing similar functionality while keeping up with the changes in the NVDA screen reader.
## About

This add-on is inspired by the abandoned "objsounds" add-on created by Tyler Spivey. Since that add-on hasn't been updated for a long time, we've created this add-on to continue providing similar functionality while keeping up with the changes in the NVDA screen reader.

## Features

- Provides navigation sounds based on different roles.
- Toggle Functionality: Easily switch between enabling and disabling object sounds and toggling object type reading with a simple keyboard gesture.
- Play a different keyboard sounds as you type
- Customization: Access a settings page where you can choose from various navigation sound packages / keyboard typing sound effects and configure additional options.
- Expandable: includes a selection of sound packages / typing keyboard sound effects, and you can even create and add your custom packages.
- Easily toggle object sounds and keyboard typing sounds on and off using the keyboard shortcut NVDA+alt+n. You can also customize these settings through the NVDA menu Preferences > Input gestures > Navigation Sounds.
- Access a settings page where you can choose from various navigation sound packages and keyboard typing sound effects, as well as configure additional options.
- Includes a selection of sound packages and typing keyboard sound effects, with the ability to create and add your custom packages.
- Compatibility: Designed to work seamlessly with modern NVDA versions, starting from 2019.3.
- Available in multiple languages, including English, Arabic, Spanish, French, Danish, Polish, and Chinese.
- Watch a video about it on [YouTube](https://www.youtube.com/watch?v=p-Gw28CDzrA) (in Arabic).

- Compmpatibility: Designed to seamlessly work with modern NVDA versions, starting from 2019.3 and later.
## Installation

### Direct Installation (NVDA Version 2023.2+)

## Installation
For NVDA Installed Versions:
1. Download the latest release from the [Releases](https://github.com/ahmedthebest31/navsounds/releases/) section.
2. Double-click the downloaded add-on file and confirm the installation by clicking "OK."
3. NVDA will automatically restart, and you're ready to use NavigationSounds.
If you have NVDA version 2023.2 or newer, you can install it directly from the Add-on store with the name "Navigation Sound Effects."

### Manual Installation (For Older Versions)

For NVDA Portable Installation:
1. Download the latest release from the [Releases](https://github.com/ahmedthebest31/navsounds/releases/) section.
2. Double-click the downloaded add-on file and confirm the installation by clicking "OK."
3. NVDA will automatically restart, and you're ready to use Navigation Sounds.

1. Download the latest release from the [Releases](https://github.com/ahmedthebest31/navsounds/releases) section.
2. Open your NVDA screen reader.
3. Navigate to the NVDA menu: Tools -> Manage add-ons.
4. Click the "Install" button and select the downloaded add-on file.
5. Restart NVDA to activate NavigationSounds.
## Contributing

Contributions to this project are welcome! If you find a bug, have an idea for an improvement, or want to contribute in any other way, please feel free to open an issue or submit a pull request.

## Usage
Special thanks to [mesteranas](https://github.com/mesteranas/) for their wonderful contributions to developing this add-on.

- The navigation sounds will play based on the roles of objects as you interact with NVDA.
- Keyboard typing setting that will allow you to play a different keyboard sound as you type with NVDA, you can choose to play it in any time you press a button or while you focus on a text box.
- use the keybord shortcut (NVDA+alt+n) Pressing it once toggles between on and off object sounds, and Pressing twice it toggles between reading and disabling object types
- You can customize the keyboard shortcut as you prefer
open nvda menue Preferences subMenu / Input gestures
navigation sounds
## License

## Contributing
This project is licensed under the [GNU General Public License, version 2] - see the [LICENSE.md](LICENSE.md) file for details.

Contributions to this project are welcome! If you find a bug, have an idea for an improvement, or want to contribute in any other way, please feel free to open an issue or submit a pull request.
## Contact

Special thanks to [mesteranas](https://github.com/mesteranas/) for his wonderful Contributions in developing this add-on with me.
If you have questions or need support, you can [contact us](mailto:youremail@example.com).
24 changes: 24 additions & 0 deletions navsounds/doc/ar/readme.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
<html><head><style>body {
color: black;
}
</style></head><body><h1 id="nav-sounds-">nav Sounds (أصوات التصفح)</h1>
<p>هذه إضافة لقارئ الشاشة NVDA توفر أصوات التنقل وأصوات الكتابة على لوحة المفاتيح.
يمكنك سماع مؤثرات صوتية مختلفة استنادًا إلى أنواع العناصر التي تتفاعل معها.
كما يتيح لك تشغيل أصوات لوحة المفاتيح المختلفة أثناء الكتابة.
بإمكانك أيضًا تخصيص كل شيء وفقًا لاحتياجاتك.</p>
<h2 id="-">حول الإضافة</h2>
<p>تم برمجة هذه الإضافة بفكرة مستوحاة من إضافة &quot;objsounds&quot; التي تم التخلي عنها والتي أنشأها Tyler Spivey. نظرًا لأن هذه الإضافة لم تتم تحديثها لفترة طويلة، قررت إنشاء هذه الإضافة للاستمرار في تقديم وظائف مماثلة مع متابعة التغييرات في قارئ الشاشة NVDA.</p>
<p>تم إنشاء الإضافة بواسطة أحمد سامي (AhmedTheBest)
البريد الإلكتروني: ahmedthebest31@gmail.com
بالإضافة إلى مساهمة من أنس محمد
[المشروع على GitHub]&quot;<a href="https://github.com/ahmedthebest31/navsounds">https://github.com/ahmedthebest31/navsounds</a>)
<a href="https://www.paypal.me/ahmedthebest31">التبرع</a>
<a href="https://www.youtube.com/watch?v=p-Gw28CDzrA&amp;t=112s">ويمكنك ان تسمع شرح بالفيديو من يوتيوب من هذا الرابط</a>
وأنا صاحب اشهر قناة للمكفوفين على اليوتيوب تخص التقنية في الوطن العربي يمكنك زيارتها من الرابط التالي
<a href="https://www.youtube.com/ahmedsamy31">قناتي على يوتيوب</a></p>
<p>يمكنك بسهولة التبديل بين تفعيل وتعطيل أصوات العناصر وأصوات لوحة المفاتيح باستخدام إيماءة بسيطة على لوحة المفاتيح NVDA+alt+n، ويمكنك تخصيصها كما تريد من خلال الوصول إلى قائمة NVDA ومن ثم التفضيلات ثم قائمة إيماءات الإدخال وأصوات التصفح.
يمكنك الوصول إلى صفحة إعدادات حيث يمكنك اختيار من بين مجموعات متنوعة من أصوات التصفح وتأثيرات أصوات لوحة المفاتيح وتكوين خيارات إضافية.
تشمل مجموعة التأثيرات أيضًا مجموعة من حزم الأصوات وتأثيرات أصوات لوحة المفاتيح، ويمكنك حتى إنشاء وإضافة حزم مخصصة بنفسك.</p>
<p>نرحب بالمساهمات في هذا المشروع! إذا وجدت خللاً، أو كان لديك فكرة لتحسين الإضافة، أو ترغب في المساهمة بأي وسيلة أخرى، فلا تتردد في فتح مشكلة (issue) أو إرسال طلب استلام (pull request).</p>
<p>أشكر بشكل خاص صديقي العزيز <a href="https://github.com/mesteranas/">أنس محمد</a> على مساهماته الرائعة في تطوير هذه الإضافة معي.</p>
</body></html>
29 changes: 29 additions & 0 deletions navsounds/doc/ar/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# nav Sounds (أصوات التصفح)

هذه إضافة لقارئ الشاشة NVDA توفر أصوات التنقل وأصوات الكتابة على لوحة المفاتيح.
يمكنك سماع مؤثرات صوتية مختلفة استنادًا إلى أنواع العناصر التي تتفاعل معها.
كما يتيح لك تشغيل أصوات لوحة المفاتيح المختلفة أثناء الكتابة.
بإمكانك أيضًا تخصيص كل شيء وفقًا لاحتياجاتك.


## حول الإضافة

تم برمجة هذه الإضافة بفكرة مستوحاة من إضافة "objsounds" التي تم التخلي عنها والتي أنشأها Tyler Spivey. نظرًا لأن هذه الإضافة لم تتم تحديثها لفترة طويلة، قررت إنشاء هذه الإضافة للاستمرار في تقديم وظائف مماثلة مع متابعة التغييرات في قارئ الشاشة NVDA.

تم إنشاء الإضافة بواسطة أحمد سامي (AhmedTheBest)
البريد الإلكتروني: ahmedthebest31@gmail.com
بالإضافة إلى مساهمة من أنس محمد
[المشروع على GitHub]"https://github.com/ahmedthebest31/navsounds)
[التبرع](https://www.paypal.me/ahmedthebest31)
[ويمكنك ان تسمع شرح بالفيديو من يوتيوب من هذا الرابط](https://www.youtube.com/watch?v=p-Gw28CDzrA&t=112s)
وأنا صاحب اشهر قناة للمكفوفين على اليوتيوب تخص التقنية في الوطن العربي يمكنك زيارتها من الرابط التالي
[قناتي على يوتيوب](https://www.youtube.com/ahmedsamy31)


يمكنك بسهولة التبديل بين تفعيل وتعطيل أصوات العناصر وأصوات لوحة المفاتيح باستخدام إيماءة بسيطة على لوحة المفاتيح NVDA+alt+n، ويمكنك تخصيصها كما تريد من خلال الوصول إلى قائمة NVDA ومن ثم التفضيلات ثم قائمة إيماءات الإدخال وأصوات التصفح.
يمكنك الوصول إلى صفحة إعدادات حيث يمكنك اختيار من بين مجموعات متنوعة من أصوات التصفح وتأثيرات أصوات لوحة المفاتيح وتكوين خيارات إضافية.
تشمل مجموعة التأثيرات أيضًا مجموعة من حزم الأصوات وتأثيرات أصوات لوحة المفاتيح، ويمكنك حتى إنشاء وإضافة حزم مخصصة بنفسك.

نرحب بالمساهمات في هذا المشروع! إذا وجدت خللاً، أو كان لديك فكرة لتحسين الإضافة، أو ترغب في المساهمة بأي وسيلة أخرى، فلا تتردد في فتح مشكلة (issue) أو إرسال طلب استلام (pull request).

أشكر بشكل خاص صديقي العزيز [أنس محمد](https://github.com/mesteranas/) على مساهماته الرائعة في تطوير هذه الإضافة معي.
61 changes: 61 additions & 0 deletions navsounds/doc/de/readme.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>navSounds - help</title>
</head>
<body>

<h1 id="nav-sounds">nav Sounds</h1>
<p>This is an NVDA screen reader add-on that
providing navigation sounds and keyboard typing sounds.
You can hear different sounds based on the roles of the elements you interact with,
Also allow you to play different keyboard sound as you type.
with the ability to customize everything.</p>
<h2 id="about">About</h2>
<p>This add-on is inspired by the abandoned &quot;objsounds&quot; add-on created by Tyler Spivey. Since that add-on hasn&#39;t been updated for a long time, I decided to create this add-on to continue providing similar functionality while keeping up with the changes in the NVDA screen reader.</p>
<h2 id="features">Features</h2>
<ul>
<li><p>Provides navigation sounds based on different roles.</p>
</li>
<li><p>Toggle Functionality: Easily switch between enabling and disabling object sounds and toggling object type reading with a simple keyboard gesture.</p>
</li>
<li><p>Play a different keyboard sounds as you type</p>
</li>
<li><p>Customization: Access a settings page where you can choose from various navigation sound packages / keyboard typing sound effects and configure additional options.</p>
</li>
<li><p>Expandable: includes a selection of sound packages / typing keyboard sound effects, and you can even create and add your custom packages.</p>
</li>
<li><p>Compmpatibility: Designed to seamlessly work with modern NVDA versions, starting from 2019.3 and later.</p>
</li>
</ul>
<h2 id="installation">Installation</h2>
<p>For NVDA Installed Versions:</p>
<ol>
<li>Download the latest release from the <a href="https://github.com/ahmedthebest31/navsounds/releases/">Releases</a> section.</li>
<li>Double-click the downloaded add-on file and confirm the installation by clicking &quot;OK.&quot;</li>
<li>NVDA will automatically restart, and you&#39;re ready to use NavigationSounds.</li>
</ol>
<p>For NVDA Portable Installation:</p>
<ol>
<li>Download the latest release from the <a href="https://github.com/ahmedthebest31/navsounds/releases">Releases</a> section.</li>
<li>Open your NVDA screen reader.</li>
<li>Navigate to the NVDA menu: Tools -&gt; Manage add-ons.</li>
<li>Click the &quot;Install&quot; button and select the downloaded add-on file.</li>
<li>Restart NVDA to activate NavigationSounds.</li>
</ol>
<h2 id="usage">Usage</h2>
<ul>
<li>The navigation sounds will play based on the roles of objects as you interact with NVDA.</li>
<li>Keyboard typing setting that will allow you to play a different keyboard sound as you type with NVDA, you can choose to play it in any time you press a button or while you focus on a text box. </li>
<li>use the keybord shortcut (NVDA+alt+n) Pressing it once toggles between on and off object sounds, and Pressing twice it toggles between reading and disabling object types </li>
<li>You can customize the keyboard shortcut as you prefer<br>open nvda menue Preferences subMenu / Input gestures
navigation sounds</li>
</ul>
<h2 id="contributing">Contributing</h2>
<p>Contributions to this project are welcome! If you find a bug, have an idea for an improvement, or want to contribute in any other way, please feel free to open an issue or submit a pull request.</p>
<p>Special thanks to <a href="https://github.com/mesteranas/">mesteranas</a> for his wonderful Contributions in developing this add-on with me.</p>

</body>
</html>
27 changes: 27 additions & 0 deletions navsounds/doc/de/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# nav Sounds
This is an NVDA screen reader add-on that
providing navigation sounds and keyboard typing sounds.
You can hear different sounds based on the roles of the elements you interact with,
Also allow you to play different keyboard sound as you type.
with the ability to customize everything.


## About


This add-on is inspired by the abandoned "objsounds" add-on created by Tyler Spivey. Since that add-on hasn't been updated for a long time, I decided to create this add-on to continue providing similar functionality while keeping up with the changes in the NVDA screen reader.

created by Ahmed Samy (AhmedTheBest)
email: ahmedthebest31@gmail.com
with a Contribution from mesteranas
[github]("https://github.com/ahmedthebest31/navsounds")
[donation]("https://www.paypal.me/ahmedthebest31")

Easily switch between enabling and disabling object sounds and keyboard typing sound with a simple keyboard gesture NVDA+alt+n and you can customize it as you want from open nvda menue Preferences subMenu / Input gestures navigation sounds.
Access a settings page where you can choose from various navigation sound packages / keyboard typing sound effects and configure additional options.
includes a selection of sound packages / typing keyboard sound effects, and you can even create and add your custom packages.


Contributions to this project are welcome! If you find a bug, have an idea for an improvement, or want to contribute in any other way, please feel free to open an issue or submit a pull request.

Special thanks to [mesteranas](https://github.com/mesteranas/) for his wonderful Contributions in developing this add-on with me.
Loading

0 comments on commit e41c77d

Please sign in to comment.