search

quiet / quiet-js

Transmit data with sound using Web Audio -- Javascript binding for libquiet
BSD 3-Clause "New" or "Revised" License
2.18k stars 151 forks source link

Instructions to use locally #35

Open lrq3000 opened 4 years ago

lrq3000 commented 4 years ago

I think it would be great to add instructions in the README on how to use quiet-js locally. It seems to me there are two ways:

I have tested the latter and it works very well.

Also the readme (or the live demo) could maybe be more explicit about the fact that ultrasound is way more reliable than sound transfer, and also that the volume should be quite low. At first, I thought it did not work because:

1- my computer had automatic noise filtering from microphone that I had to disable 2- Then, quiet-js (gh-pages branch) started to pick up the sound as evidenced by "1/1 packet lost" message, but all packets were lost, 3- Then I tried to lower down the sound to 20-50%, and the ultrasound send worked flawlessly from there on (even with music or other noises in the background!), whereas the sound transfer still did not work.

I know it's not your fault as the dev of this package that there are these roadblocks that may prevent users from effectively testing the app, but I think a few notes in the readme could save a lot of time (both for the users and for you since you'll get less questions about these issues!).

Thanks a lot for making this software, it works awesomely well!

lrq3000 commented 4 years ago

BTW I made a portable version of quiet-js using Laragon on Windows that can be run locally, the package can be downloaded here: https://drive.google.com/file/d/1g1fqSydeXY-ewDCYo3GVc8HzlN4osAXq/view?usp=sharing

nishant2019 commented 3 years ago

BTW I made a portable version of quiet-js using Laragon on Windows that can be run locally, the package can be downloaded here: https://drive.google.com/file/d/1g1fqSydeXY-ewDCYo3GVc8HzlN4osAXq/view?usp=sharing

I downloaded the package but I am getting errors. Screenshots are attached

image

image

lrq3000 commented 3 years ago

Look at your path, the parent folder is test in your setup while in mine it was quiet-js, you may want to tweak the paths to get it working. I admit i didn't spend too much time to ensure coverage of edge cases or bugs, i just hacked the package together quickly as a proof of concept for a portable release.

Le sam. 27 mars 2021 à 11:49, nishant2019 @.***> a écrit :

BTW I made a portable version of quiet-js using Laragon on Windows that can be run locally, the package can be downloaded here: https://drive.google.com/file/d/1g1fqSydeXY-ewDCYo3GVc8HzlN4osAXq/view?usp=sharing

I downloaded the package but I am getting errors. Screenshots are attached

[image: image] https://user-images.githubusercontent.com/49723167/112718304-1ccb3a80-8f18-11eb-92ab-17feb0e38003.png

[image: image] https://user-images.githubusercontent.com/49723167/112718313-2d7bb080-8f18-11eb-8c5d-a824a5e0dde5.png

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/quiet/quiet-js/issues/35#issuecomment-808710360, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAIRFXSRYADKDRKYUBR2IHTTFWZ35ANCNFSM4LJJFW7A .