Skip to content

Outspending/BiomesAPI

Repository files navigation

BiomesAPI

Custom Biomes!


Note

BiomesAPI is currently being developed and ain't finished yet

BiomesAPI is a Custom Biome API for Spigot / PaperMC Servers. This API allows you to create custom biomes with custom colors. This API is also pretty easy to use and user-friendly.

BiomesAPI was made for servers who are looking for more of an aesthetic feel to their builds.

Release Notes 📃

Check out the more detailed release notes HERE

Installation ⭐

Installing BiomesAPI is easy! Just follow these steps, and you'll be on your way to creating your own custom biomes!

  1. Find the latest version of BiomesAPI HERE
  2. Add the repository to your build.gradle file
repositories {
    mavenCentral()
    maven { url 'https://jitpack.io' }
}
  1. Add the dependency to your build.gradle file
dependencies {
        implementation 'com.github.Outspending:BiomesAPI:0.0.5'
}
  1. Build your project
  2. All done!

Now you can use our API to create your own custom biomes!

Nightly Builds 🌙

Nightly builds are builds that add experimental features to BiomesAPI. Some of these features are just in testing and might not make it into the main API!

If you are intrested in Nightly Builds please check our Wiki and the Nightly Branch

Wiki 🧑‍💻

Our Wiki is a great place to learn how to use BiomesAPI. This Wiki is updated frequently to make sure our users know how to use our API.

The wiki has everything from how to create a biome to how to use our API to its full potential. It's also pretty descriptive, so you'll know exactly what you're doing.

Check out the Wiki HERE

Why BiomesAPI 🤔

BiomesAPI is the best way to create custom biomes for free, and it's easy to use! We also offer a Plugin and Skript addon for people who don't know how to use Java.

BiomesAPI is a light-weight API and is pretty small in size. This API is also very fast and efficient, so you don't have to worry about lag. And is updated frequently to make sure it's up-to-date with the latest version of Spigot.

Advantages & Disadvantages 👌

Advantages

  • Easy to use
  • Light-weight
  • Fast and efficient
  • Updated frequently
  • Free
  • Plugin and Skript addon
  • Well Documented Wiki

Disadvantages

  • Only works on Spigot 1.19.3+

Credits 🙏

Thanks to all of these people for helping make BiomesAPI possible!

  • SpigotMC - For making Spigot and allowing us to use their API
  • Jitpack - For allowing us to use their repository
  • Gradle - For allowing us to use their build tool
  • GitHub - For hosting our code
  • IntelliJ IDEA - For allowing us to use their IDE
  • Lombok - For allowing us to use their library

Contributing 📰

Warning

If you do not follow our conventions, your pull request will be denied.

If you are looking to contribute to BiomesAPI, please read our CONTRIBUTING.md file before doing so.

This file will tell you everything about our conventions and how to contribute to BiomesAPI.

License 🪪

BiomesAPI is licensed under the GPL-3.0 License