wiki roadmap - magemonkeystudio/fabled GitHub Wiki

🗺️ Wiki Roadmap

This page outlines the planned additions and improvements for the Fabled wiki. It serves as a guide for our future documentation efforts, ensuring we cover all aspects of the plugin in detail.

High-Priority Pages

These pages are considered essential for providing a complete and user-friendly documentation experience.

1. Mechanics: A Deep Dive

  • Goal: To create a comprehensive guide explaining every mechanic available in Fabled.
  • Details: This page will list each mechanic (e.g., Value Add, Value Random, Fire, Remember Target) and provide a detailed description, all available settings, and a simple, practical example of how to use it in a skill.
  • Impact: This will be one of the most valuable resources for server admins creating complex and unique skills.

2. Developer API Guide

  • Goal: To document Fabled's extensive API for other developers.
  • Details: This guide will provide instructions and code examples for hooking into Fabled, accessing player data (PlayerAccount, PlayerData), casting skills programmatically, listening for Fabled's custom events (PlayerCastSkillEvent), and creating custom mechanics, triggers, or targets.
  • Impact: This will empower other developers to create addons and integrations, growing the Fabled ecosystem.

3. Custom Triggers

  • Goal: To provide a complete reference for all skill triggers.
  • Details: This page will list all built-in triggers (e.g., Block Break, Block Place, Crouch, Death, Kill) with a description of the event they correspond to and examples of how they can be used to create dynamic skills.
  • Impact: This will help users understand the full range of possibilities for activating skills beyond simple casting.

Content Enhancement

These sections focus on improving existing topics with more detailed explanations.

4. Addon Plugins

  • Goal: To create the official list of plugins made specifically for Fabled.
  • Details: This page, which is already linked from other pages, will feature community-made or official addons that extend Fabled, providing descriptions and download links.
  • Impact: This will help users discover new ways to enhance their Fabled experience.

5. Damage & Defense System Explained

  • Goal: To explain the nuances of Fabled's damage and defense system.
  • Details: This page will break down the different damage and defense types (e.g., skill-damage, physical-defense, projectile-damage), explain the damage calculation formula, and show how to create RPG-style elemental weaknesses and resistances.
  • Impact: This will be a critical resource for server owners focused on creating a balanced and engaging combat system.