Skip to content

Getting Started

Jump to bottom
SkyCore edited this page May 21, 2026 · 4 revisions

Getting Started

Purpose

This guide explains how to install FaunaReborn on a Minecraft server.

Compatibility Requirements

Before installation, verify:

  • Server software: Paper-compatible server (FaunaReborn targets Paper API 1.21.x)
  • Folia: Supported
  • Java runtime: Java 21

Installation

1. Stop the server

Shut down the server cleanly before adding or upgrading the plugin.

2. Copy the plugin JAR

Place the FaunaReborn JAR into your server plugins/ directory.

Example: plugins/FaunaReborn.jar

3. Start the server

Boot the server and wait for plugin initialization.

4. Confirm plugin load

Validate that FaunaReborn enables without exceptions in console logs.

First Startup (Expected Files)

On first boot, FaunaReborn generates its runtime directory under:

plugins/FaunaReborn/

Review these files first:

  • config.yml (global behavior, targeting, LOD, caps, language, world filter)
  • entities/chicken.yml
  • entities/cow.yml
  • entities/pig.yml
  • lang/english.yml
  • lang/spanish.yml
  • lang/portuguese.yml
  • lang/italian.yml
  • lang/french.yml

Recommended first-pass workflow:

  1. Start once to generate files
  2. Edit configs
  3. Validate logs and in-game behavior

Minimum First Configuration

In plugins/FaunaReborn/config.yml, validate:

  • global-enabled: true
  • language.file: en (or es / pt)
  • world-filter.mode: ALL, WHITELIST, or BLACKLIST
  • lod.enabled and distance/interval tiers
  • Hard caps:
    • max-active-hostile-chickens-per-chunk
    • max-active-hostile-chickens-per-world
    • max-processed-chickens-per-tick

Then review per-entity modules in:

  • entities/chicken.yml
  • entities/cow.yml
  • entities/pig.yml

Command Test

Base command: /fauna
Aliases: /faunareborn, /fr

Run these checks:

  • /fauna help
  • /fauna version
  • /fauna entities
  • /fauna about
  • /fauna reload
  • /fauna gui
  • /fauna lang en (or es / pt)

Expected result: commands execute without errors and respect sender permissions.

Permission Baseline

Primary permission nodes:

  • fauna.* (all commands)
  • fauna.admin (admin command set)
  • fauna.command.help
  • fauna.command.help.admin
  • fauna.command.version
  • fauna.command.about
  • fauna.command.entities
  • fauna.command.reload
  • fauna.command.gui
  • fauna.command.lang

Troubleshooting Quick Guide

Plugin does not enable

  • Confirm Paper/Folia compatibility and server version
  • Confirm Java 21 runtime
  • Confirm JAR path is correct (plugins/)
  • Inspect full startup stack trace

Commands do not work

  • Check assigned permission nodes
  • Test commands from console
  • Confirm command spelling/subcommand usage (/fauna help)

Config changes not applied

  • Run /fauna reload (for runtime reload path)
  • If behavior persists, perform full restart
  • Validate YAML formatting in edited files

Related Pages

Last updated: 2026-05-21 Project: https://github.com/devskycore/FaunaReborn

Clone this wiki locally