https://github.com/hubblecommand/directional_sprites
n-directional sprites in 2D and 3D, for Godot 4.x
https://github.com/hubblecommand/directional_sprites
Last synced: about 2 months ago
JSON representation
n-directional sprites in 2D and 3D, for Godot 4.x
- Host: GitHub
- URL: https://github.com/hubblecommand/directional_sprites
- Owner: HubbleCommand
- Created: 2024-07-18T19:47:13.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-01-06T16:20:30.000Z (over 1 year ago)
- Last Synced: 2025-01-06T17:28:23.021Z (over 1 year ago)
- Language: GDScript
- Size: 6.07 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Directional Sprites
n-directional sprites in 2D and 3D, for Godot 4.x
Make sure all of your animations and frames have the same orientation and number of directions.
## Scripts
Some helper python scripts for making sprite sheets.
`build_sprite_sheet.py` generates a single image with sprite sheet frames.
`convert_col.py` converts one color to another in a batch operation. Useful for making backgrounds transparent.
## 3D : (Animated) Directional Sprite 3D
Two nodes have been added, `DirectionalSprite3D` and `AnimatedDirectionalSprite3D`.
They work similar to their non-directional counterparts, [Sprite3D](https://docs.godotengine.org/en/stable/classes/class_sprite3d.html) and [AnimatedSprite3D](https://docs.godotengine.org/en/stable/classes/class_animatedsprite3d.html).
The only two properties that have been added are `directions` and `orientation`.
- `directions` is the number of frames / directions each of your frames has.
- `orientation` is the axis of the direction frames (vertical or horizontal)
For all other properties, read up on the base nodes linked above.
In all cases, make sure you have enabled Shadows on your light nodes.
## 2D : (Animated) Directional Sprite 2D
While directional sprites are mostly known in the 3D world from games like [DOOM](https://en.wikipedia.org/wiki/Doom_(1993_video_game)) and [Wolfenstein 3D](https://en.wikipedia.org/wiki/Wolfenstein_3D), directional sprites are also prevailant in 2D games like [RimWorld](https://rimworldgame.com/).
As with 3D, two new 2D nodes are added: `DirectionalSprite2D` and `AnimatedDirectionalSprite2D`.
They work similar to their non-directional counterparts, [Sprite2D](https://docs.godotengine.org/en/stable/classes/class_sprite2d.html) and [AnimatedSprite2D](https://docs.godotengine.org/en/stable/classes/class_animatedsprite2d.html).
The only two properties that have been added are `directions` and `orientation`.
- `directions` is the number of frames / directions each of your frames has.
- `orientation` is the axis of the direction frames (vertical or horizontal)
For all other properties, read up on the base nodes linked above.
The major difference between 2D and 3D is how lighting works.
Read the next section for details.
### Lighting and Shadows
2D lighting requires a LightOccluder2D nodes, the Sprites won't generate shadow on their own. In all cases, make sure you have enabled Shadows on your light nodes.
While the [official documentation](https://docs.godotengine.org/en/stable/tutorials/2d/2d_lights_and_shadows.html) is a good start, it doesn't provide a complete solution.
In the case of shadows and occluders with sprites, we usually don't want the shadows to self-cast on the sprite itself.
With the official example, the `LightOccluder2D`s cast shadows on Sprites, which we don't want.
To fix this, follow the solution [detailed here](https://github.com/godotengine/godot/issues/74265#issuecomment-1755039506).
Use two `PointLight2D`s, each on a different light layer (the `Item Cull Mask` on `Range` and/or `Shadow`).
One layer should be for the occluders and shadow casting, while the other should just be to light up the sprites.
So, make sure only the Lights on the correct layer have shadows enabled.
Check the 2D demo to see it in action.
Note that having the same `PointLight2D` on different `Range` `Item Cull Mask` layers won't work.
Note that in the future (4.4+), Godot may [use z-index for shadow casting](https://github.com/godotengine/godot/pull/93881).