# 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 > Edit**](https://creator.tebex.io/game-servers).

### Installation Instructions

1. Download the plugin from [**Tebex > Plugins > Hytale**.](https://creator.tebex.io/game-servers)
2. Place the `.jar` file into `/mods` in your server directory.
3. Start your server. If it is already running, you can run:<br>

   ```
   plugin load Tebex:Tebex-Hytale
   ```
4. In console, run:

   ```
   tebex secret YOUR_SECRET_KEY
   ```
5. 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:

```
tebex
```

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

<table><thead><tr><th>Command</th><th width="287.4559326171875">Permission</th><th>Notes</th></tr></thead><tbody><tr><td>tebex forcecheck</td><td><em>hytale.command.tebex.forcecheck</em></td><td>Immediately checks for and runs commands that are due. <strong>Note: use this only for testing, checks are performed every 2 minutes by default</strong></td></tr><tr><td>tebex secret &#x3C;key></td><td><em>hytale.command.tebex.secret</em></td><td>Connects the server to Tebex.</td></tr><tr><td>tebex info</td><td><em>hytale.command.tebex.info</em></td><td>For players, displays a clickable store URL.</td></tr><tr><td>tebex checkout &#x3C;id></td><td><em>hytale.command.tebex.checkout</em></td><td>Creates an instant checkout link for a package.</td></tr><tr><td>tebex sendlink &#x3C;username> &#x3C;id></td><td><em>hytale.command.tebex.sendlink</em></td><td>Creates an instant checkout link and sends it to a player.</td></tr><tr><td>tebex debug &#x3C;true/false></td><td><em>hytale.command.tebex.debug</em></td><td>Toggles verbose logging on/off.</td></tr><tr><td>tebex goals</td><td><em>hytale.command.tebex.goals</em></td><td>Shows status to any goals on your store.</td></tr><tr><td>buy</td><td><em>hytale.command.tebex.buy</em></td><td>A customizable command and message shown to the player. See '<em>Configuration</em>'</td></tr></tbody></table>

## Configuration

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

```json
{
  
"SecretKey": "qwertyuiopasdfghjklzxcvbnm9876543210",
  
"BuyCommandName": "buy",
  
"BuyCommandEnabled": true,
"BuyCommandMessage": "Buy ranks, kits, and more at our store: {url}",
"DebugMode": false
}
```

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:

```
plugin reload Tebex:Tebex-Hytale 
```

## 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 Form](https://wkf.ms/45PQwfE) if you have suggestions for new features with the plugin.