KeyAllX

A premium timed reward distribution system designed to increase player engagement, retention, and server activity.

KeyAllX automates crate key distribution using a powerful timer engine, advanced reminder system, and full customization — giving you complete control over how and when rewards are delivered. Built using optimized practices, version 1.8 handles timed events effortlessly.

Ideal For

• Survival / SMP servers — Keep players returning with predictable reward cycles.
• OP / Prison servers — Automated key distribution for crate-based economies.
• Event-based servers — Tie rewards to timed events for maximum impact.
• Growing communities — Increase engagement and drive online time.

Why KeyAllX

Most keyall plugins simply give rewards. KeyAllX is built to engineer player behavior and engagement.

Installation

Setting up KeyAllX is straightforward. Follow these steps to get started.

1. Download the latest KeyAllX.jar from our releases or Discord.
2. Place the .jar file into your server's /plugins directory.
3. Start or restart your server (do not use /reload).
4. Configure the generated config.yml at plugins/KeyAllX/config.yml.
5. Apply changes by running:

/keyallx reload

Commands

KeyAllX provides a minimal, focused set of commands for management.

Usage Examples

# Reload configuration after changes
/keyallx reload

# Reset the timer back to full duration
/reset-timer

# Stop the timer entirely
/stop-timer

Permissions

KeyAllX uses granular permissions for administrative control.

Configuration

All KeyAllX behavior is controlled through config.yml. Below is a breakdown of every configuration section.

Core Settings

license-key: "LICENSE-KEY-123456"
debug: false
bStats: true

Timer System

The timer engine is the core of KeyAllX. It controls when rewards are automatically distributed.

timeInterval: 300
autoStart: true

Timer Controls

• /reset-timer — Resets the countdown back to the configured timeInterval.
• /stop-timer — Completely stops the timer until the server restarts (if autoStart is enabled) or until reset manually.

Rewards

Define what happens when the keyall event triggers. KeyAllX supports both global and per-player command execution.

Global Commands

These commands execute once from the console when a keyall triggers:

command:
  - "crate key giveall key 1 -s"
  - "broadcast &6[KeyAllX] &aAll players received a key!"

Per-Player Commands

These commands execute once for each online player. Use {player} as a placeholder for the player's name.

perPlayerCommand:
  - "give {player} diamond 5"
  - "eco give {player} 500"

Messages & Visuals

KeyAllX provides rich visual feedback when rewards are distributed. All messages support standard Minecraft color codes (&a, &e) and hex colors.

Title Display

title-message: "&a&lCONGRATULATIONS!"
subtitle-message: "&7You've received a free key from KeyAll event!"
title-fade-in: 10
title-stay: 70
title-fade-out: 20

Broadcast Message

message:
  - "&6&lKEYALL EVENT COMPLETED"
  - "&a✓ &7All online players have been awarded a free key!"

Sound Effect

sound: "ENTITY_PLAYER_LEVELUP"
volume: 1.0
pitch: 1.2

Hotbar / Action Bar

hotbar-message: "&6✨ &aFree key awarded! &6✨"

Reminder System

The built-in reminder system lets you send timed notifications before each keyall event, building anticipation and driving engagement. Support for sounds, titles, chat, and action bar per stage.

reminders:
  300: # 5 minutes warning
    message: '&6[KeyAllX] &eKeyAll event starting in &c5 minutes&e!'
    hotbar: '&6⏰ KeyAll in 5 minutes!'
    sound: BLOCK_NOTE_BLOCK_BELL
    volume: 0.7
    pitch: 1.0

  10: # 10 seconds countdown
    title: '&6&lKEYALL EVENT'
    subtitle: '&eStarting in &c&l10 seconds'
    fadeIn: 5
    stay: 30
    fadeOut: 5
    sound: UI_BUTTON_CLICK
    volume: 1.0
    pitch: 2.0

Each key in the reminders map represents the number of seconds before the event. The components are optional—use only what you want to show.

Restrictions

KeyAllX supports several restriction types to control when and where events can trigger.

Player Requirements

minimumPlayers: 1

The event will only trigger if the number of online players meets or exceeds this threshold.

Time, Day & World Restrictions

# Restrict to specific time windows (24h format)
timeRestrictions:
  - "09:00-12:00"
  - "18:00-22:00"

# Restrict to specific days of the week
allowedDays:
  - "FRIDAY"
  - "SATURDAY"
  - "SUNDAY"

# Restrict to specific worlds
allowedWorlds:
  - "world"
  - "world_nether"

# Require a permission to receive rewards
requiredPermission: "keyallx.receive"

Leave arrays empty ([]) to disable that restriction. When a restriction is set, the event will only trigger if all conditions are met.

Discord Integration

KeyAllX can send an automated webhook to your Discord server whenever a keyall event completes.

discordWebhook: "https://discord.com/api/webhooks/your-webhook-url"
discordMessage: "🎁 **KeyAll Event Completed!** 🎁\n{playerCount} players received free keys!"

Setup Steps

1. Open your Discord server settings.
2. Go to Integrations → Webhooks.
3. Click New Webhook and copy the webhook URL.
4. Paste the URL into discordWebhook in your config.
5. Customize the discordMessage (use {playerCount} for online players).
6. Run /keyallx reload.

PlaceholderAPI

KeyAllX natively integrates with PlaceholderAPI to expose accurate, real-time timer stats.

Available Placeholders

Usage Example — Scoreboard

# Example with TAB or FeatherBoard
scoreboard:
  lines:
    - "&6⏱ Next KeyAll: &f%keyallx_timer%"

Features

A comprehensive overview of everything KeyAllX offers.

Use Cases

📈 Retention Boost

Keep players online during reward cycles. By setting a predictable timeInterval, players learn when rewards are coming and stay logged in. Combine with reminders for maximum effect.

🔥 Activity Spikes

Use the multi-stage reminder system to bring players back at peak times. A 5-minute, 1-minute, and 10-second countdown creates urgency and drives players to re-join before the event fires.

🎮 Event Integration

Combine KeyAllX with server events — use timeRestrictions and allowedDays to create weekend-only keyalls, or special event windows that amplify your server's activities.

# Only run keyalls on weekends between 2pm and 10pm
allowedDays:
  - "SATURDAY"
  - "SUNDAY"
timeRestrictions:
  - "14:00-22:00"

Troubleshooting

Common issues and how to resolve them.

Commands not working

Timer not starting

• Verify autoStart: true in your config.
• Check that your license-key is valid and active.
• Restart the server fully (don't use /reload).
• Check the console for any error messages from KeyAllX.

Rewards not being given

• Verify the commands in the command and perPlayerCommand list work when run manually from console.
• Check that minimumPlayers is met — the event won't fire if not enough players are online.
• If using timeRestrictions or allowedDays, ensure the current time/day is within the allowed window.
• Check for typos in the YAML — use a YAML validator.

Discord webhook not sending

• Verify the webhook URL is correct and active in your Discord server settings.
• Ensure your server has outbound HTTPS access (some hosts restrict this).
• Enable debug: true to see detailed webhook logs in console.

Getting Help

If you can't resolve your issue, join our Discord server and open a support ticket with:

• Your server version (/version)
• KeyAllX version
• Relevant console errors
• Your config.yml contents (redact your license key)

FAQ

Support

Need help with KeyAllX? We're here for you.