API Reference

@core/

Core library modules providing foundational utilities and patterns.

Module	Description
lib/dev	Development mode utilities for controlling module loading.
lib/di	Angular-style dependency injection system.
lib/disposable	Disposable pattern for resource cleanup, similar to VSCode's IDisposable pattern.
lib/events	Event system exports.
lib/logging	Logging and telemetry system for True Life.
lib/math	Math utilities including Vector2, Vector3, and Color classes with immutable operations.
lib/module	Angular-style module registration system.
lib/observable	Angular-like reactive observable system for FiveM.
lib/rpc	RPC system for client/server communication via the SWC modules plugin.
lib/utils	General utility types and functions.
lib/zod	Extended Zod schema library with FiveM handle type support.

@modules/

Feature modules implementing game functionality.

Module	Description
@modules/atm	ATM module - ATM interface for banking operations.
@modules/banking	Banking module - placeholder for banking functionality.
@modules/characters	Characters module - manages player characters and profiles.
@modules/debug	Debug module - development tools and debug HUD.
@modules/init	Init module - core initialization, player profiles, database indexes.
@modules/needs	Needs module - manages player needs (hunger, thirst, health, armor).
@modules/notifications	Notifications module - in-game notification system.
@modules/spawning	Spawning module - handles player spawn and position persistence.