feat: initial implementation (#160)

Author: ReenigneArcher

.github/copilot-instructions.md

@@ -3,6 +3,27 @@ You need to prefix commands with `C:\msys64\msys2_shell.cmd -defterm -here -no-s
 
 Prefix build directories with `cmake-build-`.
 
+The xbox build uses Unix Makefiles.
+
+The host native tests will use MinGW Makefiles on Windows, but Unix Makefiles on other platforms.
+
 The project uses gtest as a test framework.
 
+Always add or update doxygen documentation.
+
+The project requires that everything be documented in doxygen or the build will fail.
+
+Primary doxygen comments should be done like so:
+
+```cpp
+  /**
+   * @brief Describe the function, structure, etc.
+   *
+   * @param my_param Describe the parameter.
+   * @return Describe the return.
+   */
+```
+
+Inline doxygen comments should use `///< ...` instead of `/**< ... */`.
+
 Always follow the style guidelines defined in .clang-format for c/c++ code.

.github/workflows/ci.yml

@@ -103,14 +103,15 @@ jobs:
           update: true
           install: >-
             bison
-            cmake
             flex
             git
             make
+            mingw-w64-x86_64-cmake
             mingw-w64-x86_64-clang
             mingw-w64-x86_64-gcc
             mingw-w64-x86_64-lld
             mingw-w64-x86_64-llvm
+            mingw-w64-x86_64-make
 
       - name: Setup python
         id: setup-python

.gitignore

@@ -43,5 +43,8 @@ cmake-*/
 .local/
 docs/doxyconfig*
 
+# test output
+test-output/
+
 # Temporary files
 *.cmd~

.gitmodules

@@ -16,4 +16,8 @@
 [submodule "third-party/openssl"]
 	path = third-party/openssl
 	url = https://github.com/openssl/openssl.git
+	branch = OpenSSL_1_1_1-stable
+[submodule "third-party/tomlplusplus"]
+	path = third-party/tomlplusplus
+	url = https://github.com/marzer/tomlplusplus.git
 	branch = master

.run/docs.run.xml

@@ -0,0 +1,7 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="docs" type="CMakeRunConfiguration" factoryName="Application" PROGRAM_PARAMS="&quot;file:\\$CMakeCurrentBuildDir$\build\html\index.html&quot;" REDIRECT_INPUT="false" ELEVATE="false" USE_EXTERNAL_CONSOLE="false" EMULATE_TERMINAL="false" PASS_PARENT_ENVS_2="true" PROJECT_NAME="Moonlight" TARGET_NAME="docs" CONFIG_NAME="nxdk-release (mingw64)" RUN_PATH="$PROJECT_DIR$/../../../../../Windows/explorer.exe">
+    <method v="2">
+      <option name="com.jetbrains.cidr.execution.CidrBuildBeforeRunTaskProvider$BuildBeforeRunTask" enabled="true" />
+    </method>
+  </configuration>
+</component>

CMakeLists.txt

@@ -5,6 +5,7 @@ cmake_minimum_required(VERSION 3.18)
 
 # Allow third-party subdirectories that use cmake_minimum_required < 3.5 (removed in CMake 4.x)
 set(CMAKE_POLICY_VERSION_MINIMUM 3.5 CACHE STRING "")
+set(CMAKE_EXPORT_COMPILE_COMMANDS ON CACHE BOOL "Export compile commands for IDE tooling" FORCE)
 
 set(MOONLIGHT_BUILD_KIND "HOST" CACHE STRING "Internal Moonlight build mode")
 set_property(CACHE MOONLIGHT_BUILD_KIND PROPERTY STRINGS HOST XBOX)
@@ -51,12 +52,14 @@ option(BUILD_XBOX "Build the Xbox target through an internal child configure" ON
 option(MOONLIGHT_FORCE_NXDK_DISTCLEAN "Force a fresh nxdk distclean during configure" OFF)
 
 include("${CMAKE_CURRENT_SOURCE_DIR}/cmake/sources.cmake")
+include("${CMAKE_CURRENT_SOURCE_DIR}/cmake/moonlight-dependencies.cmake")
 
 if(BUILD_DOCS)
     add_subdirectory(third-party/doxyconfig docs)
 endif()
 
 if(BUILD_TESTS)
+    moonlight_prepare_common_dependencies()
     enable_testing()
     add_subdirectory(tests)
 endif()

CMakePresets.json

@@ -34,6 +34,40 @@
       "cacheVariables": {
         "CMAKE_BUILD_TYPE": "Debug"
       }
+    },
+    {
+      "name": "xbox-release (mingw64)",
+      "displayName": "Xbox Release (mingw64)",
+      "description": "Direct nxdk Xbox configure for IDE/code-model support on Xbox-only sources",
+      "generator": "Unix Makefiles",
+      "toolchainFile": "${sourceDir}/third-party/nxdk/share/toolchain-nxdk.cmake",
+      "binaryDir": "${sourceDir}/cmake-build-xbox-release",
+      "environment": {
+        "CHERE_INVOKING": "1",
+        "MSYSTEM": "MINGW64",
+        "NXDK_DIR": "${sourceDir}/third-party/nxdk"
+      },
+      "cacheVariables": {
+        "BUILD_DOCS": "OFF",
+        "CMAKE_BUILD_TYPE": "Release",
+        "CMAKE_DEPENDS_USE_COMPILER": "FALSE",
+        "CMAKE_EXPORT_COMPILE_COMMANDS": "ON",
+        "CMAKE_MAKE_PROGRAM": "C:/msys64/usr/bin/make.exe",
+        "CMAKE_TRY_COMPILE_TARGET_TYPE": "STATIC_LIBRARY",
+        "MOONLIGHT_BUILD_KIND": "XBOX",
+        "MOONLIGHT_SKIP_NXDK_PREP": "ON",
+        "NXDK_DIR": "${sourceDir}/third-party/nxdk"
+      }
+    },
+    {
+      "name": "xbox-debug (mingw64)",
+      "displayName": "Xbox Debug (mingw64)",
+      "description": "Direct nxdk Xbox configure for IDE/code-model support on Xbox-only sources",
+      "inherits": "xbox-release (mingw64)",
+      "binaryDir": "${sourceDir}/cmake-build-xbox-debug",
+      "cacheVariables": {
+        "CMAKE_BUILD_TYPE": "Debug"
+      }
     }
   ],
   "buildPresets": [
@@ -44,6 +78,14 @@
     {
       "name": "nxdk-debug (mingw64)",
       "configurePreset": "nxdk-debug (mingw64)"
+    },
+    {
+      "name": "xbox-release (mingw64)",
+      "configurePreset": "xbox-release (mingw64)"
+    },
+    {
+      "name": "xbox-debug (mingw64)",
+      "configurePreset": "xbox-debug (mingw64)"
     }
   ]
 }

README.md

@@ -7,9 +7,12 @@
 
 Port of Moonlight for the Original Xbox. Unlikely to ever actually work. Do NOT use!
 
-Nothing works, except the splash screen.
+> [!WARNING]
+> Streaming does not work yet.
 
-![Splash Screen](./docs/images/loading.png)
+![Splash Screen](./docs/images/screenshots/01-splash.png)
+![Hosts Screen](./docs/images/screenshots/02-hosts.png)
+![Apps Screen](./docs/images/screenshots/03-apps.png)
 
 
 ## Build
@@ -33,14 +36,15 @@ Nothing works, except the splash screen.
 pacman -Syu
 nxdk_dependencies=(
   "bison"
-  "cmake"
   "flex"
   "git"
   "make"
+  "mingw-w64-x86_64-cmake"
   "mingw-w64-x86_64-clang"
   "mingw-w64-x86_64-gcc"
   "mingw-w64-x86_64-lld"
   "mingw-w64-x86_64-llvm"
+  "mingw-w64-x86_64-make"
 )
 moonlight_dependencies=(
   "mingw-w64-x86_64-doxygen"
@@ -188,6 +192,10 @@ If you only want the emulator without the ROM/HDD support bundle, run:
 scripts\setup-xemu.cmd --skip-support-files
 ```
 
+> [!NOTE]
+> You can set Xemu to use widescreen mode by using https://github.com/Ernegien/XboxEepromEditor
+> but 1080i does not work in Xemu.
+
 ## Todo
 
 - Build
@@ -204,18 +212,19 @@ scripts\setup-xemu.cmd --skip-support-files
    - [x] Enable sonarcloud
    - [x] Build moonlight-common-c
       - [x] Build custom enet
+   - [x] Docs via doxygen
 - Menus / Screens
    - [x] Loading/splash screen
       - [x] Initial loading screen, see https://github.com/XboxDev/nxdk/blob/master/samples/sdl_image/main.c
       - [x] Set video mode based on the best available mode
       - [x] dynamic splash screen (size based on current resolution)
       - [x] simplify (draw background color and overlay logo) to reduce total size
-   - [ ] Main/Home
-   - [ ] Settings
-   - [ ] Add Host
-   - [ ] Game/App Selection
-   - [ ] Host Details
-   - [ ] App Details
+   - [x] Main/Home
+   - [x] Settings
+   - [x] Add Host
+   - [x] Game/App Selection
+   - [x] Host Details
+   - [x] App Details
    - [ ] Pause/Hotkey overlay
 - Streaming
    - [ ] Video - https://www.xbmc4xbox.org.uk/wiki/XBMC_Features_and_Supported_Formats#Xbox_supported_video_formats_and_resolutions
@@ -230,10 +239,9 @@ scripts\setup-xemu.cmd --skip-support-files
    - [ ] Mouse Input
    - [ ] Mouse Emulation via Gamepad
 - Misc.
-  - [ ] Save config and pairing states, probably use nlohmann/json
-  - [ ] Host pairing
+  - [x] Save config and pairing states
+  - [x] Host pairing
   - [ ] Possibly, GPU overclocking, see https://github.com/GXTX/XboxOverclock
-  - [x] Docs via doxygen
 
 <details style="display: none;">
   <summary></summary>

build.sh

@@ -63,13 +63,32 @@ if [[ "${CLEAN_BUILD}" -eq 1 ]]; then
   rm -rf "${BUILD_DIR_PATH}"
 fi
 
-cmake \
-  -S . \
-  -B "${BUILD_DIR_PATH}" \
-  -DBUILD_DOCS=OFF \
-  -DBUILD_TESTS=ON \
-  -DBUILD_XBOX=ON \
-  -DCMAKE_DEPENDS_USE_COMPILER=FALSE \
+cmake_configure_args=(
+  -S .
+  -B "${BUILD_DIR_PATH}"
+  -DBUILD_DOCS=OFF
+  -DBUILD_TESTS=ON
+  -DBUILD_XBOX=ON
+  -DCMAKE_DEPENDS_USE_COMPILER=FALSE
   -DCMAKE_BUILD_TYPE=Release
+)
+
+case "$(uname -s)" in
+  MINGW*|MSYS*|CYGWIN*)
+    if ! cmake --help 2>/dev/null | grep -q "MinGW Makefiles"; then
+      echo "Windows builds require a CMake that supports MinGW Makefiles. Install the MSYS2 package 'mingw-w64-x86_64-cmake'."
+      exit 1
+    fi
+
+    cmake_configure_args+=(
+      -G "MinGW Makefiles"
+      -DCMAKE_TOOLCHAIN_FILE="${PROJECT_ROOT}/cmake/host-mingw64-clang.cmake"
+    )
+    ;;
+  *)
+    ;;
+esac
+
+cmake "${cmake_configure_args[@]}"
 
 cmake --build "${BUILD_DIR_PATH}"

cmake/modules/FindNXDK.cmake

@@ -62,13 +62,6 @@ if(NOT TARGET NXDK::NXDK)
             IMPORTED_LOCATION "${NXDK_DIR}/lib/winmm.lib"
     )
 
-    add_library(ws2_32 STATIC IMPORTED)
-    set_target_properties(
-            ws2_32
-            PROPERTIES
-            IMPORTED_LOCATION "${NXDK_DIR}/lib/ws2_32.lib"
-    )
-
     add_library(xboxrt STATIC IMPORTED)
     set_target_properties(
             xboxrt
@@ -130,17 +123,3 @@ if (NOT TARGET NXDK::Net)
             "${NXDK_DIR}/lib/net/nvnetdrv"
     )
 endif ()
-
-if (NOT TARGET NXDK::ws2_32)
-    add_library(NXDK::ws2_32 INTERFACE IMPORTED)
-    target_link_libraries(
-            NXDK::ws2_32
-            INTERFACE
-            ws2_32
-    )
-    target_include_directories(
-            NXDK::ws2_32
-            SYSTEM INTERFACE
-            "${NXDK_DIR}/lib/winapi/ws2_32"
-    )
-endif ()