Sunday, July 21, 2013

OpenFL gestures using roxlib gesture library

When I work with NME before , I used a gesture library called roxlib  for gesture handling. This roxlib library is greats! it's not dependent on native features so I can use it on flash also (for the sake rapid prototyping of course). now that this library is updated to support OpenFL (thanks rockswang!) I can happily tell everyone how awesome this library is. This library is great for basic mobile touch screen gestures, it supports :
  • pinch
  • pan
  • swipe 
  • long press
  • tap 
  • rotation
All the gesture that is common usage in the mobile environment nowadays.

The only problem with this library is the lack of documentation and how cluttered it's code with so many unnecessary code (the "how to use" piece of code could be separated from the library itself I guess). But after a while I figured out how this library works. So I'll write a little tutorial for those who need to use gestures on their games :)

Gesture with Roxlib

First we must download the roxlib library from the github page and extract it somewhere. 

Then copy the roxlib library into your project, this is necessary because it's not a haxelib project so we need to import it manually into the project. 

copy library to project

There's not only gesture package inside the library, but we can remove the others without any problem (once again thanks roxswang for making it independent from another package).

only gesture package left

now for the coding part, all we need to do is create a RoxGestureAgent for the gesture event handler, and some sprite used for the target of gesture , the register the gesture event handler to the target sprite using RoxGestureEvent.

var image:Sprite = new Sprite();
image.addChild(new Bitmap(Assets.getBitmapData("img/rock.png")));
image.x = 300;
image.y = 200;
image.scaleX = 2;
image.scaleY = 2;

var roxAgent = new RoxGestureAgent(image, RoxGestureAgent.GESTURE);

image.addEventListener(RoxGestureEvent.GESTURE_SWIPE, onSwipe);
image.addEventListener(RoxGestureEvent.GESTURE_PAN, onPan);
image.addEventListener(RoxGestureEvent.GESTURE_PINCH, onPinch);
image.addEventListener(RoxGestureEvent.GESTURE_ROTATION, onRotation);
image.addEventListener(RoxGestureEvent.GESTURE_TAP, onTap);
image.addEventListener(RoxGestureEvent.GESTURE_LONG_PRESS, onLongPress);

then for each callBack method, as it receive RoxGestureEvent as parameter, the 2 necessary properties to remember from it are the target and extra properties. The target properties contain the target sprite used as gesture target, and extra properties contain different thing for different actions :

  • extra on Pinch contain scale factor (float)
  • extra on Rotation contain rotation angle (float)
  • extra on Pan/Swipe contain pan/swipe speed (Point)
One thing to note about Pan and Swipe difference is that Pan action called continously when you move your finger across the screen, and swipe is only called when you removed your hand from the screen. 

The below codes is the callback I use for this tutorial, you can create your own version. I'll not really explain too much about each callback but here's a brief explanation about each callback method 

When tap gesture called the target will be scaled up:

 private function onTap(e:RoxGestureEvent):Void
  var sp:DisplayObject = cast(, DisplayObject);
  var scX = sp.scaleX; //current scaleX factor
  var scY = sp.scaleY; //current scaleY factor 
  Actuate.tween(sp, 0.5, { scaleX: scX + 0.1, scaleY:scY + 0.1 } ).ease(Bounce.easeOut);

When long press gesture called the target will be scaled down:

 private function onLongPress(e:RoxGestureEvent):Void
  var sp:DisplayObject = cast(, DisplayObject);
  var scX = sp.scaleX; //current scaleX factor
  var scY = sp.scaleY; //current scaleY factor 
  Actuate.tween(sp, 0.5, { scaleX: scX - 0.3, scaleY:scY - 0.3 } ).ease(Bounce.easeOut);

When pinch called the target will be resized:

private function onPinch(e:RoxGestureEvent):Void
 var sp = cast(, DisplayObject);
 var scale: Float = e.extra;
        var spt = sp.parent.localToGlobal(new Point(sp.x, sp.y));
        var dx = spt.x - e.stageX, dy = spt.y - e.stageY;
        var angle = Math.atan2(dy, dx);
        var nowlen = new Point(dx, dy).length;
        var newlen = nowlen * scale;
        var newpos = Point.polar(newlen, angle);
        newpos.offset(e.stageX, e.stageY);
        newpos = sp.parent.globalToLocal(newpos);
        sp.scaleX *= scale;
        sp.scaleY *= scale;
        sp.x = newpos.x;
        sp.y = newpos.y;

When pan called the object will move following the mouse/finger movement:

private function onPan(e:RoxGestureEvent):Void
 var sp = cast(, DisplayObject);
 var pt = cast(e.extra,Point);
        sp.x += pt.x;
        sp.y += pt.y;

When swipe called the target will move using the swipe speed

private function onSwipe(e:RoxGestureEvent):Void
 var sp= cast(, DisplayObject);
 var pt = cast(e.extra, Point);
        Actuate.tween(sp,  0.5, { x:sp.x + pt.x, y:sp.y + pt.y });

And here's the result of the example:
Note : I have only tested this on flash, android, and windows and works without problem . If anyone can try it on iOS or blackberry and tell me the result I would be grateful!
Note : When I tested this on html5 ,swipe and pan didn't work. maybe anyone can figure out why? 

That's all. 

I hope you can make use of this awesome library. as for this is the best library I found for simple mobile gestures. again, all thanks for rockswang for this awesome gesture library :D


Monday, July 1, 2013

From NME to OpenFL with FlashDevelop

Right now OpenFL already up on the haxelib  so I could say that it's safe to use it now. For some , the migration process wouldn't be as smooth as one expect. Some problem like different build file type (NME use .nmml while OpenFL use .xml) and the support of OpenFL on FlashDevelop would cause a problem.

I've sucessfully migrated my NME project into OpenFL, it's not a big deal but maybe it can help they who don't know how to migrate :) 

First here's how to install OpenFL and FlashDevelop :
  1. Install haxe 3 from and the official site
  2. open the newly installed haxelib and install these libs: openfl, openfl-compatibility, openfl-tools,openfl-native,openfl-html5
  3. after those libs installed, run this command : haxelib run openfl setup 
  4. run additional setup command to setup each platform : openfl setup android, openfl setup blackberry, etc . If you already run nme setup [platform] previously , the setting would be saved in OpenFL
  5. The current release build of FlashDevelop doesn't support OpenFL project, so you need to install the dev build version of FlashDevelop. you can download it here
  6. if you select New Project in FlashDevelop you can see the OpenFL project can be created there.

Migrating NME Project to OpenFL Project

Using the new FlashDevelop we can migrate NME Project to OpenFL, but it need some configuration changes in .nmml file to do so.
  • change .nmml file extension in your NME project into .xml 
  • change <haxelib="nme"/> into <haxelib="openfl"/>
  • add <haxelib="openfl-compatibility"/> so OpenFL will recognize all the old nme package
  • looks like <haxelib="actuate"/> is necessary in OpenFL so don't forget to add that (Edit: turns out It's not really necessary if you don't use actuate)
  • I'm not sure if this one necessary or not but you can delete all <ndll/> tags without problem (except your own ndll of course)
  • This one too , delete the old <haxeflag/> tag and change with this one <haxeflag name="-dce std" if="haxe3" />
  • Last, we need to tell FlashDevelop to use the .xml file as the build file. Right click Project -> Properties . On the output file, change the application.nmml extension to application.xml
  • Try to run the project. It should be no problem now.

Other notes
  • check the haxe 3 migration  for some feature changes like Maps and properties
  • haxe 3 use different haxelib repo than haxe 2. so make sure that your lib that you use is  exist in 
  • some library like spritesheet changes it's package name so you need to be careful about that.
for the end note, OpenFL is a great framework with so many potential. so don't hestitate to use it and keep creating awesome things . Cheers! :)

Tuesday, June 11, 2013

JKT48 Fanmade Game

So I create a fanmade game for all JKT48 out there. this is a small example, if the feedback is good I would consider to add more :)
try to get as highest as you can, Enjoy!

note : I could make the android version if there's anyone want to download :p

Saturday, May 25, 2013

Resolving NME Android build fail after upgrading SDK to version 22

I just met a problem with NME deployment to android after I upgraded the SDK to v22. The problem would look something like this

D:\Programming\SDKs\android-sdk-windows\tools\ant\build.xml:479: SDK does not have any Build Tools installed.

After going for a googling for a while I found out from this stackoverflow question that now android separate the platform-tools and build-tools. you can check on android sdk folder that now there is build-tools folder inside. To resolve this problem we need to open the SDK Manager and install the missing build tools. 

At first when I update the sdk to v22 this Android SDK build-tool doesn't exist, but after updating the  list it showed up on the list. Install it and the problem can be solved. have fun :)

Sunday, April 28, 2013

Haxe Game : Color Word , a demonstration of Stroop Effect

So I create a simple game for the weekend. I just feel the urge to create it because I love the idea so much :))
The idea is simple, it's demonstrate what it's called by Stroop Effect. Simply said, Brain will have difficult to process a color when conflicted with different color name. Good explanation here .
This game created with Haxe NME . It also has the android version , you can download it here

enjoy :)

Animated Sprite using Bitmap Spritesheet with Haxe NME/OpenFL Spritesheet Library

NME comes with great spritesheet lib which can be installed with haxelib install spritesheet command on commandline. Unfortunately it lacks documentation and how to example tutorial. The only spritesheet tutorial available is the singmajesty's tutorial which also doesn't give a clue about how to work with bitmap spritesheet. So I tried to figured it out myself. And turns out it's not that hard, so I'll tell you how in a fast and effective way.

The first thing needed to create animated sprite of course is the spritesheet itself. I will use the spritesheet I took from opengameart as example.

also don't forget to add  spritesheet lib to nmml with haxelib tag

<haxelib name="spritesheet" />

to load the bitmap and parse it as animation frames we can use BitmapImporter class inside com.ecleticdesignstudio.spritesheet.importers package. this class is really simple because it's only contain one static function called create(). as the input parameter it ask for the BitmapData , column count, row count, frame width, frame height, and some additional parameter which I'm not sure what it is so I'll leave it like that for now. The create() methods gives output a Spritesheet class, we need to create a variable to hold this output.

var spritesheet:Spritesheet = BitmapImporter.create(Assets.getBitmapData("img/kit_from_firefox.png"), 3, 9, 56, 80);

we can (and must) assign BehaviourData this Spritesheet object. BehaviourData required to define how the spritesheet should be used, which frame should be played at what speed(fps) and should it be looped or not.
for this example I create 9 behaviour for the spritesheet and assigns it to each row of frames, and I give different parameter for each behaviour. What's important for this BehaviourData input parameter is the name and frame number.

spritesheet.addBehavior(new BehaviorData("stand", [0, 1, 2], true));
spritesheet.addBehavior(new BehaviorData("down", [3, 4, 5], false,15));
spritesheet.addBehavior(new BehaviorData("jump", [6, 7, 8], false,15));
spritesheet.addBehavior(new BehaviorData("hit", [9, 10, 11], false,15));
spritesheet.addBehavior(new BehaviorData("punch", [12, 13, 14], false,5));
spritesheet.addBehavior(new BehaviorData("kick", [15, 16, 17], false,15));
spritesheet.addBehavior(new BehaviorData("flypunch", [18, 19, 20], false,10));
spritesheet.addBehavior(new BehaviorData("flykick", [21, 22, 23], false,10));
spritesheet.addBehavior(new BehaviorData("dizzy", [24, 25, 26], true));

The spritesheet itself is ready, but we can't use it directly. spritesheet library has their own sprite class for animation called AnimatedSprite. We can use this AnimatedSprite to animate the spritesheet created before. to use it simply input the spritesheet into the constructor parameter.

var animated:AnimatedSprite = new AnimatedSprite(spritesheet, true)

AnimatedSprite need to update itself for animation, so we must call it's update() method on each update cycle

 public function onEnterFrame(e:Event):Void
  var delta = Lib.getTimer()- lastTime;
  lastTime = Lib.getTimer();

To play animation we can call behaviour names from spritesheet using showBehaviour() method or showBehaviours() if we want to call a list of behaviour consecutively. We can also queue behaviour using queueBehaviour(), the method will queue behaviour and animate it after the current animation finished. Remember that a looping behaviour will loop forever and so it should not be used inside the behaviour queue (if we use showBehaviours() or queueBehaviour())


So that's what I know about how to use spritesheet library . I hope it could help as the a simple tutorial of how to use Haxe NME spritesheet library because spritesheet is a fundamental thing in game. and spritesheet lib is a neat library for a playing animation. :)

Here is the result:
you could find the example source here .

Cheers! :)

Update : Dealing with Haxe 3 Change

if you switch to haxe 3 you may deal with error saying that package not found. that's happen because spritesheet library on haxe 3 use different package name. The solution is to change the package name


import com.eclecticdesignstudio.spritesheet.AnimatedSprite;
import com.eclecticdesignstudio.spritesheet.importers.BitmapImporter;
import com.eclecticdesignstudio.spritesheet.Spritesheet;


import spritesheet.AnimatedSprite;
import spritesheet.importers.BitmapImporter;
import spritesheet.Spritesheet;

there you go. now it will run without any problems . Good luck! :)

Sunday, April 14, 2013

NME Gesture Library

I was struggling with how to do gestures with NME . I need to do swipe control in my games but I can't found any good gesture library to use.
Then luckily I stumbled upon this roxlib library. it was after browsing through the haxe google group that I found a  thread about it. I tested it on my android and it works really well

it's a good library but really need documentation about how to use it.
I've figured out how it works and maybe will create some examples later.
currently it support pan, pinch , swipe, long press, tap, double tap, and some other's that I forgot. (well at least I can use the swipe :p )

the downside is it's need some sprite with graphic registered as the input listener so an empty sprite without anything inside would be no good. I use empty sprite as the input listener so this really troubles me. My solution is create a screen-sized transparent image as the graphic and add it to the sprite. it works well, but if there's any better solution maybe I'll try that.

Sunday, April 7, 2013

Integrating Chartboost with Haxe NME for Android

Haxe NME is a great cross platform framework for game which support wide range of platform from desktop to mobile. It compiles to native, and have the similarity with flash AS3. NME is extensible and have numbers of useful third party library support. I prefer it mostly because it could compile to many different platform especially flash, Android, iOS, and Blackberry10.

maybe the only problem with NME is the lack of documentation and not so active community outside the forum and mailing list. there's still so many things not covered in the tutorial and some googling of NME-Android related things won't give you direct answer to the problem. stackoverflow tag of haxe/nme tag doesn't have so much question and  reddit r/haxe sub just have a small number of reader.

One problem stuck me now is integration of ads, specifically Chartboost . Chartboost is a really good ads network with a high CPM. before using NME I used libgdx to create android games, and chartboost integration with libgdx is easy as breeze because it's covered on the tutorial.

I searched everywhere looking for how to integrate chartboost (Android) on NME and it result on nothing. Luckily, after struggling so much with so many different keyword I stumbled upon gigglingcorpse's blog post and found some answer. I contacted gigglingcorpse and after consulting for a while finally I could integrate the ads! Big Thanks!

I feel the urge to write this tutorial to help others give more understanding about of how to integrate chartboost (Android) with NME. It's not really hard but maybe it could confuse new player which still not understand about how NME work behind the screen.

So let's start!

First thing first! In order to integrate chartboost ads in our game we need to first register the app inside chartboost dashboard. just register on chartboost and Add App to get the APP_KEY and SIGNATURE.   I won't tell you how to do that here. just look it up on the official help yourself. just make sure the test mode enabled . also you need to create campaign and check the created app so the app could display ads inside.

After we got the APP_ID and APP_SIGNATURE we can integrate it in our NME project.

I used FlashDevelop in this tutorial so I will create a HelloWorld project for the purpose of tutorial.

First thing to do is adding chartboost library to the project. in order to do that we need to create libs folder inside assets folder so the structure will be like assets/libs. Download the chartboost android library from the official download and then copy it to libs folder .

add chartboost library

Then on the application.nmml write a template tag to rename it as lib folder in android

<template path="assets/libs" rename="libs" if="android" />

Adding chartboost library is done! Next step is putting the code.

Chartboost integration require us to add some code on Activiy class in Android. So we need to override the default emplate. s an android class generated by haxe as the Activity class to launch in android. the default will looks like a blank class as seen below

package ::APP_PACKAGE::;

import android.os.Bundle;

public class MainActivity extends org.haxe.nme.GameActivity {

We cannot add code directly to the generated class because the code added will be wiped out when we do the next build. In order to override the class we need to change the template and fill it with necessary code. To do that , copy template from nme installation folder. The template located in templates\default\android . copy the MainActivity template to project directory and then register it as template on application.nmml . change the [package_path] with your app package path

<template path="" rename="src/com/fugo/helloWorld/HelloWorld/" if="android" />

Open and add the code as instructed on the official tutorial . there's nothing need to be changed once you got it done so you can just copy paste code below to your .just remember to change "YOUR_APP_ID" and "YOUR_APP_SIGNATURE" with the APP_ID and APP_SIGNATURE.

package ::APP_PACKAGE::;

import android.os.Bundle;
import com.chartboost.sdk.*;

public class MainActivity extends org.haxe.nme.GameActivity {
 private Chartboost cb;
  protected void onCreate(Bundle state) {
  // Configure Chartboost
  this.cb = Chartboost.sharedChartboost();
  String appId = "YOUR_APP_ID";
  String appSignature = "YOUR_APP_SIGNATURE";
  this.cb.onCreate(this, appId, appSignature, null);
  // Notify the beginning of a user session

  // Show an interstitial

 protected void onStart() {


 protected void onStop() {


 protected void onDestroy() {


 public void onBackPressed() {

  // If an interstitial is on screen, close it. Otherwise continue as normal.
  if (this.cb.onBackPressed())

we could also use the code above as a template for next project without changing much of the code, just the APP_ID and APP_SIGNATURE.

save up the change and.... test run it on android.

Voila! Chartboost (Android) with HaxeNME
Integration done!
to give more control of the ads showing , you could change the showInterstitial() method with cacheInterstitial() in onCreate() and then call cb.showInterstitial() through JNI call from haxe. for convenience I created a public static method called showChartboost() in and call it from haxe like below

var showChartboost = JNI.createStaticMethod("com/amagine/plate2/MainActivity", "showChartboost", "()V");

there.. from here on much can be done via JNI so I'll leave it up to you about the advanced things. thanks for reading!

~End of Tutorial~

Saturday, April 6, 2013

Hello World

This is a test post.

I'm gonna make this blog as a simple diary of my programming days~

 printf("Hello World");