Guide

How to Package and Publish Your Own Hytale Mod to CurseForge

How to Package and Publish Your Own Hytale Mod to CurseForge

Publishing your custom Hytale mod to CurseForge is the official and most streamlined way to share your creations with the community, thanks to Hypixel Studios’ direct partnership with the platform. This guide will walk you through the precise steps to package your mod correctly and navigate the CurseForge submission process, ensuring your work reaches fellow Hytale players efficiently.

Understanding Hytale Mod Mechanics

Hytale’s modding system categorizes modifications into two primary types: Packs and Plugins. Grasping these, alongside the game’s server-side modding philosophy, is essential for effective development and distribution.

Packs (Content/Asset Mods)

  • Introduce new blocks, items, models, sounds, textures, and other assets.
  • Typically require no coding, utilizing tools like the Hytale Asset Editor (JSON) and Blockbench (3D models).
  • Packaged as .ZIP files.

Plugins (Code Mods)

  • Java-based modifications enabling deeper gameplay, custom commands, events, and server-side logic.
  • Offer extensive access to Hytale’s API.
  • Packaged as .JAR files.

A core feature is Hytale’s predominantly server-side modding. This means servers handle distributing necessary mod content to connecting players, reducing manual installation for users and ensuring compatibility. While some client-side assets might exist, core logic and content distribution are server-managed.

Official tools include the Hytale Asset Editor and Blockbench. A visual scripting system is also under development. For local testing, Packs go into UserData/Packs, and Plugins into UserData/Mods or UserData/EarlyPlugins.

Exact Steps to Publish Your Hytale Mod to CurseForge

Once your Hytale mod is developed, thoroughly tested, and ready, follow these precise steps to publish it on CurseForge:

  1. Create or Sign In to CurseForge

    Sign in or create a new account on CurseForge using Google, Discord, GitHub, or Twitch credentials. This account will manage your projects.

  2. Start a New Project for Hytale

    Navigate to CurseForge, hover over “Create,” then click “Start a Project.” Select “Hytale” from the game list.

  3. Enter Project Information

    Provide accurate and engaging details for your mod’s visibility:

    • Name: Choose a unique, descriptive title. Avoid version numbers or “Hytale” in the title.
    • Summary: A concise 10-250 character blurb summarizing your mod for search results.
    • Description: A comprehensive, grammatically correct English explanation of features, usage, and plans. Use clear formatting.
    • License: Select an appropriate license (e.g., MIT, GPL) defining usage rights.
    • Class: Select “Mods” for modifications, or “Worlds” for world files.
    • Category: Choose a main category and up to four additional sub-categories.
    • Logo: Upload an original, high-quality PNG graphic (min. 400x400px) representing your mod.
  4. Upload Your Mod File

    In your project’s “Files” tab, click “Add File” and provide details for this version:

    • File Type: Plugins must be .JAR files; Content Packs and Worlds must be .ZIP files.
    • Game Version: Specify the Hytale version your mod is compatible with.
    • File Name: A clear name, often including mod name and version (e.g., MyMod-1.0.jar).
    • Changelog: Detail new features, bug fixes, and changes for this version.
    • Dependencies: List any required external mods or libraries.

    Proceed with the upload after filling all details.

  5. Await Moderation Approval

    Your file will enter a moderation queue. CurseForge reviews submissions for compliance, malware, and quality. Once approved, your mod becomes publicly available.

Helpful Tips for Publishing Your Hytale Mod

  • Begin with Packs: New modders should start with content packs for an easier learning curve before tackling Java plugins.
  • Leverage Official Tools: Utilize the Hytale Asset Editor and Blockbench for streamlined development, as they are officially supported.
  • Thorough Local Testing: Rigorously test your mod in local Hytale installations (UserData/Packs, UserData/Mods) to ensure functionality and stability before uploading.
  • Adhere to File Formats: Always package plugins as .JAR and content packs/worlds as .ZIP for CurseForge. Incorrect formats will cause issues.
  • Craft a Compelling Project Page: Write clear, informative, and engaging descriptions, summaries, and changelogs. A high-quality logo is also crucial for appeal.
  • Choose a Responsible License: Select a license that clearly defines how others can use, modify, and distribute your mod, protecting your work and setting community expectations.
  • Understand Server-Side Modding: Hytale’s server-side approach simplifies user installation, but design your mod with server administrators in mind for configuration and performance.

Common Mistakes to Avoid When Publishing

  • Incorrect Local File Placement: Failing to place mod files in designated Hytale directories (UserData/Packs, UserData/Mods) will prevent them from loading during testing.
  • Forgetting to Enable Mods: Mods must be explicitly enabled in world settings or server configurations during local testing.
  • Duplicate Mod Files: Multiple copies of the same mod, especially plugins, can cause conflicts or server startup failures.
  • Missing Dependencies: Neglecting to list or include all required external libraries or other mods. Document dependencies clearly on CurseForge.
  • Mod Conflicts: Uploading mods that alter the same game systems without compatibility measures can cause crashes. Test combinations carefully.
  • Version Mismatches: Using a mod built for a different Hytale game version or protocol will likely cause errors. Ensure compatibility.
  • Poor CurseForge Project Details: Vague, grammatically incorrect, or incomplete descriptions, summaries, or an unprofessional logo deter users and can lead to moderation rejection.
  • Incorrect File Type Upload: Uploading a .ZIP for a Java plugin or a .JAR for a content pack is a common error on CurseForge.
  • Ignoring Moderation Policies: Failure to comply with CurseForge’s guidelines (e.g., distinct content, respecting IP, proper crediting) can result in project rejection or removal.

Uncertainties and Early Access Caveats

It is crucial to remember that Hytale is currently in Early Access (with an anticipated launch of January 13, 2026). This means that the game’s modding tools, APIs, and documentation are under active development and are subject to change, improvement, and potential deprecation. Information provided today may become outdated as the game evolves.

The full server source code is expected to be shared around March 2026, which will be an invaluable resource for advanced modders. While there are mentions of an “Hytale SDK,” this term might encompass various tools and libraries, some of which are still evolving or might refer to specific logging/analytics components rather than a comprehensive modding API from Hypixel Studios. Community-developed API documentation, often based on reverse engineering, exists but is not officially supported and can change rapidly with game updates.

Modders should stay updated with official Hytale announcements and community discussions to adapt to any changes in the modding landscape.