Update README (#48)
This commit is contained in:
parent
753da8b1d3
commit
758ffa8cb5
13
README.md
13
README.md
|
@ -1,12 +1,16 @@
|
||||||
# discord-screenaudio
|
# discord-screenaudio
|
||||||
|
|
||||||
A very WIP custom discord client that supports streaming with audio on Linux,
|
A custom discord client that supports streaming with audio on Linux, made
|
||||||
made possible by the
|
possible by the
|
||||||
[great work](https://github.com/edisionnano/Screenshare-with-audio-on-Discord-with-Linux)
|
[great work](https://github.com/edisionnano/Screenshare-with-audio-on-Discord-with-Linux)
|
||||||
of [@edisionnano](https://github.com/edisionnano) and the
|
of [@edisionnano](https://github.com/edisionnano) and the
|
||||||
[Rohrkabel library](https://github.com/Soundux/rohrkabel) by
|
[Rohrkabel library](https://github.com/Soundux/rohrkabel) by
|
||||||
[@Curve](https://github.com/Curve).
|
[@Curve](https://github.com/Curve).
|
||||||
|
|
||||||
|
Unlike a lot of other solutions, the audio here is directly fed into the
|
||||||
|
screenshare and not passed to the user microphone
|
||||||
|
([see explanation](#how-it-works)).
|
||||||
|
|
||||||
![Screenshot_20220718_194357](https://user-images.githubusercontent.com/48161361/179571245-11ea05f3-fb5e-4aef-9132-2736e122ef04.png)
|
![Screenshot_20220718_194357](https://user-images.githubusercontent.com/48161361/179571245-11ea05f3-fb5e-4aef-9132-2736e122ef04.png)
|
||||||
|
|
||||||
The purpose of this project is **not** to provide an alternative to the original
|
The purpose of this project is **not** to provide an alternative to the original
|
||||||
|
@ -23,8 +27,9 @@ told you and it's not my fault.
|
||||||
## Known Issues
|
## Known Issues
|
||||||
|
|
||||||
- Only works with **PipeWire**
|
- Only works with **PipeWire**
|
||||||
- Can only share primary screen on X11 (no other screens or specific applications)
|
- Can only share primary screen on X11 (no other screens or specific
|
||||||
(see [#1](https://github.com/maltejur/discord-screenaudio/issues/1))
|
applications) (see
|
||||||
|
[#1](https://github.com/maltejur/discord-screenaudio/issues/1))
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
|
|
|
@ -8,14 +8,18 @@
|
||||||
<release version="${DISCORD_SCEENAUDIO_VERSION_FULL}" timestamp="${TIMESTAMP}" />
|
<release version="${DISCORD_SCEENAUDIO_VERSION_FULL}" timestamp="${TIMESTAMP}" />
|
||||||
</releases>
|
</releases>
|
||||||
|
|
||||||
<summary>A very WIP custom discord client that supports streaming with audio on Linux</summary>
|
<summary>A custom discord client that supports streaming with audio on Linux</summary>
|
||||||
|
|
||||||
<description>
|
<description>
|
||||||
<p>A very WIP custom discord client that supports streaming with audio on Linux, made possible by the great work of @edisionnano and the Rohrkabel library by @Curve.</p>
|
<p>A custom discord client that supports streaming with audio on Linux, made possible by the great work of @edisionnano and the Rohrkabel library by @Curve.</p>
|
||||||
|
<p>Unlike a lot of other solutions, the audio here is directly fed into the screenshare and not passed to the user microphone.</p>
|
||||||
<p>The purpose of this project is not to provide an alternative to the original Discord client. Rather, it should be used in addition to the original client in case you want to stream something, maybe used with a second account. For anything else, this client has way too many things that work less well than in the original client.</p>
|
<p>The purpose of this project is not to provide an alternative to the original Discord client. Rather, it should be used in addition to the original client in case you want to stream something, maybe used with a second account. For anything else, this client has way too many things that work less well than in the original client.</p>
|
||||||
<p>Technically this could be against Discord's TOS, so be warned. Discord probably won't ban you for using this, but if they do I told you and it's not my fault.</p>
|
<p>Technically this could be against Discord's TOS, so be warned. Discord probably won't ban you for using this, but if they do I told you and it's not my fault.</p>
|
||||||
<p>Known issues:</p>
|
<p>Known issues:</p>
|
||||||
<ul><li>Only works with PipeWire</li><li>Can only share primary screen on X11</li></ul>
|
<ul>
|
||||||
|
<li>Only works with PipeWire</li>
|
||||||
|
<li>Can only share primary screen on X11</li>
|
||||||
|
</ul>
|
||||||
</description>
|
</description>
|
||||||
|
|
||||||
<launchable type="desktop-id">
|
<launchable type="desktop-id">
|
||||||
|
|
Loading…
Reference in New Issue