doc.json

{
  "name": "afk",
  "description": "Marks players as AFK if they stop moving & chatting for a set period of time",
  "author": "Shock",
  "config": {
    "auto-afk": {
      "description": "Automatically mark a player as AFK when the timeout is reached",
      "type": "boolean",
      "default": true
    },
    "auto-afk-timeout": {
      "description": "Number of minutes to wait until a player is marked as AFK",
      "type": "number",
      "default": "5"
    },
    "auto-afk-maxtimeout": {
      "description": "Additional number of minutes to wait before taking action on a player that has been marked as AFK",
      "type": "number",
      "default": "10"
    },
    "auto-afk-threshold": {
      "description": "Minimum number of players required before taking action on a player that has been marked as AFK",
      "type": "number",
      "default": "1"
    },
    "auto-afk-action": {
      "description": "Action to take when the max timeout is reached",
      "type": "enum",
      "options": ["none", "kick"],
      "default": "none"
    },
    "auto-afk-exclusions": {
      "description": "Restrict action against players marked as AFK if they are part of the specified roles (comma-separated)",
      "type": "string",
      "default": ""
    },
    "allow-manual-afk": {
      "description": "Permit players to manually go AFK using the /afk command",
      "type": "boolean",
      "default": true
    },
    "afk-announce": {
      "description": "Announce to joining players if there are people currently AFK",
      "type": "boolean",
      "default": true
    }
  },
  "commands": [
    {
      "name": "/afk",
      "description": "Manually go AFK",
      "example": "/afk eating dinner",
      "args": [{
        "name": "reason",
        "description": "Optional reason for going AFK displayed to other players",
        "required": false
      }]
    },
    {
      "name": "/afkers",
      "description": "List players currently marked as AFK",
      "example": "/afkers",
      "args": []
    }
  ]
}