Sunshine/docs/source/building/windows.rst

Windows
=======

Requirements
------------
First you need to install `MSYS2 <https://www.msys2.org>`__, then startup "MSYS2 UCRT64" and execute the following
codes.

Update all packages:
   .. code-block:: bash

      pacman -Suy

Install dependencies:
   .. code-block:: bash

      pacman -S \
        doxygen \
        git \
        mingw-w64-ucrt-x86_64-cmake \
        mingw-w64-ucrt-x86_64-cppwinrt \
        mingw-w64-ucrt-x86_64-curl \
        mingw-w64-ucrt-x86_64-graphviz \
        mingw-w64-ucrt-x86_64-miniupnpc \
        mingw-w64-ucrt-x86_64-nlohmann-json \
        mingw-w64-ucrt-x86_64-nodejs \
        mingw-w64-ucrt-x86_64-nsis \
        mingw-w64-ucrt-x86_64-onevpl \
        mingw-w64-ucrt-x86_64-openssl \
        mingw-w64-ucrt-x86_64-opus \
        mingw-w64-ucrt-x86_64-rust \
        mingw-w64-ucrt-x86_64-toolchain \
        python \
        python-pip

Build
-----
.. attention:: Ensure you are in the build directory created during the clone step earlier before continuing.

.. code-block:: bash

   cmake -G "MinGW Makefiles" ..
   mingw32-make -j$(nproc)

   cpack -G NSIS  # optionally, create a windows installer
   cpack -G ZIP  # optionally, create a windows standalone package
Initial version of sphinx documentation and... - remove ubuntu 21.04 from CI (end of life) - adjust matrix strategy for clang.yml - Use lessons learned from RetroArcher on localize.yml, crowdin.yml, and locale.py - Add end of life comments to Dockerfiles - Adjust dependency order in Dockerfiles 2022-04-18 18:53:28 +00:00			`Windows`
			`=======`

			`Requirements`
			`------------`
build(win): use UCRT64 environment instead of MinGW64. (#2323) Co-authored-by: Conn O'Griofa <connogriofa@gmail.com> 2024-05-25 20:28:14 +00:00			First you need to install `MSYS2 <https://www.msys2.org>`__, then startup "MSYS2 UCRT64" and execute the following
update docs (#574) 2022-12-28 21:30:32 +00:00			`codes.`
Initial version of sphinx documentation and... - remove ubuntu 21.04 from CI (end of life) - adjust matrix strategy for clang.yml - Use lessons learned from RetroArcher on localize.yml, crowdin.yml, and locale.py - Add end of life comments to Dockerfiles - Adjust dependency order in Dockerfiles 2022-04-18 18:53:28 +00:00
update docs (#574) 2022-12-28 21:30:32 +00:00			`Update all packages:`
			`.. code-block:: bash`

			`pacman -Suy`
Initial version of sphinx documentation and... - remove ubuntu 21.04 from CI (end of life) - adjust matrix strategy for clang.yml - Use lessons learned from RetroArcher on localize.yml, crowdin.yml, and locale.py - Add end of life comments to Dockerfiles - Adjust dependency order in Dockerfiles 2022-04-18 18:53:28 +00:00
update docs (#574) 2022-12-28 21:30:32 +00:00			`Install dependencies:`
			`.. code-block:: bash`

builds(deps): use miniupnpc package instead of submodule (#1971) Co-authored-by: Cameron Gutman <aicommander@gmail.com> 2024-01-01 23:48:27 +00:00			`pacman -S \`
ci(tests): add test framework (#1603) 2024-03-24 23:52:24 +00:00			`doxygen \`
builds(deps): use miniupnpc package instead of submodule (#1971) Co-authored-by: Cameron Gutman <aicommander@gmail.com> 2024-01-01 23:48:27 +00:00			`git \`
build(win): use UCRT64 environment instead of MinGW64. (#2323) Co-authored-by: Conn O'Griofa <connogriofa@gmail.com> 2024-05-25 20:28:14 +00:00			`mingw-w64-ucrt-x86_64-cmake \`
feat(win): new capture method, Windows.Graphics.Capture (#2580) 2024-05-27 18:16:14 +00:00			`mingw-w64-ucrt-x86_64-cppwinrt \`
build(win): use UCRT64 environment instead of MinGW64. (#2323) Co-authored-by: Conn O'Griofa <connogriofa@gmail.com> 2024-05-25 20:28:14 +00:00			`mingw-w64-ucrt-x86_64-curl \`
			`mingw-w64-ucrt-x86_64-graphviz \`
			`mingw-w64-ucrt-x86_64-miniupnpc \`
			`mingw-w64-ucrt-x86_64-nlohmann-json \`
			`mingw-w64-ucrt-x86_64-nodejs \`
			`mingw-w64-ucrt-x86_64-nsis \`
			`mingw-w64-ucrt-x86_64-onevpl \`
			`mingw-w64-ucrt-x86_64-openssl \`
			`mingw-w64-ucrt-x86_64-opus \`
			`mingw-w64-ucrt-x86_64-rust \`
			`mingw-w64-ucrt-x86_64-toolchain \`
ci(tests): add test framework (#1603) 2024-03-24 23:52:24 +00:00			`python \`
			`python-pip`
update build instructions 2022-11-19 23:58:37 +00:00
Initial version of sphinx documentation and... - remove ubuntu 21.04 from CI (end of life) - adjust matrix strategy for clang.yml - Use lessons learned from RetroArcher on localize.yml, crowdin.yml, and locale.py - Add end of life comments to Dockerfiles - Adjust dependency order in Dockerfiles 2022-04-18 18:53:28 +00:00			`Build`
			`-----`
docs: refactor and general cleanup (#1992) 2024-01-07 16:58:13 +00:00			`.. attention:: Ensure you are in the build directory created during the clone step earlier before continuing.`
Initial version of sphinx documentation and... - remove ubuntu 21.04 from CI (end of life) - adjust matrix strategy for clang.yml - Use lessons learned from RetroArcher on localize.yml, crowdin.yml, and locale.py - Add end of life comments to Dockerfiles - Adjust dependency order in Dockerfiles 2022-04-18 18:53:28 +00:00
change docs theme to `furo` 2022-10-30 02:14:16 +00:00			`.. code-block:: bash`
Initial version of sphinx documentation and... - remove ubuntu 21.04 from CI (end of life) - adjust matrix strategy for clang.yml - Use lessons learned from RetroArcher on localize.yml, crowdin.yml, and locale.py - Add end of life comments to Dockerfiles - Adjust dependency order in Dockerfiles 2022-04-18 18:53:28 +00:00
update docs (#574) 2022-12-28 21:30:32 +00:00			`cmake -G "MinGW Makefiles" ..`
			`mingw32-make -j$(nproc)`
Update documentation for cpack 2022-04-30 22:22:17 +00:00
change docs theme to `furo` 2022-10-30 02:14:16 +00:00			`cpack -G NSIS # optionally, create a windows installer`
			`cpack -G ZIP # optionally, create a windows standalone package`