Jacob Schmidt 21beefe668 feat: Enhance documentation and update variable names

This commit introduces several enhancements to the Forge client, including improved documentation for the Garage and Locker modules, updates to variable names for consistency, and additions to the .gitignore file.

The following changes were made:

- **Garage and Locker Modules:** Added comprehensive README.md files to the Garage and Locker modules, providing overviews, dependency information, author details, feature descriptions, event handler usage, debugging instructions, and version information.
- **Variable Name Consistency:** Updated variable names in `fnc_playerDBSave.sqf` and `fnc_firstLogin.sqf` to use the `FORGE_PayGrade` constant instead of `Paygrade` for consistency with the Forge naming conventions.
- **.gitignore:** Added `/api` to the .gitignore file to exclude the Forge API directory from version control.

2025-04-05 16:51:53 -05:00

1.9 KiB

Raw Blame History

Forge Admin Module

Overview

The Admin module provides administrative functionality for the Forge client system. It includes features for user management, messaging, and administrative controls.

Dependencies

forge_client_main

Authors

J. Schmidt
Creedcoder
IDSolutions

Features

Administrative Functions

Admin Initialization (fnc_initAdmin.sqf)
- Initializes the admin system
- Sets up necessary permissions and configurations
Admin Interface (fnc_openAdmin.sqf)
- Opens the administrative user interface
- Provides access to administrative controls
User Management
- Promotion (fnc_adminPromote.sqf)
  - Handles user promotion to administrative roles
- Transfer (fnc_adminTransfer.sqf)
  - Manages administrative role transfers
- Refresh (fnc_adminRefresh.sqf)
  - Updates administrative permissions and states
Communication
- Admin Messages (fnc_adminMessage.sqf)
  - Handles administrative messaging system

User Interface

The module includes two main UI components:

RscCommon.hpp
- Common UI elements and definitions
RscAdmin.hpp
- Administrative interface specific elements

Event Handlers

The module uses several event handlers for initialization and execution:

XEH_preInit.sqf: Pre-initialization setup
XEH_postInit.sqf: Post-initialization tasks
XEH_preStart.sqf: Pre-start configuration

Usage

To use the admin module:

Ensure the module is properly loaded in your mission
Access administrative functions through the provided UI
Use appropriate administrative commands based on your role

Debugging

Debug mode can be enabled by uncommenting the following in script_component.hpp:

#define DEBUG_MODE_FULL

Version Information

Version information is managed through the main Forge client system configuration.

1.9 KiB Raw Blame History