BlueGit

timfa chestpreviews

Files

chestpreviews / README.md

README.md

chore: bump version to 1.0.12
timfa GitLab CI · pushed by timfa · 2 months ago
6d6d6896 History
README.md 1.2 KiB Download Raw

ChestPreview 1.0.12

Paper 26.2 plugin that renders container previews as client-only ItemDisplay packets.

PacketEvents is bundled

ChestPreview shades PacketEvents 2.13.0 into the release JAR. A separate PacketEvents plugin is not required.

The build follows PacketEvents' bundling guidance and relocates the bundled libraries into ChestPreview's private namespace:

  • com.github.retrooper -> nl.timfalken.chestpreview.libs.packetevents
  • io.github.retrooper -> nl.timfalken.chestpreview.libs.packetevents
  • net.kyori -> nl.timfalken.chestpreview.libs.kyori
  • com.google.gson -> nl.timfalken.chestpreview.libs.gson
  • org.bstats -> nl.timfalken.chestpreview.libs.bstats

PacketEvents is initialized by ChestPreview itself:

  • onLoad(): build + load()
  • onEnable(): init()
  • onDisable(): terminate()

The embedded PacketEvents update checker is disabled.

Build

gradle shadowJar

Output:

build/libs/ChestPreview-<version>.jar

Do not use minimize() for this build; PacketEvents warns that minimization can cause classloading issues.

Releases

Releases are tagged as X.Y.Z (optional v prefix). The GitLab pipeline validates the tag, bumps version files, builds the jar, and publishes a GitLab Release.

Source
1# ChestPreview 1.0.12
2
3Paper 26.2 plugin that renders container previews as client-only ItemDisplay packets.
4
5## PacketEvents is bundled
6
7ChestPreview shades PacketEvents 2.13.0 into the release JAR. A separate PacketEvents plugin is not required.
8
9The build follows PacketEvents' bundling guidance and relocates the bundled libraries into ChestPreview's private namespace:
10
11- `com.github.retrooper` -> `nl.timfalken.chestpreview.libs.packetevents`
12- `io.github.retrooper` -> `nl.timfalken.chestpreview.libs.packetevents`
13- `net.kyori` -> `nl.timfalken.chestpreview.libs.kyori`
14- `com.google.gson` -> `nl.timfalken.chestpreview.libs.gson`
15- `org.bstats` -> `nl.timfalken.chestpreview.libs.bstats`
16
17PacketEvents is initialized by ChestPreview itself:
18
19- `onLoad()`: build + `load()`
20- `onEnable()`: `init()`
21- `onDisable()`: `terminate()`
22
23The embedded PacketEvents update checker is disabled.
24
25## Build
26
27```bash
28gradle shadowJar
29```
30
31Output:
32
33```text
34build/libs/ChestPreview-<version>.jar
35```
36
37Do not use `minimize()` for this build; PacketEvents warns that minimization can cause classloading issues.
38
39## Releases
40
41Releases are tagged as `X.Y.Z` (optional `v` prefix). The GitLab pipeline validates the tag, bumps version files, builds the jar, and publishes a GitLab Release.