Getting Started

This page walks you through installing EzAfk on your server and running it for the first time.

Requirements

Paper, Spigot, Bukkit, or Purpur 1.26+
Java 25 or newer

Installation

Download the latest EzAfk-x.x.x.jar from Modrinth.
Place the jar in your server’s plugins/ folder.
Start or restart the server. EzAfk will generate all configuration files.

Generated files

After first startup, EzAfk creates the following inside plugins/EzAfk/:

File	Purpose
`config.yml`	Main settings: AFK timeout, kick, GUI, zones, anti-bypass
`gui.yml`	In-game GUI layout and item definitions
`mysql.yml`	MySQL/SQLite database connection settings
`messages/`	One YAML file per language (en, es, nl, ru, zh, de)

First configuration steps

1. Set your AFK timeout

Open config.yml and find the AFK detection section. Set the idle threshold in seconds:

afk:
  timeout: 300   # mark a player AFK after 5 minutes of no activity

2. Configure kick behaviour (optional)

kick:
  enabled: true
  timeout: 600    # kick after 10 minutes of being AFK
  warnings:
    enabled: true
    intervals: [60, 30, 10]

See Configuration for every available option.

3. Grant operator permissions

The minimum set for an admin:

ezafk.reload      - reload config without restarting
ezafk.gui         - open the AFK player overview GUI
ezafk.afk.others  - toggle AFK for another player

See Permissions for the full node list.

4. Choose a language

Set the active language in config.yml:

messages:
  language: en   # en | es | nl | ru | zh | de

Verifying the installation

Join your server and run /afk. If your status toggles, the plugin is working. Run /afk reload to hot-reload config changes at any time (requires ezafk.reload).

Next steps

I want to…	Go to…
See all commands	Commands
Tune every config option	Configuration
Understand each feature in depth	Features
Set up MySQL for persistence	Storage
Connect PlaceholderAPI / WorldGuard / Economy	Integrations
Customise plugin messages	Messages