Documentation

    Everything you need to know about using UnifiedHytale

    Getting Started
    Learn the basics of using UnifiedHytale
    • Creating an Account
    • Browsing Projects
    • Downloading Content
    • Profile Setup
    For Creators
    Upload and manage your projects
    • Becoming a Creator
    • Uploading Projects
    • Project Types
    • Markdown Guide
    Project Management
    Manage your uploaded content
    • Editing Projects
    • Managing Versions
    • Project Requirements
    • File Formats
    Moderation
    Understanding our review process
    • Moderation Queue
    • Approval Process
    • Guidelines
    • Support
    Developers
    Build integrations with our API
    • API Reference
    • Authentication
    • License Verification
    • Rate Limits

    Getting Started

    Creating an Account

    1. Click "Sign Up" in the top right corner
    2. Enter your email, username, and password
    3. Verify your email address (check spam folder if needed)
    4. Complete your profile in Settings

    💡 Tip: Choose a unique username - you can't change it later!

    Browsing Projects

    Use the Browse page to discover content:

    • Filter by Type: Plugins, Data Packs, Asset Packs, Worlds, Prefabs, Modpacks
    • Search: Find projects by name or description
    • Sort: By newest, most downloads, most likes, or recently updated
    • Categories: Filter by gameplay, aesthetic, technical, etc.

    Downloading Content

    1. Navigate to any project page
    2. Review the description, requirements, and compatible Hytale versions
    3. Click the "Download" button for your desired version
    4. Follow installation instructions in the project description
    5. Check dependencies (some plugins require other plugins to work)

    🔒 Security: All files are scanned for viruses before approval.

    Profile Setup

    Customize your profile in Settings:

    • Avatar: Upload a profile picture (max 2MB)
    • Bio: Tell others about yourself (supports markdown)
    • Social Links: Connect your Discord, Twitter, GitHub, website
    • Email Notifications: Configure what updates you receive

    For Creators

    Becoming a Creator

    1. Create and verify your account
    2. Go to your Dashboard
    3. Click "Become a Creator"
    4. Fill out the application form explaining your plans
    5. Wait for approval (usually 24-48 hours)
    6. You'll receive an email when approved!

    ⭐ Verified Creators: Build a reputation and get verified status after consistent quality uploads.

    Uploading Projects

    Follow these steps to upload your first project:

    1. From your Dashboard, click "New Project"
    2. Basic Info: Choose type, name, and summary
    3. Description: Write detailed info using markdown (see below)
    4. Media: Upload icon (256x256px) and banner (1920x1080px)
    5. Categories: Select 1-3 relevant categories
    6. Review: Check everything and submit
    7. Wait for moderation approval (24-48 hours)

    Hytale Project Types

    UnifiedHytale supports all Hytale modding formats:

    Plugin

    Server-side Java code with custom game logic

    Max size: 200MB | Format: .jar, .zip

    Data Pack

    JSON configuration for blocks, items, NPCs, world gen

    Max size: 50MB | Format: .zip

    Asset Pack

    Visual/audio content: models, textures, sounds

    Max size: 100MB | Format: .zip

    World

    Complete playable world save files

    Max size: 500MB | Format: .zip

    Prefab

    Single structures: houses, trees, landmarks

    Max size: 50MB | Format: .zip

    Modpack

    Curated collection of plugins and packs

    Max size: 500MB | Format: .zip

    Markdown Guide

    Project descriptions support full GitHub Flavored Markdown with live preview:

    Headers

    ## Heading 2
    ### Heading 3

    Text Formatting

    **bold** *italic* ~~strikethrough~~

    Lists

    - Bullet point
    1. Numbered list

    Links

    [Link text](https://example.com)

    Code

    `inline code`
    ```java
    code block
    ```

    Tables

    | Column 1 | Column 2 |
    |----------|----------|
    | Data | Data |

    💡 Pro Tip: Use the preview tab while writing to see exactly how it will look!

    Project Management

    Editing Projects

    You can edit most project details after upload:

    • ✅ Can Edit: Name, summary, description, images, categories
    • ❌ Cannot Edit: Project type, slug (URL)
    • Changes are saved immediately
    • Image updates may take a few minutes to propagate

    Managing Versions

    Keep your projects up to date with version management:

    • Upload new versions for updates and bug fixes
    • Use semantic versioning (1.0.0, 1.1.0, 2.0.0)
    • Write detailed changelogs (supports markdown)
    • Specify compatible Hytale game versions
    • Set dependencies on other projects
    • Users always see the latest version by default

    Project Requirements

    Text Requirements

    • Name: 3-100 characters, must be unique
    • Summary: 10-150 characters, appears in cards
    • Description: Minimum 100 characters, supports markdown

    Image Requirements

    • Icon: Square (256x256px recommended), max 5MB, PNG/JPG/WebP
    • Banner: Wide (1920x1080px recommended), max 5MB, PNG/JPG/WebP
    • High quality images help attract more downloads!

    File Requirements

    • Must be properly packaged (.zip, .jar, .rar, .7z)
    • Size limits vary by project type (see above)
    • Include README or installation guide
    • No malicious code or viruses

    Accepted File Formats

    Project Files

    .zip, .rar, .7z, .jar

    Images

    .png, .jpg, .jpeg, .webp

    Moderation & Safety

    Moderation Queue

    All uploads are reviewed before going live to ensure community safety:

    • Virus Scanning: Automated checks for malware
    • Content Review: Manual review of descriptions and files
    • Guidelines Check: Compliance with community standards
    • Copyright: No stolen or unauthorized content

    Approval Process

    1

    Submission

    Your project enters the moderation queue

    2

    Automated Checks

    Virus scanning and basic validation

    3

    Manual Review

    Staff reviews content and compliance (24-48 hours)

    4

    Decision

    Project is approved or you receive feedback for changes

    📧 You'll receive email notifications at each step.

    Need More Help?
    We're here to assist you
    Contact SupportAPI ReferenceView FAQCommunity GuidelinesEmail: support@unifiedhytale.com

    Platform

    • Browse Projects
    • Servers
    • Dashboard

    Resources

    • Documentation
    • API Reference
    • Support
    • FAQ

    Legal

    • Terms
    • Privacy
    • Guidelines

    UnifiedHytale

    Unifying the Hytale community with mods, maps, and servers.

    Support: support@unifiedhytale.com

    © 2025 UnifiedHytale. All rights reserved.

    UnifiedHytale
    BrowseServers
    Sign InSign UpSign In