README.md

Flare

Flare is a powerful design and animation tool for app and game designers alike. The primary goal of Flare is to allow designers to work directly with assets that run in their final product, eliminating the need to redo that work in code.

Flare-Swift

Swift runtime for Flare.

Export Flare files with the Export to Engine picking Binary format. (JSON support is in the works)

Alpha Release Notes

This repo contains an alpha release of the Flare runtime. It handles everything Flare-related except:

• JSON format for exports
• The recently added raster image support.

If you encounter any problems, be sure to report them in the issue tracker and, if possible, include your Flare file.

Contents

The repository contains an XCode Workspace with two XCode Projects:

• FlareSwift - Swift Framework for loading and drawing Flare files. The Frameworks is further subdivided into two main Groups:
  • FlareSwift is the bottommost layer of the Framework: this is where Flare file contents are read, loaded and built in-memory.
  • FlareCoreGraphics handles the drawing operations on top of the FlareSwift abstractions. It draws into a Core Graphics context.
• BasicExample
  An iOS-based example that loads and animates a Flare file in a UIView.

Usage

Here's a step-by-step overview on how to use the Framework in your XCode Project.

• Download the repo
• Open Flare-Swift.xcworkspace
• In the XCode window, make sure FlareSwift scheme is selected
• Build the Framework (⌘ + B)

The Framework is built into the Products folder.
N.B. The folder can be accessed from XCode by right clicking on it > Show in Finder.

Lastly, to use the Framework in your Project:

• Drag-and-drop it into the XCode window.
  • In the import dialog, select "Copy items if needed" and the target in "Add to Targets"
• Add the Framework to the Build Phases:
  • Select the Project in the Project Navigator
  • Select your Target
  • Build Phases
  • Add the Framework to the Embed Frameworks phase.

License

See the LICENSE file for license rights and limitations (MIT).

FlareCoreGraphics contains a Bezier folder, that is a port of bezier.dart, and is complying with their LICENSE.txt (BSD 2-Clause License).