Skip to main content

Flora & Fauna Discoveries

Experimental feature

This is an experimental feature. It probably doesn't contain all features you need and might not work as expected.

RPGRegions is not just a regions plugin. It is also able to handle entity discoveries.

About flora/fauna discoveries​

There are several names that RPGRegions uses to handle these, because none really describe them as a whole.

  • Bestiary is a compendium of beasts.
  • Flora is all the plant life present in a particular region or time.
  • Fauna is all of the animal life present in a particular region or time.

Fauna is the main name that we use.

You can find the configuration files for these in plugins/RPGRegions/fauna.

The bestiary/flora/fauna book compendium can be opened using a command of any of those names.

Players will need the rpgregions.bestiary permission to be able to discover fauna and open the book.

Adding new fauna​

Create a new file of any name in the fauna folder, for example, if we were to add a cat entity discovery, we'd name it cat.yml.

tip

The names of the files do not matter, just make sure you use descriptive names to match what is in the file.

You should copy the base goat.yml file into your new one. For convenience, here it is:

# Whether this is enabled. Mostly for if you want to disable default files RPGRegions comes with.
enabled: true
# The type can either be of a vanilla entity type, or a MythicMob
type: GOAT
# A unique identifier for this fauna. Must not be the same name as a region, either.
identifier: goat
# Name shown in placeholder. You can use MiniMessage formatting here, especially hover events for inside the bestiary book.
display_name: "<gradient:dark_aqua:aqua>Goat"

# Description shown in bestiary book
description:
  - "    <gold>Bestiary - Goat</gold>"
  - "<gold>The Goat</gold> is a fluffy, cute mob found in <aqua>cold mountainous areas</aqua>."
  - "Goats are well-known for the milk that they produce."
  - " "
  - "<red>But beware!</red> Turn your back, and out of spite you shall find yourself rammed into the air."
  - "<newpage>" # Make a new page using the <newpage> tag. This is not MiniMessage, but a custom tag by RPGRegions.
  - "Example text on page two."

# Triggers that define when this entity is discovered
triggers:
  # Will be discovered when nearby to a goat in a radius of 5.
  nearby:
    radius: 5.0

The type field supports MythicMobs. Just use the id of the mythic mob.

For vanilla mobs, valid types can be found at https://hub.spigotmc.org/javadocs/spigot/org/bukkit/entity/EntityType.html.

Valid triggers and their properties​

nearby​

Triggers a discovery when a player is nearby within a specified radius.

kill​

Triggers a discovery when the entity is killed by a player.