creating classes - goflishMC/fabled-temp GitHub Wiki

๐Ÿง™ Creating Classes

The Classes tab in the Fabled Web Editor lets you define playable RPG classes or races, including level scaling, skill trees, permissions, and icons.


โž• Creating a New Class

  1. Click on the Classes tab at the top of the editor.
  2. Use the โž• Add Class button in the left sidebar.
  3. Name your new class and start editing its properties in the right panel.

๐Ÿงพ Class Fields & Configuration

๐Ÿ”ค Basic Info

Field Description
name The internal name of the class
prefix Text prefix shown in player chat
group Which group this class belongs to (e.g., class, subclass)
max-level The highest level this class can reach
parent Optional parent class (for creating class trees)
needs-permission Set to true if a permission is required to access this class

โš ๏ธ Class groups (like class, subclass, or custom categories) are defined in groups.yml.


๐Ÿ”ผ Progression

  • Max Level โ€“ Highest level this class can reach.
  • Exp Sources โ€“ Select how the class gains XP (e.g., Mobs, Blocks, Orbs).
  • Parent โ€“ The class this one professes from (e.g., Knight's parent = Fighter).

Players can only profess into this class once they meet the parent class requirements.


๐Ÿ” Permissions

  • Permission Required โ€“ Toggle whether a permission node is needed to use this class.
    • Format: fabled.class.<classname>

โค๏ธ Stats & Attributes

  • Health โ€“ Base health for the class.
  • Mana โ€“ Base mana for the class.
  • Mana Regen โ€“ Mana regenerated per tick (interval is set in config.yml).

๐Ÿงช Custom Attributes

  • You can set values for all defined attributes (e.g., Strength, Vitality, Agility).
  • Drag & drop your attributes.yml file into the editor to load your custom attributes.

๐ŸŒฒ Skill Tree

  • Skill Tree Type โ€“ Determines layout style of the skill GUI:
    • Custom, Requirement, Basic Horizontal, Basic Vertical, Level Horizontal, Level Vertical, Flood
  • Skills โ€“ Select which skills this class can use.

Skill requirements, levels, and layout depend on your tree type.


๐Ÿงฐ Restrictions

  • Unusable Items โ€“ Blacklist of items this class cannot use.
    • Example: Swords, Bows, Diamond Armor

โญ Icon

  • Icon โ€“ Select or upload an item to represent this class in menus.

๐Ÿ”€ Combo Starters

Combo starters let players activate special skills using input sequences (e.g., L R R).

  • Combo Material List โ€“ A list of materials that are allowed (or disallowed) as combo starters.
  • Inverted Setting โ€“ If inverted, the materials in the list are not allowed as combo starters; all others are.
  • If a material is not listed and the list is not inverted, it cannot be used to initiate a combo.

Combo logic is configured in the config.yml under the combo section.


๐Ÿ’พ Saving & Exporting

Once you're done editing:

  • Click ๐Ÿ’พ Save to export the current class.
  • Or click ๐Ÿ“ค Upload All to Server to export everything.
  • The resulting file will be saved as:
    /plugins/Fabled/classes.yml
    

Reload the plugin with:

/fabled reload

๐Ÿงช Testing Your Class

  • Use /class select <name> to try your class in-game.
  • Use /class skill to assign unlocked skills to your casting bar or GUI.
  • Make sure XP sources are enabled in config.yml.

๐Ÿ”— Related Pages

โš ๏ธ **GitHub.com Fallback** โš ๏ธ