Hytale

Tebex supports seamless integration with the official Hytale server via a dedicated plugin. These integrations allow automated command execution, player-specific package fulfillment, and robust monetization for server operators.

Prerequisites

  • You must have a Hytale server running

  • Your Tebex store must be configured for Hytale

  • Access to your server's console and FTP / File system

You must authenticate your server with a secret key. Find your Tebex secret key from: Control Panel > Integrations > Game Servers > Editarrow-up-right.

Installation Instructions

  1. Place the .jar file into /mods in your server directory.

  2. Start your server. If it is already running, you can run:

    plugin load Tebex:Tebex-Hytale
  3. In console, run:

    tebex secret YOUR_SECRET_KEY
  4. In-game, run:

    tebex info

    Confirm your store's details are displayed.

You're all set! Your Hytale server is now fully integrated with Tebex. Ready to start earning? Create packages and publish your store today!

Commands and Permissions

To view a list of commands available, from the console, run:

Below is a breakdown of the available commands and their permissions:

Command
Permission
Notes

tebex forcecheck

hytale.command.tebex.forcecheck

Immediately checks for and runs commands that are due. Note: use this only for testing, checks are performed every 2 minutes by default

tebex secret <key>

hytale.command.tebex.secret

Connects the server to Tebex.

tebex info

hytale.command.tebex.info

For players, displays a clickable store URL.

tebex checkout <id>

hytale.command.tebex.checkout

Creates an instant checkout link for a package.

tebex sendlink <username> <id>

hytale.command.tebex.sendlink

Creates an instant checkout link and sends it to a player.

tebex debug <true/false>

hytale.command.tebex.debug

Toggles verbose logging on/off.

tebex goals

hytale.command.tebex.goals

Shows status to any goals on your store.

buy

hytale.command.tebex.buy

A customizable command and message shown to the player. See 'Configuration'

Configuration

There are more in-depth configuration options available in the plugin's configuration file at mods/Tebex_Tebex-Hytale/config.json

Below is a breakdown of each configuration parameter and its function:

Parameter
Description

SecretKey

The current secret key for the server's store.

BuyCommandName

The customizable name for the buy command. Note: permission will always be tebex.buy

BuyCommandEnabled

true by default. false to disable the buy command altogether

BuyCommandMessage

The message to show when a player runs the buy command. Use {url} to fill in with your store's domain.

DebugMode

false by default. true to enable more verbose logging.

After making changes to your configuration file, you can apply them with:

Support

If you are having any issues with the Tebex Hytale plugin, please make sure to toggle debug mode on using the command tebex debug true . This shows more in-depth log messages that will help diagnose the problem.

When reaching to our support team, please include these debug logs with your ticket.

Feedback

The plugin is in active development. Please do not hesitate to contact us with any questions or feedback which you may have.

We have a dedicated Feedback Formarrow-up-right if you have suggestions for new features with the plugin.

Last updated

Was this helpful?