Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
manual:the_scaffold_project [2013/05/28 16:14]
daniel
manual:the_scaffold_project [2015/05/27 20:30] (current)
88.229.130.202 [Landscape-only]
Line 1: Line 1:
 +====== The Scaffold Project ======
  
 +Don't be fooled: while the Scaffold project that comes with Sparrow doesn'​t look like much, it's actually extremely powerful! This section will teach you all you need to know to get started.
 +
 +===== Overview =====
 +
 +==== Start me up! ====
 +
 +Before we begin to modify the project, I recommend having a look at what it's capable of per default. Open it up in Xcode and start it in the simulator or on your device. It's configured as a universal app, i.e. it runs on iPhone, iPod Touch and iPad in full resolution.
 +
 +When the app is started, rotate your device and see what happens: the app is rotating in all directions!
 +
 +Furthermore,​ it uses optimized graphics for both iPhone versions (Retina and non-Retina) and the iPad. It doesn'​t contain HD textures for new iPads (3rd generation),​ but it would be easy to add those, too.
 +
 +Last but not least, it has everything prepared to add conventional UIKit elements on top of Sparrow content, which makes it easy to integrate iAds, the GameCenter, etc. We'll have a look at that later.
 +
 +{{ :​manual:​scaffold_rotation_and_retina.png?​nolink |}}
 +
 +==== Project contents ====
 +
 +{{ :​manual:​scaffold_classes_v2.png?​nolink}}
 +
 +As you can see, the project is really lightweight;​ it contains just three classes. Most of the functionality is provided by Sparrow itself.
 +
 +  * The ''​Game''​-class is where your game logic starts. In its raw form, it displays an image and a text field; you will replace the contents with your game logic.
 +  * The ''​Media''​ class is a helper class that manages all your textures and sounds at a single place.
 +  * The ''​AppDelegate''​ is the standard startup-class of iOS projects. Sparrow'​s ''​SPViewController''​ is created here.
 +
 +===== Choosing a target device family =====
 +
 +An iOS app can be optimized either for iPhone/iPod Touch, for the iPad, or for both ("​universal application"​). This choice has several implications:​
 +
 +  * An app targeting the iPhone is always created in a resolution of 320x480 points (not pixels!).
 +  * An app targeting the iPad is always created in a resolution of 768x1024 points (not pixels!).
 +  * A universal app has to support both of those resolutions.
 +
 +Which target device family you want to choose depends on the project. Some games only make sense on the big screen of the iPad, others will work fine on both. Make your choice as soon as possible, because it will affect the complete development process.
 +
 +My recommendation is to create a universal app whenever possible. You'll reach all iOS customers that way. Yes, it's more work than the other options; but thanks to Sparrow, the additional effort is minimal.
 +
 +To change the target device family, enter the target summary view of Xcode and make your choice in the "​Devices"​ dropdown menu.
 +
 +{{ :​manual:​target_settings.png?​nolink |}}
 +
 +==== iPhone / iPod Touch ====
 +
 +There'​s nothing special you have to do with this setup! ​
 +
 +  * The stage size of your game will be 320x480 ​
 +  * Retina displays are supported by adding graphics with the ''​@2x''​ suffix.
 +
 +==== iPad ====
 +
 +This requires a minor code change, but in the end it will work like this:
 +
 +  * The stage size of your game will be 768x1024
 +  * Retina displays are supported by adding graphics with the ''​@2x''​ suffix.
 +
 +To prepare the project, make the following change in the file "​AppDelegate.m":​
 +
 +<code objc>
 +// EXCHANGE the following line:
 +[_viewController startWithRoot:​[Game class] supportHighResolutions:​YES doubleOnPad:​YES];​
 +
 +// with this:
 +[_viewController startWithRoot:​[Game class] supportHighResolutions:​YES];​
 +</​code>​
 +
 +==== Universal ====
 +
 +This is how the scaffold is configured per default; you don't have to change anything.
 +
 +But how does it work? The iPhone and the iPad have quite different screen sizes, after all. We will look at the details of this in a separate article ([[Universal App Development]]) -- but for now, it suffices to know the following:
 +
 +  * You have to align your objects within two different stage sizes:
 +    * 320x480 for iPhone devices
 +    * 384x512 for iPad devices
 +  * You have to include different sets of textures for each device type:
 +    * iPhone, non-retina: ''​image.png''​
 +    * iPhone, retina: ''​image@2x.png''​
 +    * iPad, non-retina: ''​image@2x.png''​
 +    * iPad, retina: ''​image@4x.png''​
 +
 +===== Handling Device Rotation =====
 +
 +The iPhone automatically rotates the user interface depending to the physical state of the device --- that was one of the most revolutionary features of the iPhone when it was first released. Here is how to do that in Sparrow-based games.
 +
 +Before you jump in, keep in mind that rotating the game does not make sense in all cases. Depending on the game, it might be a lot of work to move all objects to different positions when the orientation changes. I recommend, however, to support at least both portrait or both landscape orientations. That's very easy to do.
 +
 +<note important>​
 +In Xcode, the supported orientations can be enabled with the corresponding buttons in the project summary. Note that the order you press those buttons is important! The first button that is activated will be the default interface orientation on startup.
 +</​note>​
 +
 +==== Portrait-only ====
 +
 +To create an app that supports both portrait orientations (with the home-button at the top or bottom), choose those orientations in the target summary tab in Xcode.
 +
 +{{ :​manual:​orientations_portrait.png?​nolink |}}
 +
 +That's it! Your app will now automatically rotate to those orientations.
 +
 +==== Landscape-only ====
 +
 +To create an app that supports both landscape orientations (with the home button at the left or right side), choose those orientations in the target summary tab in Xcode.
 +
 +{{ :​manual:​orientations_landscape.png?​nolink |}}
 +
 +Then open the file "​App-Info.plist"​ and add the following entry:
 +
 +{{ :​manual:​initial_interface_orientation.png?​nolink |}}
 +
 +That's it! Your app will now automatically rotate to those orientations...
 +
 +==== All orientations ====
 +
 +Per default, the Scaffold supports all orientations:​
 +
 +{{ :​manual:​orientations_all.png?​nolink |}}
 +
 +This makes the app rotate in all directions, but of course Sparrow can't decide for itself how your objects should be distributed in which orientation. Those changes have to be done manually.
 +
 +This is what the ''​SPResizeEvent''​ is for. It is automatically dispatched on all your display objects, and it contains the width and height of the stage after the rotation. Listen for that event like this:
 +
 +<code objc>
 +[self addEventListener:​@selector(onResize:​) atObject:​self forType:​SP_EVENT_TYPE_RESIZE];​
 +
 +- (void)onResize:​(SPResizeEvent *)event
 +{
 +    NSLog(@"​new size: %.0fx%.0f (%@)", event.width,​ event.height, ​
 +          event.isPortrait ? @"​portrait"​ : @"​landscape"​);​
 +}
 +</​code>​
 +
 +The ''​Game''​ class in the scaffold already contains this method stub. Make your user interface updates in this method!
 +
 +===== Adding UIKit elements =====
 +
 +Sometimes, you want to add standard UIKit elements to your game. This is e.g. necessary when you want to display an input textfield or when you want to include Apple'​s iAds or GameCenter. ​
 +
 +{{ :​manual:​scaffold_layers_v2.png?​width=450 |}}
 +
 +That's very easy to do with Sparrow. You can access the UIView object from anywhere with the following line of code:
 +
 +<code objc>
 +UIView *view = Sparrow.currentController.view;​
 +</​code>​
 +
 +Just like your Sparrow content, that view is automatically rotated according to the device orientation and your app settings. It is thus the perfect place to put any UIKit content.
 +
 +We will look into the details of how this is done in one of the next chapters. (If you can't wait, here's the link: [[Adding UIKit elements on top of Sparrow]].)
 +
 +
 +
 +===== Final words =====
 +
 +These are the most important tasks you can achieve with the help of the Scaffold project. The rest of the fun lies within the ''​Game''​ class, where you'll create the actual game. Good luck!
 +
 +----
 +
 +//Next section: [[Universal App Development]]//​
  manual/the_scaffold_project.txt · Last modified: 2015/05/27 20:30 by 88.229.130.202
 
Powered by DokuWiki