Workflow to automate and guide people in delivering Unity builds for macOS.
We delivered builds to the Appstore using this script but beyond that it is possible that some things are not correct (e.g. iCloud, Building for outside the Appstore, ... ) Things also change often so if you notice a mistake don't hesitate to tell in the thread below.
There seems to be a bug with Unity 2018 which will have your bundle rejected because of gamekit. So don't upgrade until this is fixed (fixed in 2018.3 and up). Link to workaround by giorgos_gs
Fix from Giorgos
- Install MachOView
- Open the binary in Contents/MacOS
- Expand the "Load Commands" section
- Look for LC_LOAD_DYLIB (GameKit)
- Notice the command size is 88, we need to find a same length framework to replace it, we'll use Webkit
- Change Command Data to 0000000C (with our build data already had this value)
- Change Current Version to 025C0407 (check the value at Webkit)
- Change Name to 2F53797374656D2F4C6962726172792F4672616D65776F726B732F5765624B69742E6672616D65776F726B2F56657273696F6E732F412F5765624B697400
- File -> Save
- Proceed to signing
There is a bug with OSX/MacOS and Unitypurchasing. When quitting your build either takes up to 10 seconds to close or outright crashes. We are not 100% sure if it has something to do with our setup or not, so just see if your build closes properly, if it does ignore this. Below is currently the only fix I have found taken from this Issue. Place this on an object that will live throughout your game/app.
void OnApplicationQuit()
{
if (!Application.isEditor) { System.Diagnostics.Process.GetCurrentProcess().Kill(); }
}
We decided to leave IAP behind though and disable Purchasing altogether. If you are developing for more Platforms and like us want to use Purchasing in them, just wrap the code for initialising (in unitypurchasing) in platform dependant directives.
If you are supporting users on Mavericks make sure you have added OpenGlCore Graphics Library otherwise if you only use Metal you can set the Minimum system version to 10.10.0 in your Info.plist (see chapter Info.plist)
For a first build just follow all the steps. In each folder you will find instructions to deal with the problem at hand in chronology. After you finished the steps a first time you can just run "RepeatForUpdatedBuild" to quickly repeat the whole process. But you need to finish the steps so all the data used is correct otherwise problems will arise.
If you already have all the necessaries you can place them in their respective directories, following the table below and run "RepeatForUpdatedBuild"
| WHAT | DIR |
|---|---|
| DEV.provisionprofile | 0_BeforeYouBuild/ProvisioningProfiles/Development/ |
| APPSTORE.provisionprofile | 0_BeforeYouBuild/ProvisioningProfiles/Appstore/ |
| DEV_ID.provisionprofile | 0_BeforeYouBuild/ProvisioningProfiles/Developer/ |
| YOURGAME | 1_MyBuild/ |
| PlayerIcon.icns | 2_Icons/MyOsxIcon/ |
| UnityPlayerIcon.png | 2_Icons/MyUnityPlayerIcon/ |
| Info.plist | 4_InfoPlist/ |
| entitlements.plist | 5_Entitlements/Distribution/ |
| OPTIONAL (entitlements.plist) | 5_Entitlements/Development/ |
All scripts (and todos) are described in more detail in each folder. As everything is automated there are also failsafes in place for overwriting or to check if needed files are present. We will not describe all of those, but you can view the script to see what is happening.
Creates PlayerIcon.icns & UnityPlayerIcon.png from single png file and placed them in BUILD/Contents/resources/
Script to Delete meta files in "BUILD/Contents/Plugins/plugin_x"
Info.plist is copied from "BUILD/Contents/" to "4_InfoPlist/" so you can update it manually once and reuse it after.
Copies your manually updated Info.plist from "4_InfoPlist/" to "BUILD/Contents/"
Takes the adjusted Info.plist and finds your BundleIdentifier. Opens all bundles in the plugins folder and replaces the BundleIdentifier value with yours.
Self explanatory.
- Create a version folder structure for your builds in 7_Distribution/
- Copies the correct provisioning profile as embedded.provisionprofile to "BUILD/Contents/" depending on Appstore, Development or Distribution choice.
- Signs all code with your entitlements. Loops over bundles in plugins, finds .dylib files in Frameworks, signs app.
- Verify
- Builds signed package for either Appstore, Development or Distribution outside Appstore (installer or zip)
Script that calls all the other scripts to speed up preparing updates and creating new builds.
When you need to run the script over and over again, or you want to automate this process for future builds, call ./PluginsReplaceBundleId -h to see automation options.
Here is an example of a fully automated process:
ATTENTION: This is no shortcut to set up the steps by hand!
DO NOT RUN IF YOU HAVE NOT FINISHED THE STEPS
./RepeatForUpdatedBuild -q -t appstore -i 'TEAM NAME (XXXXXXXXXX)' -s deep
The only thing that needs to be done manually is placing the build in the right directory, and uploading the final package via Application Loader.
PM or ask at UNITY THREAD or to contribute
As we will not be constantly uploading games to the App Store it might be good to have other people pitching in so that there's a central point to get help that doesn't age. So anyone who wants to become a contributor just pm me on git even if it is to just add some documentation.
We do not take credit for anything besides creating this workflow, tying the code we found together in bash with added automation and organising & rehashing documentation. Below are the credits for all the posts, threads we used. If we missed a spot please contact us.
We created this workflow because delivering a Unity build to Apple is a mess and the answer is spread across several websites which makes it hard to wrap your head around the correct final chronology especially if you're new or on Windows.
There are tools out there like Signed that will also take care of signing, but often it's better to understand and not depend upon 3rd party assets, especially when things go wrong. We have tried to include paths, actions and DIY as much as possible so you can understand what's happening and where everything is supposed to go.
| WHO | WHAT | HOME |
|---|---|---|
| Joel | GUIDE ICLOUD DEV | Kittehface.com |
| N3uRo | UNITY THREAD | Unity Assetstore Page |
| Zwilnik | GUIDE | Strangeflavour.com |
| Victor Leung | MEDIUM GUIDE | .. |
| Matthias | GUIDE | Gentlymad.org |
| Dilmer Valecillos | GUIDE | www.dilmergames.com |
| BrainAndDrain | UNITY POST/GUIDE | Brainandbrain.co |
| Alamboley | CODESIGNING GIT | Davikingcode.com |
| JoeStrout | POST BUILD,SIGN, ZIP | Stroutandsons.com |
| Henry | ICON GEN | .. |
| TranslucentCloud | PIXEL GRID | .. |
| Jeremy Statz | CONTROLLER SUPPORT | Kittehface.com |
Worked on this workflow? Add yourself! Btw you can use the "doc/CombineAllReadmeIntoDoc" to recompile all readme's for the online manual page.
| WHAT | WHO | HOME |
|---|---|---|
| ORGINAL WORKFLOW | UNSH | UNSH.IO |
| Post | Atorisa | Assets |
| Corrections guide iCloud | omgitsraven | [Home](https://github.com/omgitsraven |
| Build automation | v01pe | brokenrul.es |