diff --git a/build.gradle.kts b/build.gradle.kts new file mode 100644 index 0000000..25878a1 --- /dev/null +++ b/build.gradle.kts @@ -0,0 +1,97 @@ +import org.gradle.api.GradleException +import org.gradle.api.tasks.testing.Test +import dev.projectcapture.buildlogic.VerifyFanProjectPolicy + +plugins { + base +} + +group = "dev.projectcapture" +version = "0.1.0" + +allprojects { + group = rootProject.group + version = rootProject.version + + repositories { + mavenCentral() + maven { + name = "hytaleRelease" + url = uri("https://maven.hytale.com/release") + mavenContent { releasesOnly() } + } + } +} + +subprojects { + plugins.withId("java") { + extensions.configure { + toolchain.languageVersion.set(JavaLanguageVersion.of(25)) + withSourcesJar() + } + + tasks.withType().configureEach { + options.encoding = "UTF-8" + options.release.set(25) + options.compilerArgs.addAll(listOf("-Xlint:all", "-parameters")) + } + + tasks.withType().configureEach { + useJUnitPlatform() + testLogging { + events("failed", "skipped") + exceptionFormat = org.gradle.api.tasks.testing.logging.TestExceptionFormat.FULL + } + } + } +} + +val verifyFanProjectPolicy = tasks.register("verifyFanProjectPolicy") { + group = "verification" + description = "Verifies the public, non-commercial and unofficial fan-project safeguards." + projectRoot.set(layout.projectDirectory) +} + +tasks.named("check") { + dependsOn( + verifyFanProjectPolicy, + ":engine:check", + ":content-pokemon:check", + ":content-tools:check", + ":hytale-adapter:check", + ) +} + +tasks.register("fanBuild") { + group = "build" + description = "Builds and verifies the unofficial non-commercial fan mod." + dependsOn("check", ":hytale-adapter:fanModJar") +} + +val releaseReviewFile = layout.projectDirectory.file("release-review.json").asFile + +tasks.register("publish") { + group = "release" + description = "Guarded public publishing entry point; no upload is performed by this task." + doFirst { + if (!releaseReviewFile.isFile || !releaseReviewFile.readText().contains("\"approved\": true")) { + throw GradleException( + "Release review is missing. Copy release-review.example.json to release-review.json, " + + "complete the Hytale and third-party-rights review, then set approved to true." + ) + } + } +} + +tasks.register("release") { + group = "release" + description = "Guarded release entry point; requires a current manual policy review." + doFirst { + if (!releaseReviewFile.isFile || !releaseReviewFile.readText().contains("\"approved\": true")) { + throw GradleException( + "Release review is missing. Copy release-review.example.json to release-review.json, " + + "complete the Hytale and third-party-rights review, then set approved to true." + ) + } + } +} diff --git a/buildSrc/src/main/java/dev/projectcapture/buildlogic/VerifyFanProjectPolicy.java b/buildSrc/src/main/java/dev/projectcapture/buildlogic/VerifyFanProjectPolicy.java new file mode 100644 index 0000000..0ec171d --- /dev/null +++ b/buildSrc/src/main/java/dev/projectcapture/buildlogic/VerifyFanProjectPolicy.java @@ -0,0 +1,48 @@ +package dev.projectcapture.buildlogic; + +import org.gradle.api.DefaultTask; +import org.gradle.api.GradleException; +import org.gradle.api.file.DirectoryProperty; +import org.gradle.api.tasks.Internal; +import org.gradle.api.tasks.TaskAction; + +import java.io.File; +import java.io.IOException; +import java.nio.file.Files; +import java.util.List; + +public abstract class VerifyFanProjectPolicy extends DefaultTask { + @Internal + public abstract DirectoryProperty getProjectRoot(); + + @TaskAction + public void verify() throws IOException { + File root = getProjectRoot().get().getAsFile(); + List requiredFiles = List.of( + "LICENSE", + "THIRD_PARTY_NOTICE.md", + "fan-project-metadata.json", + "docs/UNOFFICIAL_FAN_PROJECT_POLICY.md" + ); + List missing = requiredFiles.stream() + .filter(path -> !root.toPath().resolve(path).toFile().isFile()) + .toList(); + if (!missing.isEmpty()) { + throw new GradleException("Missing fan-project safeguards: " + String.join(", ", missing)); + } + + String metadata = Files.readString(root.toPath().resolve("fan-project-metadata.json")); + List requiredFlags = List.of( + "\"unofficial\": true", + "\"nonCommercial\": true", + "\"containsPokemonFanContent\": true", + "\"bundlesHytaleGameFiles\": false" + ); + List absentFlags = requiredFlags.stream() + .filter(flag -> !metadata.contains(flag)) + .toList(); + if (!absentFlags.isEmpty()) { + throw new GradleException("Invalid fan-project metadata; missing: " + String.join(", ", absentFlags)); + } + } +} diff --git a/gradle.properties b/gradle.properties new file mode 100644 index 0000000..6e51808 --- /dev/null +++ b/gradle.properties @@ -0,0 +1,6 @@ +org.gradle.caching=true +org.gradle.configuration-cache=true +org.gradle.parallel=true +org.gradle.warning.mode=all +org.gradle.java.installations.auto-download=false + diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..b1b8ef5 Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..a9db115 --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,9 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-9.6.1-bin.zip +networkTimeout=10000 +retries=0 +retryBackOffMs=500 +validateDistributionUrl=true +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100755 index 0000000..249efbb --- /dev/null +++ b/gradlew @@ -0,0 +1,248 @@ +#!/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 +# + +############################################################################## +# +# gradlew 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 gradlew +# +# 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/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/. +# +############################################################################## + +# 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 + + + +# 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" ) + + 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" \ + -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" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000..8508ef6 --- /dev/null +++ b/gradlew.bat @@ -0,0 +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 gradlew 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 gradlew +@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% diff --git a/hytale-adapter/build.gradle.kts b/hytale-adapter/build.gradle.kts new file mode 100644 index 0000000..f032b6a --- /dev/null +++ b/hytale-adapter/build.gradle.kts @@ -0,0 +1,65 @@ +plugins { + `java-library` +} + +dependencies { + api(project(":engine")) + implementation(project(":content-pokemon")) + + compileOnly("com.hypixel.hytale:Server:0.5.9") + implementation("com.fasterxml.jackson.core:jackson-databind:2.20.0") + + testImplementation(platform("org.junit:junit-bom:6.0.0")) + testImplementation("org.junit.jupiter:junit-jupiter") + testRuntimeOnly("org.junit.platform:junit-platform-launcher") + testImplementation("org.assertj:assertj-core:3.27.6") +} + +tasks.jar { + enabled = false +} + +val fanModJar = tasks.register("fanModJar") { + group = "build" + description = "Packages the unofficial non-commercial fan plugin and embedded asset pack." + dependsOn(configurations.runtimeClasspath) + archiveBaseName.set("ProjectCapture") + archiveClassifier.set("fan-dev") + duplicatesStrategy = DuplicatesStrategy.EXCLUDE + + from(sourceSets.main.get().output) + from({ + configurations.runtimeClasspath.get() + .filter { it.exists() } + .map { if (it.isDirectory) it else zipTree(it) } + }) + + exclude("META-INF/*.SF", "META-INF/*.DSA", "META-INF/*.RSA") + manifest { + attributes["Implementation-Title"] = "ProjectCapture Unofficial Fan Project" + attributes["Implementation-Version"] = project.version + attributes["ProjectCapture-Distribution"] = "UNOFFICIAL-NONCOMMERCIAL" + } +} + +tasks.assemble { + dependsOn(fanModJar) +} + +tasks.register("installToDevMods") { + group = "development" + description = "Copies the fan mod only into an explicitly configured isolated dev Mods directory." + dependsOn(fanModJar) + + val configuredModsDir = providers.gradleProperty("projectCapture.devModsDir") + onlyIf { + if (!configuredModsDir.isPresent) { + logger.lifecycle("Skipping install: set -PprojectCapture.devModsDir=.") + false + } else { + true + } + } + from(fanModJar.flatMap { it.archiveFile }) + into(configuredModsDir) +} diff --git a/hytale-adapter/src/main/java/dev/projectcapture/hytale/FeatureFlags.java b/hytale-adapter/src/main/java/dev/projectcapture/hytale/FeatureFlags.java new file mode 100644 index 0000000..1431d19 --- /dev/null +++ b/hytale-adapter/src/main/java/dev/projectcapture/hytale/FeatureFlags.java @@ -0,0 +1,13 @@ +package dev.projectcapture.hytale; + +/** Keeps unstable Hytale API features outside the stable 0.5.9 integration. */ +public record FeatureFlags( + boolean updateSixPersistentResources, + boolean updateSixCustomBattleUi, + boolean updateSixServerCamera +) { + public static FeatureFlags stableRelease() { + return new FeatureFlags(false, false, false); + } +} + diff --git a/hytale-adapter/src/main/java/dev/projectcapture/hytale/ProjectCapturePlugin.java b/hytale-adapter/src/main/java/dev/projectcapture/hytale/ProjectCapturePlugin.java new file mode 100644 index 0000000..4016d4f --- /dev/null +++ b/hytale-adapter/src/main/java/dev/projectcapture/hytale/ProjectCapturePlugin.java @@ -0,0 +1,37 @@ +package dev.projectcapture.hytale; + +import com.hypixel.hytale.server.core.plugin.JavaPlugin; +import com.hypixel.hytale.server.core.plugin.JavaPluginInit; +import dev.projectcapture.hytale.persistence.JsonStateStore; + +import java.util.concurrent.CompletableFuture; + +/** + * Thin Hytale entry point. Domain behavior lives in {@code engine}; this class + * owns only Hytale lifecycle and adapter wiring. + */ +public final class ProjectCapturePlugin extends JavaPlugin { + private final JsonStateStore stateStore; + private final FeatureFlags featureFlags; + + public ProjectCapturePlugin(JavaPluginInit init) { + super(init); + this.stateStore = new JsonStateStore(init.getDataDirectory()); + this.featureFlags = FeatureFlags.stableRelease(); + } + + @Override + public CompletableFuture preLoad() { + stateStore.initialize(); + return CompletableFuture.completedFuture(null); + } + + JsonStateStore stateStore() { + return stateStore; + } + + FeatureFlags featureFlags() { + return featureFlags; + } +} + diff --git a/hytale-adapter/src/main/java/dev/projectcapture/hytale/persistence/JsonStateStore.java b/hytale-adapter/src/main/java/dev/projectcapture/hytale/persistence/JsonStateStore.java new file mode 100644 index 0000000..c9ff4cd --- /dev/null +++ b/hytale-adapter/src/main/java/dev/projectcapture/hytale/persistence/JsonStateStore.java @@ -0,0 +1,107 @@ +package dev.projectcapture.hytale.persistence; + +import com.fasterxml.jackson.databind.JsonNode; +import com.fasterxml.jackson.databind.ObjectMapper; +import com.fasterxml.jackson.databind.SerializationFeature; + +import java.io.IOException; +import java.nio.file.AtomicMoveNotSupportedException; +import java.nio.file.Files; +import java.nio.file.Path; +import java.nio.file.StandardCopyOption; +import java.util.Objects; + +/** + * Atomic JSON persistence rooted in Hytale's plugin data directory. Paths are + * logical save identifiers, never caller-controlled filesystem paths. + */ +public final class JsonStateStore { + public static final int CURRENT_SCHEMA_VERSION = 1; + + private final Path root; + private final ObjectMapper mapper; + + public JsonStateStore(Path pluginDataDirectory) { + this.root = Objects.requireNonNull(pluginDataDirectory, "pluginDataDirectory") + .toAbsolutePath() + .normalize() + .resolve("state"); + this.mapper = new ObjectMapper().enable(SerializationFeature.INDENT_OUTPUT); + } + + public void initialize() { + try { + Files.createDirectories(root); + } catch (IOException exception) { + throw new StateStoreException("Unable to initialize ProjectCapture state directory", exception); + } + } + + public synchronized void write(String saveId, JsonNode payload) { + Path destination = resolveSaveId(saveId); + Path temporary = destination.resolveSibling(destination.getFileName() + ".tmp"); + try { + Files.createDirectories(destination.getParent()); + mapper.writeValue(temporary.toFile(), new StateEnvelope(CURRENT_SCHEMA_VERSION, payload)); + try { + Files.move( + temporary, + destination, + StandardCopyOption.ATOMIC_MOVE, + StandardCopyOption.REPLACE_EXISTING + ); + } catch (AtomicMoveNotSupportedException ignored) { + Files.move(temporary, destination, StandardCopyOption.REPLACE_EXISTING); + } + } catch (IOException exception) { + throw new StateStoreException("Unable to persist save " + saveId, exception); + } + } + + public synchronized JsonNode read(String saveId) { + Path source = resolveSaveId(saveId); + if (!Files.exists(source)) { + return null; + } + try { + StateEnvelope envelope = mapper.readValue(source.toFile(), StateEnvelope.class); + if (envelope.schemaVersion() != CURRENT_SCHEMA_VERSION) { + throw new StateStoreException( + "Unsupported state schema " + envelope.schemaVersion() + " for " + saveId + ); + } + return envelope.payload(); + } catch (IOException exception) { + throw new StateStoreException("Unable to read save " + saveId, exception); + } + } + + private Path resolveSaveId(String saveId) { + if (saveId == null || !saveId.matches("[a-z0-9][a-z0-9._-]{0,63}")) { + throw new IllegalArgumentException("Invalid logical save id"); + } + Path result = root.resolve(saveId + ".json").normalize(); + if (!result.startsWith(root)) { + throw new IllegalArgumentException("Save path escapes plugin state root"); + } + return result; + } + + public record StateEnvelope(int schemaVersion, JsonNode payload) { + public StateEnvelope { + Objects.requireNonNull(payload, "payload"); + } + } + + public static final class StateStoreException extends RuntimeException { + private static final long serialVersionUID = 1L; + + public StateStoreException(String message) { + super(message); + } + + public StateStoreException(String message, Throwable cause) { + super(message, cause); + } + } +} diff --git a/hytale-adapter/src/main/java/dev/projectcapture/hytale/ports/UiPort.java b/hytale-adapter/src/main/java/dev/projectcapture/hytale/ports/UiPort.java new file mode 100644 index 0000000..a1cddb2 --- /dev/null +++ b/hytale-adapter/src/main/java/dev/projectcapture/hytale/ports/UiPort.java @@ -0,0 +1,12 @@ +package dev.projectcapture.hytale.ports; + +import java.util.UUID; + +/** Server-driven UI boundary; no client mod or client hook is assumed. */ +public interface UiPort { + void showCaptureResult(UUID playerId, UUID creatureId, boolean captured); + + void showBattleCommands(UUID playerId, UUID creatureId, String basicMove, String[] commandedMoves); + + void showUnofficialFanProjectNotice(UUID playerId); +} diff --git a/hytale-adapter/src/main/java/dev/projectcapture/hytale/ports/WorldPort.java b/hytale-adapter/src/main/java/dev/projectcapture/hytale/ports/WorldPort.java new file mode 100644 index 0000000..964b7ab --- /dev/null +++ b/hytale-adapter/src/main/java/dev/projectcapture/hytale/ports/WorldPort.java @@ -0,0 +1,20 @@ +package dev.projectcapture.hytale.ports; + +import java.util.List; +import java.util.UUID; + +/** Stable boundary between domain services and the evolving Hytale world API. */ +public interface WorldPort { + void spawnWildCreature(String speciesId, SpawnPoint point, long deterministicSeed); + + void despawnCreature(UUID creatureId); + + void setVisibleCompanion(UUID playerId, UUID creatureId); + + void clearVisibleCompanion(UUID playerId); + + List eligibleSpawnPoints(String biomeId, String timeBand); + + record SpawnPoint(String worldId, double x, double y, double z, String biomeId) {} +} + diff --git a/hytale-adapter/src/main/resources/Server/ProjectCapture/content-index.json b/hytale-adapter/src/main/resources/Server/ProjectCapture/content-index.json new file mode 100644 index 0000000..b6543b3 --- /dev/null +++ b/hytale-adapter/src/main/resources/Server/ProjectCapture/content-index.json @@ -0,0 +1,10 @@ +{ + "schemaVersion": 1, + "namespace": "projectcapture", + "distribution": "UNOFFICIAL_NONCOMMERCIAL_FAN_PROJECT", + "unofficialFanContent": true, + "nonCommercial": true, + "rightsReviewRequired": true, + "contentModule": "content-pokemon", + "notes": "Runtime-facing index only. Definitions are original ProjectCapture production files; Pokemon ownership remains with the respective rights holders." +} diff --git a/hytale-adapter/src/main/resources/manifest.json b/hytale-adapter/src/main/resources/manifest.json new file mode 100644 index 0000000..15ecead --- /dev/null +++ b/hytale-adapter/src/main/resources/manifest.json @@ -0,0 +1,17 @@ +{ + "Group": "dev.projectcapture", + "Name": "ProjectCapture", + "Version": "0.1.0", + "Description": "Unofficial, open-source and non-commercial Pokemon fan mod", + "Authors": [ + { + "Name": "Christian Schindler" + } + ], + "ServerVersion": "0.5.9", + "Dependencies": {}, + "OptionalDependencies": {}, + "DisabledByDefault": false, + "IncludesAssetPack": true, + "Main": "dev.projectcapture.hytale.ProjectCapturePlugin" +} diff --git a/hytale-adapter/src/test/java/dev/projectcapture/hytale/persistence/JsonStateStoreTest.java b/hytale-adapter/src/test/java/dev/projectcapture/hytale/persistence/JsonStateStoreTest.java new file mode 100644 index 0000000..6cf33f1 --- /dev/null +++ b/hytale-adapter/src/test/java/dev/projectcapture/hytale/persistence/JsonStateStoreTest.java @@ -0,0 +1,45 @@ +package dev.projectcapture.hytale.persistence; + +import com.fasterxml.jackson.databind.ObjectMapper; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.io.TempDir; + +import java.nio.file.Path; + +import static org.assertj.core.api.Assertions.assertThat; +import static org.assertj.core.api.Assertions.assertThatThrownBy; + +class JsonStateStoreTest { + private static final ObjectMapper MAPPER = new ObjectMapper(); + + @TempDir + Path temporaryDirectory; + + @Test + void roundTripsVersionedState() { + JsonStateStore store = new JsonStateStore(temporaryDirectory); + store.initialize(); + store.write("player-01", MAPPER.createObjectNode().put("partySize", 6)); + + assertThat(store.read("player-01").path("partySize").asInt()).isEqualTo(6); + } + + @Test + void rejectsFilesystemPathsAsSaveIds() { + JsonStateStore store = new JsonStateStore(temporaryDirectory); + store.initialize(); + + assertThatThrownBy(() -> store.write("../../launcher", MAPPER.createObjectNode())) + .isInstanceOf(IllegalArgumentException.class) + .hasMessageContaining("Invalid logical save id"); + } + + @Test + void missingStateReturnsNull() { + JsonStateStore store = new JsonStateStore(temporaryDirectory); + store.initialize(); + + assertThat(store.read("missing")).isNull(); + } +} + diff --git a/settings.gradle.kts b/settings.gradle.kts new file mode 100644 index 0000000..931a81e --- /dev/null +++ b/settings.gradle.kts @@ -0,0 +1,8 @@ +rootProject.name = "ProjectCapture" + +include( + "engine", + "hytale-adapter", + "content-pokemon", + "content-tools", +)