The AFK System is a Lua-based solution designed to enhance player engagement on Garry's Mod servers. It prompts players with a question after a period of inactivity. Failing to answer correctly within a given timeframe results in the player being considered AFK and subject to being kicked, thus ensuring active server participation.
- Configurable AFK Timer: Customize the duration of inactivity before the AFK check is initiated.
- Question-Based AFK Check: Engage players with simple math questions to determine their presence.
- Client-Side UI: Presents players with an intuitive interface for answering the AFK question.
- Server-Side Validation: Responses are validated server-side to maintain security.
- Customizable Messages and UI: Tailor the AFK system's messages and UI colors to fit your server's theme.
- Rewards for Response: Incentivize players to respond to the AFK check with customizable rewards.
-
Copy Lua Files: Place the folder into your server's garrysmod/addons
-
Configure the System: Adjust settings in StormAFK.Config.lua to set your AFK timer, questions, UI colors, and messages.
-
Restart Your Server: Apply the changes by restarting your Garry's Mod server.
Edit afk_config.lua to customize the AFK system:
- AFKTimerDisplay: Time in seconds before showing the AFK check.
- AFKTimertoKick: Time allowed for the player to answer the AFK question.
- questions: List of questions and their answers for the AFK check.
- bannerColor, afkTagColor, afkTagName, afkMessageColor: Customize the appearance of the AFK check UI and messages.
- kickMessage: The message shown to players who fail the AFK check.
- reward: Function defining the reward given to players who successfully respond to the AFK check.
The system is designed to automatically trigger an AFK prompt after a predetermined period of time. Players must respond correctly to this prompt within a specified timeframe to avoid being kicked from the server.
This project is licensed under the MIT License - see the LICENSE.md file for details.
For support, open an issue on GitHub