How to include file as resource in Xcode programmatically during build?

Question

I have a file that is created by a script that is run during a build phase. Consequently, the file does not exist until build time.

How can I add the file to the app/project so that my code can access it at run time?

I know what the filename will be.

Normally, if I created the file by hand, I would just drag/drop it into Xcode, and I can instantly access it by using the filename in code. Since I am generating the file during build, I want to know how I can add it to my project.

EDIT: The file that I am adding is an Image file, that is created by a script during a build phase. I want to be able to access this file at runtime in my product.

Found the answer in this post: stackoverflow.com/questions/4884927/… — Rahul Iyer
– Rahul Iyer, Commented Mar 25, 2012 at 13:14

Community · Accepted Answer · 2017-05-23 12:14:14Z

1

You could create the file and add it to the project and then during the build phase, your script could replace the existing file with the generated one....

The other option is to try manipulating the project file itself but that's quite complicated. Here are some resources on the subject...

edited May 23, 2017 at 12:14

CommunityBot

11 silver badge

answered Mar 22, 2012 at 10:07

iffi

2683 silver badges8 bronze badges

Sign up to request clarification or add additional context in comments.

8 Comments

Rahul Iyer Over a year ago

I don't need to compile the file - it is an image. The image is created by a script during a build phase. I want to add it to the product so that my app can access it from code at runtime

iffi Over a year ago

It should be the same case, you can add dummy image to the project and then replace it in build time.

iffi Over a year ago

Also there are number of tools on github and bitbucket that try to parse and manipulate the project file (here's one example bitbucket.org/darktable/mod-pbxproj/src/dde0e05c126a/… ) so you can try to clone one call it via your script.

Rahul Iyer Over a year ago

Is there a way to do it without manipulating the xcodeproj file? For example, in this post: stackoverflow.com/questions/4884927/… The file is just copied into the app. I'm not sure if this is the right way. So I was wondering if I should do it. Also, for some reason my product is always "red" in Xcode.

iffi Over a year ago

My simpler idea is the following. You create a dummy image, you add it to the project and you add it to the Copy Bundle Resources phase of your target d1xzuxjlafny7l.cloudfront.net/wp-content/uploads/2011/07/… . Then in your script you generate the image you want and you overwrite the dummy file. I think that should work fine

|

Ryan Wersal · Accepted Answer · 2014-01-16 20:34:03Z

1

I ended up using build references.

edited Jan 16, 2014 at 20:34

Ryan Wersal

3,2281 gold badge22 silver badges29 bronze badges

answered Apr 9, 2012 at 4:35

Rahul Iyer

21.1k22 gold badges110 silver badges208 bronze badges

1 Comment

Punita Over a year ago

Hey Pterie, can you please explain more about solution? Thanks is advance

Alex Curylo · Accepted Answer · 2019-12-10 04:46:59Z

You can copy the generated file to the build output using a script like this one I use to copy a plist with values maintained outside version control, as anything copied to "${BUILT_PRODUCTS_DIR}/${FULL_PRODUCT_NAME}/" is available using NSBundle APIs.

SECRETS="${SRCROOT}/../../secrets/Secrets.plist"
APP="${BUILT_PRODUCTS_DIR}/${FULL_PRODUCT_NAME}/Secrets.plist"
if [ -f "$SECRETS" ]; then
    cp -f "$SECRETS" "$APP"
    echo "copied Secrets.plist: $APP"
else
    echo "Secrets.plist not found at $SECRETS, all secrets will be 'MISSING'"
fi

For instance, that plist of secrets is defined as the Decodable struct SecretsFile and loaded with

    private static var file: SecretsFile? = {
        guard let url = Bundle.main.url(forResource: "Secrets", withExtension: "plist"),
              let data = try? Data(contentsOf: url) else { return nil }
        return try? PropertyListDecoder().decode(SecretsFile.self, from: data)
    }()

Collectives™ on Stack Overflow

How to include file as resource in Xcode programmatically during build?

3 Answers 3

8 Comments

1 Comment

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

8 Comments

1 Comment

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related