Scripting quick start

Flarial scripts are lightweight extensions that can add modules or commands. This page covers the setup path; the dedicated scripting site is the source of truth for current functions, events, signatures, and examples.

• Add modules that appear in Flarial’s in-game menu.
• Add commands for small tools and repeatable actions.
• Store script-specific settings.
• React to game and client events exposed by the current scripting API.

Only install scripts you trust. Review a script before running it, especially if it uses networking or filesystem features.

1. Open the complete Scripts folder in your editor.
2. Follow the current quick-start on the scripting site to create a module or command file.
3. Generate or refresh editor autocomplete using the command documented for your installed Flarial version.
4. Reload scripts in game after making a change.
5. Test with a disposable world or suitable server before distributing the script.

The scripting API changes independently from this website. Use the dedicated documentation for current APIs, event parameters, settings, UI constraints, and examples.