Skip to content

Spigot plugin that features an unique compass for finding biomes anywhere in any dimension.

License

Notifications You must be signed in to change notification settings

rusthero/BiomeCompass

Repository files navigation


CodeFactor

About

Biome Compass is a Spigot plugin that adds a new item to the game – a compass that helps players navigate to specific biomes in any dimension. Players can use a GUI to select the desired biome and the compass will locate it in a short time.

preview

Compatibility

This plugin is compatible with Minecraft versions 1.16.2 up to 1.19.2.

To ensure that the plugin is compatible with your server, make sure that you are using a compatible version of Spigot and Minecraft.

Please note that the plugin may not be compatible with other custom servers or mods. If you experience any issues, please report them in the issues section of the repository.

Installation

To install the Biome Compass plugin, you will need to follow these steps:

  1. Make sure you have the latest version of Java installed on your machine.
  2. Install Spigot on your server. You can find instructions on how to install it here.
  3. Download the latest release of the "Biome Compass" plugin from the releases page.
  4. Copy the downloaded JAR file to the plugins folder of your Spigot server.
  5. Start the server and wait for the plugin to be loaded.
  6. You can now use the Biome Compass plugin in your game.

Alternatively, you can use Gradle to build the plugin from source:

  1. Clone the repository by running git clone https://github.com/rusthero/BiomeCompass.git in your terminal.
  2. Navigate to the root directory of the repository.
  3. Run gradle build to build the plugin. This will create a JAR file in the build/libs directory.
  4. Copy the JAR file to the plugins folder of your Spigot server and start the server.

Learn More

For more information about the Biome Compass plugin, including usage guide, configuration options, and troubleshooting tips, please check out the wiki.

The wiki includes detailed instructions and examples to help you use the Biome Compass, as well as answers to frequently asked questions.

Contributing

Contributions are welcome! Please see CONTRIBUTING.md.

License

GNU General Public License (v3.0)