So you want to try out Sparrow? This step-by-step guide will get you started in a matter of minutes, and will show you how to plan your next steps.

Download Sparrow

The first step is, of course, to download Sparrow. The download-package contains everything you’ll need: the source code, a demo project and a scaffold for your own games. Extract it somewhere in your home directory.

Test-Drive the Demo

Next, we recommend you have a look at the demo application, which can be found in the folder “samples/demo”. Open the project in Xcode and build it — everything should work out of the box. Have a look around to get a feeling of what can be done with Sparrow!

Prepare Xcode

Before you dig into your own project, you have to prepare Xcode. We recommend to link Sparrow to your application via an Xcode project reference, as this makes it easy to update Sparrow later. Don’t worry, this has to be done only once:

Xcode 3 and 4
Add a “Source Tree” variable that Xcode can use to dynamically find Sparrow:

  • In the Xcode preferences, tab: “Source Trees”, create a new Source Tree variable.
  • Create SPARROW_SRC and let it point to /path_to_sparrow/sparrow/src/
  • Be careful: Xcode does not allow any spaces in that path.

Xcode 3 only
Set up a shared build output directory that will be shared by all Xcode projects:

  • In the Xcode preferences, tab: “Building”, set “Place Build Products in” to “Customized location” and specify a common build directory (anywhere you want).
  • Set “Place Intermediate Build Files in” to “With build products.”

Open up the Xcode preferences and enter the “Documentation”-tab. Add the following publisher:

http://doc.sparrow-framework.org/core/feed/docset.atom

Now you can get information about Sparrow classes and methods with the following shortcuts:

  • Xcode 3: Option double-click on symbol
  • Xcode 4: Option single-click on symbol


Create your own game project

To make it easy to create your own Xcode projects with Sparrow, the download package contains a “Scaffold”-project, which is a bare-bone Sparrow application that is easy to customize.

The folder “samples/scaffold” contains a bare-bone Sparrow application in the form of a standard Xcode project. Follow these simple steps to use it as a basis for your game:

  • Copy the “scaffold”-folder to the place where you want to have your game project.
  • Open “AppScaffold.xcodeproj”
  • Build and run — just to see if everything works fine. If it does not work, check if you have created the SPARROW_SRC variable in Xcode, and if it points to the right place.
  • Rename the project:
    • Xcode 3: click on “Project” → “Rename …” and enter the name of your choice.
    • Xcode 4:
      • Select the project in the Project Navigator, then open the file inspector (⌥⌘1) and change the text in the “Project Name” field. Accept the requests of the appearing popups.
      • Click on “Product – Manage Schemes” and then on the Scheme name (“AppScaffold”) to rename that, too.
  • That’s it! Now you can start to develop your game with Sparrow.

After creating your project, you can choose the target hardware (iPhone / iPad / Universal) in the project’s build settings (search for Targeted Device Family).

Master Sparrow!

Now that everything is in place, you might want to learn more about how to use Sparrow. Our homepage provides many sources of information. If something remains unanswered, don’t despair: the Sparrow community will help you out!

  • Read through the excellent Sparrow Manual in our Wiki. It will give you an overview about all concepts and techniques you need for your first game.
  • For specific topics, browse through our tutorials.
  • Consult the Sparrow API Reference for specific information about all classes and methods.
  • The FAQ page contains an easy to browse list of questions – perhaps yours is among it!
  • If you still have not found a way out of your misery, please pay a visit to the Sparrow Forum!

Good luck with your projects!