Server/src/engine/documentation/Handler_Documentation_Index.md

Magicbane Database Handler Documentation Index

This index provides an overview of all database handler documentation files created for the Magicbane emulator project.

Available Documentation Files

1. dbAccountHandler_Documentation.md

   • Documents account management functionality including authentication and account status tracking
   • Covers obj_account table and its relationships to character objects

2. dbCityHandler_Documentation.md

   • Documents city management functionality including city creation, zones, and buildings
   • Covers obj_city, obj_zone, and obj_building tables

3. dbPlayerCharacterHandler_Documentation.md

   • Describes player character handling including creation, updates, and retrieval operations
   • Covers obj_character table and related dynamic tables

4. dbRaceHandler_Documentation.md

   • Describes race-related data handling for beard colors and styles
   • Focuses on static race data tables

5. dbGuildHandler_Documentation.md

   • Describes the complex guild system with relationships to history, alliances, enemies, and member management
   • Covers multiple related tables including obj_guild, dyn_character_guildhistory, dyn_guild_allianceenemylist, etc.

6. dbBaneHandler_Documentation.md

   • Documents bane management functionality for city-based special objects
   • Covers dyn_banes table and its relationships to cities, players, and buildings

7. dbCSSessionHandler_Documentation.md

   • Documents client session management including session creation, retrieval, updating, and deletion
   • Covers dyn_session table and its relationships to accounts and characters

8. dbKitHandler_Documentation.md

   • Documents kit management functionality for static kit data
   • Covers static_rune_validkit table and its relationships to races, classes, and items

9. dbLootHandler_Documentation.md

   • Documents loot system functionality including general tables, item tables, modifier tables, and booty sets
   • Covers static_loot_gen, static_loot_item, static_loot_mod, static_loot_modtype, and static_loot_bootySet tables

10. dbMenuHandler_Documentation.md

    • Documents NPC menu option handling including retrieval of menu options by menu ID
    • Covers static_npc_menuoption table

11. dbContractHandler_Documentation.md

    • Documents contract management functionality for player contracts and quest tracking
    • Covers dyn_contract table and its relationships to characters and quests

12. dbEffectsBaseHandler_Documentation.md

    • Documents effect base data handling including effect types, categories, and properties
    • Covers static_effect_base table and related lookup tables

13. dbEffectsResourceCostHandler_Documentation.md

    • Documents resource cost handling for game effects and abilities
    • Covers static_effect_resourcecost table and its relationships to effects and resources

14. dbEnchantmentHandler_Documentation.md

    • Documents enchantment management functionality for item enhancements
    • Covers dyn_enchantment table and related data structures

15. dbHeightMapHandler_Documentation.md

    • Documents height map data handling for terrain and elevation information
    • Covers static_heightmap table and its spatial data relationships

16. dbItemBaseHandler_Documentation.md

    • Documents base item data handling including item properties, types, and categories
    • Covers static_item_base table and related lookup tables

17. dbItemHandler_Documentation.md

    • Documents item management functionality for player inventory and items
    • Covers dyn_item table and its relationships to characters and locations

18. dbMineHandler_Documentation.md

    • Documents mine management functionality including resource extraction and mining operations
    • Covers dyn_mine table and related mining data structures

19. dbMobBaseHandler_Documentation.md

    • Documents base mob data handling including mob types, stats, and behaviors
    • Covers static_mob_base table and related lookup tables

20. dbMobHandler_Documentation.md

    • Documents mob management functionality for NPC creatures and monster behavior
    • Covers dyn_mob table and its relationships to zones and character data

21. dbNPCHandler_Documentation.md

    • Documents NPC handling including conversation systems and NPC properties
    • Covers dyn_npc table and related interaction data

22. dbPetitionHandler_Documentation.md

    • Documents petition management functionality for player support requests
    • Covers dyn_petition table and its relationships to accounts and characters

23. dbPowerHandler_Documentation.md

    • Documents power handling including character abilities, skills, and power systems
    • Covers static_power_base, dyn_character_power, and related tables

24. dbPromotionClassHandler_Documentation.md

    • Documents promotion class handling for character advancement and class changes
    • Covers static_promotion_class table and related data structures

25. dbRealmHandler_Documentation.md

    • Documents realm management functionality including realm data and server information
    • Covers obj_realm table and its relationships to accounts and characters

26. dbResistHandler_Documentation.md

    • Documents resistance handling for character stats and damage mitigation
    • Covers static_resist table and related resistance data structures

27. dbRuneBaseAttributeHandler_Documentation.md

    • Documents rune base attribute handling for magical properties and modifiers
    • Covers static_rune_baseattribute table and related lookup tables

28. dbRuneBaseEffectHandler_Documentation.md

    • Documents rune base effect handling including effect types and properties
    • Covers static_rune_baseeffect table and related data structures

29. dbRuneBaseHandler_Documentation.md

    • Documents rune base data handling for rune creation and properties
    • Covers static_rune_base table and related lookup tables

30. dbRunegateHandler_Documentation.md

    • Documents runegate management functionality for magical portal systems
    • Covers dyn_runegate table and its relationships to characters and locations

31. dbShrineHandler_Documentation.md

    • Documents shrine management functionality including shrine effects and locations
    • Covers dyn_shrine table and related data structures

32. dbSkillBaseHandler_Documentation.md

    • Documents skill base data handling for character abilities and skills
    • Covers static_skill_base table and related lookup tables

33. dbSkillReqHandler_Documentation.md

    • Documents skill requirement handling for character advancement and skill unlocks
    • Covers static_skill_requirement table and related data structures

34. dbVendorDialogHandler_Documentation.md

    • Documents vendor dialog handling for NPC merchant interactions
    • Covers static_npc_dialog table and related conversation data

35. dbWarehouseHandler_Documentation.md

    • Documents warehouse management functionality for player storage systems
    • Covers dyn_warehouse table and its relationships to characters and items

36. dbBaseClassHandler_Documentation.md

    • Documents base class handling for character race and class structures
    • Covers static_rune_racebaseclass table and related data structures

37. dbBlueprintHandler_Documentation.md

    • Documents blueprint handling for building and construction systems
    • Covers static_building_blueprint and static_building_doors tables

38. dbBoonHandler_Documentation.md

    • Documents boon handling for item and character enhancements
    • Covers static_item_boons table and related data structures

39. dbBuildingHandler_Documentation.md

    • Documents building management functionality including construction and ownership
    • Covers obj_building, dyn_building_friendslist, and related tables

40. dbBuildingLocationHandler_Documentation.md

    • Documents building location handling for spatial positioning and placement
    • Covers static_building_location table and related data structures

41. dbCharacterPowerHandler_Documentation.md

    • Documents character power handling for ability and skill management
    • Covers dyn_character_power table and related data structures

42. dbCharacterRuneHandler_Documentation.md

    • Documents character rune handling for magical rune systems
    • Covers dyn_character_rune table and related data structures

43. dbCharacterSkillHandler_Documentation.md

    • Documents character skill handling for ability progression and skill management
    • Covers dyn_character_skill table and related data structures

44. dbZoneHandler_Documentation.md

    • Documents zone management functionality including world zones and area definitions
    • Covers obj_zone table and its relationships to cities and buildings

Documentation Structure

All documentation files follow a consistent format with the following sections:

• Overview
• Handler Class information
• Database Tables involved
• Key Queries with line references
• Relationships between entities
• Java Field to Database Column Mappings

Usage Notes

These documents are intended for:

• Developers working on the Magicbane emulator
• Wiki documentation for project maintainers
• Database schema understanding and maintenance
• Future reference when code changes may affect database relationships

The files are located in: src/engine/documentation/Handler Specific Documentation/