-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
046a3ed
commit 4d7999a
Showing
1 changed file
with
22 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,24 @@ | ||
# Flux | ||
|
||
You can install this package on Wally | ||
```toml | ||
Flux = "supersocial/[email protected]" | ||
``` | ||
|
||
## About | ||
This is still a massive work-in-progress. There will almost certinaly be changes that are not backwards compatible, documentation will not be created until we get a solid V1, etc. | ||
|
||
Flux is a Knit variant with some added functionality: | ||
- You can now do `GetService` and `GetController` at the top of modules | ||
- Components are an integrated part of the framework. | ||
- This allows you to do things like `Flux.GetComponent` at the top of modules as adding useful methods such as `Flux.GetComponentFromInstanceAndTag`. | ||
- Added a `_Trove` to all Components which are cleaned up when the Component is removed. | ||
- Added an `Activate` method to components so they don't run until Flux is started. | ||
- Added multiple new lifecycle methods | ||
- Services | ||
- Service:FluxPlayerAdded(player: Player) | ||
- Service:FluxPlayerRemoving(player: Player) | ||
- Service:FluxHeartbeat(deltaTime: number) | ||
- ... | ||
- Controllers | ||
- ... |