feat: Adds branch for Hytale-Tools plugin example (#21)
This commit is contained in:
Neil
22
.github/workflows/gradle.yml
vendored
Normal file
22
.github/workflows/gradle.yml
vendored
Normal file
@@ -0,0 +1,22 @@
|
||||
name: Verifying Everything Compiles
|
||||
on:
|
||||
push:
|
||||
branches: [ "main" ]
|
||||
pull_request:
|
||||
branches: [ "main" ]
|
||||
jobs:
|
||||
build:
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
contents: read
|
||||
steps:
|
||||
- uses: actions/checkout@v6
|
||||
- name: Set up JDK 25
|
||||
uses: actions/setup-java@v5
|
||||
with:
|
||||
java-version: '25'
|
||||
distribution: 'temurin'
|
||||
- name: Setup Gradle
|
||||
uses: gradle/actions/setup-gradle@v5
|
||||
- name: Verify build is not broken
|
||||
run: ./gradlew build
|
||||
49
.gitignore
vendored
49
.gitignore
vendored
@@ -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/
|
||||
.settings/
|
||||
|
||||
168
README.md
168
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.
|
||||
|
||||
@@ -1,11 +1,50 @@
|
||||
/**
|
||||
* 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
|
||||
}
|
||||
|
||||
tasks.withType<Javadoc>().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()
|
||||
generateAssetsBinary = property("generateAssetsBinary").toString().toBoolean()
|
||||
// hytaleHomeOverride = property("hytaleHomeOverride").toString()
|
||||
}
|
||||
|
||||
repositories {
|
||||
mavenCentral()
|
||||
}
|
||||
|
||||
// Uncomment if you are using IntelliJ.
|
||||
// idea {
|
||||
// module {
|
||||
// isDownloadSources = true
|
||||
// isDownloadJavadoc = true
|
||||
// }
|
||||
// }
|
||||
|
||||
@@ -1,8 +1,86 @@
|
||||
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=...
|
||||
# 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.+
|
||||
|
||||
# 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 = true
|
||||
|
||||
# Controls whether prepareDecompiledSourcesForIde / idea generate the large hytale-assets.jar IDE binary from Assets.zip. Disable to avoid creating the extra assets jar.
|
||||
generateAssetsBinary = false
|
||||
|
||||
# Optional path to a local Hytale installation, a directory containing Assets.zip, or an Assets.zip file. When set, local dev tasks use this assets zip directly instead of requiring the Gradle cached assets zip.
|
||||
hytaleHomeOverride = /path/to/Hytale/install/release/package/game/latest/Assets.zip
|
||||
BIN
gradle/wrapper/gradle-wrapper.jar
vendored
BIN
gradle/wrapper/gradle-wrapper.jar
vendored
Binary file not shown.
4
gradle/wrapper/gradle-wrapper.properties
vendored
4
gradle/wrapper/gradle-wrapper.properties
vendored
@@ -1,7 +1,9 @@
|
||||
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
|
||||
retries=0
|
||||
retryBackOffMs=500
|
||||
validateDistributionUrl=true
|
||||
zipStoreBase=GRADLE_USER_HOME
|
||||
zipStorePath=wrapper/dists
|
||||
|
||||
5
gradlew
vendored
5
gradlew
vendored
@@ -57,7 +57,7 @@
|
||||
# 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
|
||||
# https://github.com/gradle/gradle/blob/3d91ce3b8caaf77ad09f381f43615b715b53f72c/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/.
|
||||
@@ -114,7 +114,6 @@ case "$( uname )" in #(
|
||||
NONSTOP* ) nonstop=true ;;
|
||||
esac
|
||||
|
||||
CLASSPATH="\\\"\\\""
|
||||
|
||||
|
||||
# Determine the Java command to use to start the JVM.
|
||||
@@ -172,7 +171,6 @@ fi
|
||||
# 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" )
|
||||
|
||||
@@ -212,7 +210,6 @@ DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
|
||||
|
||||
set -- \
|
||||
"-Dorg.gradle.appname=$APP_BASE_NAME" \
|
||||
-classpath "$CLASSPATH" \
|
||||
-jar "$APP_HOME/gradle/wrapper/gradle-wrapper.jar" \
|
||||
"$@"
|
||||
|
||||
|
||||
176
gradlew.bat
vendored
176
gradlew.bat
vendored
@@ -1,94 +1,82 @@
|
||||
@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
|
||||
@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, and ensure extensions are enabled
|
||||
setlocal EnableExtensions
|
||||
|
||||
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
|
||||
|
||||
"%COMSPEC%" /c exit 1
|
||||
|
||||
: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
|
||||
|
||||
"%COMSPEC%" /c exit 1
|
||||
|
||||
:execute
|
||||
@rem Setup the command line
|
||||
|
||||
|
||||
|
||||
@rem Execute Gradle
|
||||
@rem endlocal doesn't take effect until after the line is parsed and variables are expanded
|
||||
@rem which allows us to clear the local environment before executing the java command
|
||||
endlocal & "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -jar "%APP_HOME%\gradle\wrapper\gradle-wrapper.jar" %* & call :exitWithErrorLevel
|
||||
|
||||
:exitWithErrorLevel
|
||||
@rem Use "%COMSPEC%" /c exit to allow operators to work properly in scripts
|
||||
"%COMSPEC%" /c exit %ERRORLEVEL%
|
||||
|
||||
@@ -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"
|
||||
}
|
||||
}
|
||||
rootProject.name = "Replace Me"
|
||||
|
||||
@@ -3,20 +3,32 @@ package dev.hytalemodding;
|
||||
import com.hypixel.hytale.server.core.event.events.player.PlayerReadyEvent;
|
||||
import com.hypixel.hytale.server.core.plugin.JavaPlugin;
|
||||
import com.hypixel.hytale.server.core.plugin.JavaPluginInit;
|
||||
import com.hypixel.hytale.server.core.util.Config;
|
||||
import dev.hytalemodding.commands.ExampleCommand;
|
||||
import dev.hytalemodding.config.ExampleConfig;
|
||||
import dev.hytalemodding.events.ExampleEvent;
|
||||
|
||||
import javax.annotation.Nonnull;
|
||||
|
||||
public class ExamplePlugin extends JavaPlugin {
|
||||
|
||||
private static Config<ExampleConfig> config = null;
|
||||
|
||||
public ExamplePlugin(@Nonnull JavaPluginInit init) {
|
||||
super(init);
|
||||
config = this.withConfig("example_config", ExampleConfig.CODEC);
|
||||
}
|
||||
|
||||
@Override
|
||||
protected void setup() {
|
||||
config.save();
|
||||
this.getCommandRegistry().registerCommand(new ExampleCommand("example", "An example command"));
|
||||
this.getEventRegistry().registerGlobal(PlayerReadyEvent.class, ExampleEvent::onPlayerReady);
|
||||
if (getConfig().get().isEnabledWelcomeMessage()) {
|
||||
this.getEventRegistry().registerGlobal(PlayerReadyEvent.class, ExampleEvent::onPlayerReady);
|
||||
}
|
||||
}
|
||||
|
||||
public static Config<ExampleConfig> getConfig() {
|
||||
return config;
|
||||
}
|
||||
}
|
||||
25
src/main/java/dev/hytalemodding/config/ExampleConfig.java
Normal file
25
src/main/java/dev/hytalemodding/config/ExampleConfig.java
Normal file
@@ -0,0 +1,25 @@
|
||||
package dev.hytalemodding.config;
|
||||
|
||||
import com.hypixel.hytale.codec.Codec;
|
||||
import com.hypixel.hytale.codec.KeyedCodec;
|
||||
import com.hypixel.hytale.codec.builder.BuilderCodec;
|
||||
|
||||
public class ExampleConfig {
|
||||
|
||||
public static final BuilderCodec<ExampleConfig> CODEC = BuilderCodec.builder(ExampleConfig.class, ExampleConfig::new)
|
||||
.append(
|
||||
new KeyedCodec<>("EnableWelcomeMessage", Codec.BOOLEAN),
|
||||
(exConfig, aBoolean, extraInfo) -> exConfig.enabledWelcomeMessage = aBoolean,
|
||||
(exConfig, extraInfo) -> exConfig.enabledWelcomeMessage
|
||||
)
|
||||
.add()
|
||||
.build();
|
||||
|
||||
private boolean enabledWelcomeMessage;
|
||||
|
||||
private ExampleConfig() {}
|
||||
|
||||
public boolean isEnabledWelcomeMessage() {
|
||||
return enabledWelcomeMessage;
|
||||
}
|
||||
}
|
||||
@@ -1,8 +1,11 @@
|
||||
package dev.hytalemodding.events;
|
||||
|
||||
import com.hypixel.hytale.component.Ref;
|
||||
import com.hypixel.hytale.component.Store;
|
||||
import com.hypixel.hytale.server.core.Message;
|
||||
import com.hypixel.hytale.server.core.entity.entities.Player;
|
||||
import com.hypixel.hytale.server.core.event.events.player.PlayerReadyEvent;
|
||||
import com.hypixel.hytale.server.core.universe.PlayerRef;
|
||||
import com.hypixel.hytale.server.core.universe.world.storage.EntityStore;
|
||||
|
||||
public class ExampleEvent {
|
||||
|
||||
|
||||
@@ -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": ""
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user