Update macOS documentation
This commit is contained in:
@@ -22,7 +22,7 @@ location by modifying the configuration file.
|
||||
======= ===========
|
||||
Docker /config/
|
||||
Linux /usr/local/sunshine/config/
|
||||
MacOS /usr/local/sunshine/config/
|
||||
macOS /usr/local/sunshine/config/
|
||||
Windows ./config/
|
||||
======= ===========
|
||||
|
||||
@@ -225,7 +225,7 @@ Description
|
||||
To be supported by Sunshine, it needs to have at the very minimum:
|
||||
``VAProfileH264High : VAEntrypointEncSlice``
|
||||
|
||||
.. Todo:: MacOS
|
||||
.. Todo:: macOS
|
||||
|
||||
Windows
|
||||
.. code-block:: batch
|
||||
@@ -241,7 +241,7 @@ Examples
|
||||
|
||||
adapter_name = /dev/dri/renderD128
|
||||
|
||||
.. Todo:: MacOS
|
||||
.. Todo:: macOS
|
||||
|
||||
Windows
|
||||
.. code-block:: text
|
||||
@@ -265,7 +265,7 @@ Description
|
||||
|
||||
You need to use the value before the colon in the output, e.g. ``0``.
|
||||
|
||||
.. Todo:: MacOS
|
||||
.. Todo:: macOS
|
||||
|
||||
Windows
|
||||
.. code-block:: batch
|
||||
@@ -281,7 +281,7 @@ Examples
|
||||
|
||||
output_name = 0
|
||||
|
||||
.. Todo:: MacOS
|
||||
.. Todo:: macOS
|
||||
|
||||
Windows
|
||||
.. code-block:: text
|
||||
@@ -376,8 +376,8 @@ Description
|
||||
# in some causes you'd need to use the `Sink` device, if `Source` doesn't work, so try:
|
||||
pactl info | grep Sink
|
||||
|
||||
MacOS
|
||||
Sunshine can only access microphones on MacOS due to system limitations. To stream system audio use
|
||||
macOS
|
||||
Sunshine can only access microphones on macOS due to system limitations. To stream system audio use
|
||||
`Soundflower <https://github.com/mattingalls/Soundflower>`_ or
|
||||
`BlackHole <https://github.com/ExistentialAudio/BlackHole>`_.
|
||||
|
||||
@@ -395,7 +395,7 @@ Examples
|
||||
|
||||
audio_sink = alsa_output.pci-0000_09_00.3.analog-stereo
|
||||
|
||||
MacOS
|
||||
macOS
|
||||
.. code-block:: text
|
||||
|
||||
audio_sink = BlackHole 2ch
|
||||
@@ -993,7 +993,7 @@ vt_software
|
||||
Description
|
||||
Force Video Toolbox to use software encoding.
|
||||
|
||||
.. Note:: This option only applies when using MacOS.
|
||||
.. Note:: This option only applies when using macOS.
|
||||
|
||||
**Choices**
|
||||
|
||||
@@ -1023,7 +1023,7 @@ vt_realtime
|
||||
Description
|
||||
Realtime encoding.
|
||||
|
||||
.. Note:: This option only applies when using MacOS.
|
||||
.. Note:: This option only applies when using macOS.
|
||||
|
||||
.. Warning:: Disabling realtime encoding might result in a delayed frame encoding or frame drop.
|
||||
|
||||
@@ -1041,7 +1041,7 @@ vt_coder
|
||||
Description
|
||||
The entropy encoding to use.
|
||||
|
||||
.. Note:: This option only applies when using MacOS.
|
||||
.. Note:: This option only applies when using macOS.
|
||||
|
||||
**Choices**
|
||||
|
||||
|
||||
@@ -9,8 +9,6 @@ Binaries
|
||||
Binaries of Sunshine are created for each release. They are available for Linux, and Windows.
|
||||
Binaries can be found in the `latest release`_.
|
||||
|
||||
.. Todo:: Create binary package(s) for MacOS. See `here <https://github.com/SunshineStream/Sunshine/issues/61>`_.
|
||||
|
||||
.. Tip:: Some third party packages also exist. See
|
||||
:ref:`Third Party Packages <about/third_party_packages:third party packages>`.
|
||||
|
||||
@@ -97,7 +95,7 @@ RPM Package
|
||||
|
||||
.. Tip:: You can double click the rpm file to see details about the package and begin installation.
|
||||
|
||||
MacOS
|
||||
macOS
|
||||
-----
|
||||
Requirements
|
||||
.. table::
|
||||
@@ -112,6 +110,11 @@ Requirements
|
||||
.. image:: https://img.shields.io/github/issues/sunshinestream/sunshine/os:macos?logo=github&style=for-the-badge
|
||||
:alt: GitHub issues by-label
|
||||
|
||||
pkg
|
||||
.. Warning:: The `pkg` does not include runtime dependencies and should be considered experimental.
|
||||
|
||||
#. Download the ``sunshine.pkg`` file and install it as normal.
|
||||
|
||||
Portfile
|
||||
#. Install `MacPorts <https://www.macports.org>`_
|
||||
#. Update the Macports sources.
|
||||
|
||||
@@ -27,7 +27,7 @@ Usage
|
||||
list of applications that are started just before running a stream. This is the directory within the GitHub
|
||||
repo.
|
||||
|
||||
.. Attention:: Application list is not fully supported on MacOS
|
||||
.. Attention:: Application list is not fully supported on macOS
|
||||
|
||||
#. In Moonlight, you may need to add the PC manually.
|
||||
#. When Moonlight request you insert the correct pin on sunshine:
|
||||
@@ -137,7 +137,7 @@ Sunshine needs access to `uinput` to create mouse and gamepad events.
|
||||
|
||||
sudo reboot now
|
||||
|
||||
MacOS
|
||||
macOS
|
||||
^^^^^
|
||||
Sunshine can only access microphones on macOS due to system limitations. To stream system audio use
|
||||
`Soundflower <https://github.com/mattingalls/Soundflower>`_ or
|
||||
|
||||
Reference in New Issue
Block a user