Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Cody-Nelson authored Aug 9, 2024
1 parent 046a3ed commit 4d7999a
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
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
- ...

0 comments on commit 4d7999a

Please sign in to comment.