Installation & Usage
How to use the plugin? How to install? This page will tell you everything!
Requirements
Installation
Extremely typical. Step 1: Download the plugin. Step 2: Move the plugin over to (your server's location)/plugins. Step 3: (Re)start your server.
Usage
Very simple.
Base URL is /api
Supports custom ports, you can see in the config.yml. Default port is `4567`.
Any change in configuration requires a restart, therefore no commands are registered in the plugin.
Custom Endpoint
As of 1.1.0, the default endpoints are no more. You can create your own custom endpoint! Yay!
You can create both the users kind, and the global kind. Setting require-user
to true makes it so that you need to put a /(username) after the endpoint. This is useful for user-based placeholders such as %player_name%
.
In the object
is the main thing you're looking for. You put your keys and values for the object there.
Last updated