Building from source - vrcx-team/VRCX GitHub Wiki

Windows

  • Get source code

    • Download latest source code zip or clone repo with git clone "https://github.com/vrcx-team/VRCX.git"
  • Build .NET

  • Build Node.js

    • Download and install Node.js.
    • Run the following commands from the root of the project, referencing the scripts in the build-scripts folder:
      build-scripts\build-node.js.cmd
      build-scripts\make-junction.cmd
      
    • These scripts will set up the Node.js environment and create necessary symbolic links for the build process.
  • Run

    • .\build\Cef\VRCX.exe
    • Auto build script changes with npm run watch then reload with Ctrl + R
  • Create release zip

    • Run build-scripts\make-zip.cmd for Bandizip or build-scripts\make-zip-7z.cmd for 7-Zip from the root of the project.

Linux

  • Get source code

    • Download latest source code zip or clone repo with git clone "https://github.com/vrcx-team/VRCX.git"
  • Build .NET

    • Install Dotnet 9.0 SDK
    • Build with GUI or CLI
      • Open .sln file with Rider, restore nuget packages and build VRCX-Electron.
      • Run dotnet build 'Dotnet/VRCX-Electron.csproj' -p:Configuration=Release -p:Platform=x64 -p:RestorePackagesConfig=true -t:"Restore;Clean;Build" -m --self-contained
  • Build Node.js

    • Install nodejs and npm
    • Restore node modules, only necessity for first build npm ci
    • Build main app npm run prod-linux or npm run watch-linux
    • Build electron, only necessity for first build npm run build-electron
    • Launch app npm run start-electron