Initial CopperKeys 1.0.0 release for Paper 26.2.
Includes GitLab release pipeline with jar and resource-pack zip artifacts. Co-authored-by: Cursor <cursoragent@cursor.com>
@@ -0,0 +1,12 @@
1
.gradle/
2
build/
3
out/
4
bin/
5
*.iml
6
.idea/
7
.vscode/
8
*.class
9
*.log
10
version.env
11
.DS_Store
12
Thumbs.db
@@ -0,0 +1,12 @@1
.gradle/2
build/3
out/4
bin/5
*.iml6
.idea/7
.vscode/8
*.class9
*.log10
version.env11
.DS_Store12
Thumbs.db@@ -0,0 +1,125 @@
1
# Release pipeline: runs when a version tag is created (e.g. v1.8.0 or 1.8.0).
2
#
3
# Required CI/CD variable:
4
# CI_PUSH_TOKEN — Project Access Token (Maintainer) with scopes:
5
# `write_repository`, `self_rotate` (or `api`), and `api`
6
# (api is required to write the rotated token back to this variable).
7
#
8
# Flow:
9
# 1. validate — reject invalid or non-increasing versions
10
# 2. bump — update version in project files and push commit (ci.skip; tag unchanged)
11
# 3. build — produce CopperKeys-<version>.jar + resource-pack zip; upload to Package Registry
12
# 4. release — publish a GitLab Release with jar and resource-pack zip attached
13
# 5. rotate-token — self-rotate CI_PUSH_TOKEN and update the CI/CD variable
14
15
workflow:
16
rules:
17
- if: $CI_COMMIT_TAG
18
19
variables:
20
GIT_DEPTH: "0"
21
GIT_FETCH_EXTRA_FLAGS: "--tags"
22
GRADLE_OPTS: "-Dorg.gradle.daemon=false"
23
PACKAGE_NAME: copperkeys
24
JAR_NAME: "CopperKeys-${VERSION}.jar"
25
PACK_NAME: "CopperKeys-resourcepack-${VERSION}.zip"
26
27
stages:
28
- validate
29
- bump
30
- build
31
- release
32
- rotate
33
34
.validate_image:
35
image: alpine:3.20
36
before_script:
37
- apk add --no-cache bash git grep coreutils
38
- git fetch --tags --force origin
39
- chmod +x scripts/release.sh
40
41
validate:version:
42
extends: .validate_image
43
stage: validate
44
script:
45
- ./scripts/release.sh validate
46
artifacts:
47
reports:
48
dotenv: version.env
49
paths:
50
- version.env
51
52
bump:version:
53
extends: .validate_image
54
stage: bump
55
needs:
56
- job: validate:version
57
artifacts: true
58
script:
59
- ./scripts/release.sh bump
60
artifacts:
61
reports:
62
dotenv: version.env
63
paths:
64
- version.env
65
- build.gradle.kts
66
- src/main/resources/plugin.yml
67
- README.md
68
- src/main/java/nl/timfalken/copperkeys/CopperKeysPlugin.java
69
70
build:artifacts:
71
stage: build
72
image: gradle:jdk25
73
needs:
74
- job: bump:version
75
artifacts: true
76
before_script:
77
- apt-get update -qq && apt-get install -y -qq curl zip >/dev/null
78
- chmod +x scripts/release.sh
79
script:
80
- test -n "${VERSION}"
81
- gradle --no-daemon clean jar zipResourcePack
82
- test -f "build/libs/${JAR_NAME}"
83
- test -f "build/dist/${PACK_NAME}"
84
- ls -la "build/libs/${JAR_NAME}" "build/dist/${PACK_NAME}"
85
- ./scripts/release.sh upload
86
artifacts:
87
reports:
88
dotenv: version.env
89
paths:
90
- "build/libs/CopperKeys-*.jar"
91
- "build/dist/CopperKeys-resourcepack-*.zip"
92
- version.env
93
expire_in: 30 days
94
95
release:gitlab:
96
stage: release
97
image: registry.gitlab.com/gitlab-org/release-cli:latest
98
needs:
99
- job: build:artifacts
100
artifacts: true
101
script:
102
- echo "Publishing GitLab Release for ${TAG} (version ${VERSION})"
103
release:
104
name: "CopperKeys $VERSION"
105
tag_name: "$TAG"
106
description: "Release $VERSION of CopperKeys."
107
assets:
108
links:
109
- name: "CopperKeys-$VERSION.jar"
110
url: "$CI_API_V4_URL/projects/$CI_PROJECT_ID/packages/generic/$PACKAGE_NAME/$VERSION/CopperKeys-$VERSION.jar"
111
link_type: package
112
- name: "CopperKeys-resourcepack-$VERSION.zip"
113
url: "$CI_API_V4_URL/projects/$CI_PROJECT_ID/packages/generic/$PACKAGE_NAME/$VERSION/CopperKeys-resourcepack-$VERSION.zip"
114
link_type: package
115
116
rotate:push-token:
117
image: alpine:3.20
118
stage: rotate
119
needs:
120
- job: release:gitlab
121
before_script:
122
- apk add --no-cache bash curl jq coreutils
123
- chmod +x scripts/release.sh
124
script:
125
- ./scripts/release.sh rotate-token
@@ -0,0 +1,125 @@1
# Release pipeline: runs when a version tag is created (e.g. v1.8.0 or 1.8.0).
2
#
3
# Required CI/CD variable:
4
# CI_PUSH_TOKEN — Project Access Token (Maintainer) with scopes:
5
# `write_repository`, `self_rotate` (or `api`), and `api`
6
# (api is required to write the rotated token back to this variable).
7
#
8
# Flow:
9
# 1. validate — reject invalid or non-increasing versions
10
# 2. bump — update version in project files and push commit (ci.skip; tag unchanged)
11
# 3. build — produce CopperKeys-<version>.jar + resource-pack zip; upload to Package Registry
12
# 4. release — publish a GitLab Release with jar and resource-pack zip attached
13
# 5. rotate-token — self-rotate CI_PUSH_TOKEN and update the CI/CD variable
14
15
workflow:
16
rules:
17
- if: $CI_COMMIT_TAG
18
19
variables:
20
GIT_DEPTH: "0"
21
GIT_FETCH_EXTRA_FLAGS: "--tags"
22
GRADLE_OPTS: "-Dorg.gradle.daemon=false"
23
PACKAGE_NAME: copperkeys
24
JAR_NAME: "CopperKeys-${VERSION}.jar"
25
PACK_NAME: "CopperKeys-resourcepack-${VERSION}.zip"
26
27
stages:
28
- validate
29
- bump
30
- build
31
- release
32
- rotate
33
34
.validate_image:
35
image: alpine:3.20
36
before_script:
37
- apk add --no-cache bash git grep coreutils
38
- git fetch --tags --force origin
39
- chmod +x scripts/release.sh
40
41
validate:version:
42
extends: .validate_image
43
stage: validate
44
script:
45
- ./scripts/release.sh validate
46
artifacts:
47
reports:
48
dotenv: version.env
49
paths:
50
- version.env
51
52
bump:version:
53
extends: .validate_image
54
stage: bump
55
needs:
56
- job: validate:version
57
artifacts: true
58
script:
59
- ./scripts/release.sh bump
60
artifacts:
61
reports:
62
dotenv: version.env
63
paths:
64
- version.env
65
- build.gradle.kts
66
- src/main/resources/plugin.yml
67
- README.md
68
- src/main/java/nl/timfalken/copperkeys/CopperKeysPlugin.java
69
70
build:artifacts:
71
stage: build
72
image: gradle:jdk25
73
needs:
74
- job: bump:version
75
artifacts: true
76
before_script:
77
- apt-get update -qq && apt-get install -y -qq curl zip >/dev/null
78
- chmod +x scripts/release.sh
79
script:
80
- test -n "${VERSION}"
81
- gradle --no-daemon clean jar zipResourcePack
82
- test -f "build/libs/${JAR_NAME}"
83
- test -f "build/dist/${PACK_NAME}"
84
- ls -la "build/libs/${JAR_NAME}" "build/dist/${PACK_NAME}"
85
- ./scripts/release.sh upload
86
artifacts:
87
reports:
88
dotenv: version.env
89
paths:
90
- "build/libs/CopperKeys-*.jar"
91
- "build/dist/CopperKeys-resourcepack-*.zip"
92
- version.env
93
expire_in: 30 days
94
95
release:gitlab:
96
stage: release
97
image: registry.gitlab.com/gitlab-org/release-cli:latest
98
needs:
99
- job: build:artifacts
100
artifacts: true
101
script:
102
- echo "Publishing GitLab Release for ${TAG} (version ${VERSION})"
103
release:
104
name: "CopperKeys $VERSION"
105
tag_name: "$TAG"
106
description: "Release $VERSION of CopperKeys."
107
assets:
108
links:
109
- name: "CopperKeys-$VERSION.jar"
110
url: "$CI_API_V4_URL/projects/$CI_PROJECT_ID/packages/generic/$PACKAGE_NAME/$VERSION/CopperKeys-$VERSION.jar"
111
link_type: package
112
- name: "CopperKeys-resourcepack-$VERSION.zip"
113
url: "$CI_API_V4_URL/projects/$CI_PROJECT_ID/packages/generic/$PACKAGE_NAME/$VERSION/CopperKeys-resourcepack-$VERSION.zip"
114
link_type: package
115
116
rotate:push-token:
117
image: alpine:3.20
118
stage: rotate
119
needs:
120
- job: release:gitlab
121
before_script:
122
- apk add --no-cache bash curl jq coreutils
123
- chmod +x scripts/release.sh
124
script:
125
- ./scripts/release.sh rotate-token
@@ -0,0 +1,40 @@
1
# CopperKeys
2
3
Paper 26.2 plugin that adds a non-stackable key item and event-driven locks for containers and openable blocks.
4
5
## Requirements
6
7
- Paper 26.2
8
- Java 25
9
- Resource pack in `resource-pack/`
10
11
## Build
12
13
```bash
14
gradle clean build
15
```
16
17
The plugin jar is created in `build/libs/`.
18
19
## Resource pack
20
21
Zip the *contents* of `resource-pack/` so `pack.mcmeta` is at the root of the zip. A ready-to-use zip is distributed alongside the source archive.
22
23
The supplied texture is the user's 16x16 key sprite and is selected through the `minecraft:item_model` component (`copperkeys:key`).
24
25
## Behaviour
26
27
- Two copper nuggets placed diagonally craft a `Blank Key`.
28
- Keys have max stack size 1.
29
- Right-click a supported unlocked block with a Blank Key to bind it.
30
- Bound keys display `Unlocks <block name>`.
31
- Containers require the matching key somewhere in the player's inventory, including recursively inside Bundles and Shulker Boxes.
32
- Locked doors/trapdoors/fence gates may always be closed, but cannot be opened without the matching key. Redstone may close them but may not open them.
33
- Hopper transfers, hopper pickup/search and Copper Golem target validation are denied for locked containers.
34
- Breaking either half of a double chest or either half of a door breaks the binding.
35
- Keys found online are immediately blanked when their bound block is broken. Keys elsewhere are lazily blanked the next time the plugin encounters them.
36
- No periodic world or inventory scan is used.
37
38
## Persistence
39
40
Block bindings are stored in `plugins/CopperKeys/locks.yml`. The binding UUID itself is stored on the key item using the Persistent Data Container.
@@ -0,0 +1,40 @@1
# CopperKeys2
3
Paper 26.2 plugin that adds a non-stackable key item and event-driven locks for containers and openable blocks.4
5
## Requirements6
7
- Paper 26.28
- Java 259
- Resource pack in `resource-pack/`10
11
## Build12
13
```bash14
gradle clean build15
```16
17
The plugin jar is created in `build/libs/`.18
19
## Resource pack20
21
Zip the *contents* of `resource-pack/` so `pack.mcmeta` is at the root of the zip. A ready-to-use zip is distributed alongside the source archive.22
23
The supplied texture is the user's 16x16 key sprite and is selected through the `minecraft:item_model` component (`copperkeys:key`).24
25
## Behaviour26
27
- Two copper nuggets placed diagonally craft a `Blank Key`.28
- Keys have max stack size 1.29
- Right-click a supported unlocked block with a Blank Key to bind it.30
- Bound keys display `Unlocks <block name>`.31
- Containers require the matching key somewhere in the player's inventory, including recursively inside Bundles and Shulker Boxes.32
- Locked doors/trapdoors/fence gates may always be closed, but cannot be opened without the matching key. Redstone may close them but may not open them.33
- Hopper transfers, hopper pickup/search and Copper Golem target validation are denied for locked containers.34
- Breaking either half of a double chest or either half of a door breaks the binding.35
- Keys found online are immediately blanked when their bound block is broken. Keys elsewhere are lazily blanked the next time the plugin encounters them.36
- No periodic world or inventory scan is used.37
38
## Persistence39
40
Block bindings are stored in `plugins/CopperKeys/locks.yml`. The binding UUID itself is stored on the key item using the Persistent Data Container.@@ -0,0 +1,41 @@
1
plugins {
2
java
3
}
4
5
group = "nl.timfalken"
6
version = "1.0.0"
7
8
repositories {
9
maven {
10
name = "papermc"
11
url = uri("https://repo.papermc.io/repository/maven-public/")
12
}
13
}
14
15
dependencies {
16
compileOnly("io.papermc.paper:paper-api:26.2.build.112-stable")
17
}
18
19
java {
20
toolchain.languageVersion.set(JavaLanguageVersion.of(25))
21
}
22
23
tasks.withType<JavaCompile>().configureEach {
24
options.encoding = "UTF-8"
25
options.release.set(25)
26
}
27
28
tasks.processResources {
29
filteringCharset = "UTF-8"
30
}
31
32
tasks.jar {
33
archiveBaseName.set("CopperKeys")
34
}
35
36
tasks.register<Zip>("zipResourcePack") {
37
archiveBaseName.set("CopperKeys-resourcepack")
38
archiveVersion.set(project.version.toString())
39
destinationDirectory.set(layout.buildDirectory.dir("dist"))
40
from("resource-pack")
41
}
@@ -0,0 +1,41 @@1
plugins {2
java3
}4
5
group = "nl.timfalken"6
version = "1.0.0"7
8
repositories {9
maven {10
name = "papermc"11
url = uri("https://repo.papermc.io/repository/maven-public/")12
}13
}14
15
dependencies {16
compileOnly("io.papermc.paper:paper-api:26.2.build.112-stable")17
}18
19
java {20
toolchain.languageVersion.set(JavaLanguageVersion.of(25))21
}22
23
tasks.withType<JavaCompile>().configureEach {24
options.encoding = "UTF-8"25
options.release.set(25)26
}27
28
tasks.processResources {29
filteringCharset = "UTF-8"30
}31
32
tasks.jar {33
archiveBaseName.set("CopperKeys")34
}35
36
tasks.register<Zip>("zipResourcePack") {37
archiveBaseName.set("CopperKeys-resourcepack")38
archiveVersion.set(project.version.toString())39
destinationDirectory.set(layout.buildDirectory.dir("dist"))40
from("resource-pack")41
}@@ -0,0 +1,6 @@
1
{
2
"model": {
3
"type": "minecraft:model",
4
"model": "copperkeys:item/key"
5
}
6
}
@@ -0,0 +1,6 @@1
{2
"model": {3
"type": "minecraft:model",4
"model": "copperkeys:item/key"5
}6
}@@ -0,0 +1,6 @@
1
{
2
"parent": "minecraft:item/generated",
3
"textures": {
4
"layer0": "copperkeys:item/key"
5
}
6
}
@@ -0,0 +1,6 @@1
{2
"parent": "minecraft:item/generated",3
"textures": {4
"layer0": "copperkeys:item/key"5
}6
}The contents of this binary file are not shown.
@@ -0,0 +1,6 @@
1
{
2
"pack": {
3
"pack_format": 88,
4
"description": "CopperKeys resource pack for Minecraft 26.2"
5
}
6
}
@@ -0,0 +1,6 @@1
{2
"pack": {3
"pack_format": 88,4
"description": "CopperKeys resource pack for Minecraft 26.2"5
}6
}@@ -0,0 +1,249 @@
1
#!/usr/bin/env bash
2
# Release helpers for GitLab CI.
3
set -euo pipefail
4
5
VERSION_REGEX='^v?(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)$'
6
7
normalize_version() {
8
echo "${1#v}"
9
}
10
11
is_valid_version_tag() {
12
[[ "$1" =~ $VERSION_REGEX ]]
13
}
14
15
# True if $1 is strictly greater than $2 (semver X.Y.Z).
16
is_newer_version() {
17
local a b
18
a="$(normalize_version "$1")"
19
b="$(normalize_version "$2")"
20
[[ "$a" != "$b" ]] && [[ "$(printf '%s\n' "$a" "$b" | sort -V | tail -n1)" == "$a" ]]
21
}
22
23
write_version_env() {
24
local version="$1"
25
local tag="$2"
26
{
27
echo "VERSION=${version}"
28
echo "TAG=${tag}"
29
} > version.env
30
}
31
32
validate() {
33
local tag="${CI_COMMIT_TAG:?CI_COMMIT_TAG is required}"
34
local version newest
35
36
if ! is_valid_version_tag "$tag"; then
37
echo "ERROR: Tag '${tag}' has an invalid format."
38
echo "Expected: v1.7.0, 1.7.10, 1.8.0, ..."
39
exit 1
40
fi
41
42
version="$(normalize_version "$tag")"
43
echo "Validated release tag: ${tag} (version ${version})"
44
45
mapfile -t tags < <(
46
git tag -l \
47
| grep -E "$VERSION_REGEX" \
48
| grep -vxF "$tag" \
49
|| true
50
)
51
52
if ((${#tags[@]} == 0)); then
53
echo "No previous release tags found; accepting ${version} as first release."
54
write_version_env "$version" "$tag"
55
return 0
56
fi
57
58
newest="$(printf '%s\n' "${tags[@]}" | sed 's/^v//' | sort -V | tail -n1)"
59
echo "Previous release version: ${newest}"
60
61
if ! is_newer_version "$version" "$newest"; then
62
echo "ERROR: Release version ${version} is not greater than previous release ${newest}."
63
exit 1
64
fi
65
66
write_version_env "$version" "$tag"
67
echo "Version check passed: ${version} > ${newest}"
68
}
69
70
bump_files() {
71
local version="${1:?version required}"
72
73
sed -i "s/^version = \".*\"/version = \"${version}\"/" build.gradle.kts
74
sed -i -E "s/^version: ['\"]?[0-9]+\.[0-9]+\.[0-9]+['\"]?/version: ${version}/" \
75
src/main/resources/plugin.yml
76
sed -i "1s/.*/# CopperKeys ${version}/" README.md
77
sed -i -E "s/CopperKeys [0-9]+\.[0-9]+\.[0-9]+ enabled/CopperKeys ${version} enabled/" \
78
src/main/java/nl/timfalken/copperkeys/CopperKeysPlugin.java
79
80
echo "Updated project files to version ${version}"
81
}
82
83
require_push_token() {
84
if [[ -n "${CI_PUSH_TOKEN:-}" ]]; then
85
return 0
86
fi
87
88
cat <<'EOF' >&2
89
ERROR: CI_PUSH_TOKEN is not available in this job.
90
91
The variable may exist in Settings → CI/CD → Variables but still be hidden here if:
92
1. It is Protected, while this tag/branch is not protected
93
→ Protect tag pattern (e.g. *) or uncheck Protected on the variable
94
2. Its Environment scope is not "*"
95
3. The key is misspelled (must be exactly CI_PUSH_TOKEN)
96
97
EOF
98
exit 1
99
}
100
101
bump_and_push() {
102
local version="${1:?version required}"
103
local tag="${2:?tag required}"
104
local token branch
105
106
require_push_token
107
token="${CI_PUSH_TOKEN}"
108
branch="${CI_DEFAULT_BRANCH:?CI_DEFAULT_BRANCH is required}"
109
110
git config user.email "gitlab-ci@${CI_SERVER_HOST:-gitlab.com}"
111
git config user.name "GitLab CI"
112
113
bump_files "$version"
114
115
# Stage only versioned project files (never CI artifacts like version.env).
116
git add -- \
117
build.gradle.kts \
118
src/main/resources/plugin.yml \
119
README.md \
120
src/main/java/nl/timfalken/copperkeys/CopperKeysPlugin.java
121
122
if git diff --cached --quiet; then
123
echo "No version file changes to commit (already at ${version})."
124
else
125
git commit -m "chore: bump version to ${version}"
126
fi
127
128
git remote set-url origin "https://oauth2:${token}@${CI_SERVER_HOST}/${CI_PROJECT_PATH}.git"
129
130
# Push version bump only. Protected tags cannot be moved/updated.
131
git push origin "HEAD:refs/heads/${branch}" -o ci.skip
132
133
echo "Pushed version bump for ${tag} to ${branch} (ci.skip). Tag left unchanged."
134
}
135
136
upload_file() {
137
local file="$1"
138
local package_url="$2"
139
140
if [[ ! -f "$file" ]]; then
141
echo "ERROR: Expected file not found: ${file}"
142
return 1
143
fi
144
145
curl --fail --show-error --header "JOB-TOKEN: ${CI_JOB_TOKEN}" \
146
--upload-file "$file" \
147
"$package_url"
148
149
echo "Uploaded ${file}"
150
echo " -> ${package_url}"
151
}
152
153
upload_package() {
154
local version="${1:?version required}"
155
local jar="build/libs/CopperKeys-${version}.jar"
156
local pack="build/dist/CopperKeys-resourcepack-${version}.zip"
157
local base_url package_jar_url package_pack_url
158
159
if [[ ! -f "$jar" ]]; then
160
echo "ERROR: Expected jar not found: ${jar}"
161
ls -la build/libs/ || true
162
exit 1
163
fi
164
if [[ ! -f "$pack" ]]; then
165
echo "ERROR: Expected resource pack zip not found: ${pack}"
166
ls -la build/dist/ || true
167
exit 1
168
fi
169
170
base_url="${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/generic/copperkeys/${version}"
171
package_jar_url="${base_url}/CopperKeys-${version}.jar"
172
package_pack_url="${base_url}/CopperKeys-resourcepack-${version}.zip"
173
174
upload_file "$jar" "$package_jar_url"
175
upload_file "$pack" "$package_pack_url"
176
177
{
178
echo "PACKAGE_URL=${package_jar_url}"
179
echo "RESOURCE_PACK_URL=${package_pack_url}"
180
} > package.env
181
}
182
183
# Self-rotate CI_PUSH_TOKEN and write the new value back to the CI/CD variable.
184
# Requires scopes: write_repository + self_rotate (or api), and api to update variables.
185
# Project access token role should be Maintainer (needed to edit CI/CD variables).
186
rotate_push_token() {
187
local old_token expires_at response new_token var_meta protected masked raw scope
188
189
require_push_token
190
old_token="${CI_PUSH_TOKEN}"
191
192
expires_at="$(date -u -d '+365 days' +%Y-%m-%d)"
193
echo "Rotating CI_PUSH_TOKEN (new expiry ${expires_at})..."
194
195
response="$(curl --fail --silent --show-error \
196
--request POST \
197
--header "PRIVATE-TOKEN: ${old_token}" \
198
--header "Content-Type: application/json" \
199
--data "{\"expires_at\":\"${expires_at}\"}" \
200
"${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/access_tokens/self/rotate")"
201
202
new_token="$(jq -er '.token' <<<"${response}")"
203
if [[ -z "${new_token}" || "${new_token}" == "null" ]]; then
204
echo "ERROR: Token rotation response did not include a new token."
205
echo "${response}"
206
exit 1
207
fi
208
209
var_meta="$(curl --fail --silent --show-error \
210
--header "PRIVATE-TOKEN: ${new_token}" \
211
"${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/variables/CI_PUSH_TOKEN")"
212
213
protected="$(jq -r '.protected' <<<"${var_meta}")"
214
masked="$(jq -r '.masked' <<<"${var_meta}")"
215
raw="$(jq -r '.raw // false' <<<"${var_meta}")"
216
scope="$(jq -r '.environment_scope // "*"' <<<"${var_meta}")"
217
218
curl --fail --silent --show-error \
219
--request PUT \
220
--header "PRIVATE-TOKEN: ${new_token}" \
221
--form "value=${new_token}" \
222
--form "protected=${protected}" \
223
--form "masked=${masked}" \
224
--form "raw=${raw}" \
225
--form "environment_scope=${scope}" \
226
"${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/variables/CI_PUSH_TOKEN" \
227
>/dev/null
228
229
echo "CI_PUSH_TOKEN rotated and CI/CD variable updated."
230
}
231
232
case "${1:-}" in
233
validate) validate ;;
234
bump)
235
# shellcheck disable=SC1091
236
source version.env
237
bump_and_push "$VERSION" "$TAG"
238
;;
239
upload)
240
# shellcheck disable=SC1091
241
source version.env
242
upload_package "$VERSION"
243
;;
244
rotate-token) rotate_push_token ;;
245
*)
246
echo "Usage: $0 {validate|bump|upload|rotate-token}"
247
exit 1
248
;;
249
esac
@@ -0,0 +1,249 @@1
#!/usr/bin/env bash2
# Release helpers for GitLab CI.3
set -euo pipefail4
5
VERSION_REGEX='^v?(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)$'6
7
normalize_version() {8
echo "${1#v}"9
}10
11
is_valid_version_tag() {12
[[ "$1" =~ $VERSION_REGEX ]]13
}14
15
# True if $1 is strictly greater than $2 (semver X.Y.Z).16
is_newer_version() {17
local a b18
a="$(normalize_version "$1")"19
b="$(normalize_version "$2")"20
[[ "$a" != "$b" ]] && [[ "$(printf '%s\n' "$a" "$b" | sort -V | tail -n1)" == "$a" ]]21
}22
23
write_version_env() {24
local version="$1"25
local tag="$2"26
{27
echo "VERSION=${version}"28
echo "TAG=${tag}"29
} > version.env30
}31
32
validate() {33
local tag="${CI_COMMIT_TAG:?CI_COMMIT_TAG is required}"34
local version newest35
36
if ! is_valid_version_tag "$tag"; then37
echo "ERROR: Tag '${tag}' has an invalid format."38
echo "Expected: v1.7.0, 1.7.10, 1.8.0, ..."39
exit 140
fi41
42
version="$(normalize_version "$tag")"43
echo "Validated release tag: ${tag} (version ${version})"44
45
mapfile -t tags < <(46
git tag -l \47
| grep -E "$VERSION_REGEX" \48
| grep -vxF "$tag" \49
|| true50
)51
52
if ((${#tags[@]} == 0)); then53
echo "No previous release tags found; accepting ${version} as first release."54
write_version_env "$version" "$tag"55
return 056
fi57
58
newest="$(printf '%s\n' "${tags[@]}" | sed 's/^v//' | sort -V | tail -n1)"59
echo "Previous release version: ${newest}"60
61
if ! is_newer_version "$version" "$newest"; then62
echo "ERROR: Release version ${version} is not greater than previous release ${newest}."63
exit 164
fi65
66
write_version_env "$version" "$tag"67
echo "Version check passed: ${version} > ${newest}"68
}69
70
bump_files() {71
local version="${1:?version required}"72
73
sed -i "s/^version = \".*\"/version = \"${version}\"/" build.gradle.kts74
sed -i -E "s/^version: ['\"]?[0-9]+\.[0-9]+\.[0-9]+['\"]?/version: ${version}/" \75
src/main/resources/plugin.yml76
sed -i "1s/.*/# CopperKeys ${version}/" README.md77
sed -i -E "s/CopperKeys [0-9]+\.[0-9]+\.[0-9]+ enabled/CopperKeys ${version} enabled/" \78
src/main/java/nl/timfalken/copperkeys/CopperKeysPlugin.java79
80
echo "Updated project files to version ${version}"81
}82
83
require_push_token() {84
if [[ -n "${CI_PUSH_TOKEN:-}" ]]; then85
return 086
fi87
88
cat <<'EOF' >&289
ERROR: CI_PUSH_TOKEN is not available in this job.90
91
The variable may exist in Settings → CI/CD → Variables but still be hidden here if:92
1. It is Protected, while this tag/branch is not protected93
→ Protect tag pattern (e.g. *) or uncheck Protected on the variable94
2. Its Environment scope is not "*"95
3. The key is misspelled (must be exactly CI_PUSH_TOKEN)96
97
EOF98
exit 199
}100
101
bump_and_push() {102
local version="${1:?version required}"103
local tag="${2:?tag required}"104
local token branch105
106
require_push_token107
token="${CI_PUSH_TOKEN}"108
branch="${CI_DEFAULT_BRANCH:?CI_DEFAULT_BRANCH is required}"109
110
git config user.email "gitlab-ci@${CI_SERVER_HOST:-gitlab.com}"111
git config user.name "GitLab CI"112
113
bump_files "$version"114
115
# Stage only versioned project files (never CI artifacts like version.env).116
git add -- \117
build.gradle.kts \118
src/main/resources/plugin.yml \119
README.md \120
src/main/java/nl/timfalken/copperkeys/CopperKeysPlugin.java121
122
if git diff --cached --quiet; then123
echo "No version file changes to commit (already at ${version})."124
else125
git commit -m "chore: bump version to ${version}"126
fi127
128
git remote set-url origin "https://oauth2:${token}@${CI_SERVER_HOST}/${CI_PROJECT_PATH}.git"129
130
# Push version bump only. Protected tags cannot be moved/updated.131
git push origin "HEAD:refs/heads/${branch}" -o ci.skip132
133
echo "Pushed version bump for ${tag} to ${branch} (ci.skip). Tag left unchanged."134
}135
136
upload_file() {137
local file="$1"138
local package_url="$2"139
140
if [[ ! -f "$file" ]]; then141
echo "ERROR: Expected file not found: ${file}"142
return 1143
fi144
145
curl --fail --show-error --header "JOB-TOKEN: ${CI_JOB_TOKEN}" \146
--upload-file "$file" \147
"$package_url"148
149
echo "Uploaded ${file}"150
echo " -> ${package_url}"151
}152
153
upload_package() {154
local version="${1:?version required}"155
local jar="build/libs/CopperKeys-${version}.jar"156
local pack="build/dist/CopperKeys-resourcepack-${version}.zip"157
local base_url package_jar_url package_pack_url158
159
if [[ ! -f "$jar" ]]; then160
echo "ERROR: Expected jar not found: ${jar}"161
ls -la build/libs/ || true162
exit 1163
fi164
if [[ ! -f "$pack" ]]; then165
echo "ERROR: Expected resource pack zip not found: ${pack}"166
ls -la build/dist/ || true167
exit 1168
fi169
170
base_url="${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/generic/copperkeys/${version}"171
package_jar_url="${base_url}/CopperKeys-${version}.jar"172
package_pack_url="${base_url}/CopperKeys-resourcepack-${version}.zip"173
174
upload_file "$jar" "$package_jar_url"175
upload_file "$pack" "$package_pack_url"176
177
{178
echo "PACKAGE_URL=${package_jar_url}"179
echo "RESOURCE_PACK_URL=${package_pack_url}"180
} > package.env181
}182
183
# Self-rotate CI_PUSH_TOKEN and write the new value back to the CI/CD variable.184
# Requires scopes: write_repository + self_rotate (or api), and api to update variables.185
# Project access token role should be Maintainer (needed to edit CI/CD variables).186
rotate_push_token() {187
local old_token expires_at response new_token var_meta protected masked raw scope188
189
require_push_token190
old_token="${CI_PUSH_TOKEN}"191
192
expires_at="$(date -u -d '+365 days' +%Y-%m-%d)"193
echo "Rotating CI_PUSH_TOKEN (new expiry ${expires_at})..."194
195
response="$(curl --fail --silent --show-error \196
--request POST \197
--header "PRIVATE-TOKEN: ${old_token}" \198
--header "Content-Type: application/json" \199
--data "{\"expires_at\":\"${expires_at}\"}" \200
"${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/access_tokens/self/rotate")"201
202
new_token="$(jq -er '.token' <<<"${response}")"203
if [[ -z "${new_token}" || "${new_token}" == "null" ]]; then204
echo "ERROR: Token rotation response did not include a new token."205
echo "${response}"206
exit 1207
fi208
209
var_meta="$(curl --fail --silent --show-error \210
--header "PRIVATE-TOKEN: ${new_token}" \211
"${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/variables/CI_PUSH_TOKEN")"212
213
protected="$(jq -r '.protected' <<<"${var_meta}")"214
masked="$(jq -r '.masked' <<<"${var_meta}")"215
raw="$(jq -r '.raw // false' <<<"${var_meta}")"216
scope="$(jq -r '.environment_scope // "*"' <<<"${var_meta}")"217
218
curl --fail --silent --show-error \219
--request PUT \220
--header "PRIVATE-TOKEN: ${new_token}" \221
--form "value=${new_token}" \222
--form "protected=${protected}" \223
--form "masked=${masked}" \224
--form "raw=${raw}" \225
--form "environment_scope=${scope}" \226
"${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/variables/CI_PUSH_TOKEN" \227
>/dev/null228
229
echo "CI_PUSH_TOKEN rotated and CI/CD variable updated."230
}231
232
case "${1:-}" in233
validate) validate ;;234
bump)235
# shellcheck disable=SC1091236
source version.env237
bump_and_push "$VERSION" "$TAG"238
;;239
upload)240
# shellcheck disable=SC1091241
source version.env242
upload_package "$VERSION"243
;;244
rotate-token) rotate_push_token ;;245
*)246
echo "Usage: $0 {validate|bump|upload|rotate-token}"247
exit 1248
;;249
esac@@ -0,0 +1 @@
1
rootProject.name = "CopperKeys"
@@ -0,0 +1 @@1
rootProject.name = "CopperKeys"@@ -0,0 +1,31 @@
1
package nl.timfalken.copperkeys;
2
3
import org.bukkit.Location;
4
import org.bukkit.World;
5
import org.bukkit.block.Block;
6
7
import java.util.Objects;
8
import java.util.UUID;
9
10
record BlockKey(UUID worldId, int x, int y, int z) {
11
static BlockKey of(Block block) {
12
return new BlockKey(block.getWorld().getUID(), block.getX(), block.getY(), block.getZ());
13
}
14
15
static BlockKey of(Location location) {
16
World world = Objects.requireNonNull(location.getWorld(), "location world");
17
return new BlockKey(world.getUID(), location.getBlockX(), location.getBlockY(), location.getBlockZ());
18
}
19
20
String encode() {
21
return worldId + ";" + x + ";" + y + ";" + z;
22
}
23
24
static BlockKey decode(String value) {
25
String[] p = value.split(";", -1);
26
if (p.length != 4) {
27
throw new IllegalArgumentException("Invalid block key: " + value);
28
}
29
return new BlockKey(UUID.fromString(p[0]), Integer.parseInt(p[1]), Integer.parseInt(p[2]), Integer.parseInt(p[3]));
30
}
31
}
@@ -0,0 +1,31 @@1
package nl.timfalken.copperkeys;2
3
import org.bukkit.Location;4
import org.bukkit.World;5
import org.bukkit.block.Block;6
7
import java.util.Objects;8
import java.util.UUID;9
10
record BlockKey(UUID worldId, int x, int y, int z) {11
static BlockKey of(Block block) {12
return new BlockKey(block.getWorld().getUID(), block.getX(), block.getY(), block.getZ());13
}14
15
static BlockKey of(Location location) {16
World world = Objects.requireNonNull(location.getWorld(), "location world");17
return new BlockKey(world.getUID(), location.getBlockX(), location.getBlockY(), location.getBlockZ());18
}19
20
String encode() {21
return worldId + ";" + x + ";" + y + ";" + z;22
}23
24
static BlockKey decode(String value) {25
String[] p = value.split(";", -1);26
if (p.length != 4) {27
throw new IllegalArgumentException("Invalid block key: " + value);28
}29
return new BlockKey(UUID.fromString(p[0]), Integer.parseInt(p[1]), Integer.parseInt(p[2]), Integer.parseInt(p[3]));30
}31
}@@ -0,0 +1,406 @@
1
package nl.timfalken.copperkeys;
2
3
import io.papermc.paper.event.block.BlockBreakBlockEvent;
4
import io.papermc.paper.event.entity.ItemTransportingEntityValidateTargetEvent;
5
import net.kyori.adventure.text.Component;
6
import net.kyori.adventure.text.format.NamedTextColor;
7
import org.bukkit.Bukkit;
8
import org.bukkit.Material;
9
import org.bukkit.NamespacedKey;
10
import org.bukkit.block.Block;
11
import org.bukkit.block.BlockState;
12
import org.bukkit.block.DoubleChest;
13
import org.bukkit.block.data.Bisected;
14
import org.bukkit.block.data.Openable;
15
import org.bukkit.block.data.type.Door;
16
import org.bukkit.entity.HumanEntity;
17
import org.bukkit.entity.Player;
18
import org.bukkit.event.EventHandler;
19
import org.bukkit.event.block.Action;
20
import org.bukkit.event.EventPriority;
21
import org.bukkit.event.Listener;
22
import org.bukkit.event.block.BlockBreakEvent;
23
import org.bukkit.event.block.BlockBurnEvent;
24
import org.bukkit.event.block.BlockExplodeEvent;
25
import org.bukkit.event.block.BlockRedstoneEvent;
26
import org.bukkit.event.block.CrafterCraftEvent;
27
import org.bukkit.event.entity.EntityExplodeEvent;
28
import org.bukkit.event.entity.EntityPickupItemEvent;
29
import org.bukkit.event.inventory.HopperInventorySearchEvent;
30
import org.bukkit.event.inventory.InventoryClickEvent;
31
import org.bukkit.event.inventory.InventoryDragEvent;
32
import org.bukkit.event.inventory.InventoryMoveItemEvent;
33
import org.bukkit.event.inventory.InventoryOpenEvent;
34
import org.bukkit.event.inventory.InventoryPickupItemEvent;
35
import org.bukkit.event.inventory.PrepareItemCraftEvent;
36
import org.bukkit.event.player.PlayerInteractEvent;
37
import org.bukkit.event.player.PlayerJoinEvent;
38
import org.bukkit.inventory.CraftingInventory;
39
import org.bukkit.inventory.DoubleChestInventory;
40
import org.bukkit.inventory.EquipmentSlot;
41
import org.bukkit.inventory.Inventory;
42
import org.bukkit.inventory.InventoryHolder;
43
import org.bukkit.inventory.ItemStack;
44
import org.bukkit.inventory.ShapedRecipe;
45
import org.bukkit.plugin.java.JavaPlugin;
46
47
import java.util.ArrayList;
48
import java.util.LinkedHashSet;
49
import java.util.List;
50
import java.util.Locale;
51
import java.util.Set;
52
import java.util.UUID;
53
54
public final class CopperKeysPlugin extends JavaPlugin implements Listener {
55
private LockStore lockStore;
56
private KeyItems keyItems;
57
private NamespacedKey recipeKey;
58
59
@Override
60
public void onEnable() {
61
lockStore = new LockStore(this);
62
lockStore.load();
63
keyItems = new KeyItems(this);
64
recipeKey = new NamespacedKey(this, "blank_key");
65
66
registerRecipe();
67
getServer().getPluginManager().registerEvents(this, this);
68
getLogger().info("CopperKeys 1.0.0 enabled with event-driven lock handling.");
69
}
70
71
LockStore lockStore() {
72
return lockStore;
73
}
74
75
private void registerRecipe() {
76
Bukkit.removeRecipe(recipeKey);
77
ShapedRecipe recipe = new ShapedRecipe(recipeKey, keyItems.createBlankKey());
78
recipe.shape("N ", " N");
79
recipe.setIngredient('N', Material.COPPER_NUGGET);
80
Bukkit.addRecipe(recipe);
81
}
82
83
@EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true)
84
public void onPlayerInteract(PlayerInteractEvent event) {
85
if (event.getAction() != Action.RIGHT_CLICK_BLOCK) {
86
return;
87
}
88
Block clicked = event.getClickedBlock();
89
if (clicked == null) {
90
return;
91
}
92
93
LockRecord existing = lockStore.get(BlockKey.of(clicked));
94
if (existing != null) {
95
if (clicked.getBlockData() instanceof Openable openable && openable.isOpen()) {
96
// Closing is deliberately always allowed.
97
return;
98
}
99
if (!playerHasKey(event.getPlayer(), existing.bindingId())) {
100
event.setCancelled(true);
101
lockedMessage(event.getPlayer());
102
}
103
// Already locked: never bind a second key. Allow open/use only when the key check passed.
104
return;
105
}
106
107
ItemStack used = event.getItem();
108
if (used == null || !keyItems.isBlank(used) || !isBindable(clicked)) {
109
return;
110
}
111
112
List<BlockKey> members = collectMembers(clicked);
113
for (BlockKey member : members) {
114
if (lockStore.get(member) != null) {
115
event.setCancelled(true);
116
lockedMessage(event.getPlayer());
117
return;
118
}
119
}
120
121
LockRecord record = new LockRecord(UUID.randomUUID(), displayName(clicked), members);
122
lockStore.add(record);
123
keyItems.bind(used, record);
124
setUsedHandItem(event.getPlayer(), event.getHand(), used);
125
event.setCancelled(true); // The binding click itself never opens/toggles the target.
126
event.getPlayer().sendActionBar(Component.text("Key bound to " + record.displayName(), NamedTextColor.GOLD));
127
}
128
129
@EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true)
130
public void onInventoryOpen(InventoryOpenEvent event) {
131
LockRecord lock = lockForInventory(event.getInventory());
132
if (lock == null) {
133
return;
134
}
135
HumanEntity human = event.getPlayer();
136
if (human instanceof Player player && playerHasKey(player, lock.bindingId())) {
137
return;
138
}
139
event.setCancelled(true);
140
if (human instanceof Player player) {
141
lockedMessage(player);
142
}
143
}
144
145
@EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true)
146
public void onInventoryClick(InventoryClickEvent event) {
147
LockRecord lock = lockForInventory(event.getView().getTopInventory());
148
if (lock != null) {
149
HumanEntity human = event.getWhoClicked();
150
if (!(human instanceof Player player) || !playerHasKey(player, lock.bindingId())) {
151
event.setCancelled(true);
152
if (human instanceof Player player) {
153
lockedMessage(player);
154
}
155
return;
156
}
157
}
158
ItemStack current = event.getCurrentItem();
159
if (current != null && keyItems.normalizeItem(current)) {
160
event.setCurrentItem(current);
161
}
162
}
163
164
@EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true)
165
public void onInventoryDrag(InventoryDragEvent event) {
166
LockRecord lock = lockForInventory(event.getView().getTopInventory());
167
if (lock != null) {
168
HumanEntity human = event.getWhoClicked();
169
if (!(human instanceof Player player) || !playerHasKey(player, lock.bindingId())) {
170
event.setCancelled(true);
171
if (human instanceof Player player) {
172
lockedMessage(player);
173
}
174
return;
175
}
176
}
177
}
178
179
@EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true)
180
public void onInventoryMove(InventoryMoveItemEvent event) {
181
if (lockForInventory(event.getSource()) != null || lockForInventory(event.getDestination()) != null) {
182
event.setCancelled(true);
183
}
184
}
185
186
@EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true)
187
public void onInventoryPickup(InventoryPickupItemEvent event) {
188
if (lockForInventory(event.getInventory()) != null) {
189
event.setCancelled(true);
190
}
191
}
192
193
@EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true)
194
public void onHopperSearch(HopperInventorySearchEvent event) {
195
Inventory found = event.getInventory();
196
if (found != null && lockForInventory(found) != null) {
197
event.setInventory(null);
198
}
199
}
200
201
@EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true)
202
public void onTransportingEntityTarget(ItemTransportingEntityValidateTargetEvent event) {
203
if (lockStore.get(BlockKey.of(event.getBlock())) != null) {
204
// Copper Golems do not expose an inventory that could contain a key.
205
event.setAllowed(false);
206
}
207
}
208
209
@EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true)
210
public void onRedstone(BlockRedstoneEvent event) {
211
LockRecord lock = lockStore.get(BlockKey.of(event.getBlock()));
212
if (lock == null || !(event.getBlock().getBlockData() instanceof Openable openable)) {
213
return;
214
}
215
// A powered transition can close an already-open lock, but may not open a closed one.
216
if (!openable.isOpen() && event.getNewCurrent() > event.getOldCurrent()) {
217
event.setNewCurrent(event.getOldCurrent());
218
}
219
}
220
221
@EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true)
222
public void onPlayerBreak(BlockBreakEvent event) {
223
handleDestroyed(event.getBlock());
224
}
225
226
@EventHandler(priority = EventPriority.MONITOR)
227
public void onForcedBreak(BlockBreakBlockEvent event) {
228
handleDestroyed(event.getBlock());
229
}
230
231
@EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true)
232
public void onBurn(BlockBurnEvent event) {
233
handleDestroyed(event.getBlock());
234
}
235
236
@EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true)
237
public void onBlockExplosion(BlockExplodeEvent event) {
238
for (Block block : event.blockList()) {
239
handleDestroyed(block);
240
}
241
}
242
243
@EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true)
244
public void onEntityExplosion(EntityExplodeEvent event) {
245
for (Block block : event.blockList()) {
246
handleDestroyed(block);
247
}
248
}
249
250
@EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true)
251
public void onPickup(EntityPickupItemEvent event) {
252
ItemStack stack = event.getItem().getItemStack();
253
if (keyItems.normalizeItem(stack)) {
254
event.getItem().setItemStack(stack);
255
}
256
}
257
258
@EventHandler(priority = EventPriority.MONITOR)
259
public void onJoin(PlayerJoinEvent event) {
260
keyItems.normalizeInventory(event.getPlayer().getInventory());
261
}
262
263
@EventHandler(priority = EventPriority.HIGHEST)
264
public void onPrepareCraft(PrepareItemCraftEvent event) {
265
CraftingInventory inv = event.getInventory();
266
boolean containsKey = false;
267
for (ItemStack item : inv.getMatrix()) {
268
if (keyItems.isKey(item)) {
269
containsKey = true;
270
break;
271
}
272
}
273
if (!containsKey) {
274
return;
275
}
276
if (!(inv.getRecipe() instanceof org.bukkit.inventory.CraftingRecipe recipe)
277
|| !recipeKey.equals(recipe.getKey())) {
278
inv.setResult(null);
279
}
280
}
281
282
@EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true)
283
public void onCrafterCraft(CrafterCraftEvent event) {
284
if (!(event.getBlock().getState() instanceof org.bukkit.block.Crafter crafter)) {
285
return;
286
}
287
if (recipeKey.equals(event.getRecipe().getKey())) {
288
return;
289
}
290
for (ItemStack item : crafter.getInventory().getContents()) {
291
if (keyItems.isKey(item)) {
292
event.setCancelled(true);
293
return;
294
}
295
}
296
}
297
298
private void handleDestroyed(Block block) {
299
LockRecord removed = lockStore.removeByBlock(BlockKey.of(block));
300
if (removed == null) {
301
return;
302
}
303
for (Player player : Bukkit.getOnlinePlayers()) {
304
keyItems.blankBindingInInventory(player.getInventory(), removed.bindingId());
305
}
306
}
307
308
private boolean playerHasKey(Player player, UUID bindingId) {
309
return keyItems.inventoryHasBinding(player.getInventory(), bindingId);
310
}
311
312
private boolean isBindable(Block block) {
313
BlockState state = block.getState();
314
return block.getBlockData() instanceof Openable || state instanceof InventoryHolder;
315
}
316
317
private List<BlockKey> collectMembers(Block block) {
318
Set<BlockKey> members = new LinkedHashSet<>();
319
members.add(BlockKey.of(block));
320
321
BlockState state = block.getState();
322
if (state instanceof org.bukkit.block.Chest chest) {
323
Inventory inventory = chest.getInventory();
324
InventoryHolder holder = inventory.getHolder();
325
if (holder instanceof DoubleChest doubleChest) {
326
addChestSide(members, doubleChest.getLeftSide());
327
addChestSide(members, doubleChest.getRightSide());
328
}
329
}
330
331
if (block.getBlockData() instanceof Door door) {
332
Block other = door.getHalf() == Bisected.Half.BOTTOM
333
? block.getRelative(0, 1, 0)
334
: block.getRelative(0, -1, 0);
335
if (other.getBlockData() instanceof Door) {
336
members.add(BlockKey.of(other));
337
}
338
}
339
340
return new ArrayList<>(members);
341
}
342
343
private void addChestSide(Set<BlockKey> members, InventoryHolder side) {
344
if (side instanceof BlockState state) {
345
members.add(BlockKey.of(state.getBlock()));
346
}
347
}
348
349
private LockRecord lockForInventory(Inventory inventory) {
350
InventoryHolder holder = inventory.getHolder();
351
if (holder instanceof DoubleChest doubleChest) {
352
LockRecord left = lockForSide(doubleChest.getLeftSide());
353
return left != null ? left : lockForSide(doubleChest.getRightSide());
354
}
355
if (holder instanceof BlockState state) {
356
return lockStore.get(BlockKey.of(state.getBlock()));
357
}
358
// Some double chest inventories expose their holder through DoubleChestInventory.
359
if (inventory instanceof DoubleChestInventory doubleInventory) {
360
InventoryHolder doubleHolder = doubleInventory.getHolder();
361
if (doubleHolder instanceof DoubleChest doubleChest) {
362
LockRecord left = lockForSide(doubleChest.getLeftSide());
363
return left != null ? left : lockForSide(doubleChest.getRightSide());
364
}
365
}
366
return null;
367
}
368
369
private LockRecord lockForSide(InventoryHolder side) {
370
if (side instanceof BlockState state) {
371
return lockStore.get(BlockKey.of(state.getBlock()));
372
}
373
return null;
374
}
375
376
private void setUsedHandItem(Player player, EquipmentSlot hand, ItemStack item) {
377
if (hand == EquipmentSlot.OFF_HAND) {
378
player.getInventory().setItemInOffHand(item);
379
} else {
380
player.getInventory().setItemInMainHand(item);
381
}
382
}
383
384
private void lockedMessage(Player player) {
385
player.sendActionBar(Component.text("Locked — matching key required", NamedTextColor.RED));
386
}
387
388
private String displayName(Block block) {
389
return titleCase(block.getType().name());
390
}
391
392
private String titleCase(String enumName) {
393
String[] words = enumName.toLowerCase(Locale.ROOT).split("_");
394
StringBuilder result = new StringBuilder();
395
for (String word : words) {
396
if (word.isEmpty()) {
397
continue;
398
}
399
if (!result.isEmpty()) {
400
result.append(' ');
401
}
402
result.append(Character.toUpperCase(word.charAt(0))).append(word.substring(1));
403
}
404
return result.toString();
405
}
406
}
@@ -0,0 +1,406 @@1
package nl.timfalken.copperkeys;2
3
import io.papermc.paper.event.block.BlockBreakBlockEvent;4
import io.papermc.paper.event.entity.ItemTransportingEntityValidateTargetEvent;5
import net.kyori.adventure.text.Component;6
import net.kyori.adventure.text.format.NamedTextColor;7
import org.bukkit.Bukkit;8
import org.bukkit.Material;9
import org.bukkit.NamespacedKey;10
import org.bukkit.block.Block;11
import org.bukkit.block.BlockState;12
import org.bukkit.block.DoubleChest;13
import org.bukkit.block.data.Bisected;14
import org.bukkit.block.data.Openable;15
import org.bukkit.block.data.type.Door;16
import org.bukkit.entity.HumanEntity;17
import org.bukkit.entity.Player;18
import org.bukkit.event.EventHandler;19
import org.bukkit.event.block.Action;20
import org.bukkit.event.EventPriority;21
import org.bukkit.event.Listener;22
import org.bukkit.event.block.BlockBreakEvent;23
import org.bukkit.event.block.BlockBurnEvent;24
import org.bukkit.event.block.BlockExplodeEvent;25
import org.bukkit.event.block.BlockRedstoneEvent;26
import org.bukkit.event.block.CrafterCraftEvent;27
import org.bukkit.event.entity.EntityExplodeEvent;28
import org.bukkit.event.entity.EntityPickupItemEvent;29
import org.bukkit.event.inventory.HopperInventorySearchEvent;30
import org.bukkit.event.inventory.InventoryClickEvent;31
import org.bukkit.event.inventory.InventoryDragEvent;32
import org.bukkit.event.inventory.InventoryMoveItemEvent;33
import org.bukkit.event.inventory.InventoryOpenEvent;34
import org.bukkit.event.inventory.InventoryPickupItemEvent;35
import org.bukkit.event.inventory.PrepareItemCraftEvent;36
import org.bukkit.event.player.PlayerInteractEvent;37
import org.bukkit.event.player.PlayerJoinEvent;38
import org.bukkit.inventory.CraftingInventory;39
import org.bukkit.inventory.DoubleChestInventory;40
import org.bukkit.inventory.EquipmentSlot;41
import org.bukkit.inventory.Inventory;42
import org.bukkit.inventory.InventoryHolder;43
import org.bukkit.inventory.ItemStack;44
import org.bukkit.inventory.ShapedRecipe;45
import org.bukkit.plugin.java.JavaPlugin;46
47
import java.util.ArrayList;48
import java.util.LinkedHashSet;49
import java.util.List;50
import java.util.Locale;51
import java.util.Set;52
import java.util.UUID;53
54
public final class CopperKeysPlugin extends JavaPlugin implements Listener {55
private LockStore lockStore;56
private KeyItems keyItems;57
private NamespacedKey recipeKey;58
59
@Override60
public void onEnable() {61
lockStore = new LockStore(this);62
lockStore.load();63
keyItems = new KeyItems(this);64
recipeKey = new NamespacedKey(this, "blank_key");65
66
registerRecipe();67
getServer().getPluginManager().registerEvents(this, this);68
getLogger().info("CopperKeys 1.0.0 enabled with event-driven lock handling.");69
}70
71
LockStore lockStore() {72
return lockStore;73
}74
75
private void registerRecipe() {76
Bukkit.removeRecipe(recipeKey);77
ShapedRecipe recipe = new ShapedRecipe(recipeKey, keyItems.createBlankKey());78
recipe.shape("N ", " N");79
recipe.setIngredient('N', Material.COPPER_NUGGET);80
Bukkit.addRecipe(recipe);81
}82
83
@EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true)84
public void onPlayerInteract(PlayerInteractEvent event) {85
if (event.getAction() != Action.RIGHT_CLICK_BLOCK) {86
return;87
}88
Block clicked = event.getClickedBlock();89
if (clicked == null) {90
return;91
}92
93
LockRecord existing = lockStore.get(BlockKey.of(clicked));94
if (existing != null) {95
if (clicked.getBlockData() instanceof Openable openable && openable.isOpen()) {96
// Closing is deliberately always allowed.97
return;98
}99
if (!playerHasKey(event.getPlayer(), existing.bindingId())) {100
event.setCancelled(true);101
lockedMessage(event.getPlayer());102
}103
// Already locked: never bind a second key. Allow open/use only when the key check passed.104
return;105
}106
107
ItemStack used = event.getItem();108
if (used == null || !keyItems.isBlank(used) || !isBindable(clicked)) {109
return;110
}111
112
List<BlockKey> members = collectMembers(clicked);113
for (BlockKey member : members) {114
if (lockStore.get(member) != null) {115
event.setCancelled(true);116
lockedMessage(event.getPlayer());117
return;118
}119
}120
121
LockRecord record = new LockRecord(UUID.randomUUID(), displayName(clicked), members);122
lockStore.add(record);123
keyItems.bind(used, record);124
setUsedHandItem(event.getPlayer(), event.getHand(), used);125
event.setCancelled(true); // The binding click itself never opens/toggles the target.126
event.getPlayer().sendActionBar(Component.text("Key bound to " + record.displayName(), NamedTextColor.GOLD));127
}128
129
@EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true)130
public void onInventoryOpen(InventoryOpenEvent event) {131
LockRecord lock = lockForInventory(event.getInventory());132
if (lock == null) {133
return;134
}135
HumanEntity human = event.getPlayer();136
if (human instanceof Player player && playerHasKey(player, lock.bindingId())) {137
return;138
}139
event.setCancelled(true);140
if (human instanceof Player player) {141
lockedMessage(player);142
}143
}144
145
@EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true)146
public void onInventoryClick(InventoryClickEvent event) {147
LockRecord lock = lockForInventory(event.getView().getTopInventory());148
if (lock != null) {149
HumanEntity human = event.getWhoClicked();150
if (!(human instanceof Player player) || !playerHasKey(player, lock.bindingId())) {151
event.setCancelled(true);152
if (human instanceof Player player) {153
lockedMessage(player);154
}155
return;156
}157
}158
ItemStack current = event.getCurrentItem();159
if (current != null && keyItems.normalizeItem(current)) {160
event.setCurrentItem(current);161
}162
}163
164
@EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true)165
public void onInventoryDrag(InventoryDragEvent event) {166
LockRecord lock = lockForInventory(event.getView().getTopInventory());167
if (lock != null) {168
HumanEntity human = event.getWhoClicked();169
if (!(human instanceof Player player) || !playerHasKey(player, lock.bindingId())) {170
event.setCancelled(true);171
if (human instanceof Player player) {172
lockedMessage(player);173
}174
return;175
}176
}177
}178
179
@EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true)180
public void onInventoryMove(InventoryMoveItemEvent event) {181
if (lockForInventory(event.getSource()) != null || lockForInventory(event.getDestination()) != null) {182
event.setCancelled(true);183
}184
}185
186
@EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true)187
public void onInventoryPickup(InventoryPickupItemEvent event) {188
if (lockForInventory(event.getInventory()) != null) {189
event.setCancelled(true);190
}191
}192
193
@EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true)194
public void onHopperSearch(HopperInventorySearchEvent event) {195
Inventory found = event.getInventory();196
if (found != null && lockForInventory(found) != null) {197
event.setInventory(null);198
}199
}200
201
@EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true)202
public void onTransportingEntityTarget(ItemTransportingEntityValidateTargetEvent event) {203
if (lockStore.get(BlockKey.of(event.getBlock())) != null) {204
// Copper Golems do not expose an inventory that could contain a key.205
event.setAllowed(false);206
}207
}208
209
@EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true)210
public void onRedstone(BlockRedstoneEvent event) {211
LockRecord lock = lockStore.get(BlockKey.of(event.getBlock()));212
if (lock == null || !(event.getBlock().getBlockData() instanceof Openable openable)) {213
return;214
}215
// A powered transition can close an already-open lock, but may not open a closed one.216
if (!openable.isOpen() && event.getNewCurrent() > event.getOldCurrent()) {217
event.setNewCurrent(event.getOldCurrent());218
}219
}220
221
@EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true)222
public void onPlayerBreak(BlockBreakEvent event) {223
handleDestroyed(event.getBlock());224
}225
226
@EventHandler(priority = EventPriority.MONITOR)227
public void onForcedBreak(BlockBreakBlockEvent event) {228
handleDestroyed(event.getBlock());229
}230
231
@EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true)232
public void onBurn(BlockBurnEvent event) {233
handleDestroyed(event.getBlock());234
}235
236
@EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true)237
public void onBlockExplosion(BlockExplodeEvent event) {238
for (Block block : event.blockList()) {239
handleDestroyed(block);240
}241
}242
243
@EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true)244
public void onEntityExplosion(EntityExplodeEvent event) {245
for (Block block : event.blockList()) {246
handleDestroyed(block);247
}248
}249
250
@EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true)251
public void onPickup(EntityPickupItemEvent event) {252
ItemStack stack = event.getItem().getItemStack();253
if (keyItems.normalizeItem(stack)) {254
event.getItem().setItemStack(stack);255
}256
}257
258
@EventHandler(priority = EventPriority.MONITOR)259
public void onJoin(PlayerJoinEvent event) {260
keyItems.normalizeInventory(event.getPlayer().getInventory());261
}262
263
@EventHandler(priority = EventPriority.HIGHEST)264
public void onPrepareCraft(PrepareItemCraftEvent event) {265
CraftingInventory inv = event.getInventory();266
boolean containsKey = false;267
for (ItemStack item : inv.getMatrix()) {268
if (keyItems.isKey(item)) {269
containsKey = true;270
break;271
}272
}273
if (!containsKey) {274
return;275
}276
if (!(inv.getRecipe() instanceof org.bukkit.inventory.CraftingRecipe recipe)277
|| !recipeKey.equals(recipe.getKey())) {278
inv.setResult(null);279
}280
}281
282
@EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true)283
public void onCrafterCraft(CrafterCraftEvent event) {284
if (!(event.getBlock().getState() instanceof org.bukkit.block.Crafter crafter)) {285
return;286
}287
if (recipeKey.equals(event.getRecipe().getKey())) {288
return;289
}290
for (ItemStack item : crafter.getInventory().getContents()) {291
if (keyItems.isKey(item)) {292
event.setCancelled(true);293
return;294
}295
}296
}297
298
private void handleDestroyed(Block block) {299
LockRecord removed = lockStore.removeByBlock(BlockKey.of(block));300
if (removed == null) {301
return;302
}303
for (Player player : Bukkit.getOnlinePlayers()) {304
keyItems.blankBindingInInventory(player.getInventory(), removed.bindingId());305
}306
}307
308
private boolean playerHasKey(Player player, UUID bindingId) {309
return keyItems.inventoryHasBinding(player.getInventory(), bindingId);310
}311
312
private boolean isBindable(Block block) {313
BlockState state = block.getState();314
return block.getBlockData() instanceof Openable || state instanceof InventoryHolder;315
}316
317
private List<BlockKey> collectMembers(Block block) {318
Set<BlockKey> members = new LinkedHashSet<>();319
members.add(BlockKey.of(block));320
321
BlockState state = block.getState();322
if (state instanceof org.bukkit.block.Chest chest) {323
Inventory inventory = chest.getInventory();324
InventoryHolder holder = inventory.getHolder();325
if (holder instanceof DoubleChest doubleChest) {326
addChestSide(members, doubleChest.getLeftSide());327
addChestSide(members, doubleChest.getRightSide());328
}329
}330
331
if (block.getBlockData() instanceof Door door) {332
Block other = door.getHalf() == Bisected.Half.BOTTOM333
? block.getRelative(0, 1, 0)334
: block.getRelative(0, -1, 0);335
if (other.getBlockData() instanceof Door) {336
members.add(BlockKey.of(other));337
}338
}339
340
return new ArrayList<>(members);341
}342
343
private void addChestSide(Set<BlockKey> members, InventoryHolder side) {344
if (side instanceof BlockState state) {345
members.add(BlockKey.of(state.getBlock()));346
}347
}348
349
private LockRecord lockForInventory(Inventory inventory) {350
InventoryHolder holder = inventory.getHolder();351
if (holder instanceof DoubleChest doubleChest) {352
LockRecord left = lockForSide(doubleChest.getLeftSide());353
return left != null ? left : lockForSide(doubleChest.getRightSide());354
}355
if (holder instanceof BlockState state) {356
return lockStore.get(BlockKey.of(state.getBlock()));357
}358
// Some double chest inventories expose their holder through DoubleChestInventory.359
if (inventory instanceof DoubleChestInventory doubleInventory) {360
InventoryHolder doubleHolder = doubleInventory.getHolder();361
if (doubleHolder instanceof DoubleChest doubleChest) {362
LockRecord left = lockForSide(doubleChest.getLeftSide());363
return left != null ? left : lockForSide(doubleChest.getRightSide());364
}365
}366
return null;367
}368
369
private LockRecord lockForSide(InventoryHolder side) {370
if (side instanceof BlockState state) {371
return lockStore.get(BlockKey.of(state.getBlock()));372
}373
return null;374
}375
376
private void setUsedHandItem(Player player, EquipmentSlot hand, ItemStack item) {377
if (hand == EquipmentSlot.OFF_HAND) {378
player.getInventory().setItemInOffHand(item);379
} else {380
player.getInventory().setItemInMainHand(item);381
}382
}383
384
private void lockedMessage(Player player) {385
player.sendActionBar(Component.text("Locked — matching key required", NamedTextColor.RED));386
}387
388
private String displayName(Block block) {389
return titleCase(block.getType().name());390
}391
392
private String titleCase(String enumName) {393
String[] words = enumName.toLowerCase(Locale.ROOT).split("_");394
StringBuilder result = new StringBuilder();395
for (String word : words) {396
if (word.isEmpty()) {397
continue;398
}399
if (!result.isEmpty()) {400
result.append(' ');401
}402
result.append(Character.toUpperCase(word.charAt(0))).append(word.substring(1));403
}404
return result.toString();405
}406
}@@ -0,0 +1,230 @@
1
package nl.timfalken.copperkeys;
2
3
import net.kyori.adventure.text.Component;
4
import net.kyori.adventure.text.format.NamedTextColor;
5
import net.kyori.adventure.text.format.TextDecoration;
6
import org.bukkit.Material;
7
import org.bukkit.NamespacedKey;
8
import org.bukkit.block.ShulkerBox;
9
import org.bukkit.inventory.Inventory;
10
import org.bukkit.inventory.ItemStack;
11
import org.bukkit.inventory.meta.BlockStateMeta;
12
import org.bukkit.inventory.meta.BundleMeta;
13
import org.bukkit.inventory.meta.ItemMeta;
14
import org.bukkit.persistence.PersistentDataContainer;
15
import org.bukkit.persistence.PersistentDataType;
16
17
import java.util.ArrayList;
18
import java.util.List;
19
import java.util.UUID;
20
21
final class KeyItems {
22
private static final int MAX_NESTING_DEPTH = 16;
23
24
private final CopperKeysPlugin plugin;
25
private final NamespacedKey markerKey;
26
private final NamespacedKey bindingKey;
27
private final NamespacedKey itemModel;
28
29
KeyItems(CopperKeysPlugin plugin) {
30
this.plugin = plugin;
31
this.markerKey = new NamespacedKey(plugin, "key");
32
this.bindingKey = new NamespacedKey(plugin, "binding");
33
this.itemModel = new NamespacedKey("copperkeys", "key");
34
}
35
36
ItemStack createBlankKey() {
37
ItemStack item = new ItemStack(Material.CLOCK);
38
makeBlank(item);
39
return item;
40
}
41
42
boolean isKey(ItemStack item) {
43
if (item == null || item.getType() != Material.CLOCK || !item.hasItemMeta()) {
44
return false;
45
}
46
Byte marker = item.getItemMeta().getPersistentDataContainer().get(markerKey, PersistentDataType.BYTE);
47
return marker != null && marker == (byte) 1;
48
}
49
50
UUID getBinding(ItemStack item) {
51
if (!isKey(item)) {
52
return null;
53
}
54
String raw = item.getItemMeta().getPersistentDataContainer().get(bindingKey, PersistentDataType.STRING);
55
if (raw == null) {
56
return null;
57
}
58
try {
59
return UUID.fromString(raw);
60
} catch (IllegalArgumentException ignored) {
61
return null;
62
}
63
}
64
65
boolean isBlank(ItemStack item) {
66
return isKey(item) && getBinding(item) == null;
67
}
68
69
void bind(ItemStack item, LockRecord lock) {
70
ItemMeta meta = item.getItemMeta();
71
applyCommon(meta);
72
meta.getPersistentDataContainer().set(bindingKey, PersistentDataType.STRING, lock.bindingId().toString());
73
meta.itemName(Component.text("Key", NamedTextColor.WHITE));
74
meta.lore(List.of(
75
Component.text("Unlocks " + lock.displayName(), NamedTextColor.GRAY)
76
.decoration(TextDecoration.ITALIC, false)
77
));
78
item.setItemMeta(meta);
79
}
80
81
void makeBlank(ItemStack item) {
82
ItemMeta meta = item.getItemMeta();
83
applyCommon(meta);
84
meta.getPersistentDataContainer().remove(bindingKey);
85
meta.itemName(Component.text("Blank Key", NamedTextColor.WHITE));
86
meta.lore(null);
87
item.setItemMeta(meta);
88
}
89
90
private void applyCommon(ItemMeta meta) {
91
PersistentDataContainer pdc = meta.getPersistentDataContainer();
92
pdc.set(markerKey, PersistentDataType.BYTE, (byte) 1);
93
meta.setMaxStackSize(1);
94
meta.setItemModel(itemModel);
95
}
96
97
boolean inventoryHasBinding(Inventory inventory, UUID bindingId) {
98
boolean[] found = {false};
99
for (int slot = 0; slot < inventory.getSize(); slot++) {
100
ItemStack item = inventory.getItem(slot);
101
if (item == null) {
102
continue;
103
}
104
boolean changed = visit(item, 0, key -> {
105
UUID keyBinding = getBinding(key);
106
if (keyBinding != null && !plugin.lockStore().exists(keyBinding)) {
107
makeBlank(key);
108
return true;
109
}
110
if (bindingId.equals(keyBinding)) {
111
found[0] = true;
112
}
113
return false;
114
});
115
if (changed) {
116
inventory.setItem(slot, item);
117
}
118
if (found[0]) {
119
return true;
120
}
121
}
122
return false;
123
}
124
125
void normalizeInventory(Inventory inventory) {
126
for (int slot = 0; slot < inventory.getSize(); slot++) {
127
ItemStack item = inventory.getItem(slot);
128
if (item == null) {
129
continue;
130
}
131
boolean changed = visit(item, 0, key -> {
132
UUID binding = getBinding(key);
133
if (binding != null && !plugin.lockStore().exists(binding)) {
134
makeBlank(key);
135
return true;
136
}
137
return false;
138
});
139
if (changed) {
140
inventory.setItem(slot, item);
141
}
142
}
143
}
144
145
void blankBindingInInventory(Inventory inventory, UUID bindingId) {
146
for (int slot = 0; slot < inventory.getSize(); slot++) {
147
ItemStack item = inventory.getItem(slot);
148
if (item == null) {
149
continue;
150
}
151
boolean changed = visit(item, 0, key -> {
152
if (bindingId.equals(getBinding(key))) {
153
makeBlank(key);
154
return true;
155
}
156
return false;
157
});
158
if (changed) {
159
inventory.setItem(slot, item);
160
}
161
}
162
}
163
164
boolean normalizeItem(ItemStack item) {
165
if (item == null) {
166
return false;
167
}
168
return visit(item, 0, key -> {
169
UUID binding = getBinding(key);
170
if (binding != null && !plugin.lockStore().exists(binding)) {
171
makeBlank(key);
172
return true;
173
}
174
return false;
175
});
176
}
177
178
private boolean visit(ItemStack item, int depth, KeyVisitor visitor) {
179
if (item == null || item.getType().isAir() || depth > MAX_NESTING_DEPTH) {
180
return false;
181
}
182
183
boolean changed = false;
184
if (isKey(item)) {
185
changed |= visitor.visit(item);
186
}
187
188
ItemMeta meta = item.getItemMeta();
189
if (meta instanceof BundleMeta bundleMeta) {
190
List<ItemStack> oldItems = bundleMeta.getItems();
191
List<ItemStack> newItems = new ArrayList<>(oldItems.size());
192
boolean nestedChanged = false;
193
for (ItemStack nested : oldItems) {
194
ItemStack copy = nested.clone();
195
nestedChanged |= visit(copy, depth + 1, visitor);
196
newItems.add(copy);
197
}
198
if (nestedChanged) {
199
bundleMeta.setItems(newItems);
200
item.setItemMeta(bundleMeta);
201
changed = true;
202
}
203
} else if (meta instanceof BlockStateMeta blockStateMeta && blockStateMeta.getBlockState() instanceof ShulkerBox shulker) {
204
Inventory contents = shulker.getInventory();
205
boolean nestedChanged = false;
206
for (int slot = 0; slot < contents.getSize(); slot++) {
207
ItemStack nested = contents.getItem(slot);
208
if (nested == null) {
209
continue;
210
}
211
ItemStack copy = nested.clone();
212
if (visit(copy, depth + 1, visitor)) {
213
contents.setItem(slot, copy);
214
nestedChanged = true;
215
}
216
}
217
if (nestedChanged) {
218
blockStateMeta.setBlockState(shulker);
219
item.setItemMeta(blockStateMeta);
220
changed = true;
221
}
222
}
223
return changed;
224
}
225
226
@FunctionalInterface
227
private interface KeyVisitor {
228
boolean visit(ItemStack key);
229
}
230
}
@@ -0,0 +1,230 @@1
package nl.timfalken.copperkeys;2
3
import net.kyori.adventure.text.Component;4
import net.kyori.adventure.text.format.NamedTextColor;5
import net.kyori.adventure.text.format.TextDecoration;6
import org.bukkit.Material;7
import org.bukkit.NamespacedKey;8
import org.bukkit.block.ShulkerBox;9
import org.bukkit.inventory.Inventory;10
import org.bukkit.inventory.ItemStack;11
import org.bukkit.inventory.meta.BlockStateMeta;12
import org.bukkit.inventory.meta.BundleMeta;13
import org.bukkit.inventory.meta.ItemMeta;14
import org.bukkit.persistence.PersistentDataContainer;15
import org.bukkit.persistence.PersistentDataType;16
17
import java.util.ArrayList;18
import java.util.List;19
import java.util.UUID;20
21
final class KeyItems {22
private static final int MAX_NESTING_DEPTH = 16;23
24
private final CopperKeysPlugin plugin;25
private final NamespacedKey markerKey;26
private final NamespacedKey bindingKey;27
private final NamespacedKey itemModel;28
29
KeyItems(CopperKeysPlugin plugin) {30
this.plugin = plugin;31
this.markerKey = new NamespacedKey(plugin, "key");32
this.bindingKey = new NamespacedKey(plugin, "binding");33
this.itemModel = new NamespacedKey("copperkeys", "key");34
}35
36
ItemStack createBlankKey() {37
ItemStack item = new ItemStack(Material.CLOCK);38
makeBlank(item);39
return item;40
}41
42
boolean isKey(ItemStack item) {43
if (item == null || item.getType() != Material.CLOCK || !item.hasItemMeta()) {44
return false;45
}46
Byte marker = item.getItemMeta().getPersistentDataContainer().get(markerKey, PersistentDataType.BYTE);47
return marker != null && marker == (byte) 1;48
}49
50
UUID getBinding(ItemStack item) {51
if (!isKey(item)) {52
return null;53
}54
String raw = item.getItemMeta().getPersistentDataContainer().get(bindingKey, PersistentDataType.STRING);55
if (raw == null) {56
return null;57
}58
try {59
return UUID.fromString(raw);60
} catch (IllegalArgumentException ignored) {61
return null;62
}63
}64
65
boolean isBlank(ItemStack item) {66
return isKey(item) && getBinding(item) == null;67
}68
69
void bind(ItemStack item, LockRecord lock) {70
ItemMeta meta = item.getItemMeta();71
applyCommon(meta);72
meta.getPersistentDataContainer().set(bindingKey, PersistentDataType.STRING, lock.bindingId().toString());73
meta.itemName(Component.text("Key", NamedTextColor.WHITE));74
meta.lore(List.of(75
Component.text("Unlocks " + lock.displayName(), NamedTextColor.GRAY)76
.decoration(TextDecoration.ITALIC, false)77
));78
item.setItemMeta(meta);79
}80
81
void makeBlank(ItemStack item) {82
ItemMeta meta = item.getItemMeta();83
applyCommon(meta);84
meta.getPersistentDataContainer().remove(bindingKey);85
meta.itemName(Component.text("Blank Key", NamedTextColor.WHITE));86
meta.lore(null);87
item.setItemMeta(meta);88
}89
90
private void applyCommon(ItemMeta meta) {91
PersistentDataContainer pdc = meta.getPersistentDataContainer();92
pdc.set(markerKey, PersistentDataType.BYTE, (byte) 1);93
meta.setMaxStackSize(1);94
meta.setItemModel(itemModel);95
}96
97
boolean inventoryHasBinding(Inventory inventory, UUID bindingId) {98
boolean[] found = {false};99
for (int slot = 0; slot < inventory.getSize(); slot++) {100
ItemStack item = inventory.getItem(slot);101
if (item == null) {102
continue;103
}104
boolean changed = visit(item, 0, key -> {105
UUID keyBinding = getBinding(key);106
if (keyBinding != null && !plugin.lockStore().exists(keyBinding)) {107
makeBlank(key);108
return true;109
}110
if (bindingId.equals(keyBinding)) {111
found[0] = true;112
}113
return false;114
});115
if (changed) {116
inventory.setItem(slot, item);117
}118
if (found[0]) {119
return true;120
}121
}122
return false;123
}124
125
void normalizeInventory(Inventory inventory) {126
for (int slot = 0; slot < inventory.getSize(); slot++) {127
ItemStack item = inventory.getItem(slot);128
if (item == null) {129
continue;130
}131
boolean changed = visit(item, 0, key -> {132
UUID binding = getBinding(key);133
if (binding != null && !plugin.lockStore().exists(binding)) {134
makeBlank(key);135
return true;136
}137
return false;138
});139
if (changed) {140
inventory.setItem(slot, item);141
}142
}143
}144
145
void blankBindingInInventory(Inventory inventory, UUID bindingId) {146
for (int slot = 0; slot < inventory.getSize(); slot++) {147
ItemStack item = inventory.getItem(slot);148
if (item == null) {149
continue;150
}151
boolean changed = visit(item, 0, key -> {152
if (bindingId.equals(getBinding(key))) {153
makeBlank(key);154
return true;155
}156
return false;157
});158
if (changed) {159
inventory.setItem(slot, item);160
}161
}162
}163
164
boolean normalizeItem(ItemStack item) {165
if (item == null) {166
return false;167
}168
return visit(item, 0, key -> {169
UUID binding = getBinding(key);170
if (binding != null && !plugin.lockStore().exists(binding)) {171
makeBlank(key);172
return true;173
}174
return false;175
});176
}177
178
private boolean visit(ItemStack item, int depth, KeyVisitor visitor) {179
if (item == null || item.getType().isAir() || depth > MAX_NESTING_DEPTH) {180
return false;181
}182
183
boolean changed = false;184
if (isKey(item)) {185
changed |= visitor.visit(item);186
}187
188
ItemMeta meta = item.getItemMeta();189
if (meta instanceof BundleMeta bundleMeta) {190
List<ItemStack> oldItems = bundleMeta.getItems();191
List<ItemStack> newItems = new ArrayList<>(oldItems.size());192
boolean nestedChanged = false;193
for (ItemStack nested : oldItems) {194
ItemStack copy = nested.clone();195
nestedChanged |= visit(copy, depth + 1, visitor);196
newItems.add(copy);197
}198
if (nestedChanged) {199
bundleMeta.setItems(newItems);200
item.setItemMeta(bundleMeta);201
changed = true;202
}203
} else if (meta instanceof BlockStateMeta blockStateMeta && blockStateMeta.getBlockState() instanceof ShulkerBox shulker) {204
Inventory contents = shulker.getInventory();205
boolean nestedChanged = false;206
for (int slot = 0; slot < contents.getSize(); slot++) {207
ItemStack nested = contents.getItem(slot);208
if (nested == null) {209
continue;210
}211
ItemStack copy = nested.clone();212
if (visit(copy, depth + 1, visitor)) {213
contents.setItem(slot, copy);214
nestedChanged = true;215
}216
}217
if (nestedChanged) {218
blockStateMeta.setBlockState(shulker);219
item.setItemMeta(blockStateMeta);220
changed = true;221
}222
}223
return changed;224
}225
226
@FunctionalInterface227
private interface KeyVisitor {228
boolean visit(ItemStack key);229
}230
}@@ -0,0 +1,10 @@
1
package nl.timfalken.copperkeys;
2
3
import java.util.List;
4
import java.util.UUID;
5
6
record LockRecord(UUID bindingId, String displayName, List<BlockKey> members) {
7
LockRecord {
8
members = List.copyOf(members);
9
}
10
}
@@ -0,0 +1,10 @@1
package nl.timfalken.copperkeys;2
3
import java.util.List;4
import java.util.UUID;5
6
record LockRecord(UUID bindingId, String displayName, List<BlockKey> members) {7
LockRecord {8
members = List.copyOf(members);9
}10
}@@ -0,0 +1,124 @@
1
package nl.timfalken.copperkeys;
2
3
import org.bukkit.configuration.ConfigurationSection;
4
import org.bukkit.configuration.file.YamlConfiguration;
5
import org.bukkit.plugin.java.JavaPlugin;
6
7
import java.io.File;
8
import java.io.IOException;
9
import java.util.ArrayList;
10
import java.util.HashMap;
11
import java.util.List;
12
import java.util.Map;
13
import java.util.UUID;
14
import java.util.logging.Level;
15
16
final class LockStore {
17
private final JavaPlugin plugin;
18
private final File file;
19
private final Map<BlockKey, LockRecord> byBlock = new HashMap<>();
20
private final Map<UUID, LockRecord> byBinding = new HashMap<>();
21
22
LockStore(JavaPlugin plugin) {
23
this.plugin = plugin;
24
this.file = new File(plugin.getDataFolder(), "locks.yml");
25
}
26
27
void load() {
28
byBlock.clear();
29
byBinding.clear();
30
if (!file.isFile()) {
31
return;
32
}
33
34
YamlConfiguration yaml = YamlConfiguration.loadConfiguration(file);
35
ConfigurationSection root = yaml.getConfigurationSection("locks");
36
if (root == null) {
37
return;
38
}
39
40
for (String idText : root.getKeys(false)) {
41
try {
42
UUID id = UUID.fromString(idText);
43
ConfigurationSection section = root.getConfigurationSection(idText);
44
if (section == null) {
45
continue;
46
}
47
String displayName = section.getString("display-name", "Block");
48
List<BlockKey> members = new ArrayList<>();
49
for (String encoded : section.getStringList("members")) {
50
members.add(BlockKey.decode(encoded));
51
}
52
if (members.isEmpty()) {
53
continue;
54
}
55
LockRecord record = new LockRecord(id, displayName, members);
56
byBinding.put(id, record);
57
for (BlockKey member : members) {
58
byBlock.put(member, record);
59
}
60
} catch (RuntimeException ex) {
61
plugin.getLogger().log(Level.WARNING, "Ignoring invalid lock entry " + idText, ex);
62
}
63
}
64
}
65
66
LockRecord get(BlockKey block) {
67
return byBlock.get(block);
68
}
69
70
LockRecord get(UUID bindingId) {
71
return byBinding.get(bindingId);
72
}
73
74
boolean exists(UUID bindingId) {
75
return byBinding.containsKey(bindingId);
76
}
77
78
void add(LockRecord record) {
79
byBinding.put(record.bindingId(), record);
80
for (BlockKey member : record.members()) {
81
byBlock.put(member, record);
82
}
83
save();
84
}
85
86
LockRecord removeByBlock(BlockKey block) {
87
LockRecord record = byBlock.get(block);
88
if (record != null) {
89
remove(record.bindingId());
90
}
91
return record;
92
}
93
94
LockRecord remove(UUID bindingId) {
95
LockRecord record = byBinding.remove(bindingId);
96
if (record == null) {
97
return null;
98
}
99
for (BlockKey member : record.members()) {
100
byBlock.remove(member, record);
101
}
102
save();
103
return record;
104
}
105
106
private void save() {
107
if (!plugin.getDataFolder().isDirectory() && !plugin.getDataFolder().mkdirs()) {
108
plugin.getLogger().warning("Could not create plugin data directory; locks are only in memory.");
109
return;
110
}
111
112
YamlConfiguration yaml = new YamlConfiguration();
113
for (LockRecord record : byBinding.values()) {
114
String base = "locks." + record.bindingId();
115
yaml.set(base + ".display-name", record.displayName());
116
yaml.set(base + ".members", record.members().stream().map(BlockKey::encode).toList());
117
}
118
try {
119
yaml.save(file);
120
} catch (IOException ex) {
121
plugin.getLogger().log(Level.SEVERE, "Could not save locks.yml", ex);
122
}
123
}
124
}
@@ -0,0 +1,124 @@1
package nl.timfalken.copperkeys;2
3
import org.bukkit.configuration.ConfigurationSection;4
import org.bukkit.configuration.file.YamlConfiguration;5
import org.bukkit.plugin.java.JavaPlugin;6
7
import java.io.File;8
import java.io.IOException;9
import java.util.ArrayList;10
import java.util.HashMap;11
import java.util.List;12
import java.util.Map;13
import java.util.UUID;14
import java.util.logging.Level;15
16
final class LockStore {17
private final JavaPlugin plugin;18
private final File file;19
private final Map<BlockKey, LockRecord> byBlock = new HashMap<>();20
private final Map<UUID, LockRecord> byBinding = new HashMap<>();21
22
LockStore(JavaPlugin plugin) {23
this.plugin = plugin;24
this.file = new File(plugin.getDataFolder(), "locks.yml");25
}26
27
void load() {28
byBlock.clear();29
byBinding.clear();30
if (!file.isFile()) {31
return;32
}33
34
YamlConfiguration yaml = YamlConfiguration.loadConfiguration(file);35
ConfigurationSection root = yaml.getConfigurationSection("locks");36
if (root == null) {37
return;38
}39
40
for (String idText : root.getKeys(false)) {41
try {42
UUID id = UUID.fromString(idText);43
ConfigurationSection section = root.getConfigurationSection(idText);44
if (section == null) {45
continue;46
}47
String displayName = section.getString("display-name", "Block");48
List<BlockKey> members = new ArrayList<>();49
for (String encoded : section.getStringList("members")) {50
members.add(BlockKey.decode(encoded));51
}52
if (members.isEmpty()) {53
continue;54
}55
LockRecord record = new LockRecord(id, displayName, members);56
byBinding.put(id, record);57
for (BlockKey member : members) {58
byBlock.put(member, record);59
}60
} catch (RuntimeException ex) {61
plugin.getLogger().log(Level.WARNING, "Ignoring invalid lock entry " + idText, ex);62
}63
}64
}65
66
LockRecord get(BlockKey block) {67
return byBlock.get(block);68
}69
70
LockRecord get(UUID bindingId) {71
return byBinding.get(bindingId);72
}73
74
boolean exists(UUID bindingId) {75
return byBinding.containsKey(bindingId);76
}77
78
void add(LockRecord record) {79
byBinding.put(record.bindingId(), record);80
for (BlockKey member : record.members()) {81
byBlock.put(member, record);82
}83
save();84
}85
86
LockRecord removeByBlock(BlockKey block) {87
LockRecord record = byBlock.get(block);88
if (record != null) {89
remove(record.bindingId());90
}91
return record;92
}93
94
LockRecord remove(UUID bindingId) {95
LockRecord record = byBinding.remove(bindingId);96
if (record == null) {97
return null;98
}99
for (BlockKey member : record.members()) {100
byBlock.remove(member, record);101
}102
save();103
return record;104
}105
106
private void save() {107
if (!plugin.getDataFolder().isDirectory() && !plugin.getDataFolder().mkdirs()) {108
plugin.getLogger().warning("Could not create plugin data directory; locks are only in memory.");109
return;110
}111
112
YamlConfiguration yaml = new YamlConfiguration();113
for (LockRecord record : byBinding.values()) {114
String base = "locks." + record.bindingId();115
yaml.set(base + ".display-name", record.displayName());116
yaml.set(base + ".members", record.members().stream().map(BlockKey::encode).toList());117
}118
try {119
yaml.save(file);120
} catch (IOException ex) {121
plugin.getLogger().log(Level.SEVERE, "Could not save locks.yml", ex);122
}123
}124
}@@ -0,0 +1,6 @@
1
name: CopperKeys
2
version: 1.0.0
3
main: nl.timfalken.copperkeys.CopperKeysPlugin
4
api-version: '26.2'
5
author: Tim Falken
6
description: Event-driven keys for locking containers and openable blocks.
@@ -0,0 +1,6 @@1
name: CopperKeys2
version: 1.0.03
main: nl.timfalken.copperkeys.CopperKeysPlugin4
api-version: '26.2'5
author: Tim Falken6
description: Event-driven keys for locking containers and openable blocks.