Welcome to Project Aurora Macro Docs

This documentation is designed to help developers seamlessly integrate and utilize our macros, providing a comprehensive guide to enhance your experience within our ecosystem.

ARL_BUILD

Type: string

Description

The build identifier for the current loader version.

Example Usage

print(ARL_BUILD)

ARL_DISCORD_NAME

Type: string

Description

The Discord username of the current user (if linked).

Example Usage

print(ARL_DISCORD_NAME) -- returns username or "Discord not linked"

ARL_HWID

Type: string

Description

The hardware ID for the current user.

Example Usage

print(ARL_HWID)

ARL_PCALL

Type: function Signature: ARL_PCALL(func, ...) → (status, result_or_error)

Description

Safely calls the provided function func with optional arguments.
Returns a tuple:
status (boolean): whether the call was successful and safe
result_or_error: the result if successful, or the error message if failed

Example Usage

local ok, result = ARL_PCALL(function()
    return 1 + 1
end)
if ok then
    print("Result:", result)
else
    print("Error:", result)
end

ARL_NOTIFY

Type: function Signature: ARL_NOTIFY(msg)

Description

Displays a notification with the built-in notification system.

Example Usage

ARL_NOTIFY("Hello from Project Aurora!")

ARL_BYE

Type: function Signature: ARL_BYE()

Description

Triggers a forced memory protection and cleanup, then forces a game crash.
Intended as a kill-switch or emergency exit for the script, ensuring memory is protected and cleaned up before halting execution.

Example Usage

ARL_BYE()

Call this function only in situations where you need to immediately halt execution and ensure all sensitive memory is cleaned up. This is typically used as a last-resort safety mechanism.