Skip to content

A Single Scripted Virtual Joystick on your Gameplay Screen. All you need to do is to Drag and Drop to your Control UI and Assign Target Controller.

License

Notifications You must be signed in to change notification settings

JoenTNT/godot_thumbstick_addon

Repository files navigation

Godot Thumbstick Plugin


A Single Scripted and (yet) most convenient Mobile Screen Controller setup element and connector. This plugin included presets and detailed debug informations mainly used for easy setup validation.

PLUGIN FEATURES

  • Virtual Joystick, just drag and drop into your scene (Presets include Normal, Horizontal Only, and Vertical Only).
  • Touch Motion Surface, an area where it detects multiple touches and motions (COMING SOON).
  • Coloring Style, changing color based on controller actions.
  • Quick Debug Gizmos, immediately visualize touch screen controller setup, just activate Debug Mode in inspector property.
  • Quick Target Controller Setup, insert your player node into Control Target Node property and assign all functions.
  • Complete Setting Up Properties, everything you need for setting up screen controller.

How to Install?

You can either download via Asset Library available in Godot Engine, or Download from Releases here and follow these steps:

  1. Download Thumbstick Plugin ZIP file.
  2. Extract files from the ZIP file.
  3. Copy thumbstick_plugin folder and place it in your Godot Project addons folder. (If you haven't added the addons folder under the res:// folder, then create the folder first)

QUICK DOCUMENTATION

This Documentation has been updated since 16 October 2024. May be updated in the future for more tools and features.

A. VIRTUAL JOYSTICKS CONTROLLER

Normally determined as a single circular controller that can be moved in 2 axis direction placed in user interface screen. It only detects one finger touch and will ignore other touch impacting the control area.

You can completely manually customize yourself by editing or duplicating presets available in addons -> thumbstick_plugin -> plugin -> joysticks folder.



List of Properties

  1. Mode, Settings joystick behaviour between Static, Dynamic, or Follow.
    • Static, Joystick doesn't move, it will always at dev setup position on screen.
      • Additional Settings : Extend Static Area Trigger, Extends rectangular static touch trigger area for joystick static mode.
    • Dynamic, Every time the joystick area is pressed, the joystick position is set on the touched position.
    • Follow, When the finger moves outside the joystick area, the joystick will follow it.
      • Additional Settings : Follow Radius Tolerance, Extra radius in joystick follow mode to prevents joystick display move until exceeds this tolerance.
  2. Input Mode, input mode based on direction input limitation.
    • Normal, This is the default 2 axis direction joystick input.
    • Horizontal Only, Joystick can be moved only horizontally.
    • Vertical Only, Joystick can be moved only vertically.

B. TOUCH MOTION SURFACE CONTROLLER

[ ~~ IN DEVELOPMENT ~~ ]

About

A Single Scripted Virtual Joystick on your Gameplay Screen. All you need to do is to Drag and Drop to your Control UI and Assign Target Controller.

Resources

License

Stars

Watchers

Forks

Packages

No packages published