Skip to main content

Minecraft Plugin

Integrating your Minecraft: Java Edition server with our API allows us to automate many processes, enhancing the user experience and management efficiency.

Our plugin is open-source and can be viewed on GitHub:

Installation Steps​

  1. Download and Upload the Plugin:

    • Download the plugin and upload it to your /plugins folder on your server.

  2. Create and Verify the Server:

    • Go to Integrations > Servers and create a new Minecraft Server.
    • After creating the server, you will be redirected to the server verification page. Follow the instructions provided on the verification page.
    • Run the required command in your server's console.
    • Once executed, you should see a message in the console confirming that your server is verified and ready to use.

Plugin Commands​

  • gcms reload (gamecms.reload): Reload the config file.
  • gcms store-force (gamecms.store.force): Force execution of all commands that are in Waiting status.
  • gcms setserverapikey (gamecms.api.key.server): Setting up server API KEY (Server key from Integrations > Servers).
  • gcms setscheduler 1 (gamecms.setscheduler): Change the time (in minutes) to check for new commands.
  • gcms setwebsiteapikey (gamecms.api.key.website): Setting up Website API KEY.
  • gcms addbalance (gamecms.balance.add): Adding virtual balance to a user (only if registered on the website).
  • gcms checkbalance (gamecms.balance.check): Checking user balance (only if registered on the website).
  • gcms placeholderstoggle (gamecms.placeholders.toggle): Enable/disable placeholder (Requires PlaceholderAPI plugin).
  • gcms verify (gamecms.api.key.website): Allows users to verify their accounts with website registrations.

To have full access to the commands of this plugin, you must be OP or have gamecms.admin.

Config File Options​

  1. website-api-key: To enable features such as placeholders, verification, adding balance, or removing balance, you must set your Website API Key. You can obtain this key from My Website.
  2. server-api-key: This is the key used to check for commands that are in a Waiting status and ready to be executed. It is recommended to change this key via gcms server-verify or gcms setserverapikey.
  3. commands-scheduler: 1200: This option defines how often the system checks for new commands. The default is 1200 ticks, which is equivalent to 1 minute.
  4. use-placeholders: true: Set this to true if you want to use placeholders. Ensure that PlaceholderAPI is installed for this feature to work.
  5. log-fetched-commands: true: Set this to false if you wish to disable command fetch logs from appearing in the console.

List of Placeholders​

  • %gamecms_user_total_balance%: Shows the user's current total balance on your website.
  • %gamecms_user_paid_balance%: Shows the user's current paid balance on your website.
  • %gamecms_user_virtual_balance%: Shows the user's current virtual balance on your website.

Video Tutorial​

For a better understanding, please watch our quick video on setting up the Minecraft plugin.

Plugin Features

If you wish our plugin to do something more that can help your Rust Server, please contact us.