AFK Display Mod

# AFK Reminder Mod A comprehensive AFK (Away From Keyboard) detection and notification system for Minecraft servers. This mod automatically detects when players become inactive and provides customizable notifications to encourage player engagement. ## Features ### Automatic AFK Detection - **Movement Tracking**: Monitors player position, camera rotation, and movement - **Configurable Timer**: Set custom AFK detection time (default: 15 minutes) - **Intelligent Detection**: Distinguishes between genuine inactivity and brief pauses ### Visual Notifications - **Title Display**: Large, prominent AFK notifications appear on screen - **Customizable Messages**: Configure multiple random messages for variety - **Persistent Display**: Notifications remain visible until player becomes active - **GUI Scale Compatible**: Works properly with all Minecraft GUI scale settings ### Manual AFK Control - **Command Support**: Use `/afk` to manually set AFK status - **Toggle Functionality**: Execute `/afk` again to remove AFK status - **Movement Override**: Any player movement automatically removes AFK status - **Server Notifications**: Broadcast messages when players go AFK or return ### Configuration System - **JSON Configuration**: Easy-to-edit configuration file - **Custom Messages**: Add your own AFK reminder messages - **Flexible Timing**: Adjust AFK detection intervals to suit your server - **Hot Reload**: Configuration changes apply without server restart ## Commands ### `/afk` - **Permission**: Available to all players by default - **Function**: Toggle AFK status manually - **Usage**: Simply type `/afk` in chat - **Auto-complete**: Includes client-side tab completion - **Behavior**: - First use: Sets player as AFK and displays notification - Second use: Removes AFK status - Movement: Automatically removes AFK status regardless of how it was set ## Installation ### Server Installation 1. Download the latest version of AFK Reminder Mod from Modrinth 2. Place the `.jar` file in your server's `mods` folder 3. Ensure you have Fabric Loader installed on your server 4. Restart your server ### Client Installation (Optional) 1. Install Fabric Loader on your Minecraft client 2. Download and place the mod in your client's `mods` folder 3. Launch Minecraft with the Fabric profile ### Dependencies - **Fabric Loader**: 0.16.14 or higher - **Fabric API**: 0.116.0 or higher - **Minecraft**: 1.21.1 ## Gameplay ### How It Works The mod continuously monitors player activity in the background. When a player remains stationary for the configured duration (default 15 minutes), the system triggers an AFK notification. ### Player Experience - **Seamless Integration**: No interruption to normal gameplay - **Clear Notifications**: Obvious but non-intrusive AFK alerts - **Flexible Control**: Players can set themselves AFK manually when needed - **Automatic Recovery**: Simple movement removes all AFK indicators ### Server Benefits - **Player Engagement**: Encourages active participation - **Resource Management**: Helps identify inactive players - **Community Awareness**: Other players know when someone is AFK - **Customizable Behavior**: Tailor the system to your server's needs ### Configuration The mod creates a configuration file at `config/afkreminder.json` with the following structure: ```json { "afkTimeMinutes": 15, "afkMessages": } ``` ### Customization Options - **AFK Timer**: Modify `afkTimeMinutes` to change detection sensitivity - **Message Pool**: Add or modify messages in the `afkMessages` array - **Message Variety**: The system randomly selects from available messages - **Server-Specific**: Each server can have unique configurations ## Support ### Compatibility - **Server Types**: Compatible with Fabric servers - **Multiplayer**: Designed for multiplayer environments - **Performance**: Lightweight with minimal server impact - **Scalability**: Efficiently handles multiple concurrent players ### Troubleshooting - **Configuration Issues**: Verify JSON syntax in config file - **Command Problems**: Ensure Fabric API is properly installed - **Display Issues**: Check Minecraft version compatibility - **Performance**: Monitor server console for any error messages ### Getting Help - **Issue Reporting**: Submit bug reports on the project's issue tracker - **Feature Requests**: Suggest improvements through the project repository - **Documentation**: Refer to the mod's wiki for detailed configuration guides - **Community**: Join the discussion in the project's community forums ### Version Information - **Current Version**: 1.0-SNAPSHOT - **Target Minecraft**: 1.21.1 - **Fabric Loader**: 0.16.14+ - **Last Updated**: Check Modrinth page for latest release information This mod is actively maintained and regularly updated to ensure compatibility