Update README.md

This commit is contained in:
thecraftianman 2024-04-18 17:57:19 -04:00 committed by GitHub
parent c8f4c77543
commit 134b6130d1
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -1 +1,9 @@
# CFW
# Contraption Framework
[![Workshop](https://img.shields.io/steam/subscriptions/3154971187?logo=steam)](https://steamcommunity.com/sharedfiles/filedetails/?id=3154971187)
Monitors constraints to create "contraption" objects and adds callbacks for changes made to contraptions for efficient contraption-aware functionality.
For example, in order to calculate the total mass of a contraption traditionally one would need to iterate over every entity on the contraption and store this information somewhere.
With Contraption Framework (CFW), a callback is run whenever an entity is added to or removed from a contraption and the total mass is added to or subtracted from the total stored in memory on the contraption object.