mirror/Sunshine
1
0
Fork 0
mirror of https://github.com/LizardByte/Sunshine.git synced 2025-02-28 03:40:03 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update macOS documentation

Browse Source
This commit is contained in:
ReenigneArcher 2022-06-28 19:16:24 -04:00
parent 4f07672cfa
commit 3cd3d261e9
9 changed files with 51 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
CMakeLists.txt
View File

@ -6,12 +6,12 @@ project(Sunshine VERSION 0.14.0
)
set(PROJECT_LONG_DESCRIPTION "Sunshine is a self hosted, low latency, cloud gaming solution with support for AMD, \
Intel, and Nvidia gpus. It is an open source implementation of NVIDIA's GameStream, as used by the NVIDIA Shield. \
Intel, and Nvidia GPUs. It is an open source implementation of NVIDIA's GameStream, as used by the NVIDIA Shield. \
Connect to Sunshine from any Moonlight client, available for nearly any device imaginable.")
option(SUNSHINE_CONFIGURE_APPIMAGE "Configure files required for AppImage." OFF)
option(SUNSHINE_CONFIGURE_FLATPAK "Configure files required for Flatpak." OFF)
option(SUNSHINE_CONFIGURE_PORTFILE "Configure MacOS Portfile." OFF)
option(SUNSHINE_CONFIGURE_PORTFILE "Configure macOS Portfile." OFF)
option(SUNSHINE_CONFIGURE_ONLY "Configure special files only, then exit." OFF)
if(${SUNSHINE_CONFIGURE_APPIMAGE})

15
README.rst
View File

@ -6,19 +6,22 @@ SunshineStream has the full documentation hosted on `Read the Docs <http://sunsh
About
-----
Sunshine is a Game stream host for Moonlight. It is an open source version of GeForce Experience (GFE).
Sunshine is a Game stream host for Moonlight.
Sunshine is a self hosted, low latency, cloud gaming solution with support for AMD, Intel, and Nvidia gpus.
It is an open source implementation of NVIDIA's GameStream, as used by the NVIDIA Shield.
Connect to Sunshine from any Moonlight client, available for nearly any device imaginable.
These are the advantages of Sunshine over GFE.
These are the advantages of Sunshine over GeForce Experience.
- FOSS (Free and Open Source Software)
- Multi-platform
- Linux (deb, rpm, and AppImage packages)
- MacOS (Portfile)
- Windows (portable binary)
- Linux
- macOS
- Windows
- Pair over web ui
- Supports AMD and Nvidia GPUs for encoding
- Supports AMD, Intel, and Nvidia GPUs for encoding
- Supports software encoding
- Supports streaming to multiple clients
- Web UI for configuration

22
docs/source/about/advanced_usage.rst
View File

@ -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
docs/source/about/installation.rst
View File

@ -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.

4
docs/source/about/usage.rst
View File

@ -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

2
docs/source/building/build.rst
View File

@ -22,7 +22,7 @@ Compile
See the section specific to your OS.
- :ref:`Linux <building/linux:linux>`
- :ref:`MacOS <building/macos:macos>`
- :ref:`macOS <building/macos:macos>`
- :ref:`Windows <building/windows:windows>`
Remote Build

6
docs/source/building/macos.rst
View File

@ -1,11 +1,11 @@
:github_url: https://github.com/SunshineStream/Sunshine/tree/nightly/docs/source/building/macos.rst
MacOS
macOS
=====
Requirements
------------
MacOS Big Sur and Xcode 12.5+
macOS Big Sur and Xcode 12.5+
Use either `MacPorts <https://www.macports.org>`_ or `Homebrew <https://brew.sh>`_
@ -35,7 +35,7 @@ Build
cmake ..
make -j ${nproc}
cpack -G DragNDrop # optionally, create a MacOS dmg package
cpack -G DragNDrop # optionally, create a macOS dmg package
If cmake fails complaining to find Boost, try to set the path explicitly.

17
docs/source/troubleshooting/macos.rst
View File

@ -1,6 +1,6 @@
:github_url: https://github.com/SunshineStream/Sunshine/tree/nightly/docs/source/troubleshooting/macos.rst
MacOS
macOS
=====
If you get this error:
@ -12,3 +12,18 @@ If you get this error:
.. code-block:: bash
launchctl load -w /Library/LaunchAgents/org.freedesktop.dbus-session.plist
Uninstall:
- pkg
.. code-block:: bash
sudo chmod +x /opt/local/etc/sunshine/assets/uninstall_pkg.sh
sudo /opt/local/etc/sunshine/assets/uninstall_pkg.sh
- Portfile
.. code-block:: bash
sudo port uninstall Sunshine

2
sunshine/platform/common.h
View File

@ -161,7 +161,7 @@ struct sink_t {
// Play on host PC
std::string host;
// On MacOS and Windows, it is not possible to create a virtual sink
// On macOS and Windows, it is not possible to create a virtual sink
// Therefore, it is optional
struct null_t {
std::string stereo;