How do I use SwiftUSD with Xcode based projects?

[x001017]

I created an Xcode project and installed SwiftUSD with Swift Package Manager, which is linked below.

However, after installing,

import PixarUSD

and tried to build the project with the default code when newly created, but before the code is built, many errors occur as follows.

Multiple commands produce '/Users/name/Library/Developer/Xcode/DerivedData/SwiftUSDPackageCamera-gpbofwclcozunoespbordaiizrfp/Build/Products/Debug-iphoneos/Frameworks/Alembic_301B1C71A317B7B4_PackageProduct.framework'

Target 'Examples' (project 'SwiftUSD') has copy command from '/Users/name/Library/Developer/Xcode/DerivedData/SwiftUSDPackageCamera-gpbofwclcozunoespbordaiizrfp/Build/Products/Debug-iphoneos/PackageFrameworks/Alembic_301B1C71A317B7B4_PackageProduct.framework' to '/Users/name/Library/Developer/Xcode/DerivedData/SwiftUSDPackageCamera-gpbofwclcozunoespbordaiizrfp/Build/Products/Debug-iphoneos/Frameworks/Alembic_301B1C71A317B7B4_PackageProduct.framework'

Multiple commands produce '/Users/name/Library/Developer/Xcode/DerivedData/SwiftUSDPackageCamera-gpbofwclcozunoespbordaiizrfp/Build/Products/Debug-iphoneos/Frameworks/Alembic_301B1C71A317B7B4_PackageProduct.framework/Alembic_301B1C71A317B7B4_PackageProduct'.....

In the Swift Package Manager,
“If there are files with the same name in multiple directories, each with the same name, an error will occur during build.”
which is what the search says about Swift Package Manager errors. Does the fact that such errors occur mean that I need to modify the file names after installing with Swift Package Manager, for example by changing them?

[furby-tm]

@x001017

“If there are files with the same name in multiple directories, each with the same name, an error will occur during build.”

This is generally correct, for files (SomeFile.swift) with the same name in multiple directories within the same project. However, I don't believe this is the specific error you are running into here, at least from the error output you provided above.

The error output you provided above appears to indicate that you have added some other framework not related to the SwiftUSD package to your project, perhaps some sort of private or third-party framework you added for Alembic?

The SwiftUSD package already brings in an Alembic dependency from the MetaverseKit package which is automatically compiled from source and linked against the PixarUSD product when you build a project that depends on PixarUSD, so you should not need to add your own external Alembic framework to your project as the Alembic dependency has already been provided for you.

Once you've removed your external Alembic framework from your project, it's generally advised to:

1. Quit Xcode
2. Delete Xcode's DerivedData cache
3. Open Xcode and build your project.

To ensure the build graph is cleanly refreshed to no longer expect the external Alembic framework that you had initially added to your project.

[furby-tm]

It's hard to tell what's going on without seeing an example of your Package.swift file, but what I can say is that I tested the following on macOS, visionOS, and iOS and did not experience any issues:

// swift-tools-version: 5.10

import PackageDescription

let package = Package(
  name: "USDTesting",
  platforms: [
    .macOS(.v14),
    .visionOS(.v1),
    .iOS(.v17),
    .tvOS(.v17),
    .watchOS(.v10)
  ],
  dependencies: [
    .package(url: "https://github.com/wabiverse/SwiftUSD.git", from: "24.8.7")
  ],
  targets: [
    .executableTarget(
      name: "USDTesting",
      dependencies: [
        .product(name: "PixarUSD", package: "SwiftUSD")
      ],
      swiftSettings: [
        .interoperabilityMode(.Cxx)
      ]
    )
  ],
  cxxLanguageStandard: .cxx17
)

Which version of macOS/(and iOS, if you are building for iOS) and Xcode are you using as well?

[furby-tm]

Are you also using a .xcodeproj (Xcode project) by chance? If so, it sounds like you have some left over Xcode configuration that's causing you some problems.

Tip

I will note here, that I personally avoid .xcodeproj across all my projects, projects which are wholly dependent on Xcode tend to add quite a lot of developer friction, and my preference is using only a single Package.swift file at each project's root directory.

This allows me to optionally use Xcode, and additionally distribute my apps and libraries across all Apple devices (macOS, iOS, visionOS, and tvOS), Linux, and Microsoft Windows, while also leveraging code editors like Visual Studio Code. I do this with SwiftBundler, which currently has support for macOS, iOS, visionOS, and tvOS, for all other non-Apple platforms I just interface with swift build from the command line.

In the following screenshot here, do you by chance have anything in your Frameworks Libraries & Embedded Content section? Try removing everything listed in there, if you see anything listed. Though, if you are still experiencing issues, I would advise setting up a brand new project for this.

[x001017]

The OS used is Sonoma 14.7.1.
Xcode is using 15.4.

The work is done by creating a new project on Xcode.
Would the method using Xcode still not work?

After creating a new project on Xcode, I immediately add SwiftUSD with SPM, but then manually create Packaging.swift and write it there, is that correct?
Create a new project and do what you did above.

https://github.com/x001017/USDTesting

I have zipped the file to
I hope you can take a look at it.

[x001017]

What do you think?
Did the above zip code work?
If we remove the framework stuff, SwiftUSD will not work at all, and we are currently stuck.

[furby-tm]

@x001017 sorry about the long wait, I've been out of town on vacation, I will review your project and Xcode based projects (as opposed to swiftpm ones) when I return, I appreciate your patience.

[furby-tm]

@x001017 going through Xcode now (through Xcodeproj, as opposed to the SwiftPM route), wow! Xcode really overcomplicates the simplicity of SwiftPM's package manifest system.

Hidden through various settings, I believe you should get it to work.

1. Create a new app in Xcode.

2. Add the SwiftUSD package to your Xcode project like so:
   

3. Additionally you must add the PixarUSD product to your app's target.
   

4. A very important step, and one that is way too hidden, you need to enable C++ interoperability mode here:
   

5. Equally as important, you need to ensure you set the Swift version to 6, here:
   

6. You need to change yet another very hidden setting buried in your Xcode project, which is to set the C++ Language Standard to c++17:
   

I am sorry that Xcode's poor development experience had blocked your team's software development. Hopefully, once you follow the above steps, things can begin moving along smooth for you.

[x001017]

Thanks for your reply. Very helpful, I see that it was not available in Xcode 15.4, I will try to work on Xcode 16 to be able to configure the project.
It really helped me a lot. In the meantime, I would like to make a personal challenge.

[furby-tm]

And I built the project to confirm that these are the steps that worked for me.