Skip to content

Configuration Guide

Jump to bottom
Raúl M edited this page Jul 30, 2020 · 3 revisions

This is the current configuration file as of Nov. 22nd

# MAIN CONFIG FILE FOR ACCURATEREADINGS
# DO NOT forget ANY of the parameters, or it may result in a server crash.
# For more information, please read the wiki:
# https://github.com/sparkedhost/AccurateReadings/wiki/Configuration-Guide/


# What's the Pterodactyl panel URL?
panelUrl: "https://control.sparkedhost.us/" # Did you know? Sparked Host LLC has the best prices, with Budget Minecraft Hosting starting at $1/GB. Enough spam, sorry!
# Generate the API key on your control panel.
apiKey: "CHANGETHIS"
# The server ID to monitor
serverId: ""
# Should the plugin add the restart feature? DEFAULT: false
enableRestartCmd: false
# Should we show tips specifically tailored towards Sparked Host servers? DEFAULT: true
# This will ONLY work if the panel URL is https://control.sparkedhost.us/, this will NOT work with other panels
# as these tips are specifically aimed towards Sparked Host servers.
showSparkedTips: true

# --------------------------------------------------------------------------------------
# MESSAGES SECTION
# This allows you to customize the messages sent by the plugin to your liking.
# If any of these lines are left empty (""), the plugin will skip the message entirely.
# --------------------------------------------------------------------------------------

messages:
  # This is the title of the stats message.
  stats-title: "&8&m        &r &f&lSTATS&r &8&m        &r"
  # This message will show up BEFORE the stats message if the API key provided belongs to an account that doesn't own the server but has access to it.
  api-key-not-owner: "&e&lINFO: &6The API key provided in the config does not own this server, but is in fact added as a subuser."
  # Will be displayed when the command sender does not have the required permission to run a command.
  no-permission: "&cYou do not have permission to execute this command."

panelUrl

The URL to the control panel. It is where you would control your server normally. Please refer to the Installation Guide [to-do] in order to find it.

apiKey

This is the API key, you will need to generate that on the control panel URL specified above.

serverId

The ID of the server you want to control. Ideally, this should be the same server you've installed the plugin on, otherwise you will get very inaccurate readings as they would not be the resource usage from the server you would have executed the command from.

enableRestartCmd

This enables the ability to use the panel API in order to restart the server.

showSparkedTips

This will enable a few tips specifically aimed towards Sparked Host servers, such as disk usage warnings. This will ONLY work if the panel URL is https://control.sparkedhost.us/, this will NOT work with other panels.

messages section

This contains a list of messages sent by the plugin that can be customized. More customization options might come in the future, but this should be plenty.

stats-title

This is the title of the stats message.

api-key-not-owner

This message will only show up if the API key provided is linked to an account that does not own the server provided in the config but has access anyway. This can happen if the account used to make the API key is added as a subuser to the server or has admin privileges on the panel.

no-permission

Self explanatory, this will show up if the command sender doesn't have the necessary permission to run a command from this plugin.

AccurateReadings Wiki

Clone this wiki locally