Skip to content

Commit

Permalink
Merge branch 'develop' of https://github.com/BentoBoxWorld/SkyGrid.git
Browse files Browse the repository at this point in the history
…into develop
  • Loading branch information
tastybento committed Nov 12, 2023
2 parents 766847a + 68a3c6e commit c0d258d
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 2 deletions.
45 changes: 44 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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!
2 changes: 1 addition & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -327,7 +327,7 @@
<plugin>
<groupId>org.jacoco</groupId>
<artifactId>jacoco-maven-plugin</artifactId>
<version>0.8.7</version>
<version>0.8.10</version>
<configuration>
<append>true</append>
<excludes>
Expand Down

0 comments on commit c0d258d

Please sign in to comment.