robovm / robovm-docs

RoboVM Documentation Project
5 stars 16 forks source link

Add documentation regarding framework inclusion #10

Open maximiliancsuk opened 9 years ago

maximiliancsuk commented 9 years ago

I recently implemented MFi controller support for one of my games. While the code was straight-forward, the necessary inclusion of the required frameworks in the robovm.xml file wasn't. In my specific case, I needed to add

<framework>ExternalAccessory</framework>
<framework>CoreBluetooth</framework>
<framework>GameController</framework>

to get it working. If this is missing, the relevant code just does not do anything, wireless controller discovery immediately returns without finding any controller. It took me quite some time to figure this out. Nothing really points to missing frameworks, it just silently fails. If this were somehow reported (during compile- or runtime) it wouldn't be as important to document. Alternatively (or better, additionally) the process of adding the necessary frameworks when using their respective functionality should be documented somewhere. In hindsight, it might be obvious that you need to add them, but if you're a Java developer like me with little iOS development experience, it is not that clear. :)

Relevant Google Groups post: https://groups.google.com/forum/#!topic/robovm/4ppEJbRjMQ0