HytaleUtils Core Library v1.0 Documentation

⚡ STATUS: LIVE (UPDATED 2025)

🔧 PLATFORM: HytaleSDK

# Plugin Name
HytaleUtils Core Library

Overview

The HytaleUtils Core Library is a comprehensive plugin designed to provide a foundation for Hytale modders to build upon. It offers a wide range of utilities, including configuration management, command handling, and API hooks, making it an essential tool for any Hytale modding project.

Requirements

* HytaleSDK v1.0 or higher
* Java 8 or higher

Installation

1. Download the HytaleUtils Core Library v1.0 plugin from the official repository.
2. Place the plugin jar file in the `plugins` directory of your Hytale server.
3. Restart the server to enable the plugin.

Quick Start

1. Create a new configuration file named `config.yml` in the `plugins/HytaleUtils` directory.
2. Edit the `config.yml` file to customize the plugin settings.
3. Use the `/hytaleutils` command to verify the plugin is working correctly.

Configuration

yml
# config.yml

# General settings
general:
# Enable or disable the plugin
enabled: true
# Set the plugin debug level (0-5)
debug-level: 2

# Command settings
commands:
# Enable or disable command aliases
aliases: true
# Set the command prefix
prefix: '!"

# Permission settings
permissions:
# Enable or disable permission checking
enabled: true
# Set the default permission node
default-node: 'hytaleutils.user'

Commands

| Command | Description | Permission | Usage |
| --- | --- | --- | --- |
| `/hytaleutils` | Displays the plugin version and information | `hytaleutils.info` | `/hytaleutils` |
| `/hytaleutils reload` | Reloads the plugin configuration | `hytaleutils.admin` | `/hytaleutils reload` |
| `/hytaleutils debug` | Toggles debug mode on or off | `hytaleutils.admin` | `/hytaleutils debug` |

Permissions

| Node | Description | Default |
| --- | --- | --- |
| `hytaleutils.user` | Basic user permissions | true |
| `hytaleutils.admin` | Administrative permissions | op |
| `hytaleutils.info` | Permission to view plugin information | true |
| `hytaleutils.config` | Permission to manage plugin configuration | op |
| `hytaleutils.debug` | Permission to toggle debug mode | op |

API Reference

Java Code Examples

// Import the HytaleUtils API
import com.hytaleutils.core.api.HytaleUtilsAPI;

// Get the plugin instance
HytaleUtilsAPI api = HytaleUtilsAPI.getInstance();

// Register a new command
api.getCommandManager().registerCommand(new MyCommand());

// Get the plugin configuration
Configuration config = api.getConfiguration();

// Use the plugin logger
api.getLogger().info("Hello, world!");

Troubleshooting

1. Plugin not loading: Check that the plugin jar file is in the correct directory and that the server has been restarted.
2. Configuration errors: Check the `config.yml` file for syntax errors and ensure that the file is in the correct directory.
3. Command not found: Check that the command is registered correctly and that the user has the necessary permissions.
4. Permission issues: Check that the user has the necessary permissions and that the permission node is correctly configured.
5. Debug mode not working: Check that debug mode is enabled in the `config.yml` file and that the user has the necessary permissions.

FAQ

1. Q: What is the purpose of the HytaleUtils Core Library?
A: The HytaleUtils Core Library provides a foundation for Hytale modders to build upon, offering a wide range of utilities and API hooks.
2. Q: How do I install the HytaleUtils Core Library?
A: Download the plugin jar file and place it in the `plugins` directory of your Hytale server. Restart the server to enable the plugin.
3. Q: How do I configure the plugin?
A: Edit the `config.yml` file in the `plugins/HytaleUtils` directory to customize the plugin settings.
4. Q: What is the difference between `hytaleutils.user` and `hytaleutils.admin` permissions?
A: `hytaleutils.user` provides basic user permissions, while `hytaleutils.admin` provides administrative permissions.
5. Q: How do I register a new command?
A: Use the `HytaleUtilsAPI` to register a new command, as shown in the API reference section.

Changelog

v1.0

* Initial release of the HytaleUtils Core Library
* Added basic configuration management and command handling
* Introduced API hooks for modders to build upon
* Added permission system with default nodes and configuration options

Note: This is the initial release of the HytaleUtils Core Library. Future updates will be documented in this changelog.

📥 EXPLORE HYTALESDК

Join the community and start building today.

VISIT HYTALESDК 🚀