Installation

Prerequisites

  • FiveM server with proper permissions

  • Basic knowledge of FiveM server configuration

  • Access to your server's resources directory and server.cfg file

Step-by-Step Installation

  1. Download the Resource

    • Download the latest version of LuaBeans AFK

    • Extract the ZIP file if necessary

  2. Install the Resource

    • Navigate to your FiveM server's resources directory

    • Place the entire LuaBeans-afk folder into the resources directory

    • Ensure the folder structure matches the following:

      resources/
      └── LuaBeans-afk/
          ├── client/
          │   ├── client.lua
          │   └── editable.lua
          ├── server/
          │   ├── server.lua
          │   └── editable.lua
          ├── config.lua
          ├── fxmanifest.lua
          └── README.md
  3. Add to server.cfg

    • Open your server.cfg file

    • Add the following line:

      ensure LuaBeans-afk
    • Place it after any framework resources (if using ESX or QBCore)

  4. Configure the Resource

    • Open config.lua in your preferred text editor

    • Adjust settings according to your server's needs (see Configuration section)

    • Save the file

  5. Restart Your Server

    • Restart your FiveM server for changes to take effect

    • Or use restart LuaBeans-afk in the server console (after first start)

  6. Verify Installation

    • Check server console for any errors

    • Enable debug mode in config.lua to monitor AFK detection

    • Test by going AFK yourself (if you're not whitelisted)

Post-Installation

  • Test the System: Go AFK on your server to verify it's working correctly

  • Check Logs: Monitor server console for debug messages (if debug mode is enabled)

  • Configure Whitelist: Add your staff groups to the whitelist to prevent accidental kicks

Last updated