Aegis (Aegis Security)

A scripting library that has many features for anti-cheat and moderation.

This repository is in heavy development and is therefore a Work-in-Progress. Not all changes are final.

Features

Aegis is in early development, so many features are not present or incomplete.

Here's a non-exhaustive list of planned features that we plan or implemented to Aegis:

• Rate limiter
• Moderation system
• Command handler
• Player checker
• DataStore validator
• DataStore sanitizer
• Custom logger
• Player-made Plugin Support

Installation

Option 1: Downloading a nightly build

• Currently not implemented. This will become available once we implement a package manager.

Option 2: Downloading a pre-packaged build

• Navigate to the "Releases" tab on the right side of the page and click the latest release build.
• On the "Assets" dropdown menu, click on the .rbxm file. This will prompt a download.
• Place the .rbxm file in your Studio instance.

This is the best option to utilize Aegis, as it is the most stable build.

Option 3: Using Rojo

• TODO: Write this later.

License

This project is licensed under MIT. See LICENSE for more details.

Any forks of this repository should also be licensed under MIT.

Contribution

Contributions are welcome! Take a look at the contribution guide for guidelines on how to contribute to Aegis.

Questions

Any questions should be posted on the Issue Tracker or my Discord server.

Remember, don't be afraid to ask a question!

TODO List:

• Add LuaCov and Coveralls (manages coverage of project; higher percentage is good, inverse, not so much)
• Add package manager (most likely Wally)
• Add a testing framework (TestEZ? Maybe? I'll probably test it out)