Merge remote-tracking branch 'upstream/2.x' into 2.x

Author: Golfing7

.github/ISSUE_TEMPLATE/config.yml

@@ -7,14 +7,11 @@ contact_links:
     url: https://github.com/EssentialsX/Essentials/discussions/categories/q-a
     about: Visit the Q&A forum to search for previous help requests.
   - name: Check past feature suggestions
-    url: https://github.com/EssentialsX/Essentials/discussions/categories/ideas-and-feature-suggestions
+    url: https://github.com/EssentialsX/Essentials/issues?q=is%3Aissue+label%3A%22type%3A+enhancement%22
     about: Visit the Feature Suggestions forum to view and discuss existing feature suggestions.
   - name: Create help request
     url: https://github.com/EssentialsX/Essentials/discussions/new?category=q-a
     about: Create a support ticket to get help from developers.
-  - name: Suggest a feature
-    url: https://github.com/EssentialsX/Essentials/discussions/new?category=ideas-and-feature-suggestions
-    about: Suggest new features for EssentialsX!
   - name: Get help from the community on Discord
     url: https://discord.gg/casfFyh
     about: Join the MOSS Discord for community-powered EssentialsX support!

.github/ISSUE_TEMPLATE/request-a-feature.yml

@@ -0,0 +1,40 @@
+name: Request a feature
+description: Suggest a feature you want to see in EssentialsX!
+labels: 'type: enhancement'
+body:
+- type: markdown
+  attributes:
+    value: |
+      If you have a feature suggestion for EssentialsX, read the following tips:
+      1.  Fill out the template.
+            This will help us understand what you're requesting and why you want us
+            to add it.
+      2.  Keep it simple.
+            Make sure it's easy to understand what you're requesting. A good way is
+            to keep it to one request per GitHub issue, as we can then easily track
+            feature requests.
+      3.  Check whether it has already been asked or added.
+            You can search the issue tracker to see if your feature has already been
+            requested at https://github.com/EssentialsX/Essentials/issues. You can
+            also check the changelogs to see if the feature was recently added:
+            https://github.com/EssentialsX/Essentials/releases
+      4.  Ask yourself: "Does this belong in EssentialsX?"
+            There are lots of features that we reject because most servers won't
+            need or use them. If your feature is very specific or already exists in
+            another plugin, it might not be a good fit for EssentialsX.
+- type: textarea
+  attributes:
+    label: Feature description
+    description: Explain what you should expect to happen.
+    placeholder: |
+      What feature are you suggesting?
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: How the feature is useful
+    description: Explain what actually happens.
+    placeholder: |
+      How is the feature useful to players, server owners and/or developers?
+  validations:
+    required: true

.github/workflows/build-master.yml

@@ -5,6 +5,9 @@ on:
     branches:
     - 2.x
     - dev/*
+  release:
+    types:
+    - published
 
 jobs:
   build:
@@ -13,34 +16,26 @@ jobs:
 
     steps:
     - name: Checkout Git repo
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
       with:
         fetch-depth: 0
 
-    - name: Restore Gradle cache
-      uses: actions/cache@v2
+    - name: Set up JDK 17
+      uses: actions/setup-java@v3
       with:
-        path: ~/.gradle/caches
-        key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*') }}
-        restore-keys: |
-          ${{ runner.os }}-gradle-
+        distribution: 'temurin'
+        java-version: 17
 
-    - name: Set up JDK 16
-      uses: actions/setup-java@v2
-      with:
-        distribution: 'adopt'
-        java-version: 16
-
-    - name: Validate Gradle Wrapper
-      uses: gradle/wrapper-validation-action@v1
+    - name: Setup Gradle
+      uses: gradle/gradle-build-action@v2
 
     - name: Build with Gradle
       run: |
         chmod +x gradlew
         ./gradlew build --stacktrace
 
     - name: Archive plugin jars on GitHub
-      uses: actions/upload-artifact@master
+      uses: actions/upload-artifact@v3
       with:
         name: EssentialsX plugin jars
         path: jars/
@@ -54,22 +49,43 @@ jobs:
         ./gradlew publish
 
     - name: Prepare Javadocs
-      if: ${{ success() && github.event_name == 'push' && github.repository == 'EssentialsX/Essentials' && github.ref == 'refs/heads/2.x' }}
       run: |
         mv Essentials/build/docs/javadoc/ javadocs/
         cp -r EssentialsAntiBuild/build/docs/javadoc/ javadocs/EssentialsAntiBuild/
         cp -r EssentialsChat/build/docs/javadoc/ javadocs/EssentialsChat/
         cp -r EssentialsDiscord/build/docs/javadoc/ javadocs/EssentialsDiscord/
+        cp -r EssentialsDiscordLink/build/docs/javadoc/ javadocs/EssentialsDiscordLink/
         cp -r EssentialsGeoIP/build/docs/javadoc/ javadocs/EssentialsGeoIP/
         cp -r EssentialsProtect/build/docs/javadoc/ javadocs/EssentialsProtect/
         cp -r EssentialsSpawn/build/docs/javadoc/ javadocs/EssentialsSpawn/
         cp -r EssentialsXMPP/build/docs/javadoc/ javadocs/EssentialsXMPP/
 
-    - name: Deploy Javadocs
-      if: ${{ success() && github.event_name == 'push' && github.repository == 'EssentialsX/Essentials' && github.ref == 'refs/heads/2.x' }}
-      uses: netlify/actions/cli@master
+    - name: Archive Javadocs
+      uses: actions/upload-artifact@v3
+      with:
+        name: javadocs
+        path: javadocs/
+
+  publish-jd:
+    name: Publish Javadocs
+    needs: build
+    if: ${{ github.event_name == 'push' && github.repository == 'EssentialsX/Essentials' && github.ref == 'refs/heads/2.x' }}
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Setup Node
+      uses: actions/setup-node@v3
       with:
-        args: deploy --dir=javadocs/ --prod --message="GitHubActionsDeploy"
+        node-version: 16
+
+    - name: Download Javadocs
+      uses: actions/download-artifact@v3
+      with:
+        name: javadocs
+        path: javadocs/
+
+    - name: Deploy Javadocs
+      run: npx netlify-cli deploy --dir=javadocs/ --prod --message="GitHubActionsDeploy"
       env:
         NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_JD_AUTH_TOKEN }}
         NETLIFY_SITE_ID: ${{ secrets.NETLIFY_JD_2X_SITE_ID }}

.github/workflows/build-pr.yml

@@ -18,34 +18,26 @@ jobs:
 
     steps:
     - name: Checkout Git repo
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
       with:
         fetch-depth: 0
 
-    - name: Restore Gradle cache
-      uses: actions/cache@v2
+    - name: Set up JDK 17
+      uses: actions/setup-java@v3
       with:
-        path: ~/.gradle/caches
-        key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*') }}
-        restore-keys: |
-          ${{ runner.os }}-gradle-
+        distribution: 'temurin'
+        java-version: 17
 
-    - name: Set up JDK 16
-      uses: actions/setup-java@v2
-      with:
-        distribution: 'adopt'
-        java-version: 16
-
-    - name: Validate Gradle Wrapper
-      uses: gradle/wrapper-validation-action@v1
+    - name: Setup Gradle
+      uses: gradle/gradle-build-action@v2
 
     - name: Build with Gradle
       run: |
         chmod +x gradlew
         ./gradlew build --stacktrace
 
     - name: Archive plugin jars on GitHub
-      uses: actions/upload-artifact@master
+      uses: actions/upload-artifact@v3
       with:
         name: EssentialsX plugin jars
         path: jars/

.gitignore

@@ -15,6 +15,8 @@
 /Essentials/kits.yml
 /Essentials/userdata/testplayer1.yml
 /Essentials/usermap.csv
+/Essentials/usermap.bin
+/Essentials/uuids.bin
 
 # Build files
 .gradle/

.idea/checkstyle-idea.xml

@@ -1,31 +1,102 @@
-Contributing to EssentialsX
-===========================
+# Contributing to EssentialsX
 
-Want to help improve EssentialsX? There are several ways you can support and contribute to the project.
+*By contributing to EssentialsX, you agree to license your changes under the [GNU General Public License version 3](https://github.com/EssentialsX/Essentials/blob/2.x/LICENSE).*
 
-If you'd like to make a financial contribution to the project, you can join our [Patreon](https://www.patreon.com/essentialsx/),
-or to make a one-off donation you can visit our [Ko-fi page](https://ko-fi.com/essentialsx). If you can't make a
-donation, don't worry! There are lots of other ways to contribute:
+## Submitting code changes to EssentialsX
 
-* Do you run a server? Take a look at our ["help wanted"](https://github.com/EssentialsX/Essentials/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22help+wanted%22)
-  and ["bug: unconfirmed"](https://github.com/EssentialsX/Essentials/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22bug%3A+unconfirmed%22)
-  issues, where you can find issues that need extra testing and investigation.
-* Do you speak multiple languages? If so, we always welcome contributions to our [Crowdin project](https://crowdin.com/project/essentialsx-official).
-* Do you enjoy helping others? If so, why not contribute to the [EssentialsX documentation](https://github.com/EssentialsX/wiki)?
-  You can also join the [MOSS Discord community](https://discord.gg/casfFyh) and provide direct community support to
-  other EssentialsX users.
-* If you're a developer, you could look through our ["open to PR"](https://github.com/EssentialsX/Essentials/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22status%3A+open+to+PR%22)
-  issues. We're always happy to receive bug fixes and feature additions as pull requests.
+If you're interested in submitting new code to EssentialsX, we accept changes via GitHub pull requests.
 
-Submitting a PR
----------------
+### Adding features
 
-EssentialsX has extensive templates for PRs that detail how to submit your PR. To find out more, see the PR templates for:
-* [Bug fixes](https://github.com/EssentialsX/Essentials/blob/2.x/.github/PULL_REQUEST_TEMPLATE/bug-fix.md) 
-* [New features](https://github.com/EssentialsX/Essentials/blob/2.x/.github/PULL_REQUEST_TEMPLATE/new-feature.md)
+In general, we will only consider PRs for features if they have already been discussed with the team through
+GitHub issues and discussions. Check the list of
+["open to PR" issues](https://github.com/EssentialsX/Essentials/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22status%3A+open+to+PR%22)
+and [feature request discussions](https://github.com/EssentialsX/Essentials/discussions/categories/ideas-and-feature-suggestions)
+before you start working on your changes. If you don't see your desired feature listed,
+[open a feature request](https://github.com/EssentialsX/Essentials/issues/new/choose) and wait for a response, otherwise
+you may end up wasting your time on a feature that we aren't in a position to accept.
 
-Want to discuss a feature before opening a PR? Join the [EssentialsX Development Discord server](https://discord.gg/CUN7qVb). Note that this server is **not for end-users** - if you need support with EssentialsX, you should join [MOSS](https://discord.gg/casfFyh) instead.
+#### Keep it focused
 
-By contributing to EssentialsX, you agree to license your code under the [GNU General Public License version 3](https://github.com/EssentialsX/Essentials/blob/2.x/LICENSE).
+Please try to keep feature PRs focused around one feature. Your PR should ideally contain
+one feature, or a few closely-linked features. If you submit several unrelated features 
+in one PR, the PR will not be accepted.
 
+### Fixing bugs
 
+If you're opening a PR to fix a bug, please ensure a bug report has been filed - search the
+[issue tracker](https://github.com/EssentialsX/Essentials/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22bug%3A+confirmed%22%2C%22bug%3A+unconfirmed%22%2C%22bug%3A+upstream%22)
+for an existing report, and if you can't find a bug report,
+[create one](https://github.com/EssentialsX/Essentials/issues/new/choose) before you submit your PR.
+
+#### Unconfirmed bugs
+
+You may find a bug report with the label `bug: unconfirmed`. This means the EssentialsX team hasn't had the time
+to review the bug report yet or hasn't been able to confirm
+whether the reported issue is actually a bug in EssentialsX. You can help us by following the steps in the report and
+posting whether you are able to replicate this issue, ideally on the latest versions of EssentialsX and Paper. This will
+help us confirm issues and prioritise PRs accordingly.
+
+#### Upstream bugs
+
+You may also find bug reports with the `bug: upstream` label. This label means the issue is caused by a bug in *another
+project*, not EssentialsX. This includes bugs in CraftBukkit/Spigot and bugs in other plugins. It may be appropriate to
+mitigate an issue in EssentialsX, but please check with us in the [EssentialsX Development Discord server](https://discord.gg/CUN7qVb) before you submit a PR.
+
+### Making your changes
+
+You'll need the following to make your changes to EssentialsX:
+
+* A GitHub account
+* [`git`](https://git-scm.com/downloads): the Git command-line tool, used to track and save your changes
+* [`gh`](https://cli.github.com/): the GitHub command-line tool, used to submit your changes to EssentialsX
+* Your IDE of choice - we recommend [IntelliJ IDEA Community Edition](https://www.jetbrains.com/idea/download)
+
+If you're already familiar with Git, you can skip this next section.
+
+You'll need to clone the EssentialsX repository
+(`gh repo clone EssentialsX/Essentials`), then create a new branch for your work
+(`cd Essentials` then `git switch -c my-cool-pr`).
+
+You can then make changes using your IDE of choice. Follow the instructions in `README.md` to build and test your
+changes.
+
+Once you've finished, you should commit your changes (`git commit -am "My cool commit name!"`).
+
+### Submitting your PR
+
+*Even if you're already familiar with GitHub, you will need to follow these steps in order to submit a PR to
+EssentialsX. This ensures we have the information we need to test and review your changes.*
+
+Next, you'll need to fork EssentialsX on GitHub and push your changes to a branch on that fork. We strongly recommend
+using the `gh` command-line tool for this:
+
+* In your terminal, run `gh pr create`.
+* Select either the bug fix or feature template, depending on what your PR is for.
+* If you get asked `Where should we push the '...' branch?`, select `Create a fork of EssentialsX/Essentials`.
+* For the title, choose a title that describes what your PR does. For example, `Add more ducks to /spawnmob`.
+* For the body, press E. You will then need to fill in the PR template in your text editor.
+  - Follow the instructions in the template and fill out the sections as required.
+  - This step is important! Without it, we won't know why you've made your changes or how to test them.
+* Save the file in your text editor and close it, then return to the terminal.
+* Select `Submit` to open your PR.
+
+If you follow these steps correctly, GitHub will create a fork (if necessary) and then open a PR with your changes. You
+can now sit back while we review your changes. If we need to ask questions or request further changes to your code,
+we will review your PR and post a comment on GitHub. You can respond to our reviews and comments on the GitHub website,
+and you can push new changes using `git commit` and `git push`.
+
+
+## Submitting community translations to EssentialsX
+
+EssentialsX relies on community translations for its messages in other languages. You can help translate EssentialsX on
+[Crowdin](https://translate.essentialsx.net/). You'll need a Crowdin account to translate and improve messages.
+
+If your language isn't listed or doesn't have an active proofreader, please let us know on Discord (see below).
+
+
+## Discussing EssentialsX contributions 
+
+Want to discuss something before opening a PR or translating messages? Join the
+[EssentialsX Development Discord server](https://discord.gg/CUN7qVb). Note that this server is **not for end-users** -
+if you need support with EssentialsX, you should join [MOSS](https://discord.gg/casfFyh) instead.

CONTRIBUTING.md

@@ -29,6 +29,10 @@ dependencies {
     }
 }
 
+test {
+    testLogging.showStandardStreams = true
+}
+
 shadowJar {
     dependencies {
         include (dependency('io.papermc:paperlib'))