Configuration

Configuration

Example extension usage:

hytaleTools {
    javaVersion = project.java_version as Integer
    hytaleVersion = project.hytale_version.toString()
    patchline = project.hytale_patchline.toString()
    // Optional manifest ServerVersion override.
    // If unset, dynamic hytaleVersion selectors resolve to the full version in manifest.json.
    // manifestServerVersion = '>=0.5.0-pre.9 <0.6.0'

    // Optional override to an existing local Assets.zip if you don't want to download/cache it.
    // Accepts a direct Assets.zip path, a directory containing Assets.zip,
    // or a Hytale launcher/install directory.
    // Remember to update this path if changing patchlines/versions.
    // hytaleHomeOverride = "/path/to/Hytale/install/release/package/game/latest/Assets.zip"
    
    // Optional override to not generate an Assets Binary (won't show sources as binary in your IDE)
    // generateAssetsBinary = true
    manifestGroup = project.manifest_group.toString()
    modId = project.mod_id.toString()
    modDescription = project.mod_description.toString()
    modUrl = project.mod_url.toString()
    mainClass = project.main_class.toString()
    // Author format: Name, or Name|Email, or Name|Email|Url.
    // Separate multiple authors with commas. Email and Url are optional.
    modCredits = project.mod_credits.toString()

    manifestDependencies = project.manifest_dependencies.toString()
    manifestOptionalDependencies = project.manifest_opt_dependencies.toString()
    curseforgeId = project.curseforgeID.toString()

    disabledByDefault = project.disabled_by_default.toString().toBoolean()
    includesPack = project.includes_pack.toString().toBoolean()
    
    // Optional: declare sub-plugins
    subPlugin('Forestry', 'com.example.mods.forestry.ForestryPlugin')
    // subPlugin(name, main, disabledByDefault, includesAssetPack, serverVersion)
    
    serverArgs = ['--allow-op', '--disable-sentry']
    serverJvmArgs = ['-Xms1G', '-Xmx2G']
    preRunTask = 'generateDevResources'
    
    debugEnabled = false
    debugPort = 5005
    debugSuspend = false

    hotSwapEnabled = false
    requireDcevm = false
    useHotswapAgent = true
    
    // Optional external HotswapAgent jar
    hotswapAgentPath = ''
    
    // Optional JetBrains Runtime location
    // jbrHome = '/path/to/jbr'

    // Optional: defaults to the release/prerelease docs URL based on patchline
    // serverJavadocsUrl = 'https://release.server.docs.hytale.com/'

    // Optional: enabled by default
    injectServerJavadocsIntoSources = true
}

Backing Gradle properties

The plugin also reads these Gradle properties automatically:

• java_version
• hytale_version
• manifest_server_version
• hytale_patchline
• hytools.hytale.oauth.base
• hytools.hytale.accounts.base
• manifest_group
• mod_id
• mod_description
• mod_url
• main_class
• mod_credits
• manifest_dependencies
• manifest_opt_dependencies
• curseforgeID
• disabled_by_default
• includes_pack
• hytools.debug.port
• hytools.debug.suspend
• hytools.jbr.home
• hytools.hotswap.agent.path

The plugin also recognizes these system properties for dev runtime features:

• debug → enables JDWP debug mode
• hotswap → enables hot swap runtime setup

---

Home | Task Reference | Troubleshooting