Installation

Requirements

Check these before you start.


Server	Paper 26.3 or newer
Java	25
Required plugin	PlaceholderAPI

HMTAPI does not work on CraftBukkit or Spigot. It targets api-version: 26.3, so Paper will refuse to load it on an older server.

PlaceholderAPI is a hard requirement. HMTAPI declares it as a dependency and will not enable if it is missing, so install and enable PlaceholderAPI first.

Install

Install PlaceholderAPI. Download it, drop it into plugins/, and make sure it starts without errors. HMTAPI cannot enable without it.
Install HMTAPI. Drop the HMTAPI jar into your plugins folder alongside the other plugins.
Start the server once. HMTAPI creates plugins/HMTAPI/config.yml on first start. Nothing else is generated.

Check the console. On a successful start you will see a line like:

[HMTAPI] HMTAPI is serving the API on 0.0.0.0:4567 (2 endpoints, PlaceholderAPI available).

Try the default endpoint. The shipped config contains a users and a global endpoint:
Terminal window
```
curl http://localhost:4567/api/global
```

If that returns JSON, HMTAPI is working. You can now edit your config and continue with Configuration.

Updating

Replace the jar and restart the server. Your config.yml is never overwritten, so your endpoints survive an update.

If a future version adds new settings, they will fall back to their defaults until you add them yourself. The console logs a warning for any value it could not read.

Upgrading from another version

From an older HMTAPI: replace the jar, start the server, and check the console for warnings about settings that changed.

Uninstalling

Remove the HMTAPI jar.
Restart the server.
Delete plugins/HMTAPI/ if you do not plan to reinstall.

No other files are created outside of plugins/HMTAPI/.

Next steps

Configuration — every setting explained
Endpoints — building your first endpoints
Security — before you expose anything to the internet