This documentation is for egoXproject 1.x. For 2.x documentation go here.

Installation

  • Add egoXproject to your project from the Asset Store.
  • It unpacks to Assets/egomotion/egoXproject. In here there is an Editor folder containing the EgoXproject.dll.
  • When you start using egoXproject it will create two additional folders under egoXproject: Data, for storing the change files; Settings for storing settings files related to egoXproject.

Basic Concepts

There are two main windows in egoXproject, the Info.plist Editor, and the Xcode Project Editor. They modify the Info.plist and the Xcode project file respectively. They both have a similar layout of three tabs:

  • one to set up the changes
  • one to view the merged list of changes that will be applied
  • and one to setup configurations

The Info.plist editor and the Xcode Project editor use change files to store the list of changes to be applied. The change files are human readable PLists. There can be multiple change files for each. They get merged down into a single change list that is applied to either the Info.plist or the Xcode project file.

Both editors also support multiple configurations. For example if you have three change files, A, B and C, you could have a Debug Configuration that uses A and B, and a Release configuration that uses A and C.

Info.plist Modification

Where is the editor?

  • Window > EgoXproject > Info.plist Editor
Info.plist Editor Location

Info.plist Editor Location

Creating a change file

  • Under the changes tab, select New.
  • Give the change file a name and press save. You can save it elsewhere in the project if you require.
Info.plist Editor

Info.plist Editor

Adding changes

  • Use the “+” button to add in a new key and value.
  • Set the key name, the type of value and then enter the required value
  • The entries are saved automatically.
  • To swap to a different change file use the drop down at the top.
Info.plist editor with an empty change file

Info.plist editor with an empty change file

Previewing the changes and applying manually

  • Select the Preview & Merge tab.
  • Select the desired configuration from the drop down list if there is more than one.
  • The change files used in the current configuration are shown as a single change list.
  • (Optional) Changes can be applied immediately manually if required.
    • If you have previously done a build with egoXproject installed, the last used PList will be selected
    • Or you can select an Info.plist manually.
    • Once a PList is selected, press the “Apply Changes” button.

Setting up a configuration

  • Select the Configuration tab
  • In each configuration (there is one by default) you can select which change files it will use
  • To add a new configuration press the “Add” button
  • You can also rename and delete the selected configuration
  • Select the configuration that you want to use during the build
  • Changes are saved automatically
Multiple Configurations

Multiple Configurations

Xcode Project Modification

Where is the editor?

  • Window > EgoXproject > Xcode Project Editor
Xcode Project Editor Location

Xcode Project Editor Location

Creating a change file

  • Under the changes tab, select New.
  • Give the change file a name and press save. You can save it elsewhere in the project if you require.
  • To swap to a different change file use the drop down at the top.
Xcode Project Editor

Xcode Project Editor

Adding frameworks and libraries

  • Press the “+” button under the Add Frameworks section. This opens framework browser.
  • Select the frameworks you want to add.
  • To add a non system framework press the “Add Other Framework” button to browse and choose one.
  • To add a non system library press the “Add Other Library” button to browse and choose one.
  • Press the “-” button next to any added framework to remove it.
  • The changes are saved automatically.
Xcode Project Editor with an empty change file

Xcode Project Editor with an empty change file

The Framework Browser

The Framework Browser

Adding Files

  • Press the “+” button under the Add Files section to browse and select one.
  • If the file is a source file (Objective-C, Objective-C++, C++, C, or Swift) you can add compile flags like -fobjc-arc
  • Files can either be copied in to the project folder or linked from their original location. Select one using the drop down menu next to each file.
  • Press the “-” button next to any added file to remove it.
  • The changes are saved automatically

Adding Build Settings

  • Various build settings can be adjusting under the Add Build Settings section
  • Press the “+” button under the Add Build Settings section to add one.
  • Select the required setting from the drop down list or manually enter a setting name
  • There are three possible ways to enter the value for the setting depending on which setting is chosen.
    • Custom settings require a text value to be entered.
    • Some predefined settings will allow selection from a drop down list,
    • and others will allow multiple text values to be entered
  • For example:
    • To set the minimum iOS deployment target version if Unity does not yet have an option for that version select IPHONEOS_DEPLOYMENT_TARGET and enter a value for the SDK, such as 8.0
    • Select DEBUG_INFORMATION_FORMAT to change whether DSym generation should occur.
    • Select DWARF for faster builds.
    • Select DWARF with dSYM File if you need symbolicated crash reports. e.g. when distributing a Beta or Release build and using a service like Crashlytics or TestFlight.
    • Select OTHER_LDFLAGS to add additional linker flags if required. A common one is -all_load to load Objective-C class extensions in a library.
  • The changes are saved automatically

Adding Build Scripts

  • Press the “+” button under Add Build Scripts section.
  • This will add a new entry for adding a script.
  • Optionally name the script. This is helpful to allow others to know what it is for
  • Enter the Bash script in the main text area
  • The changes are saved automatically

Previewing the changes and applying manually

  • Select the Preview & Merge tab
  • Select the desired configuration from the drop down list if there is more than one
  • The change files used in the current configuration are shown as a single change list
  • (Optional) Changes can be applied immediately manually if required.
    • If you have previously done a build with egoXproject installed, the last used Xcode project will be selected
    • Or you can select an Xcode project manually
    • Once an Xcode project is selected, press the “Apply Changes” button

Setting up a configuration

  • Select the Configuration tab
  • In each configuration (there is one by default) you can select which change files it will use
  • To add a new configuration press Add
  • You can also rename and delete the selected configuration
  • Select the configuration that you want to use during the build
  • Changes are saved automatically
Multiple configurations

Multiple configurations

PList Editor

Finally, there is also an editor for PList files. If you need to create or edit a PList file and want to do it in Unity, then use this handy tool.

Where is the editor?

  • Window > EgoXproject > PList Editor
PList Editor Location

Where to find the PList Editor

The PList Editor

Create new files or open existing ones. Changes are saved automatically.

The PList Editor

The PList Editor

Editing a PList file

Editing a PList file

Back to top