Project Rules & Guidelines

Build & Development Commands

• Use the Gamesense/Skeet environment and build tools exclusively.
• Test all script changes live on controlled private servers before pushing.
• Use version control hooks to lint and validate Lua syntax before committing.
• Automate dependency checks for any imported Lua modules to prevent malicious code.

Testing Guidelines

• Write unit tests for all Lua functions interacting with game state or memory via the API.
• Validate cheat features under HVH conditions on private servers to ensure performance and stealth.
• Automate regression tests for key cheat functions after each update.
• Log and review any anti-cheat alerts generated during testing.

Code Style & Guidelines

• Use consistent Lua formatting: 2-space indentation, explicit local variable declarations, and meaningful naming.
• Document all API calls with input parameters and expected behavior.
• Avoid global state; encapsulate cheat logic within modules.
• Implement error handling to gracefully catch and log API or runtime failures.

Documentation Guidelines

• Maintain an up-to-date document covering:
  • Lua API wrappers and cheat feature descriptions
  • Known API quirks and workaround patterns
  • Development workflow and test procedures
  • Change logs with detailed descriptions of updates
• Update documentation immediately after adding features or fixes.