onevcat/XUPorter

#XUPorter

Overview

XUPorter can help you to add files and frameworks to your Xcode 4 project after it is generated by Unity 3D automatically and dramatically. Lot of changes from XCodeEditor-for-Unity.

中文版的说明请看这里

Installation

Add all files of the repo to your Unity project's Editor Folder: {$ProjectFolder}/Assets/Editor/XUPorter or you can download this unity package and import to your project.

Some demos are contained in /Mods folder, they are just a tutorial to help you getting start. Please feel free to delete or substitute all files in that folder as soon as you know how to use XUPorter. A simplified MiniJSON is now used in XUPorter, but I put it into a namespace, so there is no worry of conflicting, even if you are already using a same JSON wrapper.

XUPorter require Unity 3.5 or higher and Xcode 4 to work properly. I have tested for Xcode 5 DP and it can work well now too.

Usage

After the Unity's building phase, OnPostProcessBuild in XCodePostProcess.cs will be called and Xcode project file will be modified. All .projmods (which is in JSON) will be treated as Xcode patch setting files (In the demos, all .projmods files are in /Mods folder). XUPorter will find and read all projmods files in /Assets and modify Xcode project file as settings.

In these setting files, specify the fields using a json pattern.

• group：The group name in Xcode to which files and folders will added by this projmods file
• libs：The name of libs should be added in Xcode Build Phases, libz.dylib for example. If you want to import a .a lib to Xcode, add it as a file(in "files")
• frameworks：The name of framework should be added in Xcode Build Phases, Security.framework for example. If you want to add a third party framework, add it using a relative path to files section instead of here.
• headerpaths：Header Search Paths in Build Setting of Xcode
• files：Files which should be added
• folders：Folders which should be added. All file and folders(recursively) will be added
• excludes：Regular expression pattern. Matched files will not be added.
• compiler_flags: Compiler flags which should be added, e.g. "-Wno-vexing-parse"
• linker_flags: Linker flags which should be added, e.g. "-ObjC"
• embed_binaries: Optional fields, support XCode 6+ Embed Framework feature. Notice: The frameworks must added already in frameworks or files fields.
• plist: edit the Info.plist file, only the urltype is supported currently. in url type settings, name and schemes are required, while role is optional and is Editor by default.

Use : for folders and files to add compiler flags to those files. For example: path/to/my/folder:-fobjc-arc or path/to/my/file.m:-fobjc-arc. You can add multiple compiler flags by using , to seperate them, too.

One example, the following file will add all files in /iOS/KKKeychain to the Xcode group KKKeychain and add the Security.framework to Xcode project.

{
    "group": "KKKeychain",
    "libs": [],
    "frameworks": ["Security.framework"],
    "headerpaths": [],
    "files":   [],
    "folders": ["iOS/KKKeychain/"],    
    "excludes": ["^.*.meta$", "^.*.mdown$", "^.*.pdf$"],
    "compiler_flags": [],
    "linker_flags": [],
    "embed_binaries": [],
    "plist": {
        "urltype" : [
            {
                "role": "Editor",
                "name" : "wechat",
                "schemes":["wxyz123456789"]
            },
            {
                "name" : "twitter",
                "schemes":["www1234566"]
            }
        ],
    },
}

Contributor

Thanks for all contributors of this project. Especially @pronebird and @MatthewMaker's great effort!

LICENSE

This code is distributed under the terms and conditions of the MIT license.

Copyright (c) 2012 Wei Wang @onevcat

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.