Example-config

arenas:
  test_arena_hunters:
    display-name: "Test"
    type: HUNTERS #SURVIVAL
    worldgen-type: BEFORE_GAME
    world-view-distance: 8
    world-simulation-distance: 4
    bossbar-color: PURPLE
    max-instances: 3
    resistance-time: 200 #seconds (Only in RESISTANCE type)
    time-before-starting: 10 #seconds
    world: "test_arena"
    schematic: "fnaf1_map.schem"
    paste-location: "-33.5,-60,-43.5"
    spawn-survivors:
      - "-33.5,-60,-43.5"
    spawn-hunter: "-33.5,-59,-76.5"
    players:
      min-players: 2
      max-players: 5
    hunters:
      min-hunters: 1
      max-hunters: 1
    start-commands:
      - "say Started %arena_id%"
      - "minecraft:give %hunters% minecraft:iron_sword 1"
      - "title %hunters% title {\"text\":\"Hunt!\",\"color\":\"red\"}"
      - "title %survivors% title {\"text\":\"Survive the hunt!\",\"color\":\"green\"}"
    end-commands:
      - "say End %arena_id%"
    end-win-commands:
      - "say Winners (%winners_size%): %winners_csv%"

Explanation of functions

Variable	Fuction
max-instances	The number of Instances or Worlds that can be created at the same time by the same Arena
world	The world that will be used as a basis to then create the instance with the name, for example test_arena_instance_<number>

Start Commands

Variables	Fuction
%world%	The name of the world generated in the Arena.
%arena_id%	The id of the Arena Selected
%arena_name%	The DisplayName of the Arena
%players_size%	The number of players available in the Arena
%hunters%	This is a list of all possible hunters, and it will be replaced with their names. It will be executed for each available hunter.
%survivors%	This is a list of all possible survivors, and it will be replaced with their names. It will be executed for each available survivor.

End Commands

Variables	Fuction
%world%	The name of the world generated in the Arena.
%arena_id%	The id of the Arena Selected
%arena_name%	The DisplayName of the Arena
%hunters%	This is a list of all possible hunters, and it will be replaced with their names. It will be executed for each available hunter.
%survivors%	This is a list of all possible survivors, and it will be replaced with their names. It will be executed for each available survivor.

End Win Commands

Variables	Fuction
%world%	The name of the world generated in the Arena.
%arena_id%	The id of the Arena Selected
%arena_name%	The DisplayName of the Arena
%winners_size%	The number of winners
%winners_csv%
%winner%	The first winner on the list
%winners%	This is a list of all Winnetrs, and it will be replaced with their names. It will be executed for each available hunter.
%hunters%	This is a list of all possible hunters, and it will be replaced with their names. It will be executed for each available hunter.
%survivors%	This is a list of all possible survivors, and it will be replaced with their names. It will be executed for each available survivor.

Types

HUNTERS

In this mode, there are Survivors and Hunters. The Hunters have the task of eliminating the Survivors.

It is designed to be used with other plugins.

The Survivors win if the Hunters die.

The Hunters win if the Survivors die.

SURVIVAL

In this mode, there are only Survivors; there is no way to win.

The game ends when all Survivors die.

RESISTANCE

In this mode, there are only survivors, and they only win if the counter reaches 0.

The game ends when all Survivors die.

If the counter reaches 0 and there are players still alive, the Survivors win.

Worldgen Types

Both types are completely Empty new Worlds that depend on a schematic

with gamerules, DISABLE_RAIDS, DO_PATROL_SPAWNING, DO_MOB_SPAWNING, DO_DAYLIGHT_CYCLE in false with World Time in 12000 ticks, viewDistance(4), simulationDistance(2), keepSpawnLoaded in false

BEFORE_GAME

Arena worlds are created when the server starts (depending on the maximum number of instances), lightening the load on the server, and are used when needed.

IN_GAME

Worlds are created immediately before the game starts, up to the maximum number of instances possible, and are deleted once the game ends.

Languages

This option exists in settings.yml, allowing you to change the plugin messages that are sent.

lang: en

en.yml

messages:
  nopermission:
    message:
      - "%prefix% <red>You dont have perms to do that"
  reload:
    message:
      - "%prefix% <green>Plugin configuration has been reloaded"
  hunter_role:
    message:
      - "%prefix% <red>You are the Hunter!"
  survivor_role:
    message:
      - "%prefix% <green>You are a Guard!"
  game_started:
    message:
      - "%prefix% <gray>The game in arena %arena_name%"
      - "%prefix% <gray>Has started with <gold>%players_size%<gray> players!"
  enter_queue:
    message:
      - "%prefix% <green>You have entered in the queue of %game%."
  leave_queue:
    message:
      - "%prefix% <red>You have left the queue."
  full_queue:
    message:
      - "%prefix% <red>The queue is full, you can't get in!"
  already_in_game:
    message:
      - "%prefix% <red>You are already in a game."
  already_in_queue:
    message:
      - "%prefix% <gold>You're already in queue of %game%."
  game_no_found:
    message:
      - "%prefix% <red>The %game% could not be found."

  hunter_stray: "<gray>Animatronics Stray<dark_gray>: <gold>"
  survivor_alive: "<gray>Guards Alive<dark_gray>: <gold>"

  hunter_win: "<red>The Animatronics has won!"
  survivor_win: "<green>The Guards have won!"
  resistance_won: "<green>You have won by persevering!"

  not_enough_players: "<red>Not enough players to start the Game."
  survivors_failed_survive: "<red>The Guards failed to survive."
  game_type_scoreboard: "<gray>Game Type<dark_gray>: <gold>%type%"
  game_starting: "<gray>The game begins!"
  game_waiting_players: "<gray>Waiting for players..."
  game_finished: "<gold>End of the game."

  resistance_resist: "<gold>RESIST"
  resistance_time_left: "<gray>Time remaining<dark_gray>: <yellow>"