Improve gamepad support

Started by duffy, December 06, 2017, 04:40:40 PM

Previous topic - Next topic
Gamepad can be better handled by using SDL_gamecontroller instead of directly SDL_joystick API.

Pros :

  • Mapped buttons with "real" name
  • No need to remap buttons while switching controller
  • A default mapping can be hard coded (and why not overrideable with an engine settings file)
Cons :

  • If the controller is not known, it must be added "manually" before it can be used (which is not the case with SDL_joystick)
What I propose to do :

  • Replace SDL_joystick by SDL_gamecontroller
  • Add a hard coded default mapping

    A -> action
    B -> attack
    X -> item_1
    Y -> item_2
    start -> "pause"

    Map both left joystick (axis) and dpad (hat) to directions.

    Maybe deprecate Lua axis/hat functions (sol.input..._joypad_..., game:on_joypad_..., ...) and add something like ..._joypad_direction(direction) or use existing ...joypad_button_..  functions ?
  • Load game controller (SDL) mappings from a file E.g : Solarus_save_path/gamecontrollerdb.txt to let user add gamepad mappings if needed.
    // see SDL_GameControllerDB
    // Several gamepad are already mapped in SDL 2.0.7 (I don't know for previous version) :
  • Try to create a default (SDL) mapping if the controller is not supported
  • Handle joystick added/removed event.
    on added : If there is no controller or this controller was used before, use it.
    on removed : "do nothing" (I mean we don't pick the next one).
  • Convert "button X" from old save game with new mapping
  • Add haptic rumble in Lua API

    bool is_joypad_rumble_enabled()
    void set_joypad_rumble_enabled([bool enabled])
    void joypad_rumble_play(float strength, int duration) // strength [0-1], duration in ms
    void joypad_rumble_stop()

    A function for periodic effect  can be nice too for boss/cinematic/...
It should not break backward compatibility and be transparent from the user point of view except if the gamepad is not supported.

One future improvement which can be nice is to deport saved mapping from save game to an engine settings file + an engine menu and save mapping by controller.

December 06, 2017, 04:51:10 PM #1 Last Edit: December 06, 2017, 04:57:32 PM by Christopho
Looks great. It is annoying that we can't guess correct buttons automatically with the current solarus.
A pull request will be welcome :)

I think joystick added/removed events and a haptic rumble API are other subjects (new features) and should be developed in separate works later.

I love the idea of GENERIC joystick mapping :)
And the RUMBLE with x360 gamepad on PC or PI is really excellent to use <3

You are right about haptic rumble (I'm not sure about added/removed event but why not).
I will post here when it's done before a PR if there are some stuff that you want me to change and because it's maybe better to PR  this on a "joystick" branch (of course I can't create a branch).

Don't worry about that, you can make a PR to the dev branch and if I want to put it in a new branch I can still do it.

December 13, 2017, 05:38:50 PM #5 Last Edit: December 13, 2017, 06:17:28 PM by duffy
It's pretty much done, there is only Convert "button X" from old save game with new mapping which is not finished yet.

For now there are some issues :

Convert "button X" from old save game with new mapping

I just discovered that in ROTH SE "button" is hard coded in Lua and it's a problem when you bind a joypad button to a command (now button strings are checked):

[Solarus] [73860] Error: In on_joypad_button_pressed: scripts/menus/pause_commands.lua:65: bad argument #2 to set_command_joypad_binding (Invalid joypad string: 'button 6')

I will see if I can do something about it, but I'm not sure if I can so it may be require to update ROTH SE with a new Lua function like "string get_joypad_button_string(int button)".

Map both left joystick (axis) and dpad (hat) to directions.

If you map the right joystick for directions, both joysticks + dpad will work for directions (as expected).
The problem is if your left joystick is quite sensible an event can be emitted while you are moving with the right one and the hero will stop.
I tried with my xbox one controller and it's really annoying. (with my 360 gamepad it's ok)

There is at least 3 solutions :

  • We don't care, no one will do this and it's not a bug.
  • I remove it  :'(
  • Add something which only accept one joystick for directions (it's a pain in the ass but it should work)
Try to create a default (SDL) mapping if the controller is not supported

It's maybe useless (I didn't tried to do it), for example my xbox one controller get this mapping (which is correct) :

00000000000000000000000000000000,XInput Controller,a:b0,b:b1,back:b6,dpdown:h0.4,dpleft:h0.8,dpright:h0.2,dpup:h0.1,guide:b8,leftshoulder:b4,leftstick:b9,lefttrigger:a2,leftx:a0,lefty:a1,rightshoulder:b5,rightstick:b10,righttrigger:a5,rightx:a3,righty:a4,start:b7,x:b2,y:b3

It's weird because I don't use xinput (gamepads are disabled in xorg) and as expected xinput doesn't return it.
My gamepad uid is "030000005e040000d102000002010000" (which is neither in SDL source nor in gamecontrollerdb) and the mapping returns "00000000000000000000000000000000" which is why I guess (maybe I'm wrong) SDL already try to create a mapping.

So I will not add it.

I will try to finish it this week end.

Very new to all this... is there a way to increase the deadspace for joysticks on controllers?

Do you have an idea of which gamepads you'd like to implement? Xbox 360 seems obvious but I'd personally love the option to use my 8Bitdo controllers with these kinds of games for a slightly more authentic experience.

SDL_gamecontroller sounds like magic. Did this pull request ever happen?
RIP Aaron Swartz