Skip to content
Flint
Dokumentation
Start

Getting started

Install Flint, write your first script and set up your editor.

Install the plugin

  1. Download Flint: Flint-Paper.jar for Paper and Folia 1.21+, Flint-Velocity.jar for Velocity 3.4+. Both need Java 21 or newer.
  2. Put the jar in your server’s plugins folder and start the server.
  3. Flint creates plugins/Flint/scripts/ (on Velocity: plugins/flint/scripts/) with a disabled example script.

Your first script

Create plugins/Flint/scripts/hello.fl:

on player.join:
    send "<green>Welcome, {player.name}!" to player

command hello(name: text = "world"):
    description "Says hello"
    send "<gold>Hello, {name}!" to sender

Then run /flint reload in-game or in the console. Join the server, or type /hello Steve.

  • Files end in .fl. A file whose name starts with - is disabled.
  • Indentation matters, like in Python: the body of on, command, fn, if and loops is indented (4 spaces is the convention).
  • Text in "..." can contain {expressions} and MiniMessage colours such as <green>.

When something is wrong

/flint reload prints every error with the file, the line and a caret pointing at the problem:

hello.fl:2: unknown event 'player.joins' (did you mean 'player.join'?)
    on player.joins:
       ^

Errors while a script runs are printed to the console with the script and line, and the rest of the server keeps running. A loop that runs millions of times without a wait is stopped automatically, so a typo cannot freeze the server.

The admin command

Command Does
/flint the list below; click a line to run it
/flint reload reloads the config and every script
/flint list loaded scripts with their events, commands and timers
/flint script <name> everything one script registers
/flint modules modules that are loaded and idle
/flint events events scripts are listening to
/flint addons addon plugins and what they add
/flint info platform, storage and databases

On Velocity the command is /flintv. Permission: flint.admin.

Set up VS Code

Install the Flint Script extension from the download page:

code --install-extension flint-lang.vsix

You get highlighting, completion for modules, members and events, documentation on hover, and the same errors the server would report, before you reload. The extension picks Paper or Velocity per file: put # platform: velocity on the first line of proxy scripts, or keep them in a folder whose path contains velocity.