diff --git a/.gitignore b/.gitignore index 6525e7b..a77757f 100644 --- a/.gitignore +++ b/.gitignore @@ -1,46 +1,11 @@ -target/ -!.mvn/wrapper/maven-wrapper.jar -!**/src/main/**/target/ -!**/src/test/**/target/ - -### IntelliJ IDEA ### -.idea -.idea/modules.xml -.idea/jarRepositories.xml -.idea/compiler.xml -.idea/*.xml -.idea/libraries/ -*.iws +.gradle/ +build/ +out/ +run/ +.idea/ *.iml *.ipr - -### Eclipse ### -.apt_generated +*.iws .classpath -.factorypath .project -.settings -.springBeans -.sts4-cache - -### NetBeans ### -/nbproject/private/ -/nbbuild/ -/dist/ -/nbdist/ -/.nb-gradle/ -build/ -!**/src/main/**/build/ -!**/src/test/**/build/ - -### VS Code ### -.vscode/ - -### Mac OS ### -.DS_Store - -### Gradle ### -.gradle -.kotlin -devserver -/.idea/ \ No newline at end of file +.settings/ diff --git a/README.md b/README.md index 6d17a38..8e490dd 100644 --- a/README.md +++ b/README.md @@ -4,52 +4,158 @@ A ready-to-use starting point for creating Hytale server plugins with Java, _or been using the Asset Editor and want to start writing server-side logic — custom commands, event handling, gameplay systems — this is the simplest place to begin. -## How to start? +This template uses the [Hytale Gradle Plugin](https://github.com/AzureDoom/Hytale-Gradle-Plugin), +a Gradle plugin maintained by AzureDoom for Hytale mod/plugin development. It handles the repetitive +project setup work for you, including manifest generation, validation, local server runs, IDE source +setup, and optional hosted Hytale Javadoc injection. -1. Copy the template by downloading it or using the "Use this template" button. -2. [Configure or Install the Java SDK](https://hytalemodding.dev/en/docs/guides/plugin/setting-up-env) - to use the latest 25 from JetBrains or similar. -3. Open the project in your favorite IDE, we - recommend [IntelliJ IDEA](https://www.jetbrains.com/idea/download). -4. Optionally, run `./gradlew` if your IDE does not automtically synchronizes. -5. Run the devserver with the Run Configuration created, or `./gradlew devServer`. +## How to start -> On Windows, use `.\gradlew.bat` instead of `./gradlew`, this script is here to run the -> Gradle without you needing to install the tooling itself, only the Java is required. +1. Copy the template by downloading it or using the **Use this template** button. +2. [Configure or install the Java SDK](https://hytalemodding.dev/en/docs/guides/plugin/setting-up-env) + to use Java 25. JetBrains Runtime is recommended for the best hot-reload/debugging experience. +3. Open the project in your favorite IDE. We recommend + [IntelliJ IDEA](https://www.jetbrains.com/idea/download). +4. Update the project values in `gradle.properties`: + - `rootProject.name` in `settings.gradle.kts` + - `group` + - `manifest_group` + - `mod_name` + - `mod_id` + - `main_class` + - `mod_author` + - `mod_description` + - `mod_url` +5. Optionally run `./gradlew` if your IDE does not automatically sync the project. +6. Prepare the Hytale development environment: -With that you will be prompted in the output to authorize your server, and then you can start -developing your plugin while the server is live reloading the code changes. + ```bash + ./gradlew setupHytaleDev + ``` -From here, -the [HytaleModding guides](https://hytalemodding.dev/en/docs/guides/plugin/build-and-test) cover -more details! +7. Run the local development server: -## Scaffoldit Plugin + ```bash + ./gradlew runServer + ``` -While there are multiple plugins made for Hytale, the template currently uses a zero-boilerplate one -where you only need the absolute minimum to start. However, you do have access to everything as -normal if you know what you are doing. +> On Windows, use `./gradlew.bat` or `gradlew.bat` instead of `./gradlew`. The Gradle wrapper is +> included so you do not need to install Gradle separately; only Java is required. -For in-depth configuration, you can visit the [ScaffoldIt Plugin Docs](https://scaffoldit.dev). +When the server starts, the output may prompt you to authorize your Hytale server. After that, you +can begin developing your plugin while the server handles local development runs. + +From here, the [HytaleModding guides](https://hytalemodding.dev/en/docs/guides/plugin/build-and-test) +cover more details. + +## Hytale Gradle Plugin + +This template is built around AzureDoom's `com.azuredoom.hytale-tools` Gradle plugin. + +The plugin is configured in `build.gradle.kts`: + +```kotlin +plugins { + idea + java + id("com.azuredoom.hytale-tools") version "1.+" +} +``` + +The AzureDoom Maven repository is configured in `settings.gradle.kts`: + +```kotlin +pluginManagement { + repositories { + gradlePluginPortal() + mavenCentral() + maven { + name = "AzureDoom Maven" + url = uri("https://maven.azuredoom.com/mods") + } + } +} +``` + +Most plugin-specific settings are controlled from `gradle.properties` and passed into the +`hytaleTools` block in `build.gradle.kts`. This keeps common project metadata in one easy-to-edit +place. + +For full plugin documentation, configuration options, tasks, and multi-project setup, visit the +[Hytale Gradle Plugin repository](https://github.com/AzureDoom/Hytale-Gradle-Plugin). + +## Useful commands + +```bash +# Sync/setup the local Hytale development environment +./gradlew setupHytaleDev + +# Run the local Hytale server +./gradlew runServer + +# Run the server with debugging and hot swap enabled +./gradlew runServer -Ddebug=true -Dhotswap=true + +# Check your JVM and hot swap setup +./gradlew hytaleJvmDoctor + +# Build the plugin +./gradlew build + +# Refresh dependencies if something fails to resolve +./gradlew build --refresh-dependencies +``` + +## Project structure + +```text +src/main/java/ Plugin source code +src/main/resources/ Plugin resources, including manifest.json +gradle.properties Main template configuration +build.gradle.kts Gradle build and Hytale Gradle Plugin configuration +settings.gradle.kts Plugin repositories and project name +``` + +## Manifest configuration + +The generated `manifest.json` is driven by the values in `gradle.properties`, including: + +- `manifest_group` +- `mod_id` +- `version` +- `mod_description` +- `mod_author` +- `mod_url` +- `main_class` +- `manifest_dependencies` +- `manifest_opt_dependencies` +- `manifestServerVersion` + +After changing these values, run: + +```bash +./gradlew updatePluginManifest +``` ## Troubleshooting -- **Gradle sync fails in IntelliJ** – - _Check that Java 25 is installed and configured under File → Project Structure → SDKs._ -- **Build fails with missing dependencies** – - _Run `./gradlew build --refresh-dependencies`. Make sure you have internet access!_ -- **Permission denied on `./gradlew`** – - _Run `chmod +x gradlew` (macOS/Linux)._ -- **Hot-reload doesn't work** – - _Verify you're using JetBrains Runtime, not a regular JDK._ +- **Gradle sync fails in IntelliJ** — Check that Java 25 is installed and configured under + **File → Project Structure → SDKs**. +- **The Hytale Gradle Plugin does not resolve** — Make sure `settings.gradle.kts` includes the + AzureDoom Maven repository at `https://maven.azuredoom.com/mods`. +- **Build fails with missing dependencies** — Run `./gradlew build --refresh-dependencies` and make + sure you have internet access. +- **Permission denied on `./gradlew`** — Run `chmod +x gradlew` on macOS/Linux. +- **Hot reload or enhanced class redefinition does not work** — Use JetBrains Runtime and try + `./gradlew hytaleJvmDoctor` to verify your JVM setup. ## Resources +- [Hytale Gradle Plugin](https://github.com/AzureDoom/Hytale-Gradle-Plugin) - [Hytale Modding Guides](https://hytalemodding.dev) - [Hytale Modding Discord](https://discord.gg/hytalemodding) -- [ScaffoldIt Plugin Docs](https://scaffoldit.dev) ## License -Add your own after copying the template, though we recommend using MIT, BSD, or Apache to keep -the modding community open! +Add your own license after copying the template. We recommend MIT, BSD, or Apache to keep the +modding community open. diff --git a/build.gradle.kts b/build.gradle.kts index f961f20..3aad50f 100644 --- a/build.gradle.kts +++ b/build.gradle.kts @@ -1,11 +1,48 @@ -/** - * NOTE: This is entirely optional and basics can be done in `settings.gradle.kts` - */ - -repositories { - // Any external repositories besides: MavenLocal, MavenCentral, HytaleMaven, and CurseMaven +plugins { +// Uncomment if you are using IntelliJ. +// idea + java + id("com.azuredoom.hytale-tools") version "1.+" } -dependencies { - // Any external dependency you also want to include -} \ No newline at end of file + +tasks.withType().configureEach { + (options as org.gradle.external.javadoc.StandardJavadocDocletOptions).addStringOption("Xdoclint:-missing", "-quiet") +} + +group = project.property("group").toString() + +java { + toolchain.languageVersion.set(JavaLanguageVersion.of(property("java_version").toString().toInt())) +} + +hytaleTools { + javaVersion = property("java_version").toString().toInt() + hytaleVersion = property("hytale_version").toString() + manifestServerVersion = property("manifestServerVersion").toString() + manifestGroup = property("manifest_group").toString() + modId = property("mod_id").toString() + modDescription = property("mod_description").toString() + modUrl = property("mod_url").toString() + mainClass = property("main_class").toString() + modCredits = property("mod_author").toString() + manifestDependencies = property("manifest_dependencies").toString() + manifestOptionalDependencies = property("manifest_opt_dependencies").toString() + curseforgeId = property("curseforgeID").toString() + disabledByDefault = property("disabled_by_default").toString().toBoolean() + includesPack = property("includes_pack").toString().toBoolean() + patchline = property("patchline").toString() + injectServerJavadocsIntoSources = property("injectServerJavadocsIntoSources").toString().toBoolean() +} + +repositories { + mavenCentral() +} + +// Uncomment if you are using IntelliJ. +// idea { +// module { +// isDownloadSources = true +// isDownloadJavadoc = true +// } +// } diff --git a/gradle.properties b/gradle.properties index 0d96c92..2506439 100644 --- a/gradle.properties +++ b/gradle.properties @@ -1,8 +1,80 @@ -org.gradle.daemon=true -org.gradle.parallel=true -# Turn the following on once you finished changing your settings/build: -# org.gradle.configuration-cache=true -# org.gradle.caching=true +# Gradle runtime options +# Enables the Gradle daemon for faster repeat builds. +org.gradle.daemon = true -# Optional Hytale location for the Assets.zip resolution: -# hytale.home_path=... \ No newline at end of file +# JVM memory used by Gradle while building the project. +org.gradle.jvmargs = -Xmx3G + +# Allows Gradle to build independent tasks in parallel. +org.gradle.parallel = true + +# Enables Gradle's local build cache. +org.gradle.caching = true + +# Java / Hytale options +# Java version used by the generated mod project. +java_version = 25 + +# Hytale server version targeted by this mod. +hytale_version = 0.5.3 + +# Mod identity +# Java package group used by Gradle. +group = dev.hytalemodding + +# Group identifier written into manifest.json. +manifest_group = HytaleModding + +# Human-readable mod name. +mod_name = Replace Me + +# Fully-qualified plugin entry point class. +main_class = dev.hytalemodding.ExamplePlugin + +# Comma-separated author entries. Author names cannot contain spaces. +# Each entry supports: Name, Name|Email, or Name|Email|Url. +# Example: AzureDoom|azuredoom@example.com|https://example.com,SomeOtherAuthor +mod_author = Your_Name|your.email@example.com|https://your-website.com + +# Unique lowercase mod identifier. +mod_id = ExamplePlugin + +# SPDX-style license identifier or Proprietary. +mod_license = MIT + +# Short description written into manifest.json. +mod_description = Description of your plugin + +# Project website, source, or download URL. +mod_url = https://your-plugin-website.com + +# Initial mod version. +version = 0.0.0 + +# Manifest / packaging options +# Whether this mod includes an asset pack. +includes_pack = true + +# Whether this mod starts disabled by default. +disabled_by_default = false + +# Hytale patchline used for dependency resolution. +patchline = release + +# Server version mirrored for tooling compatibility. +server_version = 0.5.3 + +# Server version range written into manifest.json. +manifestServerVersion = >=0.5.3 <0.6.0 + +# Required manifest dependencies. Format: Group:Name=Version,Other:Mod=* +manifest_dependencies = Hytale:AssetModule=* + +# Optional manifest dependencies. Same format as manifest_dependencies. +manifest_opt_dependencies = + +# CurseForge project ID used by update checking, if any. +curseforgeID = + +# Injects hosted Hytale API docs into generated Vineflower server sources for easier IDE browsing. +injectServerJavadocsIntoSources = false \ No newline at end of file diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar index 8bdaf60..b1b8ef5 100644 Binary files a/gradle/wrapper/gradle-wrapper.jar and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties index bad7c24..4026c8b 100644 --- a/gradle/wrapper/gradle-wrapper.properties +++ b/gradle/wrapper/gradle-wrapper.properties @@ -1,6 +1,6 @@ distributionBase=GRADLE_USER_HOME distributionPath=wrapper/dists -distributionUrl=https\://services.gradle.org/distributions/gradle-9.2.0-bin.zip +distributionUrl=https://services.gradle.org/distributions/gradle-9.5.1-bin.zip networkTimeout=10000 validateDistributionUrl=true zipStoreBase=GRADLE_USER_HOME diff --git a/gradlew b/gradlew index ef07e01..196f350 100755 --- a/gradlew +++ b/gradlew @@ -1,251 +1,5 @@ #!/bin/sh - -# -# Copyright © 2015 the original authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# https://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# SPDX-License-Identifier: Apache-2.0 -# - -############################################################################## -# -# Gradle start up script for POSIX generated by Gradle. -# -# Important for running: -# -# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is -# noncompliant, but you have some other compliant shell such as ksh or -# bash, then to run this script, type that shell name before the whole -# command line, like: -# -# ksh Gradle -# -# Busybox and similar reduced shells will NOT work, because this script -# requires all of these POSIX shell features: -# * functions; -# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», -# «${var#prefix}», «${var%suffix}», and «$( cmd )»; -# * compound commands having a testable exit status, especially «case»; -# * various built-in commands including «command», «set», and «ulimit». -# -# Important for patching: -# -# (2) This script targets any POSIX shell, so it avoids extensions provided -# by Bash, Ksh, etc; in particular arrays are avoided. -# -# The "traditional" practice of packing multiple parameters into a -# space-separated string is a well documented source of bugs and security -# problems, so this is (mostly) avoided, by progressively accumulating -# options in "$@", and eventually passing that to Java. -# -# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, -# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; -# see the in-line comments for details. -# -# There are tweaks for specific operating systems such as AIX, CygWin, -# Darwin, MinGW, and NonStop. -# -# (3) This script is generated from the Groovy template -# https://github.com/gradle/gradle/blob/HEAD/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt -# within the Gradle project. -# -# You can find Gradle at https://github.com/gradle/gradle/. -# -############################################################################## - -# Attempt to set APP_HOME - -# Resolve links: $0 may be a link -app_path=$0 - -# Need this for daisy-chained symlinks. -while - APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path - [ -h "$app_path" ] -do - ls=$( ls -ld "$app_path" ) - link=${ls#*' -> '} - case $link in #( - /*) app_path=$link ;; #( - *) app_path=$APP_HOME$link ;; - esac -done - -# This is normally unused -# shellcheck disable=SC2034 -APP_BASE_NAME=${0##*/} -# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) -APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s\n' "$PWD" ) || exit - -# Use the maximum available, or set MAX_FD != -1 to use that value. -MAX_FD=maximum - -warn () { - echo "$*" -} >&2 - -die () { - echo - echo "$*" - echo - exit 1 -} >&2 - -# OS specific support (must be 'true' or 'false'). -cygwin=false -msys=false -darwin=false -nonstop=false -case "$( uname )" in #( - CYGWIN* ) cygwin=true ;; #( - Darwin* ) darwin=true ;; #( - MSYS* | MINGW* ) msys=true ;; #( - NONSTOP* ) nonstop=true ;; -esac - -CLASSPATH="\\\"\\\"" - - -# Determine the Java command to use to start the JVM. -if [ -n "$JAVA_HOME" ] ; then - if [ -x "$JAVA_HOME/jre/sh/java" ] ; then - # IBM's JDK on AIX uses strange locations for the executables - JAVACMD=$JAVA_HOME/jre/sh/java - else - JAVACMD=$JAVA_HOME/bin/java - fi - if [ ! -x "$JAVACMD" ] ; then - die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME - -Please set the JAVA_HOME variable in your environment to match the -location of your Java installation." - fi -else - JAVACMD=java - if ! command -v java >/dev/null 2>&1 - then - die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. - -Please set the JAVA_HOME variable in your environment to match the -location of your Java installation." - fi -fi - -# Increase the maximum file descriptors if we can. -if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then - case $MAX_FD in #( - max*) - # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. - # shellcheck disable=SC2039,SC3045 - MAX_FD=$( ulimit -H -n ) || - warn "Could not query maximum file descriptor limit" - esac - case $MAX_FD in #( - '' | soft) :;; #( - *) - # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. - # shellcheck disable=SC2039,SC3045 - ulimit -n "$MAX_FD" || - warn "Could not set maximum file descriptor limit to $MAX_FD" - esac -fi - -# Collect all arguments for the java command, stacking in reverse order: -# * args from the command line -# * the main class name -# * -classpath -# * -D...appname settings -# * --module-path (only if needed) -# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. - -# For Cygwin or MSYS, switch paths to Windows format before running java -if "$cygwin" || "$msys" ; then - APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) - CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) - - JAVACMD=$( cygpath --unix "$JAVACMD" ) - - # Now convert the arguments - kludge to limit ourselves to /bin/sh - for arg do - if - case $arg in #( - -*) false ;; # don't mess with options #( - /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath - [ -e "$t" ] ;; #( - *) false ;; - esac - then - arg=$( cygpath --path --ignore --mixed "$arg" ) - fi - # Roll the args list around exactly as many times as the number of - # args, so each arg winds up back in the position where it started, but - # possibly modified. - # - # NB: a `for` loop captures its iteration list before it begins, so - # changing the positional parameters here affects neither the number of - # iterations, nor the values presented in `arg`. - shift # remove old arg - set -- "$@" "$arg" # push replacement arg - done -fi - - -# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. -DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' - -# Collect all arguments for the java command: -# * DEFAULT_JVM_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, -# and any embedded shellness will be escaped. -# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be -# treated as '${Hostname}' itself on the command line. - -set -- \ - "-Dorg.gradle.appname=$APP_BASE_NAME" \ - -classpath "$CLASSPATH" \ - -jar "$APP_HOME/gradle/wrapper/gradle-wrapper.jar" \ - "$@" - -# Stop when "xargs" is not available. -if ! command -v xargs >/dev/null 2>&1 -then - die "xargs is not available" -fi - -# Use "xargs" to parse quoted args. -# -# With -n1 it outputs one arg per line, with the quotes and backslashes removed. -# -# In Bash we could simply go: -# -# readarray ARGS < <( xargs -n1 <<<"$var" ) && -# set -- "${ARGS[@]}" "$@" -# -# but POSIX shell has neither arrays nor command substitution, so instead we -# post-process each arg (as a line of input to sed) to backslash-escape any -# character that might be a shell metacharacter, then use eval to reverse -# that process (while maintaining the separation between arguments), and wrap -# the whole thing up as a single "set" statement. -# -# This will of course break if any of these variables contains a newline or -# an unmatched quote. -# - -eval "set -- $( - printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | - xargs -n1 | - sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | - tr '\n' ' ' - )" '"$@"' - -exec "$JAVACMD" "$@" + set -eu + DIR=$(CDPATH='' cd -- "$(dirname -- "$0")" && pwd) + exec java -classpath "$DIR/gradle/wrapper/gradle-wrapper.jar" org.gradle.wrapper.GradleWrapperMain "$@" + \ No newline at end of file diff --git a/gradlew.bat b/gradlew.bat index db3a6ac..bc8d659 100644 --- a/gradlew.bat +++ b/gradlew.bat @@ -1,94 +1,4 @@ -@rem -@rem Copyright 2015 the original author or authors. -@rem -@rem Licensed under the Apache License, Version 2.0 (the "License"); -@rem you may not use this file except in compliance with the License. -@rem You may obtain a copy of the License at -@rem -@rem https://www.apache.org/licenses/LICENSE-2.0 -@rem -@rem Unless required by applicable law or agreed to in writing, software -@rem distributed under the License is distributed on an "AS IS" BASIS, -@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -@rem See the License for the specific language governing permissions and -@rem limitations under the License. -@rem -@rem SPDX-License-Identifier: Apache-2.0 -@rem - -@if "%DEBUG%"=="" @echo off -@rem ########################################################################## -@rem -@rem Gradle startup script for Windows -@rem -@rem ########################################################################## - -@rem Set local scope for the variables with windows NT shell -if "%OS%"=="Windows_NT" setlocal - -set DIRNAME=%~dp0 -if "%DIRNAME%"=="" set DIRNAME=. -@rem This is normally unused -set APP_BASE_NAME=%~n0 -set APP_HOME=%DIRNAME% - -@rem Resolve any "." and ".." in APP_HOME to make it shorter. -for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi - -@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. -set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" - -@rem Find java.exe -if defined JAVA_HOME goto findJavaFromJavaHome - -set JAVA_EXE=java.exe -%JAVA_EXE% -version >NUL 2>&1 -if %ERRORLEVEL% equ 0 goto execute - -echo. 1>&2 -echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2 -echo. 1>&2 -echo Please set the JAVA_HOME variable in your environment to match the 1>&2 -echo location of your Java installation. 1>&2 - -goto fail - -:findJavaFromJavaHome -set JAVA_HOME=%JAVA_HOME:"=% -set JAVA_EXE=%JAVA_HOME%/bin/java.exe - -if exist "%JAVA_EXE%" goto execute - -echo. 1>&2 -echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2 -echo. 1>&2 -echo Please set the JAVA_HOME variable in your environment to match the 1>&2 -echo location of your Java installation. 1>&2 - -goto fail - -:execute -@rem Setup the command line - -set CLASSPATH= - - -@rem Execute Gradle -"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" -jar "%APP_HOME%\gradle\wrapper\gradle-wrapper.jar" %* - -:end -@rem End local scope for the variables with windows NT shell -if %ERRORLEVEL% equ 0 goto mainEnd - -:fail -rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of -rem the _cmd.exe /c_ return code! -set EXIT_CODE=%ERRORLEVEL% -if %EXIT_CODE% equ 0 set EXIT_CODE=1 -if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% -exit /b %EXIT_CODE% - -:mainEnd -if "%OS%"=="Windows_NT" endlocal - -:omega +@echo off + set DIR=%~dp0 + java -classpath "%DIR%gradle\wrapper\gradle-wrapper.jar" org.gradle.wrapper.GradleWrapperMain %* + \ No newline at end of file diff --git a/settings.gradle.kts b/settings.gradle.kts index 0546d1e..2069aea 100644 --- a/settings.gradle.kts +++ b/settings.gradle.kts @@ -1,28 +1,16 @@ -rootProject.name = "dev.hytalemodding" - -plugins { - // See documentation on https://scaffoldit.dev - id("dev.scaffoldit") version "0.2.+" +pluginManagement { + repositories { + gradlePluginPortal() + mavenCentral() + maven { + name = "AzureDoom Maven" + url = uri("https://maven.azuredoom.com/mods") + } + } } -// Would you like to do a split project? -// Create a folder named "common", then configure details with `common { }` +plugins { + id("org.gradle.toolchains.foojay-resolver-convention") version "1.0.0" +} -hytale { - usePatchline("release") - useVersion("latest") - - repositories { - // Any external repositories besides: MavenLocal, MavenCentral, HytaleMaven, and CurseMaven - } - - dependencies { - // Any external dependency you also want to include - } - - manifest { - Group = "HytaleModding" - Name = "ExamplePlugin" - Main = "dev.hytalemodding.ExamplePlugin" - } -} \ No newline at end of file +rootProject.name = "Replace Me" diff --git a/src/main/resources/manifest.json b/src/main/resources/manifest.json index f496bde..731a4a6 100644 --- a/src/main/resources/manifest.json +++ b/src/main/resources/manifest.json @@ -5,16 +5,23 @@ "Description": "Description of your plugin", "Authors": [ { - "Name": "Your Name", + "Name": "Your_Name", "Email": "your.email@example.com", "Url": "https://your-website.com" } ], "Website": "https://your-plugin-website.com", "DisabledByDefault": false, - "IncludesAssetPack": false, - "Dependencies": {}, - "OptionalDependencies": {}, - "ServerVersion": "*", - "Main": "dev.hytalemodding.ExamplePlugin" + "IncludesAssetPack": true, + "Dependencies": { + "Hytale:AssetModule": "*" + }, + "OptionalDependencies": { + + }, + "ServerVersion": ">=0.5.3 <0.6.0", + "Main": "dev.hytalemodding.ExamplePlugin", + "UpdateChecker": { + "CurseForge": "" + } } \ No newline at end of file