Skip to content

Commit

Permalink
move README
Browse files Browse the repository at this point in the history
  • Loading branch information
cluttered-code committed Jan 16, 2025
1 parent 51db92c commit ff0c28e
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 33 deletions.
2 changes: 1 addition & 1 deletion README.md
28 changes: 0 additions & 28 deletions addons/health_components/README.md

This file was deleted.

17 changes: 13 additions & 4 deletions addons/health_hitbox_hurtbox/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,19 @@
1. Open the `AssetLib` tab in the Godot Editor.
2. Search for `Health`, `HitBox`, or `HurtBox` in the search bar.
3. Click the download button next to the Health, HitBoxes, and HurtBoxes plugin.
4. In the installation window, select the files you want to install and click "Install".
5. Once the installation is complete, go to `Project` -> `Project Settings` -> `Plugins`.
6. Find the `Health, HitBoxes, and HurtBoxes` plugin in the list and check the box to enable it.
4. Once the installation is complete, go to `Project` -> `Project Settings` -> `Plugins`.
5. Find the `Health, HitBoxes, and HurtBoxes` plugin in the list and check the box to enable it.

## Usage

## Support
1. Add a `Health` node to a Node that needs health (ie. `CharacterBody2D` or `StaticBody3D`)
2. Add a `HurtBox2D` node with a `CollisionShape2D` to the same Node.
3. Set the `HurtBox2D` Collision layer and mask.
4. Any Node With a `HitBox2D` set to the same layer as the mask in step #3 will automatically detect collisions.

**alternativly**: `RayCast2D` nodes can be used to detect collisions with `HurtBox2D` and directly call `damage()` or `heal()` functions to affect health.


## Issues

Submit issues to the [Github Issues Page](https://github.com/cluttered-code/godot-health-hitbox-hurtbox/issues)

0 comments on commit ff0c28e

Please sign in to comment.