Installation

Before you start

PaperMC 1.21.8 or newer
Java 21 or newer
Access to the server's plugins folder

Install

Stop the server. Don't use /reload.
Put ScriptedEssentials.jar in plugins/.
Start the server.
Look for Scripted Essentials v2.0 enabled in the console. Lite says ScriptedEssentials Lite instead.

The plugin makes its own folder and files on the first start.

Never use /reload

/reload tries to start the plugin again without properly shutting the old copy down first, which causes bugs that are hard to track down. Use /se reload for config changes, or restart the server.

What gets created

text

plugins/ScriptedEssentials/
  config.yml              settings
  kits/                   one .yml per kit, categories as folders
  warps/                  warps.json
  npcs/                   NPCs, groups, queues and armies
  players/                player data and teams
  nicks/                  nickname profiles, the name pool and the skin cache
  settings/               feature permissions, blocked names, command blocker, blocked mods
  server/                 toggles like /pvp and /chatmute, recording borders
  presets/                random fill, orbital and potion presets
  replay/                 PlayerReplay recordings (Premium)
  database/               block changes for chunk restore
  backups/                kits, warps, inventories, chunks
  logs/

Next, go to Configuration and turn off anything you don't need.

Updating

Stop the server.
Swap the old jar for the new one.
Start the server.

Your config.yml is kept. If an update adds new options they get merged into your file with their comments, and your existing values stay as they are. If there's nothing new to add, the file isn't touched at all.

Back up plugins/ScriptedEssentials/ before a big version jump. It holds every kit, warp and NPC you have made.

Importing from other plugins

Kits and warps get imported on the first start if the old plugin's folder is still in plugins/.

From	Brings over
EssentialsX	Kits and warps
PlayerKits2	Kits
Observer	Kits

You can also run it yourself whenever:

commands

/kitsconvert    # import kits
/warpsconvert   # import warps

To stop the automatic import, add this to config.yml:

yaml

kit:
  auto-convert-from-other-plugins: false
warp:
  auto-convert-from-other-plugins: false

Plugins that conflict

NickAPI

ScriptedEssentials won't start if NickAPI is installed. Both of them change how player names and skins get sent out, so they end up fighting each other. Remove NickAPI and restart.

If another plugin also claims /build, /break, /team or /unfreeze, ScriptedEssentials takes those names on startup. If you want the vanilla /team back, set team.vanilla-teams: true in config.yml.

If Citizens or another plugin also uses /npc, this plugin takes it. /npc always ends up here.

Uninstalling

Stop the server.
Delete the jar from plugins/.
Delete plugins/ScriptedEssentials/ if you don't want to keep the data.