Biome Compass

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.

Compatibility

This plugin is compatible with Minecraft versions 1.16.2 up to 1.19.2. It is designed to work with Spigot servers, and may not be compatible with other custom servers or mods.

Features

The Biome Compass plugin offers a variety of features to enhance gameplay on your server:

Navigate to specific biomes: Players can use the Biome Compass to navigate to specific biomes in any dimension. The compass will locate the desired biome in a short time, making it easy for players to find the resources they need or complete quests.
Customizable settings: The Biome Compass includes a configuration file where you can adjust the plugin's settings to suit your server's needs. You can change the cooldown period, search resolution, and maximum search radius, as well as the size of the cache.
Easy to use: The Biome Compass is easy to use, with a simple GUI that allows players to select the desired biome. No complicated commands or chat messages are required.
Compatible with multiple Minecraft versions: The Biome Compass is compatible with Minecraft versions 1.16.2 up to 1.19.2, making it easy to use on a variety of servers. Note: The Biome Compass plugin requires Vault if you are using the money cost feature.

Changelog (1.3.0)

Multi-language support:

American English language support has been added
Chinese Simplified language support has been added
Turkish language support has been added

Custom model data option:

An option to change the custom model data for the biome compass from the configuration file has been added

Configuration

The Biome Compass plugin allows users to customize its behavior through the config.yml file. This file can be found in the plugins/BiomeCompass folder of your server. For detailed information on every field, please check the wiki page for Configuration.

Permissions

The Biome Compass plugin includes two permissions:

biomecompass.use: Allows players to use the Biome Compass. This permission is granted by default.
biomecompass.craft: Allows players to craft the Biome Compass. This permission is granted by default.

Documentation

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.

Issue Tracker

If you encounter any issues or bugs while using the plugin, please report them in the issues section of the repository. By providing detailed information about the issue, you can help me fix it more efficiently.

Installation

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

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

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

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

Note about Translations

Biome Compass now supports multi-language translations. If you would like to add support for your language, you can follow the guidelines provided in the CONTRIBUTING.md file on our GitHub repository.

I would greatly appreciate any contributions to help make Biome Compass more accessible to a wider range of players around the world. Thank you for your support!