├── .github ├── CODEOWNERS ├── FUNDING.yml ├── ISSUE_TEMPLATE │ ├── bug_report.md │ └── feature_request.md ├── actions │ └── common-setup │ │ └── action.yml ├── dependabot.yml ├── stale.yml └── workflows │ ├── main.yml │ ├── pr.yml │ ├── release.yml │ └── tag.yml ├── .gitignore ├── CODE_OF_CONDUCT.md ├── CONTRIBUTING.md ├── LICENSE ├── README.md ├── build.gradle ├── config └── checkstyle │ └── checkstyle.xml ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── gradlew ├── gradlew.bat ├── settings.gradle └── src ├── main ├── java │ └── com │ │ └── crimsonwarpedcraft │ │ └── exampleplugin │ │ └── ExamplePlugin.java └── resources │ ├── config.yml │ └── plugin.yml └── test ├── java └── com │ └── crimsonwarpedcraft │ └── exampleplugin │ └── ExamplePluginTest.java └── resources └── .gitkeep /.github/CODEOWNERS: -------------------------------------------------------------------------------- 1 | * @leviem1 2 | -------------------------------------------------------------------------------- /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | github: leviem1 2 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/bug_report.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Bug report 3 | about: Create a report to help us improve 4 | title: '' 5 | labels: bug 6 | assignees: '' 7 | 8 | --- 9 | 10 | **Describe the bug** 11 | A clear and concise description of what the bug is. 12 | 13 | **To Reproduce** 14 | Steps to reproduce the behavior: 15 | 1. Go to '...' 16 | 2. Click on '....' 17 | 3. Scroll down to '....' 18 | 4. See error 19 | 20 | **Expected behavior** 21 | A clear and concise description of what you expected to happen. 22 | 23 | **Screenshots** 24 | If applicable, add screenshots to help explain your problem. 25 | 26 | **Version information:** 27 | - Vanilla version: [e.g. 1.16.1] 28 | - Server version: [e.g. paper-123] 29 | - Plugin version [e.g. v0.1.0] 30 | 31 | **Additional context** 32 | Add any other context about the problem here including console errors. 33 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/feature_request.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Feature request 3 | about: Suggest an idea for this project 4 | title: '' 5 | labels: enhancement 6 | assignees: '' 7 | 8 | --- 9 | 10 | **Is your feature request related to a problem? Please describe.** 11 | A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] 12 | 13 | **Describe the solution you'd like** 14 | A clear and concise description of what you want to happen. 15 | 16 | **Describe alternatives you've considered** 17 | A clear and concise description of any alternative solutions or features you've considered. 18 | 19 | **Additional context** 20 | Add any other context or screenshots about the feature request here. 21 | -------------------------------------------------------------------------------- /.github/actions/common-setup/action.yml: -------------------------------------------------------------------------------- 1 | name: 'Common Setup' 2 | description: 'Set up JDK and grant execute permissions for gradlew' 3 | 4 | inputs: 5 | java-version: 6 | description: 'Java version' 7 | required: true 8 | default: '21' 9 | 10 | runs: 11 | using: 'composite' 12 | steps: 13 | - name: Set up JDK 14 | uses: actions/setup-java@v4 15 | with: 16 | java-version: ${{ inputs.java-version }} 17 | distribution: 'zulu' 18 | cache: gradle 19 | 20 | - name: Setup Gradle 21 | uses: gradle/actions/setup-gradle@v3 22 | -------------------------------------------------------------------------------- /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | version: 2 2 | updates: 3 | - package-ecosystem: "github-actions" 4 | directory: "/" 5 | schedule: 6 | interval: "weekly" 7 | commit-message: 8 | prefix: "build:" 9 | target-branch: "main" 10 | - package-ecosystem: "gradle" 11 | directory: "/" 12 | schedule: 13 | interval: "weekly" 14 | commit-message: 15 | prefix: "deps:" 16 | target-branch: "main" 17 | -------------------------------------------------------------------------------- /.github/stale.yml: -------------------------------------------------------------------------------- 1 | # Number of days of inactivity before an issue becomes stale 2 | daysUntilStale: 30 3 | 4 | # Number of days of inactivity before a stale issue is closed 5 | daysUntilClose: false 6 | 7 | # Label to use when marking an issue as stale 8 | staleLabel: stale 9 | 10 | # Issues or Pull Requests with these labels will never be considered stale. Set to `[]` to disable 11 | exemptLabels: 12 | - "low priority" 13 | 14 | # Comment to post when marking an issue as stale. Set to `false` to disable 15 | markComment: > 16 | This issue has been automatically marked as stale because it has not had 17 | recent activity. 18 | 19 | # Comment to post when closing a stale issue. Set to `false` to disable 20 | closeComment: false 21 | -------------------------------------------------------------------------------- /.github/workflows/main.yml: -------------------------------------------------------------------------------- 1 | name: Test and Release 2 | 3 | permissions: 4 | contents: read 5 | 6 | on: 7 | push: 8 | branches: 9 | - 'main' 10 | schedule: 11 | # PaperMC doesn't change version numbers for latest releases meaning the build may break 12 | # unexpectedly. Build every so often so that we know if a breaking change has been published 13 | - cron: '0 0 * * 6' 14 | 15 | concurrency: 16 | group: ${{ format('{0}-{1}', github.workflow, github.ref) }} 17 | cancel-in-progress: false 18 | 19 | jobs: 20 | test: 21 | name: Run unit tests 22 | strategy: 23 | matrix: 24 | os: [ ubuntu-latest, windows-latest ] 25 | java: [ 21 ] 26 | runs-on: ${{ matrix.os }} 27 | permissions: 28 | contents: write 29 | steps: 30 | - name: Checkout code 31 | uses: actions/checkout@v4 32 | 33 | - name: Common Setup 34 | uses: ./.github/actions/common-setup 35 | with: 36 | java-version: ${{ matrix.java }} 37 | 38 | - name: Build with Gradle 39 | run: ./gradlew build --info 40 | 41 | - name: Upload build results 42 | uses: actions/upload-artifact@v4 43 | with: 44 | name: ${{ matrix.os }} Java ${{ matrix.java }} build results 45 | path: ${{ github.workspace }}/build/libs/ 46 | 47 | - name: Upload test results 48 | if: ${{ always() }} 49 | uses: actions/upload-artifact@v4 50 | with: 51 | name: ${{ matrix.os }} Java ${{ matrix.java }} test results 52 | path: ${{ github.workspace }}/build/reports/ 53 | 54 | release: 55 | runs-on: ubuntu-latest 56 | permissions: 57 | contents: write 58 | needs: 59 | - test 60 | steps: 61 | - name: Checkout code 62 | uses: actions/checkout@v4 63 | 64 | - name: Common Setup 65 | uses: ./.github/actions/common-setup 66 | with: 67 | java-version: 21 68 | 69 | - name: Publish with Gradle 70 | run: ./gradlew -Pver="0.0.0-RC-1" release 71 | 72 | - name: Upload build results 73 | uses: actions/upload-artifact@v4 74 | with: 75 | name: Release Build 76 | path: ${{ github.workspace }}/build/libs/ 77 | 78 | notify: 79 | name: Send job complete notification 80 | runs-on: ubuntu-latest 81 | needs: 82 | - test 83 | - release 84 | if: always() && vars.DISCORD_WEBHOOK_ID 85 | steps: 86 | - name: Checkout code 87 | uses: actions/checkout@v4 88 | 89 | - name: Common Setup 90 | uses: ./.github/actions/common-setup 91 | with: 92 | java-version: 21 93 | 94 | - name: Retrieve Project Name 95 | run: echo "PROJECT_NAME=$(${{github.workspace}}/gradlew -q printProjectName)" >> $GITHUB_ENV 96 | 97 | - name: Notify on success 98 | if: success() 99 | uses: appleboy/discord-action@v1.2.0 100 | with: 101 | webhook_id: ${{ vars.DISCORD_WEBHOOK_ID }} 102 | webhook_token: ${{ secrets.DISCORD_WEBHOOK_TOKEN }} 103 | color: "#00FF00" 104 | username: "${{ env.PROJECT_NAME }} Release Bot" 105 | message: > 106 | An ${{ env.PROJECT_NAME }} snapshot was deployed by ${{ github.actor }}: 107 | https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }} 108 | 109 | - name: Notify on failure 110 | if: failure() 111 | uses: appleboy/discord-action@v1.2.0 112 | with: 113 | webhook_id: ${{ vars.DISCORD_WEBHOOK_ID }} 114 | webhook_token: ${{ secrets.DISCORD_WEBHOOK_TOKEN }} 115 | color: "#FF0000" 116 | username: "${{ env.PROJECT_NAME }} Release Bot" 117 | message: > 118 | An ${{ env.PROJECT_NAME }} snapshot deployment ran by ${{ github.actor }} failed: 119 | https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }} 120 | -------------------------------------------------------------------------------- /.github/workflows/pr.yml: -------------------------------------------------------------------------------- 1 | name: Test 2 | 3 | permissions: 4 | contents: read 5 | 6 | on: 7 | pull_request: 8 | branches: 9 | - 'main' 10 | merge_group: 11 | types: 12 | - checks_requested 13 | 14 | concurrency: 15 | group: ${{ format('{0}-{1}', github.workflow, github.ref) }} 16 | cancel-in-progress: true 17 | 18 | jobs: 19 | test: 20 | name: Run unit tests 21 | strategy: 22 | matrix: 23 | os: [ ubuntu-latest, windows-latest ] 24 | java: [ 21 ] 25 | runs-on: ${{ matrix.os }} 26 | permissions: 27 | contents: write 28 | steps: 29 | - name: Checkout code 30 | uses: actions/checkout@v4 31 | 32 | - name: Common Setup 33 | uses: ./.github/actions/common-setup 34 | with: 35 | java-version: ${{ matrix.java }} 36 | 37 | - name: Build with Gradle 38 | run: ./gradlew build --info 39 | 40 | - name: Upload build results 41 | uses: actions/upload-artifact@v4 42 | with: 43 | name: ${{ matrix.os }} Java ${{ matrix.java }} build results 44 | path: ${{ github.workspace }}/build/libs/ 45 | 46 | - name: Upload test results 47 | if: ${{ always() }} 48 | uses: actions/upload-artifact@v4 49 | with: 50 | name: ${{ matrix.os }} Java ${{ matrix.java }} test results 51 | path: ${{ github.workspace }}/build/reports/ 52 | -------------------------------------------------------------------------------- /.github/workflows/release.yml: -------------------------------------------------------------------------------- 1 | name: Notify on Release 2 | 3 | permissions: 4 | contents: read 5 | 6 | on: 7 | release: 8 | types: 9 | - published 10 | 11 | jobs: 12 | notify: 13 | name: Send job complete notification 14 | runs-on: ubuntu-latest 15 | if: vars.DISCORD_RELEASE_WEBHOOK_ID || vars.DISCORD_WEBHOOK_ID 16 | steps: 17 | - name: Checkout code 18 | uses: actions/checkout@v4 19 | 20 | - name: Common Setup 21 | uses: ./.github/actions/common-setup 22 | 23 | - name: Retrieve Project Name 24 | run: echo "PROJECT_NAME=$(${{github.workspace}}/gradlew -q printProjectName)" >> $GITHUB_ENV 25 | id: project_name 26 | 27 | - name: Set pre-release environment 28 | if: ${{ github.event.release.prerelease }} 29 | run: | 30 | echo "RELEASE_TYPE=pre-release" >> $GITHUB_ENV 31 | 32 | - name: Set release environment 33 | if: ${{ !github.event.release.prerelease }} 34 | run: | 35 | echo "RELEASE_TYPE=release" >> $GITHUB_ENV 36 | 37 | - name: Notify 38 | uses: appleboy/discord-action@v1.2.0 39 | with: 40 | webhook_id: ${{ !github.event.release.prerelease && vars.DISCORD_RELEASE_WEBHOOK_ID || vars.DISCORD_WEBHOOK_ID }} 41 | webhook_token: ${{ !github.event.release.prerelease && secrets.DISCORD_RELEASE_WEBHOOK_TOKEN || secrets.DISCORD_WEBHOOK_TOKEN }} 42 | color: "#00FF00" 43 | username: "${{ env.PROJECT_NAME }} Release Bot" 44 | message: > 45 | An ${{ env.PROJECT_NAME }} ${{ env.RELEASE_TYPE }} was deployed by ${{ github.actor }}: 46 | https://github.com/${{ github.repository }}/releases/tag/${{ github.ref_name }} 47 | -------------------------------------------------------------------------------- /.github/workflows/tag.yml: -------------------------------------------------------------------------------- 1 | name: Release 2 | 3 | permissions: 4 | contents: read 5 | 6 | on: 7 | push: 8 | tags: 9 | - 'v*' # For v1.0, v0.1.0, etc 10 | 11 | concurrency: 12 | group: ${{ format('{0}-{1}', github.workflow, github.ref) }} 13 | cancel-in-progress: true 14 | 15 | jobs: 16 | release: 17 | runs-on: ubuntu-latest 18 | permissions: 19 | contents: write 20 | steps: 21 | - name: Checkout code 22 | uses: actions/checkout@v4 23 | 24 | - name: Common Setup 25 | uses: ./.github/actions/common-setup 26 | 27 | - name: Publish with Gradle 28 | run: ./gradlew -Pver=${{ github.ref_name }} release 29 | 30 | - name: Upload build results 31 | uses: actions/upload-artifact@v4 32 | with: 33 | name: Release Build 34 | path: ${{ github.workspace }}/build/libs/ 35 | 36 | - name: Create Release 37 | uses: softprops/action-gh-release@v2 38 | id: release 39 | with: 40 | files: ${{ github.workspace }}/build/libs/* 41 | generate_release_notes: true 42 | name: ${{ format('Release {0}', github.ref_name) }} 43 | prerelease: ${{ contains(github.ref_name, '-rc-') }} 44 | fail_on_unmatched_files: true 45 | draft: true 46 | outputs: 47 | url: ${{ steps.release.outputs.url }} 48 | 49 | notify: 50 | name: Send job complete notification 51 | runs-on: ubuntu-latest 52 | needs: 53 | - release 54 | if: always() && vars.DISCORD_WEBHOOK_ID 55 | steps: 56 | - name: Checkout code 57 | uses: actions/checkout@v4 58 | 59 | - name: Common Setup 60 | uses: ./.github/actions/common-setup 61 | with: 62 | java-version: 21 63 | 64 | - name: Retrieve Project Name 65 | run: echo "PROJECT_NAME=$(${{github.workspace}}/gradlew -q printProjectName)" >> $GITHUB_ENV 66 | 67 | - name: Notify on success 68 | if: success() 69 | uses: appleboy/discord-action@v1.2.0 70 | with: 71 | webhook_id: ${{ vars.DISCORD_WEBHOOK_ID }} 72 | webhook_token: ${{ secrets.DISCORD_WEBHOOK_TOKEN }} 73 | color: "#00FF00" 74 | username: "${{ env.PROJECT_NAME }} Release Bot" 75 | message: > 76 | An ${{ env.PROJECT_NAME }} release draft was deployed by ${{ github.actor }}: 77 | ${{ needs.release.outputs.url }} 78 | 79 | - name: Notify on failure 80 | if: failure() 81 | uses: appleboy/discord-action@v1.2.0 82 | with: 83 | webhook_id: ${{ vars.DISCORD_WEBHOOK_ID }} 84 | webhook_token: ${{ secrets.DISCORD_WEBHOOK_TOKEN }} 85 | color: "#FF0000" 86 | username: "${{ env.PROJECT_NAME }} Release Bot" 87 | message: > 88 | An ${{ env.PROJECT_NAME }} release draft ran by ${{ github.actor }} failed: 89 | https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }} 90 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .gradle/ 2 | build/ 3 | -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Contributor Covenant Code of Conduct 2 | 3 | ## Our Pledge 4 | 5 | We as members, contributors, and leaders pledge to make participation in our 6 | community a harassment-free experience for everyone, regardless of age, body 7 | size, visible or invisible disability, ethnicity, sex characteristics, gender 8 | identity and expression, level of experience, education, socio-economic status, 9 | nationality, personal appearance, race, religion, or sexual identity 10 | and orientation. 11 | 12 | We pledge to act and interact in ways that contribute to an open, welcoming, 13 | diverse, inclusive, and healthy community. 14 | 15 | ## Our Standards 16 | 17 | Examples of behavior that contributes to a positive environment for our 18 | community include: 19 | 20 | * Demonstrating empathy and kindness toward other people 21 | * Being respectful of differing opinions, viewpoints, and experiences 22 | * Giving and gracefully accepting constructive feedback 23 | * Accepting responsibility and apologizing to those affected by our mistakes, 24 | and learning from the experience 25 | * Focusing on what is best not just for us as individuals, but for the 26 | overall community 27 | 28 | Examples of unacceptable behavior include: 29 | 30 | * The use of sexualized language or imagery, and sexual attention or 31 | advances of any kind 32 | * Trolling, insulting or derogatory comments, and personal or political attacks 33 | * Public or private harassment 34 | * Publishing others' private information, such as a physical or email 35 | address, without their explicit permission 36 | * Other conduct which could reasonably be considered inappropriate in a 37 | professional setting 38 | 39 | ## Enforcement Responsibilities 40 | 41 | Community leaders are responsible for clarifying and enforcing our standards of 42 | acceptable behavior and will take appropriate and fair corrective action in 43 | response to any behavior that they deem inappropriate, threatening, offensive, 44 | or harmful. 45 | 46 | Community leaders have the right and responsibility to remove, edit, or reject 47 | comments, commits, code, wiki edits, issues, and other contributions that are 48 | not aligned to this Code of Conduct, and will communicate reasons for moderation 49 | decisions when appropriate. 50 | 51 | ## Scope 52 | 53 | This Code of Conduct applies within all community spaces, and also applies when 54 | an individual is officially representing the community in public spaces. 55 | Examples of representing our community include using an official e-mail address, 56 | posting via an official social media account, or acting as an appointed 57 | representative at an online or offline event. 58 | 59 | ## Enforcement 60 | 61 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 62 | reported to the community leaders responsible for enforcement at 63 | levi.muniz17@gmail.com. 64 | All complaints will be reviewed and investigated promptly and fairly. 65 | 66 | All community leaders are obligated to respect the privacy and security of the 67 | reporter of any incident. 68 | 69 | ## Enforcement Guidelines 70 | 71 | Community leaders will follow these Community Impact Guidelines in determining 72 | the consequences for any action they deem in violation of this Code of Conduct: 73 | 74 | ### 1. Correction 75 | 76 | **Community Impact**: Use of inappropriate language or other behavior deemed 77 | unprofessional or unwelcome in the community. 78 | 79 | **Consequence**: A private, written warning from community leaders, providing 80 | clarity around the nature of the violation and an explanation of why the 81 | behavior was inappropriate. A public apology may be requested. 82 | 83 | ### 2. Warning 84 | 85 | **Community Impact**: A violation through a single incident or series 86 | of actions. 87 | 88 | **Consequence**: A warning with consequences for continued behavior. No 89 | interaction with the people involved, including unsolicited interaction with 90 | those enforcing the Code of Conduct, for a specified period of time. This 91 | includes avoiding interactions in community spaces as well as external channels 92 | like social media. Violating these terms may lead to a temporary or 93 | permanent ban. 94 | 95 | ### 3. Temporary Ban 96 | 97 | **Community Impact**: A serious violation of community standards, including 98 | sustained inappropriate behavior. 99 | 100 | **Consequence**: A temporary ban from any sort of interaction or public 101 | communication with the community for a specified period of time. No public or 102 | private interaction with the people involved, including unsolicited interaction 103 | with those enforcing the Code of Conduct, is allowed during this period. 104 | Violating these terms may lead to a permanent ban. 105 | 106 | ### 4. Permanent Ban 107 | 108 | **Community Impact**: Demonstrating a pattern of violation of community 109 | standards, including sustained inappropriate behavior, harassment of an 110 | individual, or aggression toward or disparagement of classes of individuals. 111 | 112 | **Consequence**: A permanent ban from any sort of public interaction within 113 | the community. 114 | 115 | ## Attribution 116 | 117 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], 118 | version 2.0, available at 119 | https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. 120 | 121 | Community Impact Guidelines were inspired by [Mozilla's code of conduct 122 | enforcement ladder](https://github.com/mozilla/diversity). 123 | 124 | [homepage]: https://www.contributor-covenant.org 125 | 126 | For answers to common questions about this code of conduct, see the FAQ at 127 | https://www.contributor-covenant.org/faq. Translations are available at 128 | https://www.contributor-covenant.org/translations. -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # How to Contribute 2 | 3 | ## General workflow 4 | 0. (External contributors only) Create a fork of the repository 5 | 1. Pull any changes from `main` to make sure you're up-to-date 6 | 2. Create a branch from `main` 7 | * Give your branch a name that describes your change (e.g. add-scoreboard) 8 | * Focus on one change per branch 9 | 3. Commit your changes 10 | * Keep your commits small and focused 11 | * Write descriptive commit messages in [Conventional Commit](https://www.conventionalcommits.org/en/v1.0.0/) format 12 | 4. When you're ready, create a pull request to `main` 13 | * Keep your PRs small (preferably <300 LOC) 14 | * Format your title in [Conventional Commit](https://www.conventionalcommits.org/en/v1.0.0/) format 15 | * List any changes made in your description 16 | * Link any issues that your pull request is related to as well 17 | 18 | ### Example: 19 | ```text 20 | Create scoreboard for total points 21 | 22 | ADDED - Scoreboard displayed in-game at game end 23 | CHANGED - Updated `StorageManager` class to persist scoreboard data 24 | ``` 25 | 26 | After the pull request has been reviewed, approved, and passes all automated checks, it will be merged into main. -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # PaperMC/Spigot Minecraft Server Plugin Template 2 | A template for building PaperMC/Spigot Minecraft server plugins! 3 | 4 | 5 | [![Test and Release](https://github.com/CrimsonWarpedcraft/plugin-template/actions/workflows/main.yml/badge.svg)](https://github.com/CrimsonWarpedcraft/plugin-template/actions/workflows/main.yml) 6 | 7 | 8 | [![](https://dcbadge.limes.pink/api/server/5XMmeV6EtJ)](https://discord.gg/5XMmeV6EtJ) 9 | 10 | ## Features 11 | ### Github Actions 🎬 12 | * Automated builds, testing, and release drafting 13 | * [Discord notifcations](https://github.com/marketplace/actions/discord-message-notify) for snapshots and releases 14 | 15 | ### Bots 🤖 16 | * **Probot: Stale** 17 | * Mark issues stale after 30 days 18 | * **Dependabot** 19 | * Update GitHub Actions workflows 20 | * Update Gradle dependencies 21 | 22 | ### Issue Templates 📋 23 | * Bug report template 24 | * Feature request template 25 | 26 | ### Gradle Builds 🏗 27 | * Shadowed [PaperLib](https://github.com/PaperMC/PaperLib) build 28 | * [Checkstyle](https://checkstyle.org/) Google standard style check 29 | * [SpotBugs](https://spotbugs.github.io/) code analysis 30 | * [JUnit](https://junit.org/) testing 31 | 32 | ### Config Files 📁 33 | * Sample plugin.yml with autofill name, version, and main class. 34 | * Empty config.yml (just to make life \*that\* much easier) 35 | * Gradle build config 36 | * Simple .gitignore for common Gradle files 37 | 38 | ## Usage 39 | In order to use this template for yourself, there are a few things that you will need to keep in mind. 40 | 41 | ### Release Info 42 | #### PaperMC Version Mapping 43 | Here's a list of the PaperMC versions and the versions of this latest compatible version. 44 | 45 | | PaperMC | ExamplePlugin | 46 | |---------|---------------| 47 | | 1.21.5 | 4.0.8+ | 48 | | 1.21.4 | 4.0.7 | 49 | | 1.21.3 | 4.0.3 | 50 | | 1.21.1 | 4.0.2 | 51 | | 1.21 | 3.12.1 | 52 | | 1.20.6 | 3.11.0 | 53 | | 1.19.4 | 3.2.1 | 54 | | 1.18.2 | 3.0.2 | 55 | | 1.17.1 | 2.2.0 | 56 | | 1.16.5 | 2.1.2 | 57 | 58 | This chart would make more sense if this plugin actually did anything and people would have a reason 59 | to be looking for older releases to run on older servers. 60 | 61 | To use this as a template, just use the latest version of this project and update the PaperMC 62 | version as needed. See more info on release stability below. 63 | 64 | #### Release and Versioning Strategy 65 | Stable versions of this repo are tagged `vX.Y.Z` and have an associated [release](https://github.com/CrimsonWarpedcraft/plugin-template/releases). 66 | 67 | Testing versions of this repo are tagged `vX.Y.Z-RC-N` and have an associated [pre-release](https://github.com/CrimsonWarpedcraft/plugin-template/releases). 68 | 69 | Development versions of this repo are pushed to the master branch and are **not** tagged. 70 | 71 | | Event | Plugin Version Format | CI Action | GitHub Release Draft? | 72 | |-------------------|-----------------------|----------------------------------|-----------------------| 73 | | PR | yyMMdd-HHmm-SNAPSHOT | Build and test | No | 74 | | Cron | yyMMdd-HHmm-SNAPSHOT | Build, test, and notify | No | 75 | | Push to `main` | 0.0.0-SNAPSHOT | Build, test, release, and notify | No | 76 | | Tag `vX.Y.Z-RC-N` | X.Y.Z-SNAPSHOT | Build, test, release, and notify | Pre-release | 77 | | Tag `vX.Y.Z` | X.Y.Z | Build, test, release, and notify | Release | 78 | 79 | ### Discord Notifications 80 | In order to use Discord notifications, you will need to create two GitHub secrets. `DISCORD_WEBHOOK_ID` 81 | should be set to the id of your Discord webhook. `DISCORD_WEBHOOK_TOKEN` will be the token for the webhook. 82 | 83 | You can find these values by copying the Discord Webhook URL: 84 | `https://discord.com/api/webhooks//` 85 | 86 | Optionally, you can also configure `DISCORD_RELEASE_WEBHOOK_ID` and `DISCORD_RELEASE_WEBHOOK_TOKEN` 87 | to send release announcements to a separate channel. 88 | 89 | For more information, see [Discord Message Notify](https://github.com/marketplace/actions/discord-message-notify). 90 | 91 | --- 92 | 93 | **I've broken the rest of the changes up by their files to make things a bit easier to find.** 94 | 95 | --- 96 | 97 | ### settings.gradle 98 | Update the line below with the name of your plugin. 99 | 100 | ```groovy 101 | rootProject.name = 'ExamplePlugin' 102 | ``` 103 | 104 | ### build.gradle 105 | Make sure to update the `group` to your package's name in the following section. 106 | 107 | ```groovy 108 | group = "com.crimsonwarpedcraft.exampleplugin" 109 | ``` 110 | 111 | Add any required repositories for your dependencies in the following section. 112 | 113 | ```groovy 114 | repositories { 115 | maven { 116 | name 'papermc' 117 | url 'https://papermc.io/repo/repository/maven-public/' 118 | content { 119 | includeModule("io.papermc.paper", "paper-api") 120 | includeModule("io.papermc", "paperlib") 121 | includeModule("net.md-5", "bungeecord-chat") 122 | } 123 | } 124 | 125 | mavenCentral() 126 | } 127 | ``` 128 | 129 | Also, update your dependencies as needed (of course). 130 | 131 | ```groovy 132 | dependencies { 133 | compileOnly 'io.papermc.paper:paper-api:1.20.1-R0.1-SNAPSHOT' 134 | compileOnly 'com.github.spotbugs:spotbugs-annotations:4.7.3' 135 | implementation 'io.papermc:paperlib:1.0.8' 136 | spotbugsPlugins 'com.h3xstream.findsecbugs:findsecbugs-plugin:1.12.0' 137 | testCompileOnly 'com.github.spotbugs:spotbugs-annotations:4.7.3' 138 | testImplementation 'io.papermc.paper:paper-api:1.20.1-R0.1-SNAPSHOT' 139 | testImplementation 'org.junit.jupiter:junit-jupiter-api:5.10.0' 140 | testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.10.0' 141 | } 142 | ``` 143 | 144 | ### src/main/resources/plugin.yml 145 | First, update the following with your information. 146 | 147 | ```yaml 148 | author: AUTHOR 149 | description: DESCRIPTION 150 | ``` 151 | 152 | Next, the `commands` and `permissions` sections below should be updated as needed. 153 | 154 | ```yaml 155 | commands: 156 | ex: 157 | description: Base command for EXAMPLE 158 | usage: "For a list of commands, type /ex help" 159 | aliases: example 160 | permissions: 161 | example.test: 162 | description: DESCRIPTION 163 | default: true 164 | example.*: 165 | description: Grants all other permissions 166 | default: false 167 | children: 168 | example.test: true 169 | ``` 170 | 171 | ### .github/dependabot.yml 172 | You will need to replace all instances of `leviem1`, such as the one below, with your GitHub 173 | username. 174 | 175 | ```yaml 176 | reviewers: 177 | - "leviem1" 178 | ``` 179 | 180 | ### .github/CODEOWNERS 181 | You will need to replace `leviem1`, with your GitHub username. 182 | 183 | ```text 184 | * @leviem1 185 | ``` 186 | 187 | ### .github/FUNDING.yml 188 | Update or delete this file, whatever applies to you. 189 | 190 | ```yaml 191 | github: leviem1 192 | ``` 193 | 194 | For more information see: [Displaying a sponsor button in your repository](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository) 195 | 196 | ### CODE_OF_CONDUCT.md 197 | If you chose to adopt a Code of Conduct for your project, please update line 63 with your preferred 198 | contact method. 199 | 200 | ## Creating a Release 201 | Below are the steps you should follow to create a release. 202 | 203 | 1. Create a tag on `main` using semantic versioning (e.g. v0.1.0) 204 | 2. Push the tag and get some coffee while the workflows run 205 | 3. Publish the release draft once it's been automatically created 206 | 207 | ## Building locally 208 | Thanks to [Gradle](https://gradle.org/), building locally is easy no matter what platform you're on. Simply run the following command: 209 | 210 | ```text 211 | ./gradlew build 212 | ``` 213 | 214 | This build step will also run all checks and tests, making sure your code is clean. 215 | 216 | JARs can be found in `build/libs/`. 217 | 218 | ## Contributing 219 | See [CONTRIBUTING.md](https://github.com/CrimsonWarpedcraft/plugin-template/blob/main/CONTRIBUTING.md). 220 | 221 | --- 222 | 223 | I think that's all... phew! Oh, and update this README! ;) 224 | -------------------------------------------------------------------------------- /build.gradle: -------------------------------------------------------------------------------- 1 | import com.github.spotbugs.snom.SpotBugsTask 2 | import java.text.SimpleDateFormat 3 | 4 | plugins { 5 | id 'checkstyle' 6 | id "com.github.spotbugs" version "6.1.13" 7 | id 'com.gradleup.shadow' version '8.3.6' 8 | id 'java' 9 | } 10 | 11 | group = "com.crimsonwarpedcraft.exampleplugin" 12 | 13 | static def getTime() { 14 | SimpleDateFormat sdf = new SimpleDateFormat("yyMMdd-HHmm") 15 | sdf.setTimeZone(TimeZone.getTimeZone("UTC")) 16 | return sdf.format(new Date()).toString() 17 | } 18 | 19 | // Set version to version property if supplied 20 | String shortVersion = null 21 | if (hasProperty('ver')) { 22 | if (ver.charAt(0) == "v") { 23 | shortVersion = ver.substring(1).toUpperCase() 24 | } else { 25 | shortVersion = ver.toUpperCase() 26 | } 27 | } 28 | 29 | // If the tag includes "-RC-" or no tag is supplied, append "-SNAPSHOT" 30 | int rcIdx 31 | if (shortVersion == null || shortVersion == "") { 32 | version = getTime() + "-SNAPSHOT" 33 | } else if ((rcIdx = shortVersion.indexOf("-RC-")) != -1) { 34 | version = shortVersion.substring(0, rcIdx) + "-SNAPSHOT" 35 | } else { 36 | version = shortVersion 37 | } 38 | 39 | java { 40 | sourceCompatibility = JavaVersion.VERSION_21 41 | targetCompatibility = JavaVersion.VERSION_21 42 | } 43 | 44 | repositories { 45 | maven { 46 | name = 'papermc' 47 | url = 'https://repo.papermc.io/repository/maven-public/' 48 | content { 49 | includeModule("io.papermc.paper", "paper-api") 50 | includeModule("io.papermc", "paperlib") 51 | includeModule("net.md-5", "bungeecord-chat") 52 | includeGroup("io.papermc.adventure") 53 | } 54 | } 55 | 56 | maven { 57 | name = 'minecraft' 58 | url = 'https://libraries.minecraft.net' 59 | content { 60 | includeModule("com.mojang", "brigadier") 61 | } 62 | } 63 | 64 | mavenCentral() 65 | } 66 | 67 | dependencies { 68 | compileOnly 'io.papermc.paper:paper-api:1.21.5-R0.1-SNAPSHOT' 69 | compileOnly 'com.github.spotbugs:spotbugs-annotations:4.9.3' 70 | implementation 'io.papermc:paperlib:1.0.8' 71 | spotbugsPlugins 'com.h3xstream.findsecbugs:findsecbugs-plugin:1.14.0' 72 | testCompileOnly 'com.github.spotbugs:spotbugs-annotations:4.9.3' 73 | testImplementation 'io.papermc.paper:paper-api:1.21.5-R0.1-SNAPSHOT' 74 | testImplementation 'org.junit.jupiter:junit-jupiter:5.13.1' 75 | testRuntimeOnly 'org.junit.platform:junit-platform-launcher:1.13.0' 76 | } 77 | 78 | test { 79 | useJUnitPlatform() 80 | } 81 | 82 | processResources { 83 | filesMatching("**/plugin.yml") { 84 | expand ( NAME: rootProject.name, VERSION: version, PACKAGE: rootProject.group.toString() ) 85 | } 86 | } 87 | 88 | checkstyle { 89 | toolVersion = '10.23.1' 90 | maxWarnings = 0 91 | } 92 | 93 | configurations.checkstyle { 94 | resolutionStrategy.capabilitiesResolution.withCapability("com.google.collections:google-collections") { 95 | select("com.google.guava:guava:23.0") 96 | } 97 | } 98 | 99 | tasks.withType(Checkstyle).configureEach { 100 | reports { 101 | xml.required = false 102 | html.required = true 103 | } 104 | } 105 | 106 | tasks.withType(SpotBugsTask).configureEach { 107 | reports.create("html") { 108 | required = true 109 | } 110 | reports.create("xml") { 111 | required = false 112 | } 113 | } 114 | 115 | shadowJar { 116 | archiveClassifier.set('') 117 | relocate 'io.papermc.lib', 'shadow.io.papermc.paperlib' 118 | minimize() 119 | } 120 | 121 | // Disable jar and replace with shadowJar 122 | jar.enabled = false 123 | assemble.dependsOn(shadowJar) 124 | 125 | tasks.register('printProjectName') { 126 | doLast { 127 | println rootProject.name 128 | } 129 | } 130 | 131 | tasks.register('release') { 132 | dependsOn build 133 | 134 | doLast { 135 | if (!version.endsWith("-SNAPSHOT")) { 136 | // Rename final JAR to trim off version information 137 | shadowJar.archiveFile.get().getAsFile() 138 | .renameTo(layout.buildDirectory.get().toString() + File.separator + 'libs' + File.separator 139 | + rootProject.name + '.jar') 140 | } 141 | } 142 | } 143 | -------------------------------------------------------------------------------- /config/checkstyle/checkstyle.xml: -------------------------------------------------------------------------------- 1 | 2 | 5 | 6 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 38 | 39 | 40 | 41 | 42 | 43 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 68 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 | 81 | 82 | 84 | 85 | 86 | 87 | 93 | 94 | 95 | 96 | 97 | 99 | 100 | 101 | 102 | 103 | 104 | 105 | 106 | 107 | 110 | 111 | 112 | 113 | 115 | 116 | 117 | 118 | 119 | 124 | 125 | 126 | 127 | 128 | 134 | 135 | 136 | 141 | 142 | 143 | 144 | 145 | 146 | 147 | 148 | 149 | 150 | 159 | 162 | 164 | 165 | 166 | 167 | 175 | 176 | 177 | 178 | 181 | 182 | 183 | 184 | 185 | 186 | 187 | 188 | 189 | 190 | 194 | 195 | 196 | 197 | 198 | 199 | 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207 | 208 | 209 | 210 | 211 | 212 | 213 | 214 | 215 | 216 | 217 | 218 | 219 | 220 | 221 | 222 | 223 | 224 | 225 | 227 | 228 | 229 | 231 | 233 | 234 | 235 | 236 | 238 | 239 | 240 | 241 | 243 | 244 | 245 | 246 | 248 | 249 | 250 | 251 | 253 | 254 | 255 | 256 | 258 | 259 | 260 | 261 | 263 | 264 | 265 | 266 | 268 | 269 | 270 | 271 | 273 | 274 | 275 | 276 | 278 | 279 | 280 | 281 | 283 | 284 | 285 | 286 | 288 | 289 | 290 | 291 | 293 | 295 | 297 | 299 | 300 | 301 | 302 | 303 | 304 | 305 | 306 | 307 | 308 | 309 | 310 | 311 | 312 | 316 | 317 | 318 | 319 | 320 | 321 | 322 | 323 | 324 | 325 | 326 | 327 | 328 | 331 | 332 | 333 | 336 | 337 | 338 | 339 | 345 | 346 | 347 | 348 | 352 | 353 | 354 | 355 | 358 | 359 | 360 | 361 | 362 | 363 | 364 | 365 | 366 | 367 | 368 | 370 | 371 | 372 | 373 | 374 | 375 | 376 | 377 | 379 | 380 | 381 | 382 | 383 | 384 | 385 | 386 | 387 | 388 | 389 | 390 | 391 | 393 | 394 | 395 | 396 | 401 | 402 | 403 | 404 | 407 | 408 | 409 | 410 | 411 | 413 | 414 | 415 | 416 | 419 | 420 | 421 | 422 | 423 | 424 | 425 | 426 | 427 | 428 | 429 | 430 | 432 | 433 | 434 | 435 | 436 | 437 | 438 | 439 | 440 | 441 | 442 | 443 | 444 | 445 | 446 | 447 | 448 | 449 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/CrimsonWarpedcraft/plugin-template/4f49f834e150f498178275071483583ec670b28d/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | distributionBase=GRADLE_USER_HOME 2 | distributionPath=wrapper/dists 3 | distributionUrl=https\://services.gradle.org/distributions/gradle-8.14-bin.zip 4 | networkTimeout=10000 5 | validateDistributionUrl=true 6 | zipStoreBase=GRADLE_USER_HOME 7 | zipStorePath=wrapper/dists 8 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | # 4 | # Copyright © 2015-2021 the original authors. 5 | # 6 | # Licensed under the Apache License, Version 2.0 (the "License"); 7 | # you may not use this file except in compliance with the License. 8 | # You may obtain a copy of the License at 9 | # 10 | # https://www.apache.org/licenses/LICENSE-2.0 11 | # 12 | # Unless required by applicable law or agreed to in writing, software 13 | # distributed under the License is distributed on an "AS IS" BASIS, 14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | # See the License for the specific language governing permissions and 16 | # limitations under the License. 17 | # 18 | # SPDX-License-Identifier: Apache-2.0 19 | # 20 | 21 | ############################################################################## 22 | # 23 | # Gradle start up script for POSIX generated by Gradle. 24 | # 25 | # Important for running: 26 | # 27 | # (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is 28 | # noncompliant, but you have some other compliant shell such as ksh or 29 | # bash, then to run this script, type that shell name before the whole 30 | # command line, like: 31 | # 32 | # ksh Gradle 33 | # 34 | # Busybox and similar reduced shells will NOT work, because this script 35 | # requires all of these POSIX shell features: 36 | # * functions; 37 | # * expansions «$var», «${var}», «${var:-default}», «${var+SET}», 38 | # «${var#prefix}», «${var%suffix}», and «$( cmd )»; 39 | # * compound commands having a testable exit status, especially «case»; 40 | # * various built-in commands including «command», «set», and «ulimit». 41 | # 42 | # Important for patching: 43 | # 44 | # (2) This script targets any POSIX shell, so it avoids extensions provided 45 | # by Bash, Ksh, etc; in particular arrays are avoided. 46 | # 47 | # The "traditional" practice of packing multiple parameters into a 48 | # space-separated string is a well documented source of bugs and security 49 | # problems, so this is (mostly) avoided, by progressively accumulating 50 | # options in "$@", and eventually passing that to Java. 51 | # 52 | # Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, 53 | # and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; 54 | # see the in-line comments for details. 55 | # 56 | # There are tweaks for specific operating systems such as AIX, CygWin, 57 | # Darwin, MinGW, and NonStop. 58 | # 59 | # (3) This script is generated from the Groovy template 60 | # https://github.com/gradle/gradle/blob/HEAD/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt 61 | # within the Gradle project. 62 | # 63 | # You can find Gradle at https://github.com/gradle/gradle/. 64 | # 65 | ############################################################################## 66 | 67 | # Attempt to set APP_HOME 68 | 69 | # Resolve links: $0 may be a link 70 | app_path=$0 71 | 72 | # Need this for daisy-chained symlinks. 73 | while 74 | APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path 75 | [ -h "$app_path" ] 76 | do 77 | ls=$( ls -ld "$app_path" ) 78 | link=${ls#*' -> '} 79 | case $link in #( 80 | /*) app_path=$link ;; #( 81 | *) app_path=$APP_HOME$link ;; 82 | esac 83 | done 84 | 85 | # This is normally unused 86 | # shellcheck disable=SC2034 87 | APP_BASE_NAME=${0##*/} 88 | # Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) 89 | APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s\n' "$PWD" ) || exit 90 | 91 | # Use the maximum available, or set MAX_FD != -1 to use that value. 92 | MAX_FD=maximum 93 | 94 | warn () { 95 | echo "$*" 96 | } >&2 97 | 98 | die () { 99 | echo 100 | echo "$*" 101 | echo 102 | exit 1 103 | } >&2 104 | 105 | # OS specific support (must be 'true' or 'false'). 106 | cygwin=false 107 | msys=false 108 | darwin=false 109 | nonstop=false 110 | case "$( uname )" in #( 111 | CYGWIN* ) cygwin=true ;; #( 112 | Darwin* ) darwin=true ;; #( 113 | MSYS* | MINGW* ) msys=true ;; #( 114 | NONSTOP* ) nonstop=true ;; 115 | esac 116 | 117 | CLASSPATH="\\\"\\\"" 118 | 119 | 120 | # Determine the Java command to use to start the JVM. 121 | if [ -n "$JAVA_HOME" ] ; then 122 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 123 | # IBM's JDK on AIX uses strange locations for the executables 124 | JAVACMD=$JAVA_HOME/jre/sh/java 125 | else 126 | JAVACMD=$JAVA_HOME/bin/java 127 | fi 128 | if [ ! -x "$JAVACMD" ] ; then 129 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 130 | 131 | Please set the JAVA_HOME variable in your environment to match the 132 | location of your Java installation." 133 | fi 134 | else 135 | JAVACMD=java 136 | if ! command -v java >/dev/null 2>&1 137 | then 138 | die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 139 | 140 | Please set the JAVA_HOME variable in your environment to match the 141 | location of your Java installation." 142 | fi 143 | fi 144 | 145 | # Increase the maximum file descriptors if we can. 146 | if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then 147 | case $MAX_FD in #( 148 | max*) 149 | # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. 150 | # shellcheck disable=SC2039,SC3045 151 | MAX_FD=$( ulimit -H -n ) || 152 | warn "Could not query maximum file descriptor limit" 153 | esac 154 | case $MAX_FD in #( 155 | '' | soft) :;; #( 156 | *) 157 | # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. 158 | # shellcheck disable=SC2039,SC3045 159 | ulimit -n "$MAX_FD" || 160 | warn "Could not set maximum file descriptor limit to $MAX_FD" 161 | esac 162 | fi 163 | 164 | # Collect all arguments for the java command, stacking in reverse order: 165 | # * args from the command line 166 | # * the main class name 167 | # * -classpath 168 | # * -D...appname settings 169 | # * --module-path (only if needed) 170 | # * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. 171 | 172 | # For Cygwin or MSYS, switch paths to Windows format before running java 173 | if "$cygwin" || "$msys" ; then 174 | APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) 175 | CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) 176 | 177 | JAVACMD=$( cygpath --unix "$JAVACMD" ) 178 | 179 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 180 | for arg do 181 | if 182 | case $arg in #( 183 | -*) false ;; # don't mess with options #( 184 | /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath 185 | [ -e "$t" ] ;; #( 186 | *) false ;; 187 | esac 188 | then 189 | arg=$( cygpath --path --ignore --mixed "$arg" ) 190 | fi 191 | # Roll the args list around exactly as many times as the number of 192 | # args, so each arg winds up back in the position where it started, but 193 | # possibly modified. 194 | # 195 | # NB: a `for` loop captures its iteration list before it begins, so 196 | # changing the positional parameters here affects neither the number of 197 | # iterations, nor the values presented in `arg`. 198 | shift # remove old arg 199 | set -- "$@" "$arg" # push replacement arg 200 | done 201 | fi 202 | 203 | 204 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 205 | DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' 206 | 207 | # Collect all arguments for the java command: 208 | # * DEFAULT_JVM_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, 209 | # and any embedded shellness will be escaped. 210 | # * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be 211 | # treated as '${Hostname}' itself on the command line. 212 | 213 | set -- \ 214 | "-Dorg.gradle.appname=$APP_BASE_NAME" \ 215 | -classpath "$CLASSPATH" \ 216 | -jar "$APP_HOME/gradle/wrapper/gradle-wrapper.jar" \ 217 | "$@" 218 | 219 | # Stop when "xargs" is not available. 220 | if ! command -v xargs >/dev/null 2>&1 221 | then 222 | die "xargs is not available" 223 | fi 224 | 225 | # Use "xargs" to parse quoted args. 226 | # 227 | # With -n1 it outputs one arg per line, with the quotes and backslashes removed. 228 | # 229 | # In Bash we could simply go: 230 | # 231 | # readarray ARGS < <( xargs -n1 <<<"$var" ) && 232 | # set -- "${ARGS[@]}" "$@" 233 | # 234 | # but POSIX shell has neither arrays nor command substitution, so instead we 235 | # post-process each arg (as a line of input to sed) to backslash-escape any 236 | # character that might be a shell metacharacter, then use eval to reverse 237 | # that process (while maintaining the separation between arguments), and wrap 238 | # the whole thing up as a single "set" statement. 239 | # 240 | # This will of course break if any of these variables contains a newline or 241 | # an unmatched quote. 242 | # 243 | 244 | eval "set -- $( 245 | printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | 246 | xargs -n1 | 247 | sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | 248 | tr '\n' ' ' 249 | )" '"$@"' 250 | 251 | exec "$JAVACMD" "$@" 252 | -------------------------------------------------------------------------------- /gradlew.bat: -------------------------------------------------------------------------------- 1 | @rem 2 | @rem Copyright 2015 the original author or authors. 3 | @rem 4 | @rem Licensed under the Apache License, Version 2.0 (the "License"); 5 | @rem you may not use this file except in compliance with the License. 6 | @rem You may obtain a copy of the License at 7 | @rem 8 | @rem https://www.apache.org/licenses/LICENSE-2.0 9 | @rem 10 | @rem Unless required by applicable law or agreed to in writing, software 11 | @rem distributed under the License is distributed on an "AS IS" BASIS, 12 | @rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | @rem See the License for the specific language governing permissions and 14 | @rem limitations under the License. 15 | @rem 16 | @rem SPDX-License-Identifier: Apache-2.0 17 | @rem 18 | 19 | @if "%DEBUG%"=="" @echo off 20 | @rem ########################################################################## 21 | @rem 22 | @rem Gradle startup script for Windows 23 | @rem 24 | @rem ########################################################################## 25 | 26 | @rem Set local scope for the variables with windows NT shell 27 | if "%OS%"=="Windows_NT" setlocal 28 | 29 | set DIRNAME=%~dp0 30 | if "%DIRNAME%"=="" set DIRNAME=. 31 | @rem This is normally unused 32 | set APP_BASE_NAME=%~n0 33 | set APP_HOME=%DIRNAME% 34 | 35 | @rem Resolve any "." and ".." in APP_HOME to make it shorter. 36 | for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi 37 | 38 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 39 | set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" 40 | 41 | @rem Find java.exe 42 | if defined JAVA_HOME goto findJavaFromJavaHome 43 | 44 | set JAVA_EXE=java.exe 45 | %JAVA_EXE% -version >NUL 2>&1 46 | if %ERRORLEVEL% equ 0 goto execute 47 | 48 | echo. 1>&2 49 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2 50 | echo. 1>&2 51 | echo Please set the JAVA_HOME variable in your environment to match the 1>&2 52 | echo location of your Java installation. 1>&2 53 | 54 | goto fail 55 | 56 | :findJavaFromJavaHome 57 | set JAVA_HOME=%JAVA_HOME:"=% 58 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 59 | 60 | if exist "%JAVA_EXE%" goto execute 61 | 62 | echo. 1>&2 63 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2 64 | echo. 1>&2 65 | echo Please set the JAVA_HOME variable in your environment to match the 1>&2 66 | echo location of your Java installation. 1>&2 67 | 68 | goto fail 69 | 70 | :execute 71 | @rem Setup the command line 72 | 73 | set CLASSPATH= 74 | 75 | 76 | @rem Execute Gradle 77 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" -jar "%APP_HOME%\gradle\wrapper\gradle-wrapper.jar" %* 78 | 79 | :end 80 | @rem End local scope for the variables with windows NT shell 81 | if %ERRORLEVEL% equ 0 goto mainEnd 82 | 83 | :fail 84 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 85 | rem the _cmd.exe /c_ return code! 86 | set EXIT_CODE=%ERRORLEVEL% 87 | if %EXIT_CODE% equ 0 set EXIT_CODE=1 88 | if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% 89 | exit /b %EXIT_CODE% 90 | 91 | :mainEnd 92 | if "%OS%"=="Windows_NT" endlocal 93 | 94 | :omega 95 | -------------------------------------------------------------------------------- /settings.gradle: -------------------------------------------------------------------------------- 1 | rootProject.name = 'ExamplePlugin' -------------------------------------------------------------------------------- /src/main/java/com/crimsonwarpedcraft/exampleplugin/ExamplePlugin.java: -------------------------------------------------------------------------------- 1 | package com.crimsonwarpedcraft.exampleplugin; 2 | 3 | import io.papermc.lib.PaperLib; 4 | import org.bukkit.plugin.java.JavaPlugin; 5 | 6 | 7 | /** 8 | * Created by Levi Muniz on 7/29/20. 9 | * 10 | * @author Copyright (c) Levi Muniz. All Rights Reserved. 11 | */ 12 | public class ExamplePlugin extends JavaPlugin { 13 | 14 | @Override 15 | public void onEnable() { 16 | PaperLib.suggestPaper(this); 17 | 18 | saveDefaultConfig(); 19 | } 20 | } 21 | -------------------------------------------------------------------------------- /src/main/resources/config.yml: -------------------------------------------------------------------------------- 1 | # A journey of 1,000 lines starts with a single char -------------------------------------------------------------------------------- /src/main/resources/plugin.yml: -------------------------------------------------------------------------------- 1 | main: ${PACKAGE}.${NAME} 2 | name: ${NAME} 3 | version: "${VERSION}" 4 | api-version: "1.21.1" 5 | author: AUTHOR 6 | description: DESCRIPTION 7 | commands: 8 | ex: 9 | description: Base command for EXAMPLE 10 | usage: "For a list of commands, type /ex help" 11 | aliases: example 12 | permissions: 13 | example.test: 14 | description: DESCRIPTION 15 | default: true 16 | example.*: 17 | description: Grants all other permissions 18 | default: false 19 | children: 20 | example.test: true -------------------------------------------------------------------------------- /src/test/java/com/crimsonwarpedcraft/exampleplugin/ExamplePluginTest.java: -------------------------------------------------------------------------------- 1 | package com.crimsonwarpedcraft.exampleplugin; 2 | 3 | import org.junit.jupiter.api.Test; 4 | 5 | /** 6 | * Tests for ExamplePlugin. 7 | * 8 | * @author Copyright (c) Levi Muniz. All Rights Reserved. 9 | */ 10 | public class ExamplePluginTest { 11 | 12 | @Test 13 | public void onEnable() { 14 | 15 | } 16 | } -------------------------------------------------------------------------------- /src/test/resources/.gitkeep: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/CrimsonWarpedcraft/plugin-template/4f49f834e150f498178275071483583ec670b28d/src/test/resources/.gitkeep --------------------------------------------------------------------------------