SPAM Framework Documentation

Changelog

All notable changes to this project, SPAM Ability Framework, will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[3.0.0] 2024-04 | Ranks

This version is a major release, which means that there might be breaking changes you need to accommodate for in your project. Please read though the changed section carefully and backup/source control your project before upgrading.

This version adds the possibility to add ranks, or variants, to an ability. Ranks allow any property to be changed, which means that you can change everything from cooldown to VFX / projectile prefab between ranks, and with a single call at runtime completely change how your ability behaves.
It also contains multiple quality-of-life fixes and changes, which will greatly speed up some workflows.

Great care has been taken to make sure any previous abilities aren't broken if you upgrade from a pre-3.0.0 version, but as usual make sure to keep a backup before upgrading.
If you encounter any issues, please reach out via Discord or Email.

Changed

[2.1.2] 2024-01 | Fixing reported errors

Happy new year!
Big shoutout and thanks to everyone who took the time to report errors. It's highly appreciated.

Changed

[2.1.1] 2023-10 | Compilation issues

Fixed

[2.1.0] 2023-05 | Pooling and VFX

This version adds two new VFX properties: Impact VFX and Cast VFX, along with giving more control over the pooling used internally by SPAM. For more information about these features, refer to the documentation either provided in the package or online at spam.infinitevoid.games

Debug mode can now be switched on by a menu toggle, making it easier for both you to troubleshoot issues in your game and me to help you when you reach out for support.

Last but not least: Directional abilities can now do a box-cast for AOE checks, and SPAM can now handle rotation of VFX, giving you even more control over how your game looks.

Added

Changed

Fixed

[2.0.0] 2023-02 | Projectiles

This version reworks projectiles, adding more customisability and quality-of-life changes. In short, projectiles has now been separated from the ability so a projectile ability can spawn multiple, independent, projectiles. This unlocks the possibility to create very complex and visually pleasing projectile abilities. Also, projectiles now move independently and can be moved by either animation curve or straight towards the target, and can be set to rotate in different directions out of the box. The animation curved movement is highly configurable, and can also be somewhat randomised for less repetitive movement.

The release includes general stability fixes. Since this version is a major upgrade, you MUST remove your previous SPAM installation (delete the folder) before upgrading, or you will encounter issues. Also make sure to read through the "Changed" section as this is where the major breaking changes are specified.
If you encounter any issues while upgrading, don't hesitate to ask on Discord or by email for help.

Added

Changed

Most of the changes are breaking changes, so please read through them carefully.

Fixed

[1.2.0] 2022-09 | Conditions

This version adds a completely new system to the framework: Conditions.
Conditions is a versatile and powerful system that can be used to create alot of diverse effects, like the following (non-exhaustive) list of examples:

Conditions can be customized in a lot of ways, and has more uses than the ones outlined above. Please see the documentation either online or supplied with the package for more information.

Added

Changed

Fixed

[1.1.2] - 2022-08

Fixed

[1.1.1] - 2022-08

Changed

Added

Fixed

[1.1.0] - 2022-08

Changed

Added

[1.0.1] - 2022-08

Fixed

[1.0.0] - 2022-08

Initial release

Backlinks: