Versatile Mobile Joystick for Godot

A highly customizable and easy-to-use virtual joystick plugin for Godot, perfect for mobile game development.

Features

• Simple to implement: Easy integration into your Godot project.
• Extremely customizable: Adjust every aspect of the joystick to fit your game's needs.
• Supports both fixed and dynamic positioning: Choose how the joystick appears on screen.
• Adjustable visibility modes: Control when the joystick is visible.
• Customizable input zones and responsiveness: Fine-tune the joystick's behavior to enhance gameplay.

Preview

Quick Start

1. Download the plugin from the AssetLib.
2. Search for joystick.tscn.
3. Drag and drop on any scene you want.
4. Customize the joystick properties in the Inspector panel.
5. Alternatively, download the addons folder and add it to your project.

Configuration Options

Here are some of the key properties you can configure:

Recommended Project Settings

For optimal functionality, adjust the following settings in your Godot project:

• "Emulate Touch from Mouse": ON
• "Emulate Mouse from Touch": OFF

These settings ensure proper touch input handling, especially when testing on desktop environments.

Usage Tips

• Add the joystick as a child of a CanvasLayer for proper rendering on top of other elements.
• Experiment with different strength_curve settings to find the right feel for your game.
• Use the DYNAMIC joystick_mode for more flexible controls in different game scenarios.
• Adjust the deadzone_circle to prevent unintended small movements.
• Customize the touch_detection_region to create larger or smaller interactive areas.

Example Code

Here's a simple example of how to read input from the joystick in your game logic:

func _process(delta: float) -> void:
	direction = Input.get_vector("ui_left", "ui_right", "ui_up", "ui_down", 0)
	position += direction * speed * delta

How to Contribute

We encourage contributions from the community! If you have ideas, bug fixes, or enhancements, please:

• Submit issues to report bugs or suggest features on our GitHub repository.

• Create pull requests with your code changes. We appreciate:

  • Clear commit messages explaining your changes.
  • Tests to ensure your code works as intended.
  • Documentation updates if your changes impact existing documentation.

Licensing Information

This project is released under the MIT License. For detailed license terms, please review the LICENSE file included in the repository.

Inspired by MarcoFazioRandom own Joystick