Flower Breath - Developers

Dear developer,
We are expecting a lot from you...
On this page you will find our todo list and a short tutorial for your first steps in building a game for the Flower Breath..
Please contact us for support

Best Regards
Pierre-Mikael Legris (Perki)
pml @ defitech.ch

https://github.com/defitech/FlowerForAll-iOs/

TODO_DEV.txt
on github.com
Flower Breath iOS ================= Many young people suffering from respiratory problems must perform daily physiotherapy for airway clearance with a PEP medical device By breathing out with a moderate force through a resistance, a positive pressure is generated in the airways, helping to keep them open. This positive pressure allows airflow to get beneath the areas of mucus obstruction and move the mucus toward the larger airways, where it can be coughed out. **Project Homepage: ** [http://www.defitech.ch/FlowerForAll-en](http://www.defitech.ch/FlowerForAll-en) ## SETUP FLowerBreath reports its data on Pryv http://pryv.com/ Install Pryv Pods with http://cocoapods.org/ run `pod install` in the developpement folder. une `FlowerForAll.xcworkspace` after pod installation ## WRITE A GAME If you want to write a game, please read: [Apps/HOWTO_WRITE_A_GAME.md](https://github.com/defitech/FlowerForAll-iOs/blob/master/Apps/HOWTO_WRITE_A_GAME.md) ## KNOWN BUGS - they must be some memory leaks.. and some crashes are caused by some runnning conditions that happend more often iPad and older iPhone models. - it would be nice to have an objective-c expert do some code review.. - in ParametersApp: it seems that UIControlEventTouchUpInside event is not called every time the slider is touched -> changes to the profile are not recorded ## DOCUMENTATION - Complete "How To develop a game" document, with ergonomic guidlines and events sequence description ## PARAMETERS - MONITORING MODE Actually the soft is design in a "target" or "goal" mode, but some people would like to use is as a simpe monitoring device for their exercices. For exemple an Adult, would not do "games" with it but he will be interested in having historical statistics. This would be easily achived by recording every blows in the database, independently of exercices start / stop. But we need to create an interface for viewing this data.. ## PARAMETERS - SETTINGS - Makes profiles editables / removables . - The model is ready to be implemented ## COSMETICS - Refactor FLOWER BREATH logo and icon ## MONITORING - Rewrite the history monitor in OpenGL or Quartz - Add a current-blow percentage view. in the needleGL view add a progress view (vertical) that shows the persent of blowduration achieved. ## APPS MENU - Placement is now manual. When we will have more apps, (more than one page) we will have to develop an automatic placement for FlowerApp subclassing applications. ## VOLCANO APPS - It's nice but minimalist, - It would be great to have some animations and litlle blows off ## GAMES ! - Integrate some game engine such as unity and cocos2d ## FLAPI - FLAPIX - Is "code spagetthi" fashionned It would be nice to have someone exetrnal do some revieweing / refactoring ## AUDIO FEEDBACK - Add a nice audio feedback for someone who would do it's exercice without holding the iPhone. ## SOUND PROCESSING - Less latency could be achieved using remote i/o audio unit see: https://developer.apple.com/library/ios/#samplecode/aurioTouch/Introduction/Intro.html - is not perfect but functionnal.. - we will probably need to rewrite FLAPI if IAV does not open their code ## R & D - Possible with a bluetooth headset ? - Other microphone - Make a special piece of plastic to fix the microphone to the flutter ## Known memory leaks ### Monitoring on the simulator: - -[FLAPIX Start] : leak in SubSys_Start() - -[FLAPIX SetDemo] : leak in FLAPI_SUBSYS_IOS_file... - +[DB colS:index:] : if leak autoreleased, app crashes... might be fixed - -[FLAPIX init] : leak in FLAPI_SUBSYS_IOS_init... - +[DB getMonthes:] : if leak autoreleased, app crashes... might be fixed ### Monitoring on the device: - many leaks detected but no one in objective c code: biggest one is in -[UIActionSheet(Private) _popoutAnimationDidStop:finished:]

HOWTO_WRITE_A_GAME
on github.com
HOW TO WRITE A GAME =================== - VolcanoApp is you friend if you're looking for an example - ExampleApp shows a skeleton of what you should get at the end of this tutorial - Choose a name for your game, let's say "FunGame" # YOU MUST - All your files must be stored in their own "FunGame" subdirectory - As the iApp packages are "flat" (no subdirs) it's difficult to deal with files having identical names. This is why every single file of your package must start with the App name. for example you will rename Icon.png MyClass.h and ressource.data to: FunGame-Icon.png FunGame-MyClass.h and FunGame-ressources.data - All strings must be ready to be translated using the method `NSLocalizedStringFromTable(XXX,@"FunGame",XXXX);` to be sure we will find the string to translate at the right place. # CREATE THE SUBDIR ENVIRONNEMENT - in the Apps directory create a sub directory called "FunGame" respect the case of the name you choose. Do this from the Finder or Terminal, NOT from Xcode. - create the subdir en.lproj to hold your localized elements in english - add an empty string files to hod your localized Strings with the name: "FunGame.strings" In a terminal that would do: $ cd FlowerForAll/Apps/ $ mkdir FunGame $ mkdir FunGame/en.lproj $ touch FunGame/en.lproj/FunGame.strings # MAP THE CREATED SUBDIR WITH XCODE In Xcode, on the FlowerForAll project - right-click on the "Apps" group Folder and select "New Group" - rename the newly created group to "FunGame" **you need to have the "utilities view open" (right layer) and show the "File inspector"** - Select the "FunGame" icone, and in the File inspector, just below the "Path" that must be set to "Relative to Group" change the "None" to your "FunGame" directory (your "FunGame" group is now mapped to your directory) * add the localized strings file right click on your "FunGame" group icon and choose "Add Files to FlowerForAll" select the file FunGame.strings in the "en.lproj" directory The following command from the FunGame/ source directory will do the job for you `$ genstrings *.m -o en.lproj` - you can create "FunGame.strings" for other languages and add them the same way. (for french it would be the file FunGame/fr.lproj/FunGame.strings) # CREATE YOU GAME CONTROLLER * You must Subclass "FlowerApp" * Right click on you "FunGame" group icon and choose "New File" - CocoaTouch -> UIViewController subclass" - in the subclass entry field choose "FlowerApp" check the "with XIB for user interface" - in the Save As entry field choose "FunGame" be sure "Where" and "Group" are set to "FunGame" # OVERRIDING FLOWER APP in Classes/AppsMenu/ * look at FlowerApp header and implementation to get an idea of what it does You must override at least /** Used to put in as label on the App Menu (Localized)**/ +(NSString*)appTitle ; The following code will do the trick /** Used to put in as label on the App Menu (Localized)**/ +(NSString*)appTitle { return NSLocalizedStringFromTable(@"My Fun Game",@"FunGame",@"App Title"); } The following command from the FunGame/ source directory will complete your english dictonary file `$ genstrings *.m -o en.lproj` * If you don't want to provide an FunGame-Icon.png file then you must override `+(UIImage*)appIcon;` * If you don't want to use XIB user interface override `+(FlowerApp*)autoInit;` * To catch events from the Application and from FLAPIX (the library that does the sound processing) you just have to override any of the flapixEventXXXXX method you need. # SHOWING A START / STOP BUTTON * look at VolcanoApp refreshStartButton method if you want to add your own control method # INSTALLING YOUR APP ON THE MENU * Add a FunGame-Icon.png file to your App directory or implement +(UIImage*)appIcon * We will soon automate this part, but for now, you have to manually add your app to FlowerController-viewDidLoad appList then add your Icon and Title to MenuView.xib and The IBAction to open your app in MenuView.m * If you start developping your own app, just let us know, we will work on this with you