Merge remote-tracking branch 'origin/master'

.github/workflows/maven.yml

@@ -0,0 +1,35 @@
+# This workflow will build a Java project with Maven, and cache/restore any dependencies to improve the workflow execution time
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-java-with-maven
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Java CI with Maven
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up JDK 17
+      uses: actions/setup-java@v3
+      with:
+        java-version: '17'
+        distribution: 'temurin'
+        cache: maven
+    - name: Build with Maven
+      run: mvn -B package --file pom.xml
+
+    # Optional: Uploads the full dependency graph to GitHub to improve the quality of Dependabot alerts this repository can receive
+    - name: Update dependency graph
+      uses: advanced-security/maven-dependency-submission-action@571e99aab1055c2e71a1e2309b9691de18d6b7d6

.github/workflows/mc-publish.yml

@@ -0,0 +1,71 @@
+# This workflow will build a Java project with Maven, and cache/restore any dependencies to improve the workflow execution time
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-java-with-maven
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: mc-publish
+
+on:
+  workflow_dispatch:
+  release:
+     types:
+       - published
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up JDK 17
+      uses: actions/setup-java@v3
+      with:
+        java-version: '17'
+        distribution: 'temurin'
+        cache: maven
+    - name: Build with Maven
+      run: mvn -B package --file pom.xml
+
+    # Optional: Uploads the full dependency graph to GitHub to improve the quality of Dependabot alerts this repository can receive
+    - name: Update dependency graph
+      uses: advanced-security/maven-dependency-submission-action@571e99aab1055c2e71a1e2309b9691de18d6b7d6
+    - uses: Kir-Antipov/[email protected]
+      with:
+        modrinth-id: 4NOso0t8
+        modrinth-featured: true
+        modrinth-token: ${{ secrets.MODRINTH_TOKEN }}
+
+        github-discussion: Announcements
+        github-token: ${{ secrets.GITHUB_TOKEN }}
+        github-draft: false
+
+        #curseforge-id: 709849
+        #curseforge-token: ${{ secrets.CURSEFORGE_TOKEN }}
+        #curseforge-name: "Codframe"
+
+        files-primary: target/!(*-@(dev|sources|javadoc)).jar
+        files-secondary: target/*-@(dev|sources|javadoc).jar
+        loaders: |
+          paper
+          purpur
+        game-versions: |
+          1.15
+          1.15.1
+          1.15.2
+          1.16
+          1.16.1
+          1.16.2
+          1.16.3
+          1.16.4
+          1.16.5
+          1.17
+          1.17.1
+          1.18
+          1.18.1
+          1.18.2
+          1.19
+          1.19.1
+          1.19.2
+        java: |
+          17

README.md

@@ -1,12 +1,26 @@
 # CodFrame
 
+A simple ItemFrame protect and in-frame item preview plugin.
+
+**This is a PAPER only plugin, can run on [Paper](https://papermc.io/), or Paper's fork like [Purpur](https://purpurmc.org/) only! DO NOT INSTALL ON SPIGOT!**
+
+**This plugin require Java 17 and up to be run.**
+
+[Modrinth](https://modrinth.com/plugin/codframe)
+
+## Why CodFrame
+
+CodFrame can protect your items in itemframe to avoid grief like explosion, shoot, lava, fire, block break, interact, rotate. 
+
+Also provide a cool and useful item-showcase feature to allow any player preview your awesome armor/weapon, or read your book without take out from ItemFrame!
+
 ## Command
-`/codframe` - Set a ItemFrame to CodFrame.
+`/codframe` - Set or remove a CodFrame when you looking at a ItemFrame.
 
 ## Permission
-
-`codframe.admin` - Permission to bypass the owner check, force remove any exists CodFrame.
+`codframe.admin` - Bypass the owner check, force remove a exists CodFrame.
 
 ## Demo Video
 
 [![DemoVideo](http://img.youtube.com/vi/WFKfd7CN-BU/0.jpg)](https://www.youtube.com/watch?v=WFKfd7CN-BU)
+