controller-lib

This Android-library should help you to show a common game controller on the screen and react to its user input

At the moment the only supported Buttons are the Directionbuttons (8-way) and the Action-Input of a user, such as on the Playstation- or the XBox-Controller

This library uses VectorDrawable and has downward-support down to API Level 14

Dependencies:

appcompat 23.2.0

How to use in your project:

Add this library as a dependency

compile 'com.andretietz.android:gamecontroller:1.1.0'

Add both of the Views to your layout:

    <com.andretietz.android.controller.DirectionView
        android:id="@+id/viewDirection"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:layout_alignParentBottom="true"
        android:layout_alignParentLeft="true"
        android:layout_alignParentStart="true"/>

    <com.andretietz.android.controller.ActionView
        android:id="@+id/viewAction"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:layout_alignParentBottom="true"
        android:layout_alignParentRight="true"
        android:layout_alignParentEnd="true" />

and create listeners for them

ActionView actionView = (ActionView) findViewById(R.id.viewAction);
actionView.setOnButtonListener(new InputView.InputEventListener() {
    @Override public void onInputEvent(View view, int buttons) {
		// foreach button (there are 4 action buttons)
		for(int i=0;i<4;i++) {
			// if the bit on position i is set
			if(((0x01 << i)&buttons)>0) {
				// Button Number (i+1) is pressed
			}
		}
		// if buttons == 0, the user stopped touching the view
    }
});
...
// same for DirectionView
DirectionView directionView = (DirectionView) findViewById(R.id.viewDirection);
directionView.setOnButtonListener(new InputView.InputEventListener() {
    @Override public void onInputEvent(View view, int buttons) {
		switch (buttons&0xff) {
			case DirectionView.DIRECTION_DOWN:
				// do smth.
				break;
			case DirectionView.DIRECTION_LEFT:
				break;
			case DirectionView.DIRECTION_RIGHT:
				break;
			case DirectionView.DIRECTION_UP:
				break;
			case DirectionView.DIRECTION_DOWN_LEFT:
				break;
			case DirectionView.DIRECTION_UP_LEFT:
				break;
			case DirectionView.DIRECTION_DOWN_RIGHT:
				break;
			case DirectionView.DIRECTION_UP_RIGHT:
				break;
		}
		
		// if buttons == 0, the user stopped touching the view
    }
});

Customizing:

If you want to customize the views, you can do it in the layout xml. I recommend creating a style for it, but thats up to you.

Since both views extend from InputView, you can customize a lot with this already. Both views will react on this attributes.

InputView options:

inputBackground (drawable reference)
- This attribute takes a Drawable (Create VectorDrawables (xml) vector-compat compatible!)
- The size of this drawable defines the maximum size of this View
deadZone (0...1)
- All Buttons are around the center of the view, like pieces of cake. If the user goes too close to the center of the view it could happen that he accidentially hits other buttons than he wanted to. To avoid that you can set a deadZone. The value has to be between 0 and 1. 0 means no deadZone, 1 means everything is deadZone ;)
buttonCenterDistance (0...1)
- each button on the view can have its own drawable. This value tells the view how far from the center of the view the buttons will be drawn. 0 means all buttons get drawn in the middle of the view. 1 means on the edge of the view. As origin of the buttons, the center of the drawables will be used.
rotateButtons (0...360)
- Rotate the whole Button Circle
vibrate (true|false)
- Vibrates on touch. Remember the Vibrate permissions!
debug_drawDeadZone (true|false)
- This is for debugging only, but if you need it, use it. It draws the deadZone ontop of everything else
debug_drawPieces (true|false)
- This is for debugging only, but if you need it, use it. It draws the button pieces, when klicking on them

Example:

    <RelativeLayout xmlns:android="http://schemas.android.com/apk/res/android"
                    xmlns:app="http://schemas.android.com/apk/res-auto" />
                    ...
    <com.andretietz.android.controller.views.DirectionView
        app:inputBackground="@drawable/my_vectordrawable"
        app:vibrate="true"
        android:id="@+id/viewDirection"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:layout_alignParentBottom="true"
        android:layout_alignParentLeft="true"
        android:layout_alignParentStart="true"/>

DirectionView options

button_r_normal - VectorDrawable for the unpressed Button: Right
button_r_pressed - VectorDrawable for the pressed Button: Right
button_d_normal - VectorDrawable for the unpressed Button: Down
button_d_pressed - VectorDrawable for the pressed Button: Down
button_l_normal - VectorDrawable for the unpressed Button: Left
button_l_pressed - VectorDrawable for the pressed Button: Left
button_u_normal - VectorDrawable for the unpressed Button: Up
button_u_pressed - VectorDrawable for the pressed Button: Up
diagonal_mode (true|false)
- When this is set to true, the DirectionView will not draw the between buttons (ul,ur,dr,dl), it will highlight the buttons arround it. So in case of ul it will highlight the buttons Up and Left. The result in the Listener will stay the same in both cases.

These values will only be drawn, if diagonal_mode is set to false

button_ur_normal
button_ur_pressed
button_ul_normal
button_ul_pressed
button_dr_normal
button_dr_pressed
button_dl_normal
button_dl_pressed

ActionView

The buttons are drawn from the right to the bottom, to the left - up and to the right again. So there indexes are as well. This is a bit inconsistent (i.e. to the listener), I should fix that in future releases.

button1_enabled - VectorDrawable for the right button if not pressed
button1_pressed - VectorDrawable for the right button if pressed
button2_enabled - VectorDrawable for the bottom button if not pressed
button2_pressed - VectorDrawable for the bottom button if pressed
button3_enabled - VectorDrawable for the left button if not pressed
button3_pressed - VectorDrawable for the left button if pressed
button4_enabled - VectorDrawable for the top button if not pressed
button4_pressed - VectorDrawable for the top button if pressed

laka2012/controller-lib