Mac Configurations

Follow this project configuration guide for your Mac setup. Once completed, return to the Quick Start Guide to finish integration.

OSX Builds

In our OSX example we have used XCode 10.1. This is automatically setup when creating a template c++ Cocos project. The XCode project files are located in ""ProjectName/proj.ios_mac/

XCode Settings

Configure the following settings in your XCode Project for all targets:

1. Include the following folders to the project: Frameplay, Frameplay/Native/Source, and Resources/Frameplay
2. Add the header search path: $(SRCROOT)/../Frameplay to General>Header Search Paths

Configure the following settings in your XCode Project for desktop target:

1. Add Frameplay/Native/Platforms/Mac/libFrameplayNative.dylib to Frameworks.
2. Add libFrameplayNative.dylib to General>Embedded Binaries.
3. Change the Destination of libFrameplayNative.dylib in Build Phases>Embedded Libraries to Executables.
4. Add $(SRCROOT)/../Frameplay/Native/Platforms/Mac to Build Settings>Library Search Paths.
5. Add @executable_path to Build Settings>Runpath Search Paths

Build Mac

Start Debugging or Build the project in your editor. You can also build by** running the following commands.

cd ./"ProjectName"
cocos compile -p mac -m debug

Successful builds will be located in "ProjectName"/bin/debug/mac/

iOS Builds

XCode Settings

Configure the following settings in your XCode Project for all targets:

1. Include the following folders to the project: Frameplay, Frameplay/Native/Source, and Resources/Frameplay
2. Add the header search path: $(SRCROOT)/../Frameplay to General>Header Search Paths

Configure the following settings in your XCode Project for desktop target:

1. Add Frameplay/Native/Platforms/iOS/FrameplayNative.Framework to General>Linked Frameworks and Libraries.
2. Add $(SRCROOT)/../Frameplay/Native/Platforms/iOS to Build Settings>Framework Search Paths.

Apple App Tracking Transparency(ATT)

To display an appropriate message when the app launchs for the first time. Like below.

Configure the following settings in your XCode Project

1. You will need iOS 12+

2. Add AdSupport.framework to Build Phases>Link Binary with Libraries.

3. Add Privacy - Tracking Usage Description to Info.plist via XCode it is located in com.frameplay.cocos\proj.ios_mac\ios more information here. (opens new window)

You will need the following include:

#include "Engine/FrameplayATTManager.h"

Which has the following functions calls.

RequestAppTrackingTransparency()
This will call the pop up and will set the App Tracking Status.

GetAuthorizationTrackingStatus()
This will get the current App Tracking Status.

GetAdvertisingIdentifier()
This will return a AdvertisingId based on the App Tracking Status.

An example of the ATT implementaion can be found in the Frameplay SDK example scene.

More information on authorizationstatus here. (opens new window)

Build iOS

Deploy to an iOS device using your editor. You can also build by running the following commands:

cd ./com.company.cocos
cocos compile -p ios -m debug

Successful builds will be located in "Project"/bin/debug/ios/...