Skip to content

What is Allure?

Allure is a loader framework that acts as a container and orchestrator for your game.
You can use it to structure your module hierarchy, while Allure handles all of the overhead:

  • Injects dependencies into Nodes
  • Controls Node metadata
  • Mutates dependency trees
  • Handles worker thread queries
  • and more!

Potentially, Allure is the Core module of the Allure Ecosystem.

Why Allure?

  • 🪄 Freely extensible

    Allure itself is a Node!
    Not only parts of Allure or packages can be nodes for your architecture, but anything.

  • Lightweight

    You can easily learn and use Allure without any required knowledge above standard Luau.
    It's also just a single modulescript under 20 KB.

  • 🌲 More than just a loader

    Create multiple dependency trees for any purpose.
    Slice them, merge them, tag necessary nodes, etc.

  • 📦 Actively maintained

    You can witness, or even contribute to, the becoming of Allure as a framework and the ecosystem with it.

IMPORTANT

Allure is fresh and new

This means that Allure possibly has some unfinished features and overlooked issues.
At the moment, Allure exists as a simple loader container framework without any additions. There be dragons.

Released under the MIT License.