Merge pull request #66 from BentoBoxWorld/develop

Release 2.1.0
BentoBoxWorld · Aug 12, 2024 · d9859eb · d9859eb
2 parents d1fbf6f + d18a496
commit d9859eb
Show file tree

Hide file tree

Showing 14 changed files with 2,978 additions and 1,300 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -11,22 +11,22 @@ jobs:
     name: Build
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
         with:
           fetch-depth: 0  # Shallow clones should be disabled for a better relevancy of analysis
-      - name: Set up JDK 17
-        uses: actions/setup-java@v2
+      - name: Set up JDK 21
+        uses: actions/setup-java@v3
         with:
           distribution: 'adopt'
-          java-version: 17
+          java-version: 21
       - name: Cache SonarCloud packages
-        uses: actions/cache@v2
+        uses: actions/cache@v3
         with:
           path: ~/.sonar/cache
           key: ${{ runner.os }}-sonar
           restore-keys: ${{ runner.os }}-sonar
       - name: Cache Maven packages
-        uses: actions/cache@v2
+        uses: actions/cache@v3
         with:
           path: ~/.m2
           key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}

diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md
diff --git a/README.md b/README.md
@@ -1,13 +1,56 @@
 # SkyGrid
-Game Mode Add-on for BentoBox the provides a SkyGrid experience
+Welcome to the SkyGrid for Minecraft! This game introduces a unique and challenging gameplay experience where you find yourself navigating a grid of floating blocks high in the sky. Your goal is to survive, gather resources, and conquer the SkyGrid!
+
+This is a Game Mode Add-on that uses the BentoBox library plugin.
+
+<img src="https://github.com/BentoBoxWorld/SkyGrid/assets/4407265/d350349a-ff46-4f1e-9900-4690bae41fac" width="200" height="200">
+
+## Features
+
+- **Challenging Gameplay**: SkyGrid presents a challenging environment where you must carefully navigate from block to block to avoid falling.
+- **Randomized Grid**: Each player will have a unique grid layout - a fresh and unpredictable experience every time.
+- **Limited Resources**: Resources are scarce, so you must strategize and prioritize what to gather and when to use them.
+- **Mobs and Dangers**: The SkyGrid is not empty. Beware of hostile mobs and other dangers that lurk in the grid!
+- **Multiplayer Support**: Enjoy the SkyGrid mini game with your friends; form a team or coop.
 
 ## Installation
 
+To play the SkyGrid mini game, follow these steps:
+
 1. Place the addon jar in the addons folder of the BentoBox plugin
 2. Restart the server
 3. The addon will create worlds and a data folder and inside the folder will be a config.yml
 4. Stop the server 
 5. Edit the config.yml how you want.
 6. Delete any worlds that were created by default.
 7. Restart the server
+9. Launch the game and type /sg to enjoy the SkyGrid!
+
+## How to Play
+
+The objective of the SkyGrid mini game is to survive and complete various challenges in the grid (install the Challenges addon to enable this). Here are some essential gameplay tips:
+
+- **Avoid Falling**: Falling off the grid means certain death. Always be cautious when moving from block to block.
+- **Gather Resources**: Break blocks to collect resources such as wood, stone, and ores. Use these resources wisely to craft tools and equipment.
+- **Complete Challenges**: The SkyGrid mini game may have specific challenges to complete. Pay attention to your objectives and try to achieve them.
+- **Interact with Mobs**: Hostile mobs roam the grid. You can fight them for valuable loot or choose to avoid them altogether. There are also mob spawners that can be used to farm mobs.
+- **Use Your Skills**: Utilize your Minecraft skills to their fullest. Building, crafting, and combat will all play a significant role in your survival.
+
+## Contributing
+
+Contributions to the SkyGrid GitHub project are welcome! If you have ideas, bug fixes, or new features to propose, follow these steps:
+
+1. Fork the repository on GitHub.
+2. Create a new branch with a descriptive name for your changes.
+3. Make your modifications and additions.
+4. Test your changes to ensure they work as intended.
+5. Commit your changes and push them to your forked repository.
+6. Submit a pull request to the main repository, explaining the purpose and details of your changes.
+
+## License
+
+The SkyGrid mini game is released under the [Eclipse Public License 2.0]([LICENSE](https://github.com/BentoBoxWorld/SkyGrid/blob/develop/LICENSE)). Feel free to modify and distribute the game, but remember to credit the original authors.
+
+## Contact
 
+If you have any questions, suggestions, bug reports, or feedback regarding the SkyGrid mini game, you can file them on [GitHub](https://github.com/BentoBoxWorld/SkyGrid/issues). We would love to hear from you!
diff --git a/pom.xml b/pom.xml
@@ -54,18 +54,18 @@
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
-        <java.version>17</java.version>
+        <java.version>21</java.version>
         <!-- Non-minecraft related dependencies -->
-        <powermock.version>2.0.2</powermock.version>
+        <powermock.version>2.0.9</powermock.version>
         <!-- More visible way how to change dependency versions -->
-        <spigot.version>1.19.4-R0.1-SNAPSHOT</spigot.version>
-        <bentobox.version>1.23.0</bentobox.version>
+        <spigot.version>1.21-R0.1-SNAPSHOT</spigot.version>
+        <bentobox.version>2.4.1-SNAPSHOT</bentobox.version>
         <!-- Revision variable removes warning about dynamic version -->
         <revision>${build.version}-SNAPSHOT</revision>
         <!-- Do not change unless you want different name for local builds. -->
         <build.number>-LOCAL</build.number>
         <!-- This allows to change between versions. -->
-        <build.version>1.19.0</build.version>
+        <build.version>2.1.0</build.version>
         <!-- SonarCloud -->
         <sonar.projectKey>BentoBoxWorld_SkyGrid</sonar.projectKey>
         <sonar.organization>bentobox-world</sonar.organization>
@@ -113,6 +113,14 @@
             </properties>
         </profile>
     </profiles>
+
+    <pluginRepositories>
+        <pluginRepository>
+            <id>apache.snapshots</id>
+            <url>https://repository.apache.org/snapshots/</url>
+        </pluginRepository>
+    </pluginRepositories>
+
 
     <repositories>
         <repository>
@@ -145,7 +153,7 @@
         <dependency>
             <groupId>org.mockito</groupId>
             <artifactId>mockito-core</artifactId>
-            <version>3.0.0</version>
+            <version>3.11.1</version>
             <scope>test</scope>
         </dependency>
         <dependency>
@@ -219,45 +227,74 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-resources-plugin</artifactId>
-                <version>3.1.0</version>
+                <version>3.2.0</version>
                 <configuration>
                     <nonFilteredFileExtensions>
-                        <nonFilteredFileExtension>schem</nonFilteredFileExtension>
+                        <nonFilteredFileExtension>blu</nonFilteredFileExtension>
                     </nonFilteredFileExtensions>
                 </configuration>
             </plugin>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-compiler-plugin</artifactId>
-                <version>3.7.0</version>
+                <version>3.8.1</version>
                 <configuration>
                     <release>${java.version}</release>
                 </configuration>
             </plugin>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-surefire-plugin</artifactId>
-                <version>2.22.0</version>
+                <version>3.0.0-M5</version>
+                <configuration>
+                    <argLine>
+                        ${argLine}
+                        --add-opens java.base/java.lang=ALL-UNNAMED
+                        --add-opens java.base/java.math=ALL-UNNAMED
+                        --add-opens java.base/java.io=ALL-UNNAMED
+                        --add-opens java.base/java.util=ALL-UNNAMED
+                        --add-opens
+                        java.base/java.util.stream=ALL-UNNAMED
+                        --add-opens java.base/java.text=ALL-UNNAMED
+                        --add-opens
+                        java.base/java.util.regex=ALL-UNNAMED
+                        --add-opens
+                        java.base/java.nio.channels.spi=ALL-UNNAMED
+                        --add-opens java.base/sun.nio.ch=ALL-UNNAMED
+                        --add-opens java.base/java.net=ALL-UNNAMED
+                        --add-opens
+                        java.base/java.util.concurrent=ALL-UNNAMED
+                        --add-opens java.base/sun.nio.fs=ALL-UNNAMED
+                        --add-opens java.base/sun.nio.cs=ALL-UNNAMED
+                        --add-opens java.base/java.nio.file=ALL-UNNAMED
+                        --add-opens
+                        java.base/java.nio.charset=ALL-UNNAMED
+                        --add-opens
+                        java.base/java.lang.reflect=ALL-UNNAMED
+                        --add-opens
+                        java.logging/java.util.logging=ALL-UNNAMED
+                        --add-opens java.base/java.lang.ref=ALL-UNNAMED
+                        --add-opens java.base/java.util.jar=ALL-UNNAMED
+                        --add-opens java.base/java.util.zip=ALL-UNNAMED
+                    </argLine>
+                </configuration>
             </plugin>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-jar-plugin</artifactId>
-                <version>3.1.0</version>
+                <version>3.2.0</version>
             </plugin>
-           <plugin>
+            <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-javadoc-plugin</artifactId>
                 <version>3.3.0</version>
                 <configuration>
                     <failOnError>false</failOnError>
                     <additionalJOption>-Xdoclint:none</additionalJOption>
-                    <!-- To compile with Java 11, this tag may be required -->
-                    <javadocExecutable>${java.home}/bin/javadoc</javadocExecutable>
                 </configuration>
                 <executions>
                     <execution>
                         <id>attach-javadocs</id>
-                        <phase>install</phase>
                         <goals>
                             <goal>jar</goal>
                         </goals>
@@ -267,7 +304,7 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-source-plugin</artifactId>
-                <version>3.0.1</version>
+                <version>3.2.1</version>
                 <executions>
                     <execution>
                         <id>attach-sources</id>
@@ -280,23 +317,25 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-install-plugin</artifactId>
-                <version>2.5.2</version>
+                <version>3.0.0-M1</version>
             </plugin>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-deploy-plugin</artifactId>
-                <version>2.8.2</version>
+                <version>3.0.0-M1</version>
             </plugin>
             <plugin>
                 <groupId>org.jacoco</groupId>
                 <artifactId>jacoco-maven-plugin</artifactId>
-                <version>0.8.3</version>
+                <version>0.8.10</version>
                 <configuration>
                     <append>true</append>
                     <excludes>
                         <!-- This is required to prevent Jacoco from adding 
                             synthetic fields to a JavaBean class (causes errors in testing) -->
                         <exclude>**/*Names*</exclude>
+                        <!-- Prevents the Material is too large to mock error -->
+                        <exclude>org/bukkit/Material*</exclude>
                     </excludes>
                 </configuration>
                 <executions>