Integrating Reveal using Visual Studio for Mac

The quickest way to get Reveal running with your Visual Studio for Mac projects is to link against RevealServer.xcframework in the Debug configuration of your project.

Unfortunately, Visual Studio for Mac does not currently have support for XCFrameworks. This makes linking to the frameworks a more manual process than it is with other IDEs. The good news is that Microsoft is working on supporting XCFrameworks for a future update to Visual Studio, so when it lands, we'd encourage you to update your copy of Visual Studio - we'll update these instructions when the update is available.

  1. Right click your iOS project in Visual Studio for Mac and select "Options"
  2. Select Build → iOS Build
  3. Ensure that the "Configuration" is set to your Debug configuration. Be sure not to ship Reveal Server in a release build of your app.
  4. Add the following argument to "Additional mtouch arguments":

    For iOS Device targets:

    --framework:"$(HOME)/Library/Application Support/Reveal/RevealServer/RevealServer.xcframework/ios-arm64_armv7/RevealServer.framework"

    For iOS Simulator targets:

    --framework:"$(HOME)/Library/Application Support/Reveal/RevealServer/RevealServer.xcframework/ios-arm64_i386_x86_64-simulator/RevealServer.framework"

    For tvOS Device targets:

    --framework:"$(HOME)/Library/Application Support/Reveal/RevealServer/RevealServer.xcframework/tvos-arm64/RevealServer.framework"

    For tvOS Simulator targets:

    --framework:"$(HOME)/Library/Application Support/Reveal/RevealServer/RevealServer.xcframework/tvos-arm64_x86_64-simulator/RevealServer.framework"
    This assumes you've launched at least once, and that you're running Reveal version 27 or later. Running Reveal creates and installs the frameworks into your application support directory. If you're running an older release, please see the instructions below.


Further information on embedding frameworks in Xamarin is available from their developer site.