rutgerkok / WorldGeneratorApi

Minecraft Spigot plugin that enables other plugins to customize world generation
MIT License
96 stars 9 forks source link
api minecraft spigot-plugin terrain-generation

WorldGeneratorApi

Build Status Download at SpigotMC.org Dev Builds at codemc.io Latest release Commits since latest release

Nowadays, you have many options to edit how your world generates. Bukkit got a hugely expanded world generation API in 2021, and data packs are able to take control over almost any aspect of world generation. But, how would you generate a map like this?

Example biome map

The answer: first, install a data pack that increases ocean size, then install WorldGeneratorApi, then run /worldgeneratorapi biomemap.

WorldGeneratorApi is a modest API, adding some functionality for world generation. It used to be bigger, but most code has been dropped in favor of the new methods in the Bukkit API.

Please head to the wiki to learn more.

License

License is MIT, so you can freely use this API, even in premium plugins. Just put up a note that you're using WorldGeneratorApi.

Compiling

We use Maven. Maven can be a bit tricky to install (you need to modify the environment variables of your computer), but once you have managed to do that, just run:

mvn install

You'll end up with a file ./target/WorldGeneratorApi-1.0.jar (version number will be different of course), which is a ready-to-use plugin. There's also the file ./worldgeneratorapi/target/worldgeneratorapi-1.0.jar, which is just the API. This file can be used by plugin developers to code against: it will not run on the server, as it is missing the implementation.

Bug reports, feature requests and pull requests

Contributions are always welcome! Just open an issue or pull request.