groups yml - magemonkeystudio/fabled GitHub Wiki

📘 groups.yml — Group Configuration

The groups.yml file defines group-level rules for your classes, such as how skill points, attribute points, death penalties, scoreboard visibility, and friendly fire behave across all classes within the same group.

📂 File Location

/plugins/Fabled/groups.yml

This file is automatically generated and updated as new class groups are loaded.

🧩 What Are Groups?

In Fabled, every class belongs to a group — such as class, race, or class-fighter. Group settings define how those classes interact with each other and control global behaviors like point gain, friendly fire, scoreboard visibility, and more.

Groups are referenced:

When players switch or profess into other classes
When determining PvP rules (via the friendly setting)
When calculating skill and attribute point progression

🛠️ Common Group Settings

Each group section contains the following configurable options:

Key	Description
`default`	The starting class for players in this group (`none` = no auto-assign)
`permission`	Permission required to access any class in the group
`profess-reset`	Whether XP/points reset when professing into a subclass
`profess-refund-skills`	If true, refunds skill points when resetting instead of deleting them
`profess-refund-attributes`	If true, refunds attribute points when resetting instead of deleting them
`can-reset`	Whether `/class reset` works for this group
`friendly`	Prevents PvP between players in the same group
`show-scoreboard`	Displays the scoreboard for this group (if enabled globally)
`exp-lost-on-death`	% of XP lost on death (doesn't affect levels)
`starting-points`	Skill points granted at level 1
`points-per-level`	Skill points earned per level (ignored if `use-custom-points: true`)
`starting-attribs`	Attribute points granted at level 1
`attribs-per-level`	Attribute points earned per level (ignored if `use-custom-attribute-points: true`)
`use-custom-points`	Enables custom skill point table (see `custom-points`)
`use-custom-attribute-points`	Enables custom attribute point table (see `custom-attribute-points`)
`custom-points`	Specific skill points granted at certain levels
`custom-attribute-points`	Specific attribute points granted at certain levels

🧪 Example Entry

class:
  default: 'none'
  permission: 'none'
  profess-reset: 'false'
  profess-refund-skills: 'true'
  profess-refund-attributes: 'true'
  can-reset: 'true'
  friendly: 'false'
  show-scoreboard: 'true'
  exp-lost-on-death: 0.0
  starting-points: 1
  points-per-level: 0.0
  starting-attribs: 6
  attribs-per-level: 0.0
  use-custom-points: 'false'
  use-custom-attribute-points: 'true'
  custom-attribute-points:
    4: 2
    8: 2
    12: 2
    16: 2
    20: 2

🧠 Tips & Notes

Every class must be assigned to a group. If not manually grouped, it will fall into the default class group.
Group sections are automatically added to this file when new classes are detected.
If use-custom-points is true, the points-per-level setting is ignored.
Scoreboards only work if globally enabled in config-scoreboard.
You can use groups to organize your class system by race, specialization, rank, or faction.