Gamepads in Android, anyone got experience considering Godot?

wombatstampede

Hi all, since I moved my project from 2.x to 3.1 I noticed that the gamepad support in Godot for my android app seems to have stopped.

I checked and found this issue: https://github.com/godotengine/godot/issues/25151

Which reads very strange. It seems that the GUIDs are inconsistent even between the Android SDL2 Controllermap app (I didn't build that yet because it seemingly needs some shell script to build and I mostly build on Windows) and Godot which are supposed to use the same library. And furthermore I wonder if and why it may be forcably required to have an entry in the gamecontrollerdb.txt for a gamepad to be listed?

For example: I connected a "Nintendo Switch Pro Controller" via bluetooth to my phone.

Then I started an app called "Gamepad Tester" which recognized the gamepad. Then I started the Godot Gamepad demo app. Which found.... nothing. I also have an usb gamepad (connected via USB-OTG) which worked with my app in 2.x but doesn't anymore in 3.1. Funny enough the nintendo controller is also one of the very, very few gamepads listed in the controllermappings. But my guess is that even here, the GUID is somewhat different or some other magic/error prevents gamepad handling on Android.

So anyone got some experience here? If I personally find something notable I'll also be happy to share it...

wombatstampede

As I don't seem to be able to edit my initial post, I'll have to add another one to update.

I did some "code forensics" on the godot source. Apparently the code for getting joysticks in android is in "\platform\android\java\src\org\godotengine\godot\".

Which resembles quite a bit the ControllerSample.zip project mentioned here: https://developer.android.com/training/game-controllers/compatibility.html

That code in GodotView.java calls on "onInputDeviceAdded()" -> GodotLib.joyconnectionchanged() which forwards to main\input_default.cpp "joy_connection_changed".

The interesting part is that it seems that (at least in android) joystick devices are ONLY added when such an event occurs. Normally I'd expect that they use the function (which is also declared but never used in the java code) "getInputDeviceIds()" to iterate the devices on start like the ControllerSample demo project does.

I tried it and plugged an USB-Controller in while a godot app was running, but no event occurs. So this doesn't seem to be the only problem (if any at all).

wombatstampede

I have now put my feet into the git hell (well, it was about time) and hope to get a pull request for a android+gamepad related fix ready by the weekend. Then it is up to the godot gods to decide what to do with it.

What will be corrected: Android only: - Godot will now notice gamepads/joysticks that have been connected BEFORE the game/app has been started.

Well, this is it. The only way you could gamepads/joysticks to work before is by adding/connecting them (i.e. pairing/enabling bluetooth) WHILE the app was running. And even then, some joysticks make Godot restart on connection. Those could never be connected with godot.

Why that restart? I have a joystick which also connects as mouse. Maybe this put up some context change or whatever. But Godot gets some signal to restart (it is not an internal failure according to logs).

What this fix doesn't fix: Joypads should be visible but there won't be any mappings for the majority of them because the android gamepad mappings list is very very short. That means that the Gamepad will display and even work but for most of them the axes and buttons will be somewhat numbered arbitrary (which means the mapping to actions will probably fail). So you'll have to add some customization. Perhaps some GUIDs can also be ported from the other platforms list if anyone knows how to convert GUIDs.

What I tested so far: - Some cheap bluetooth "VR-Park" one-handed combined single joystick/mouse -> lets godot restart. Now works. - Nintendo Switch Pro Controller. This one worked before when connecting while the app was running. It even has an entry in the mappings file (although I didn't check if the GUIDs match). - Nintendo Switch Joy Con: Doesn't deliver analog joystick signals. Joystick sends button clicks instead. (comparable to a digital gamepad)

Jerware

I just wanted to say thanks for your post and source contribution. I’m new to Godot and struggling with this exact issue. Looking forward to 3.2.

cybereality

I think I'm running into this issue possibly. I'm testing the platformer2D sample that comes with the engine. On my local desktop it works fine with the Xbox controller. If I build for Android the controller doesn't work (I have a Bluetooth Xbox controller paired to the tablet, and it works in published games on the store). What is the workaround here? This is a pretty substantial problem if widespread.

cybereality

So I went deep into the bug reports on Github, tried compiling from source myself, and finally realized it's fixed in the 3.2 beta (I was using the Steam version). Works fine now, please carry on.

wombatstampede

Wonderful to hear. I didn't check this in the 3.2, yet but a general lack/problem of mappings remains.

To my knowledge (unless somebody else has fixed this now), the GUIDs in Godot/Android are not SDL compatible. Instead they're just the first letters of the (reported) Joystick Name converted to Hex.

I put up a little script in the githup issue above. That script was never tested, so I cannot guarantee that it works. I takes a list/array of mappings, ignores the GUID and builds it own based on the name (column 2), and then adds it as a mapping. (uncomment the init_mappings in ready when you want in to set the mappings automatically on ready)

extends Node

var mappings = [
"05000000bc20000000550000ffff3f00,GameSir G3w,a:b0,b:b1,back:b4,dpdown:b12,dpleft:b13,dpright:b14,dpup:b11,leftshoulder:b9,leftstick:b7,lefttrigger:a5,leftx:a0,lefty:a1,rightshoulder:b10,rightstick:b8,righttrigger:a4,rightx:a2,righty:a3,start:b6,x:b2,y:b3,platform:Android,",
"05000000d6020000e5890000dfff3f00,GPD XD Plus,a:b0,b:b1,back:b4,dpdown:b12,dpleft:b13,dpright:b14,dpup:b11,leftshoulder:b9,leftstick:b7,lefttrigger:a3,leftx:a0,lefty:a1,rightshoulder:b10,rightstick:b8,righttrigger:a4,rightx:a2,righty:a5,start:b6,x:b2,y:b3,platform:Android,",
"64633436313965656664373634323364,Microsoft X-Box 360 pad,a:b0,b:b1,dpdown:h0.4,dpleft:h0.8,dpright:h0.2,dpup:h0.1,leftshoulder:b9,leftstick:b7,lefttrigger:a4,leftx:a0,lefty:a1,rightshoulder:b10,rightstick:b8,righttrigger:a5,rightx:a2,righty:a3,x:b2,y:b3,platform:Android,",
"050000007e05000009200000ffff0f00,Nintendo Switch Pro Controller,a:b0,b:b1,back:b15,dpdown:b12,dpleft:b13,dpright:b14,dpup:b11,guide:b5,leftshoulder:b3,leftstick:b4,lefttrigger:b9,leftx:a0,lefty:a1,rightshoulder:b18,rightstick:b6,righttrigger:b10,rightx:a2,righty:a3,start:b16,x:b17,y:b2,platform:Android,",
"050000007e05000009200000ffff0f00,Pro Controller,a:b0,b:b1,back:b15,dpdown:b12,dpleft:b13,dpright:b14,dpup:b11,guide:b5,leftshoulder:b3,leftstick:b4,lefttrigger:b9,leftx:a0,lefty:a1,rightshoulder:b18,rightstick:b6,righttrigger:b10,rightx:a2,righty:a3,start:b16,x:b17,y:b2,platform:Android,",
"37336435666338653565313731303834,NVIDIA Controller,a:b0,b:b1,dpdown:h0.4,dpleft:h0.8,dpright:h0.2,dpup:h0.1,leftshoulder:b9,leftstick:b7,lefttrigger:a4,leftx:a0,lefty:a1,rightshoulder:b10,rightstick:b8,righttrigger:a5,rightx:a2,righty:a3,start:b6,x:b2,y:b3,platform:Android,",
"4e564944494120436f72706f72617469,NVIDIA Controller,a:b0,b:b1,dpdown:h0.4,dpleft:h0.8,dpright:h0.2,dpup:h0.1,leftshoulder:b9,leftstick:b7,lefttrigger:a4,leftx:a0,lefty:a1,rightshoulder:b10,rightstick:b8,righttrigger:a5,rightx:a2,righty:a3,start:b6,x:b2,y:b3,platform:Android,",
"61363931656135336130663561616264,NVIDIA Controller,a:b0,b:b1,dpdown:h0.4,dpleft:h0.8,dpright:h0.2,dpup:h0.1,leftshoulder:b9,leftstick:b7,lefttrigger:a4,leftx:a0,lefty:a1,rightshoulder:b10,rightstick:b8,righttrigger:a5,rightx:a2,righty:a3,start:b6,x:b2,y:b3,platform:Android,",
"050000005509000003720000cf7f3f00,NVIDIA Controller v01.01,a:b0,b:b1,dpdown:b12,dpleft:b13,dpright:b14,dpup:b11,leftshoulder:b9,leftstick:b7,lefttrigger:a4,leftx:a0,lefty:a1,rightshoulder:b10,rightstick:b8,righttrigger:a5,rightx:a2,righty:a3,start:b6,x:b2,y:b3,platform:Android,",
"050000005509000010720000ffff3f00,NVIDIA Controller v01.03,a:b0,b:b1,dpdown:b12,dpleft:b13,dpright:b14,dpup:b11,leftshoulder:b9,leftstick:b7,lefttrigger:a4,leftx:a0,lefty:a1,rightshoulder:b10,rightstick:b8,righttrigger:a5,rightx:a2,righty:a3,start:b6,x:b2,y:b3,platform:Android,",
"050000004c05000068020000dfff3f00,PS3 Controller,a:b0,b:b1,back:b4,dpdown:b12,dpleft:b13,dpright:b14,dpup:b11,leftshoulder:b9,leftstick:b7,lefttrigger:a4,leftx:a0,lefty:a1,rightshoulder:b10,rightstick:b8,righttrigger:a5,rightx:a2,righty:a3,start:b6,x:b2,y:b3,platform:Android,",
"050000004c050000c4050000fffe3f00,PS4 Controller,a:b1,b:b17,back:b15,dpdown:b12,dpleft:b13,dpright:b14,dpup:b11,guide:b5,leftshoulder:b3,leftstick:b4,lefttrigger:+a3,leftx:a0,lefty:a1,rightshoulder:b18,rightstick:b6,righttrigger:+a4,rightx:a2,righty:a5,start:b16,x:b0,y:b2,platform:Android,",
"050000004c050000cc090000fffe3f00,PS4 Controller,a:b1,b:b17,back:b15,dpdown:b12,dpleft:b13,dpright:b14,dpup:b11,guide:b5,leftshoulder:b3,leftstick:b4,lefttrigger:a3,leftx:a0,lefty:a1,rightshoulder:b18,rightstick:b6,righttrigger:a4,rightx:a2,righty:a5,start:b16,x:b0,y:b2,platform:Android,",
"35643031303033326130316330353564,PS4 Controller,a:b1,b:b17,back:b15,dpdown:h0.4,dpleft:h0.8,dpright:h0.2,dpup:h0.1,guide:b5,leftshoulder:b3,leftstick:b4,lefttrigger:+a3,leftx:a0,lefty:a1,rightshoulder:b18,rightstick:b6,righttrigger:+a4,rightx:a2,righty:a5,start:b16,x:b0,y:b2,platform:Android,",
"050000003215000000090000bf7f3f00,Razer Serval,a:b0,b:b1,dpdown:b12,dpleft:b13,dpright:b14,dpup:b11,guide:b5,leftshoulder:b9,leftstick:b7,lefttrigger:a4,leftx:a0,lefty:a1,rightshoulder:b10,rightstick:b8,righttrigger:a5,rightx:a2,righty:a3,x:b2,y:b3,platform:Android,",
"05000000de2800000511000001000000,Steam Controller,a:b0,b:b1,back:b6,guide:b8,leftshoulder:b4,leftstick:b9,lefttrigger:a2,leftx:a0,lefty:a1,rightshoulder:b5,righttrigger:a3,start:b7,x:b2,y:b3,platform:Android,",
"05000000de2800000611000001000000,Steam Controller,a:b0,b:b1,back:b6,guide:b8,leftshoulder:b4,leftstick:b9,lefttrigger:a2,leftx:a0,lefty:a1,rightshoulder:b5,righttrigger:a3,start:b7,x:b2,y:b3,platform:Android,",
"5477696e20555342204a6f7973746963,Twin USB Joystick,a:b22,b:b21,back:b28,dpdown:h0.4,dpleft:h0.8,dpright:h0.2,dpup:h0.1,leftshoulder:b26,leftstick:b30,lefttrigger:b24,leftx:a0,lefty:a1,rightshoulder:b27,rightstick:b31,righttrigger:b25,rightx:a3,righty:a2,start:b29,x:b23,y:b20,platform:Android,",
"050000005e040000e00200000ffe3f00,Xbox One Wireless Controller,a:b0,b:b1,back:b9,dpdown:b12,dpleft:b13,dpright:b14,dpup:b11,leftshoulder:b3,leftstick:b15,lefttrigger:a2,leftx:a0,lefty:a1,rightshoulder:b18,rightstick:b16,righttrigger:a5,rightx:a3,righty:a4,start:b10,x:b17,y:b2,platform:Android,",
"050000005e040000fd020000ffff3f00,Xbox One Wireless Controller,a:b0,b:b1,back:b4,dpdown:b12,dpleft:b13,dpright:b14,dpup:b11,leftshoulder:b9,leftstick:b7,lefttrigger:a5,leftx:a0,lefty:a1,rightshoulder:b10,rightstick:b8,righttrigger:a4,rightx:a2,righty:a3,start:b6,x:b2,y:b3,platform:Android,",
"050000005e04000091020000ff073f00,Xbox Wireless Controller,a:b0,b:b1,back:b4,guide:b5,leftshoulder:b9,leftstick:b7,lefttrigger:a2,leftx:a0,lefty:a1,rightshoulder:b10,rightstick:b8,righttrigger:a5,rightx:a3,righty:a4,start:b6,x:b2,y:b3,platform:Android,",
"34356136633366613530316338376136,Xbox Wireless Controller,a:b0,b:b1,back:b9,dpdown:h0.4,dpleft:h0.8,dpright:h0.2,dpup:h0.1,guide:b10,leftshoulder:b3,leftstick:b15,lefttrigger:a2,leftx:a0,lefty:a1,rightshoulder:b18,rightstick:b16,righttrigger:a5,rightx:a3,righty:a4,x:b17,y:b2,platform:Android,",
]

func _ready():
	#init_mappings()
	pass
	
func init_mappings():
	for i in range(mappings.size()):
		var newmap=""
		var maparr = mappings[i].split(",")
		if maparr.size()>=2:
			maparr[0]=gen_android_joypad_guid(maparr)
			for j in range(maparr.size()):
				newmap+=maparr[j]+","
			#print(newmap)
			Input.add_joy_mapping(newmap,true)

func gen_android_joypad_guid(maparr):
	if (maparr!=null) and (maparr.size()>=2):
		var nameascii = maparr[1].to_ascii()
		var uid=""
		for i in range(min(nameascii.size(),16)):
			uid+=("%02x" % nameascii[i])
		return uid	
	else:
		print("Error: empty or too small map array passed to gen_android_joypad_guid")
		return ""