[Idea]: Folia support for OpenInv

.github/dependabot.yml

@@ -0,0 +1,10 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "monthly"
+  - package-ecosystem: "maven"
+    directory: "/"
+    schedule:
+      interval: "monthly"

.github/workflows/automerge_dependabot.yml

@@ -0,0 +1,55 @@
+name: Auto-merge Dependabot PRs
+
+on:
+  workflow_run:
+    workflows: [ "Pull Request" ]
+    types: [ completed ]
+
+jobs:
+  merge-dependabot:
+    if: "github.actor == 'dependabot[bot]'
+      && github.event.workflow_run.event == 'pull_request'
+      && github.event.workflow_run.conclusion == 'success'"
+    runs-on: ubuntu-latest
+    steps:
+      # Note: this is directly from GitHub's example for using data from a triggering workflow:
+      # https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#using-data-from-the-triggering-workflow
+      - name: 'Download artifact'
+        uses: actions/github-script@v6
+        with:
+          script: |
+            let allArtifacts = await github.rest.actions.listWorkflowRunArtifacts({
+               owner: context.repo.owner,
+               repo: context.repo.repo,
+               run_id: context.payload.workflow_run.id,
+            });
+            let matchArtifact = allArtifacts.data.artifacts.filter((artifact) => {
+              return artifact.name == "pr_number"
+            })[0];
+            let download = await github.rest.actions.downloadArtifact({
+               owner: context.repo.owner,
+               repo: context.repo.repo,
+               artifact_id: matchArtifact.id,
+               archive_format: 'zip',
+            });
+            let fs = require('fs');
+            fs.writeFileSync(`${process.env.GITHUB_WORKSPACE}/pr_number.zip`, Buffer.from(download.data));
+
+      # This might be a useless use of cat, but I'm not sure what shell Actions is going to be running.
+      - name: Add Pull Number Variable
+        run: |-
+          unzip pr_number.zip
+          echo "PR_NUMBER=$(cat pr_number)" >> "$GITHUB_ENV"
+
+      - name: Approve
+        uses: hmarr/[email protected]
+        with:
+          github-token: "${{ secrets.GITHUB_TOKEN }}"
+          pull-request-number: "${{ env.PR_NUMBER }}"
+      - name: Merge
+        uses: pascalgn/[email protected]
+        env:
+          GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
+          MERGE_LABELS: "dependencies,java"
+          MERGE_METHOD: "squash"
+          PULL_REQUEST: "${{ env.PR_NUMBER }}"

.github/workflows/ci.yml

@@ -2,32 +2,26 @@ name: OpenInv CI
 
 on:
   push:
-  create:
-    types: [tag]
-  pull_request_target:
+    branches:
+      - '**'
+    tags-ignore:
+      - '**'
+  # Enable running CI via other Actions, i.e. for drafting releases and handling PRs.
+  workflow_call:
 
 jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout Code
-        uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
-      - name: Set Up Java
-        uses: actions/setup-java@v1
+      - uses: actions/setup-java@v3
         with:
-          java-version: 1.8
+          distribution: 'temurin'
+          java-version: '17'
+          cache: 'maven'
 
-      # Use cache to speed up build
-      - name: Cache Maven Repo
-        uses: actions/cache@v2
-        id: cache
-        with:
-          path: ~/.m2/repository
-          key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
-
-      # Install Spigot dependencies.
-      # This script uses Maven to check all required installations and ensure that they are present.
+      # Install Spigot dependencies if necessary.
       - name: Install Spigot Dependencies
         run: . scripts/install_spigot_dependencies.sh
 
@@ -37,51 +31,13 @@ jobs:
       # Upload artifacts
       - name: Upload Distributable Jar
         id: upload-final
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v3
         with:
           name: dist
           path: ./target/OpenInv.jar
       - name: Upload API Jar
         id: upload-api
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v3
         with:
           name: api
           path: ./api/target/openinvapi*.jar
-
-  release:
-    name: Create Github Release
-    needs: [ build ]
-    if: github.event_name == 'create' && github.event.ref_type == 'tag'
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout Code
-        uses: actions/checkout@v2
-
-      - name: Download Artifacts
-        uses: actions/download-artifact@v2
-
-      - name: Generate changelog
-        run: . scripts/generate_changelog.sh
-
-      - name: Create Release
-        id: create-release
-        uses: actions/create-release@v1
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          tag_name: ${{ github.ref }}
-          release_name: Release ${{ github.ref }}
-          body: ${{ env.GENERATED_CHANGELOG }}
-          draft: true
-          prerelease: false
-
-      - name: Upload Release Asset
-        id: upload-release-asset
-        uses: actions/[email protected]
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          upload_url: ${{ steps.create-release.outputs.upload_url }}
-          asset_path: ./OpenInv.jar
-          asset_name: OpenInv.jar
-          asset_content_type: application/java-archive

.github/workflows/draft_release.yml

@@ -0,0 +1,39 @@
+name: Draft Github Release
+
+on:
+  push:
+    tags:
+      - '**'
+
+jobs:
+  run-ci:
+    uses: Jikoo/OpenInv/.github/workflows/ci.yml@master
+  draft-release:
+    needs: [ run-ci ]
+    runs-on: ubuntu-latest
+    steps:
+      # Fetch all history - used to assemble changelog.
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set Release Variables
+        run: bash ./scripts/set_release_env.sh
+
+      - name: Download Artifact
+        uses: actions/download-artifact@v3
+        with:
+          name: dist
+          path: dist
+
+      - name: Create Release
+        id: create-release
+        uses: softprops/[email protected]
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          name: ${{ env.VERSIONED_NAME }}
+          body: ${{ env.GENERATED_CHANGELOG }}
+          draft: true
+          prerelease: false
+          files: ./dist/OpenInv.jar

.github/workflows/external_release.yml

@@ -0,0 +1,37 @@
+name: Release to CurseForge
+
+on:
+  release:
+    types: [ released ]
+
+jobs:
+  curseforge_release:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Fetch Github Release Asset
+        uses: dsaltares/[email protected]
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          version: ${{ github.event.release.id }}
+          file: OpenInv.jar
+
+      - name: Set CurseForge Variables
+        run: . scripts/set_curseforge_env.sh "${{ github.event.release.body }}"
+
+      - name: Create CurseForge Release
+        uses: itsmeow/curseforge-upload@v3
+        with:
+          token: "${{ secrets.CURSEFORGE_TOKEN }}"
+          project_id: 31432
+          game_endpoint: minecraft
+          file_path: ./OpenInv.jar
+          display_name: "${{ github.event.release.name }}"
+          game_versions: "${{ env.CURSEFORGE_MINECRAFT_VERSIONS }}"
+          release_type: release
+          changelog_type: markdown
+          changelog: "${{ env.CURSEFORGE_CHANGELOG }}"

.github/workflows/pull_request.yml

@@ -0,0 +1,22 @@
+name: Pull Request
+
+on:
+  pull_request:
+
+jobs:
+  run-ci:
+    uses: Jikoo/OpenInv/.github/workflows/ci.yml@master
+  store-dependabot-pr-data:
+    if: "github.actor == 'dependabot[bot]' && github.event_name == 'pull_request'"
+    runs-on: ubuntu-latest
+    steps:
+      # Note: this is directly from GitHub's example for using data from a triggering workflow:
+      # https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#using-data-from-the-triggering-workflow
+      - name: Store Pull Number
+        run: |
+          mkdir -p ./pr
+          echo ${{ github.event.number }} > ./pr/pr_number
+      - uses: actions/upload-artifact@v3
+        with:
+          name: pr_number
+          path: pr/

README.MD

@@ -15,48 +15,7 @@ OpenInv is a [Bukkit plugin](https://dev.bukkit.org/bukkit-plugins/openinv/) whi
 - **AnyContainer**: Open containers, even if blocked by ocelots or blocks.
 
 ## Commands
-<table width=100%>
-  <tr>
-    <th width=175px>Command</th>
-    <th>Aliases</th>
-    <th>Description</th>
-  </tr>
-  <tr>
-    <td>/openinv [player]</td>
-    <td>oi, inv, open</td>
-    <td>Open a player's inventory. If unspecified, will select last player opened or own if none opened previously.</td>
-  </tr>
-  <tr>
-    <td>/openender [player]</td>
-    <td>oe</td>
-    <td>Open a player's ender chest. If unspecified, will select last player opened or own if none opened previously.</td>
-  </tr>
-  <tr>
-    <td>/searchinv &ltitem&gt [minAmount]</td>
-    <td>si</td>
-    <td>Lists all online players that have a certain item in their inventory.</td>
-  </tr>
-  <tr>
-    <td>/searchender &ltitem&gt [minAmount]</td>
-    <td>se</td>
-    <td>Lists all online players that have a certain item in their ender chest.</td>
-  </tr>
-  <tr>
-    <td>/searchenchant &lt[enchantment] [MinLevel]&gt</td>
-    <td>searchenchants</td>
-    <td>Lists all online players with a specific enchantment.</td>
-  </tr>
-  <tr>
-    <td>/anycontainer [check]</td>
-    <td>ac, anychest</td>
-    <td>Check or toggle the AnyContainer function, allowing opening blocked containers.</td>
-  </tr>
-  <tr>
-    <td>/silentcontainer [check]</td>
-    <td>sc, silentchest</td>
-    <td>Check or toggle the SilentContainer function, allowing opening containers silently.</td>
-  </tr>
-</table>
+See [the wiki](https://github.com/Jikoo/OpenInv/wiki/Commands).
 
 ## Permissions
 <table>
@@ -143,30 +102,38 @@ OpenInv is a [Bukkit plugin](https://dev.bukkit.org/bukkit-plugins/openinv/) whi
 </table>
 
 ## For Developers
-To compile, the relevant Craftbukkit/Spigot jars must be installed in your local repository using the install plugin.
-Ex: `mvn install:install-file -Dpackaging=jar -Dfile=spigot-1.8-R0.1-SNAPSHOT.jar -DgroupId=org.spigotmc -DartifactId=spigot -Dversion=1.8-R0.1-SNAPSHOT`
-
-To compile for a single version, specify the NMS revision you are targeting: `mvn -pl <NMS module> -am clean install`
-
-To compile for a set of versions, you'll need to use a profile. The only provided profile is `all`. Select a profile using the `-P` argument: `mvn clean package -am -P all`
 
-For more information, check out the [official Maven guide](http://maven.apache.org/guides/introduction/introduction-to-profiles.html).
-
-The final file is `target/OpenInv.jar`
-
-## License
+### As a Dependency
+The OpenInv API is available via [JitPack](https://jitpack.io/).
+```xml
+  <repositories>
+    <repository>
+      <id>jitpack.io</id>
+      <url>https://jitpack.io</url>
+    </repository>
+  </repositories>
+```
+```xml
+  <dependencies>
+    <dependency>
+      <groupId>com.github.jikoo.OpenInv</groupId>
+      <artifactId>openinvapi</artifactId>
+      <version>${openinv.version}</version>
+    </dependency>
+  </dependencies>
 ```
-Copyright (C) 2011-2020 lishid. All rights reserved.
 
-This program is free software: you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation, version 3.
+### Compilation
+To compile, the relevant Spigot jars must be installed in the local repository.
+As OpenInv is compiled against Mojang's mappings, you must run BuildTools with the `--remapped` argument:  
+`java -jar BuildTools.jar --remapped --rev $serverVersion`  
+`$serverVersion` is the version of the server, i.e. `1.18.1`
 
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-GNU General Public License for more details.
+To compile for a single version, specify the module you are targeting:  
+`mvn -pl $moduleName -am clean install`  
+`$moduleName` is the name of the module, i.e. `internal/v1_18_R1`.
 
-You should have received a copy of the GNU General Public License
-along with this program. If not, see <http://www.gnu.org/licenses/>.
-```
+To compile for a set of versions, use a profile. Select a profile using the `-P` argument:  
+`mvn clean package -am -P all`  
+The only provided profile is `all`. The final file is `target/OpenInv.jar`  
+For more information, check out the [official Maven guide](http://maven.apache.org/guides/introduction/introduction-to-profiles.html).