Skip to content

Home

Jump to bottom
Outspending edited this page Dec 22, 2023 · 4 revisions

BiomesAPI Wiki!

Welcome to the BiomesAPI Wiki! Here you will learn the in's and out's of BiomeAPI! This wiki should be up-to-date 24/7 whenever i change something major in the API.

Firstly we will go through the basics of looking through BiomesAPI and using BiomesAPI!

On each Class, Interface, Record, Enum, and Methods will have an annotation like @AsOf("VERSION") this tells you when an element was added to the API, most useful if you are running an outdated version of BiomesAPI. This annotation was made for the convenience of developing with this API. This will hopefully also reduce the amount of questions while trying to use this API.

You can also check out Nightly builds of BiomesAPI. Nightly is a version of this API that contains more features that are in testing for the main API. Remember not all of these features make it to the stable build of BiomesAPI so be cautious while using these. The API won't be fully complete and might cause errors, and or messy code.

BiomesAPI is my main project for right now. Hopefully this guide will help you lots and i will try and go into as much detail as i can. Thanks <3

Initializing NMS

Now, once you've learned that. Now its time to initialize NMS for BiomesAPI. Before creating your custom biomes please add

NMSHandler.init();

to your onEnable() or onLoad() methods.

Contributing

If you'd like to contribute to the project please refer to CONTRIBUTING.md

BiomesAPI has lots of features to improve your builds / server. As listed below, these are the features as of V0.0.1:

Features

  • Creating Biomes w/ Custom Colors
  • Setting Biomes easily with BiomeSetter
  • Auto update biomes for all players
  • Support for Ambient Particles
  • Support for 1.19+
  • Light-Weight
Clone this wiki locally