diff --git a/CMakeLists.txt b/CMakeLists.txt index ba27a8a5..86a68db0 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -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}) diff --git a/README.rst b/README.rst index 24d0c161..95408df8 100644 --- a/README.rst +++ b/README.rst @@ -6,19 +6,22 @@ SunshineStream has the full documentation hosted on `Read the Docs `_ or `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** diff --git a/docs/source/about/installation.rst b/docs/source/about/installation.rst index e175bd99..ed8e9ac1 100644 --- a/docs/source/about/installation.rst +++ b/docs/source/about/installation.rst @@ -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 `_. - .. Tip:: Some third party packages also exist. See :ref:`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 `_ #. Update the Macports sources. diff --git a/docs/source/about/usage.rst b/docs/source/about/usage.rst index 8ae0287c..92038cf9 100644 --- a/docs/source/about/usage.rst +++ b/docs/source/about/usage.rst @@ -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 `_ or diff --git a/docs/source/building/build.rst b/docs/source/building/build.rst index cd83cb14..a703959d 100644 --- a/docs/source/building/build.rst +++ b/docs/source/building/build.rst @@ -22,7 +22,7 @@ Compile See the section specific to your OS. - :ref:`Linux ` -- :ref:`MacOS ` +- :ref:`macOS ` - :ref:`Windows ` Remote Build diff --git a/docs/source/building/macos.rst b/docs/source/building/macos.rst index 51ae6b15..d20a5517 100644 --- a/docs/source/building/macos.rst +++ b/docs/source/building/macos.rst @@ -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 `_ or `Homebrew `_ @@ -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. diff --git a/docs/source/troubleshooting/macos.rst b/docs/source/troubleshooting/macos.rst index 18ea9361..5a6ae658 100644 --- a/docs/source/troubleshooting/macos.rst +++ b/docs/source/troubleshooting/macos.rst @@ -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 diff --git a/sunshine/platform/common.h b/sunshine/platform/common.h index 4d1588a3..ef9a2cf6 100644 --- a/sunshine/platform/common.h +++ b/sunshine/platform/common.h @@ -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;