Hitbox

2D and 3D hit detection system plugin for Godot 4.7.

Getting started

There are two ways to set up the development environment: with devenv (recommended) or manually.

With devenv

devenv provides all required packages in a self-contained reproducible shell.

1. Install devenv.

2. From the project directory, enter the development shell:

   devenv shell
   

Manually

Install the following requirements:

• Godot 4.7
• gdscript-formatter 0.27 (make sure it is available on your PATH)

Git hooks

The repository ships a pre-commit hook in .githooks/pre-commit that lints staged GDScript files with gdscript-formatter and blocks the commit if there are any warnings. Only when linting passes does it format the files and re-stage them.

• With devenv: the hook is enabled automatically when entering the shell.

• Manual setup: enable it with:

  git config core.hooksPath .githooks
  

Opening the project

Open the project using the Godot Project Manager or run the following command from the project directory:

godot --path . --editor

Running tests

The project uses GUT. Run the test suite from the project directory:

godot --headless --path . -s addons/gut/gut_cmdln.gd -gdir=res://test -gexit

Installation

1. Copy addons/hitbox into your project's addons directory.
2. Enable hitbox in Project > Project Settings > Plugins.

Documentation

• Contributing

License

Released under the MIT License.