flok

Flok Engine

Performance-First Server Scripting for Modern Minecraft

Flok is a lightweight, high-performance scripting engine for Paper and Spigot servers (1.21+). Designed as a modern, safety-conscious alternative to traditional scripting plugins, Flok allows you to create custom mechanics, commands, and event handlers using a natural, easy-to-read syntax—without the overhead or server-freeze risks.

Why Choose Flok?

• World-Class Performance: Benchmarked at an average tick rate of 2.076ms under load.
• Crash-Proof Safety: Includes a built-in 50,000 op-limit per script execution, preventing infinite loops from ever freezing your server thread.
• Smart Throttling: The on player-move event is natively throttled to once per second per player, providing a massive TPS safety net.
• Persistent Data: A global, human-readable storage system (flok_data.yml) that survives restarts and force-stops.
• Modern Java: Built on Java 21 to leverage the latest JVM optimizations.

Key Features

• Asynchronous Delays: Fully functional wait effect for non-blocking script delays.
• Event Cancellation: Full control over event flow with cancel and uncancel support.
• Custom Commands: Register commands with custom permissions, aliases, and descriptions on the fly.
• Addon API: A stable Java API for developers to register custom effects and fire custom events.
• Zero Restarts: Use /flok reload to update your scripts instantly without a server reboot.

Quick Start

1. Drop Flok-1.0.jar into your plugins folder.
2. Restart the server to generate the /plugins/Flok/scripts/ directory.
3. Create a .fk file and start scripting!

on player-join:
    send "&aWelcome to the server, %player-name%!"
    if %first-join% is true:
        broadcast "&e%player-name% joined for the first time!"# 🐺 Flok Engine

Performance-First Server Scripting for Modern Minecraft

Flok is a lightweight, high-performance scripting engine for Paper and Spigot servers (1.21+). Designed as a modern, safety-conscious alternative to traditional scripting plugins, Flok allows you to create custom mechanics, commands, and event handlers using a natural, easy-to-read syntax—without the overhead or server-freeze risks.

Why Choose Flok?

• World-Class Performance: Benchmarked at an average tick rate of 2.076ms under load.
• Crash-Proof Safety: Includes a built-in 50,000 op-limit per script execution, preventing infinite loops from ever freezing your server thread.
• Smart Throttling: The on player-move event is natively throttled to once per second per player, providing a massive TPS safety net.
• Persistent Data: A global, human-readable storage system (flok_data.yml) that survives restarts and force-stops.
• Modern Java: Built on Java 21 to leverage the latest JVM optimizations.

Key Features

• Asynchronous Delays: Fully functional wait effect for non-blocking script delays.
• Event Cancellation: Full control over event flow with cancel and uncancel support.
• Custom Commands: Register commands with custom permissions, aliases, and descriptions on the fly.
• Addon API: A stable Java API for developers to register custom effects and fire custom events.
• Zero Restarts: Use /flok reload to update your scripts instantly without a server reboot.

Quick Start

1. Drop Flok-1.0.jar into your plugins folder.
2. Restart the server to generate the /plugins/Flok/scripts/ directory.
3. Create a .fk file and start scripting!

on player-join:
    send "&aWelcome to the server, %player-name%!"
    if %first-join% is true:
        broadcast "&e%player-name% joined for the first time!"

Documentation: https://flokdev-dev.github.io/flok/ Source Code: https://github.com/FlokDev-dev/flok