Installation
Requirements, the install steps, what happens on the first run and what the plugin folder looks like afterwards.
Installing EventPulse takes about two minutes. There is nothing to configure before the first start, and the shipped events work as they are on any server with an economy plugin.
Requirements
| Server software | Spigot, Paper, or any fork of either |
| Minecraft | 1.21 and newer, including the 26.x line |
| Java | 21 on the 1.21 line, 25 on the 26.x line |
| PlaceholderAPI | Optional, for the placeholders in other plugins |
| Vault and an economy plugin | Optional, only for the money reward and any eco give style command |
| SuperiorSkyblock2, BentoBox or IridiumSkyblock | Optional, only for team mode |
| MySQL | Optional, SQLite is the default and needs no setup |
The Java version is what Minecraft itself asks for on that line, not something the plugin adds. The jar is compiled once and loads on both lines unchanged.
Paper is fully supported, and one thing is Paper only. Hiding the red numbers down the right hand side of the scoreboard needs an API that only Paper exposes. On plain Spigot the numbers stay, and the plugin says so once in the console. Everything else works the same on both. See Scoreboard.
Install
Get the jar
See Download for where to buy it and how to get the latest build.
Stop the server
Shut it down fully before adding the jar.
Drop in the jar
Move the EventPulse jar into your plugins/ folder.
Start the server
The first start writes every config file, downloads the database driver it needs, and opens the database. The console line to look for ends in enabled. If something stopped it, the line above says what, in plain words.
Try it
Run /event start cobble_rush in game. The event announces itself, the board appears on the right, and breaking stone scores. /event stop ends it early and pays out.
First run
The first start writes config.yml, events.yml, farmpoints.yml, scoreboard.yml and a lang folder holding en.yml, es.yml and fr.yml. Every key in every file has a short comment above it.
Storage is set up at the same time. With the default SQLite backend that means creating eventpulse.db in the plugin's own folder. Nothing else is needed.
The database driver and the connection pool are not inside the jar. They are declared in the plugin's own plugin.yml and the server downloads them on the first start, which keeps the jar small. A server with no internet access on first start needs those two files in the server's libraries folder already, see Storage.
Plugin folder
| File | What is in it | Page |
|---|---|---|
config.yml | Language, storage, scheduler, team mode, defaults, logging and sounds | Configuration |
events.yml | Every event, what it counts and what it pays | Events file |
farmpoints.yml | What every action is worth in FarmPoints | FarmPoints |
scoreboard.yml | The board, both the solo and the team layout | Scoreboard |
lang/*.yml | Every message, one file per language | Messages & language |
eventpulse.db | The SQLite database, only when storage.type is sqlite | Storage |
Upgrading
Stop the server, replace the jar, start it again. config.yml, scoreboard.yml and the three shipped language files update themselves. New keys arrive with their comments, your values are kept exactly as you left them, and the console prints one line per file that moved forward.
events.yml and farmpoints.yml are never touched by an upgrade. They are lists you curate, and updating them would put back every example event you deleted. When a release adds a new event setting, the changelog names it and you add it by hand where you want it.
A key you added yourself to config.yml, scoreboard.yml or a shipped language file is dropped on upgrade, because the plugin cannot tell your key apart from one it retired. Nothing on this site asks you to add keys to those files, so this should never bite, but you should know it.
Reloading without a restart
/event reload rereads every config file and reloads the events. An event that is already running keeps the settings it started with until it ends, so a reload mid event is safe. See Commands.
Optional integrations
| What | Why | Where |
|---|---|---|
| PlaceholderAPI | %eventpulse_...% placeholders in any other plugin | Placeholders |
| Vault plus an economy plugin | The money reward, and the shipped eco give reward commands | Rewards |
| SuperiorSkyblock2, BentoBox or IridiumSkyblock | Team events scored per island | Team mode |
| MySQL | Stats and history shared across a network | Storage |