Home

Setup

Manual

1. Get MeAPI.jar file

You can download latest release from here.

2. Set up your enviroment variables

You can find a list of env variables here. Variables will be loaded from the environment itself or from the .env file.

3. Run the program

Use java 17 or above to run the jar file. You can provide certain arguments to your startup command. Current available argument list is available here.

Pterodacyl panel

1. Download egg file

Download premade pterodactyl egg from here.

2. Import the egg

In pterodactyl's admin panel click on "Nests", and then on "Import egg" button. Choose the json file you downloaded in previous step and associate it with whichever nest you wish.

3. Create a server

Create a server using the imported egg. You can fill out all relevant environment variables is "Startup" tab of server configuration.

4. Run the app

At this point you can just upload the MeAPI.jar file directly to the main directory through file manager or sftp and start the server.

Configuration

Configuration is done via environment variables and startup arguments. Startup arguments will always override env variables.

Endpoint behavior

If required configuration is not provided for endpoint to function, that endpoint will return empty json body and 404 status response.

If endpoint has no data due to error with retrieving it from the outside (failed http requests, etc), endpoint will return empty json body and 500 status response.