E-Utils

EverlastingUtils (Hytale)

Note: If you're seeing this as a dependency or requirement for another mod, you can simply install it and ignore this documentation.

EverlastingUtils is a robust utility library for Hytale server development. It abstracts away complex boilerplate code, allowing developers to focus on gameplay features rather than infrastructure.

Features

Advanced Config Management

A direct port of a robust JSONC configuration system.

JSONC Support: Fully supports comments (// and /* */) in configuration files.

Hot-Reloading: Automatically detects file changes and reloads configs at runtime without restarting the server.

Auto-Save & Backup: Built-in auto-saving and automatic backup generation before migrations.

Versioning: Handles config version updates automatically.

Threading & Scheduling

A safe wrapper for managing tasks in the Hytale environment.

Safety: Prevents common concurrency errors by explicitly defining Async vs Sync execution.

Cleanup: Automatically tracks and cancels tasks on plugin shutdown.

Unified API: Simple static methods to run one-time or repeating tasks.

Color Parsing

Bridging the gap between legacy workflows and Hytale's component system.

Legacy Support: Parse classic &a, &l, &f codes into Hytale Message objects.

Hex Support: Automatically maps standard color codes to specific Hex values.

Usage Examples

1. Config Management

Create your config class by implementing ConfigManager.ConfigData:

public class MyConfig implements ConfigManager.ConfigData { // Required methods @Override public String getVersion() { return "1.0.0"; } @Override public String getConfigId() { return "my_plugin"; }

// Your Settings public boolean debugMode = false; public String welcomeMessage = "Hello World"; } Initialize it in your main class:

// Setup Metadata (Header comments, etc) ConfigMetadata meta = ConfigMetadata.createDefault("my_plugin");

// Initialize Manager ConfigManager<MyConfig> configManager = new ConfigManager<>( MyConfig.class, new MyConfig(), meta );

// Access values anywhere boolean isDebug = configManager.getConfig().debugMode;

2. Task Scheduling

Initialize the scheduler in your plugin's startup (to hook into the main game thread):

@Override public void onServerStarted() { // Hook into Hytale's main thread executor SchedulerManager.init(runnable -> HytaleServer.getInstance().getScheduler().execute(runnable) ); } Schedule tasks easily:

// Run a task 5 seconds later on the Main Thread (Sync) SchedulerManager.schedule("my_task_id", 5, TimeUnit.SECONDS, false, () -> { player.sendMessage(Message.raw("Delayed message!")); });

// Run a generic async task immediately SchedulerManager.schedule("async_calc", 0, TimeUnit.SECONDS, true, () -> { // Heavy calculation here... });

3. Color Parsing

Easily send formatted messages using legacy codes:

String rawText = "&aSuccess! &7You have received &e100 Coins&7."; Message message = ColorParser.parse(rawText);

player.sendMessage(message);

Installation for Developers

Add the library to your build.gradle.kts.

1. Add the jar to a libs folder

C:\Users\Administrator\Desktop\Mods\EventAntiXray\libs\everlastingutils-1.0.0.jar 2. Add the Dependency: Since EverlastingUtils is a standalone mod, use compileOnly so it isn't bundled inside your jar:

dependencies { compileOnly("com.hysocs:everlastingutils:1.0.0") // OR if using a local jar in libs/ // compileOnly(files("libs/everlastingutils-1.0.0.jar")) } Note: Ensure the EverlastingUtils jar is present in your server's mods folder during runtime.