Fray

Fray Logo

📖 About

Fray is a modular Godot 4 addon designed to aid in the development of action-oriented games. It offers solutions for combatant state management, complex input detection, input buffering, and hitbox organization. If your project requires any of these functionalities you may benefit from using Fray.

⚠️ IMPORTANT

Fray is currently in an alpha state.

What does this mean?

It has not been tested rigorously enough for me to be comfortable recommending it for use in a serious project.
The documentation is incomplete and there is a lack of good examples.
Lastly, it is still susceptible to refactors, meaning the API is subject to change.

That being said, a significant portion of Fray is functional, with any remaining bugs likely being simple oversights rather than major design flaws. If these issues do not concern you, and/or you are interested in testing the framework, please feel free to explore!

✨ Core Features

Resource-Based Hierarchical State Machine

Build state machines declaratively in code using the included builder class.
Control state transitions using callable transition prerequisites and advance conditions.
Extend states and transitions to further control state flow and/or encapsulate game behavior within different states.

[comment]:

Composite Input Detection

Declaratively describe the many composite inputs featured in action / fighting games (directional inputs, motion inputs, charged inputs, and sequence inputs) using component based approach.
Check defined inputs anywhere using included input singleton.

[comment]: <Make animation which shows code on left, controller on the bottom highlighting the combined inputs, and example of executing input in game on right.>

Hitbox management

Define hitboxes using template class with extendable attributes resource.
Organize hitboxes using hit states and hit state managers.
Key active hitboxes in animation player using a single property for easier timeline management.

[comment]:

📚 Getting Started

Fray comes with comprehensive documentation integrated with Godot 4's documentation comments. This means you can access explanations for classes and functions directly within the Godot editor.

For additional guides and resources, check out the official Fray wiki.

📦 Installation

GitHub Release (Recommended, Stable)

Coming soon...

Asset Library (Recommended, Stable)