gta5-chaos-luascript-template/README.md

effect_template.lua

A minimal template for creating new GTA V Chaos Mod effects. Use this file as the starting point for all future effect scripts.

Purpose

Provide a consistent structure and common conventions (metadata, configuration, initialization, per-tick logic, and cleanup) so effects are easy to read, maintain, and extend.

Usage

Copy the effect_template.lua file into your effects directory, change as needed and rename it for the new effect.

Editing checklist

• Update metadata (name, description, author, toggle key, priority).
• Set configurable parameters (duration, intensity, cooldown).
• Add comments for any non-obvious behavior.

Conventions

• Use clear, consistent naming for variables and functions.
• Keep per-tick work minimal to avoid performance issues.
• Restore all modified game state(s) in OnStop().

Updates

• This script template will get minimal updates for additional functions or changes.