diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..f91f646 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,12 @@ +# +# https://help.github.com/articles/dealing-with-line-endings/ +# +# Linux start script should use lf +/gradlew text eol=lf + +# These are Windows script files and should use crlf +*.bat text eol=crlf + +# Binary files should be left untouched +*.jar binary + diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..1b6985c --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +# Ignore Gradle project-specific cache directory +.gradle + +# Ignore Gradle build output directory +build diff --git a/build.gradle.kts b/build.gradle.kts new file mode 100644 index 0000000..f9583ac --- /dev/null +++ b/build.gradle.kts @@ -0,0 +1,42 @@ +group = "net.hareworks" +version = "1.0" + +plugins { + kotlin("jvm") version "2.2.21" + id("de.eldoria.plugin-yml.paper") version "0.8.0" + id("com.gradleup.shadow") version "9.2.2" +} +repositories { + mavenCentral() + maven("https://repo.papermc.io/repository/maven-public/") +} + +dependencies { + compileOnly("io.papermc.paper:paper-api:1.21.10-R0.1-SNAPSHOT") + implementation("org.jetbrains.kotlin:kotlin-stdlib") + implementation("net.hareworks:kommand-lib:1.1") + implementation("net.hareworks:permits-lib:1.1") + implementation("net.kyori:adventure-text-minimessage:4.17.0") + implementation("net.kyori:adventure-text-serializer-plain:4.17.0") +} + +kotlin { + jvmToolchain(21) +} + +paper { + main = "net.hareworks.npc_mannequin.Plugin" + name = "MannequinNPC" + version = project.version as String + apiVersion = "1.21" + description = "Mannequin!" + authors = listOf("Hareworks") +} +tasks { + withType { + archiveBaseName.set("MannequinNPC") + } + shadowJar { + archiveClassifier.set("min") + } +} diff --git a/gradle.properties b/gradle.properties new file mode 100644 index 0000000..d9c7950 --- /dev/null +++ b/gradle.properties @@ -0,0 +1,6 @@ +org.gradle.configuration-cache=true +org.gradle.parallel=true +org.gradle.caching=true +org.gradle.daemon=false + +kotlin.stdlib.default.dependency=false diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml new file mode 100644 index 0000000..4ac3234 --- /dev/null +++ b/gradle/libs.versions.toml @@ -0,0 +1,2 @@ +# This file was generated by the Gradle 'init' task. +# https://docs.gradle.org/current/userguide/platforms.html#sub::toml-dependencies-format diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..1b33c55 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..d4081da --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,7 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-8.14.3-bin.zip +networkTimeout=10000 +validateDistributionUrl=true +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100755 index 0000000..23d15a9 --- /dev/null +++ b/gradlew @@ -0,0 +1,251 @@ +#!/bin/sh + +# +# Copyright © 2015-2021 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" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000..db3a6ac --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,94 @@ +@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 diff --git a/kommand-lib b/kommand-lib new file mode 160000 index 0000000..6c62d33 --- /dev/null +++ b/kommand-lib @@ -0,0 +1 @@ +Subproject commit 6c62d3306e2cc0e0fefe8ec7fb9b64a47caae3cb diff --git a/main/kotlin/net/hareworks/npc-mannequin/Plugin.kt b/main/kotlin/net/hareworks/npc-mannequin/Plugin.kt new file mode 100644 index 0000000..03367b0 --- /dev/null +++ b/main/kotlin/net/hareworks/npc-mannequin/Plugin.kt @@ -0,0 +1,24 @@ +package net.hareworks.npc_mannequin + +import net.hareworks.kommand_lib.KommandLib +import net.hareworks.permits_lib.PermitsLib +import org.bukkit.plugin.ServicePriority +import org.bukkit.plugin.java.JavaPlugin + +class GhostDisplaysPlugin : JavaPlugin() { + private var permissionSession: MutationSession? = null + private var kommand: KommandLib? = null + + override fun onEnable() { + instance = this + } + + override fun onDisable() { + instance = null + } + + companion object { + @Volatile + private var instance: GhostDisplaysPlugin? = null + } +} diff --git a/note-mannequin.md b/note-mannequin.md new file mode 100644 index 0000000..6ad8594 --- /dev/null +++ b/note-mannequin.md @@ -0,0 +1,64 @@ +# Mannequinエンティティ技術メモ + +Minecraft Java Edition 1.21.9(The Copper Age)で正式追加された `minecraft:mannequin` の仕様を、データパック/プラグイン制作者向けに整理する。 + +## 更新タイムライン +- **2025-09-02 Snapshot 25w36a(Data Pack 86.0)** + コマンド専用の技術的エンティティとしてマンネキンが初登場。`below_score` 表示欄に「NPC」ラベルが常時出るプレイヤー型エンティティとして実装された。[^snapshot] +- **2025-09-16 Java 1.21.9 Pre-release 1(Data Pack 87.1)** + `description` のカスタマイズ機能と、スポナーなどのデータコンポーネント経由で `minecraft:profile` を受け取る処理が追加され、演出用途が一気に実用化。[^prerelease] +- **2025-09-30 Java 1.21.9 リリース** + Mannequin が正式仕様化。`fetchprofile` コマンドにより取得したプレイヤープロファイルを即時に適用できるなど、表示系データが安定した。[^release] + +## 基本仕様とスポーン +- `/summon minecraft:mannequin` のみで生成できる。スポーンエッグや自然生成は存在しない。 +- Living Entity として扱われるため、装備・手持ちアイテム、NBT 属性、ポーション効果、被ダメージ、ノックバックなどがプレイヤー同様に機能する。 +- `below_score` 位置にはデフォルトで `entity.minecraft.mannequin.label`(表示テキスト「NPC」)が描画される。`description`/`hide_description` によって文言や表示有無を制御可能。 +- `main_hand` フィールドで左右の利き手スイッチができ、視覚的な持ち手を固定できる。 + +## データフィールド一覧(1.21.9) +| フィールド | 型 / 値 | 既定値 | 用途 | +| --- | --- | --- | --- | +| `profile` | `minecraft:profile` 互換 | `{}` | 表示するプレイヤープロファイル、または独自マネキンプロファイル。詳細は後述。 | +| `hidden_layers` | 文字列リスト | `[]` | `cape`, `jacket`, `left_sleeve`, `right_sleeve`, `left_pants_leg`, `right_pants_leg`, `hat` から選び、レイヤーごとに表示を非表示化。 | +| `pose` | `standing`,`crouching`,`swimming`,`fall_flying`,`sleeping` | `standing` | 5 種類の静的姿勢を固定。 | +| `main_hand` | `left` / `right` | `right` | 利き手。手持ちアイテムの表示向きを切り替える。 | +| `immovable` | `true` / `false` | `false` | `true` でノックバックやピストン押し出しを無効化。 | +| `description` | Text Component | 既定(「NPC」) | `below_score` 表示欄に任意メッセージを表示。 | +| `hide_description` | `true` / `false` | `false` | `true` で `below_score` 表示自体を非表示に。 | + +## `profile` フィールド詳細 +- **プレイヤープロファイル指定** + `profile:{name:"ExamplePlayer"}` のように UUID/名前を渡すと、実プレイヤーと同じスキン・ケープ情報が適用される。 +- **マネキン固有プロファイル** + `profile:{texture:"entity/player/wide/steve",cape:"entity/cape/mojang",elytra:"entity/elytra/phantom",model:"slim"}` のように、テクスチャパスやケープ、エリトラ、`wide`/`slim` モデルを直接定義できる。いずれかを省略した場合はデフォルトスキンもしくはプレイヤープロファイル上の値が使われる。 +- **データコンポーネントとの連携** + Data Pack 87.1 以降はスポナーやアイテムの `minecraft:profile` コンポーネントからも同様の構造で渡せるため、プレイヤーヘッドと同じ仕組みでマネキンの見た目を配布できる。 + +## 表示・姿勢・移動制御の実装ポイント +- 姿勢は NBT 固定だが、必要ならコマンドチェーンで `data merge entity` を繰り返して状況に応じて切り替えできる。`swimming` と `fall_flying` は水平姿勢の検証や演出に便利。 +- `immovable:1b` と `Invulnerable:1b` を併用するとデコレーション用途で事故を防げる。`NoGravity:1b` も併用すれば空中展示が容易。 +- `hidden_layers` の組み合わせで帽子だけを非表示にしたり、半袖スキンの腕ラインを消すなど細部調整が可能。 +- `description` に JSON テキストを渡すことで、クリックイベントや色付き案内文をマネキン直下に表示できる。`hide_description:1b` で完全なダミーにもできる。 + +## 代表的な NBT テンプレート +```mcfunction +/summon minecraft:mannequin ~ ~1 ~ { + profile:{name:"PlayerName"}, + pose:"crouching", + hidden_layers:["cape","hat"], + main_hand:"left", + immovable:1b, + description:'{"text":"Quest NPC","color":"gold"}' +} +``` + +## 制作フロー上のTips +- **`fetchprofile` コマンド活用**:1.21.9で追加された `fetchprofile ` 実行後は、ログにプレイヤープロファイルをコピーしたり、その場でマネキンを召喚するクリックテキストが表示される。取得した JSON をデータパック内で流用すれば大量のスキンを手作業で収集する必要がない。[^release] +- **データパックのバージョンガード**:`pose` などは Data Pack 87.1 で追加されたため、`pack.mcmeta` の `data_pack_format` と併せて `execute if data` による存在チェックを入れると、古いワールドでも安全に無視できる。 +- **スポナー/アイテム経由の配布**:`component:{minecraft:profile:{...}}` を持つスポーンエッグやコマンドブロックを用意しておくと、ワールド配布時に `/summon` 記述を隠蔽できる。 + +## 参考資料 +[^snapshot]: [Minecraft Snapshot 25w36a/b – Java Team (2025-09-02)](https://www.minecraft.net/fr-fr/article/minecraft-snapshot-25w36a) +[^prerelease]: [Minecraft Java Edition 1.21.9 Pre-Release 1 – Minecraft Feedback (2025-09-16)](https://feedback.minecraft.net/hc/en-us/articles/39609762119053-Minecraft-Java-Edition-1-21-9-Pre-Release-1) +[^release]: [Minecraft Java Edition 1.21.9 – minecraft.net (2025-09-30)](https://www.minecraft.net/en-us/article/minecraft-java-edition-1-21-9) diff --git a/settings.gradle.kts b/settings.gradle.kts new file mode 100644 index 0000000..b135446 --- /dev/null +++ b/settings.gradle.kts @@ -0,0 +1,10 @@ +/* + * This file was generated by the Gradle 'init' task. + * + * The settings file is used to specify which projects to include in your build. + * For more detailed information on multi-project builds, please refer to https://docs.gradle.org/8.14.3/userguide/multi_project_builds.html in the Gradle documentation. + */ + +rootProject.name = "GhostDisplays" + +includeBuild("kommand-lib")