Home - magemonkeystudio/divinity GitHub Wiki

🧿 Divinity Wiki

Divinity is a modular Minecraft RPG plugin that handles items, stats, durability, refinement, upgrades, and loot. This wiki provides comprehensive documentation for everything you need to configure and integrate Divinity into your server.


πŸ“˜ Getting Started


πŸ” Integration & Permissions

  • Commands β€” A complete reference for all admin and player commands.
  • Permission β€” A list of all permission nodes for controlling access to commands and features.
  • PlaceholderAPI Placeholders β€” A guide to displaying Divinity data in other plugins like scoreboards and chat.
  • Supported Plugins β€” Lists all plugins and services that Divinity is designed to work with.

βš™οΈ Actions System


πŸ› οΈ Troubleshooting & Help

  • Common Errors & Fixes β€” A guide to resolving the most frequently encountered issues.
  • How to Report Bugs β€” Provides the correct format and procedure for submitting effective bug reports.

πŸ—ƒοΈ Configuration Files


🧩 Modules

  • arrows β€” Manages custom arrow types, behaviors, and effects.
  • combat_log β€” Configure the in-game logging of combat events for players.
  • consumables β€” Create custom food, potions, and other items that are consumed on use.
  • custom_items β€” A guide to defining your own unique items with custom stats and lore.
  • dismantle β€” Configure how players can break down items into crafting materials.
  • drops β€” Control custom mob drops and loot tables.
  • essences β€” Defines magical essences used for enchanting or crafting.
  • extractor β€” Configure how players can extract gems or runes from socketed items.
  • fortify β€” Set up the system for strengthening and upgrading equipment.
  • gems β€” Create and manage gems that can be socketed into items for powerful bonuses.
  • identify β€” Configure the system for revealing the stats of unidentified items.
  • item_generator β€” Control the procedural generation of random loot and treasure.
  • item_hints β€” Manage the hints and lore that appear on item tooltips.
  • loot β€” Defines loot chests and other container-based rewards.
  • magic_dust β€” Configure the properties of dust used in refinement and enchanting.
  • money β€” Manages the server's economy and integrates with currency plugins.
  • party β€” Configure the settings for player parties and group mechanics.
  • refine β€” Control the item refinement process for improving equipment quality.
  • repair β€” Configure custom item repair costs, methods, and mechanics.
  • runes β€” Create and manage runes that grant special abilities when socketed.
  • sell β€” Configure how players can sell items to the server or NPC shops.
  • sets β€” A guide to creating item sets that provide powerful bonuses when worn together.
  • soulbound β€” Configure how items can be permanently bound to a player.

Root Files

  • config.yml
    • divinity β€” High-level plugin settings and version info.
    • data β€” Configure database connections and data saving intervals.
    • tiers β€” Define the different item rarity tiers (e.g., Common, Rare, Legendary).
    • modules β€” Enable or disable specific gameplay modules globally.
    • Item Definitions (Sub-Types & Groups) β€” Create custom categories and types for items.
    • core β€” Core settings that affect the entire plugin.
  • data.db β€” Information on the SQLite database file where local data is stored.
  • engine.yml
    • packets β€” Low-level settings for managing network packets to reduce lag.
    • compatibility β€” Settings for ensuring compatibility with other server plugins.
    • performance β€” Adjust settings to optimize plugin performance and reduce TPS loss.
    • attributes β€” Define custom player attributes and how they are handled.
    • combat β€” Configure the core combat mechanics, including damage formulas and effects.
    • lore β€” Control the format and appearance of item lore and tooltips.
  • worth.yml β€” Define the base monetary value for items and materials.

πŸ“ item_stats/

  • ammo.yml β€” Defines stats specific to custom arrows and ammunition.
  • damage.yml β€” Configure all possible damage-related stats for weapons.
  • defense.yml β€” Configure all possible defense-related stats for armor.
  • hand.yml β€” Defines stats related to a player's main-hand and off-hand.
  • sockets.yml β€” Configure how gem and rune sockets are defined on items.
  • stats.yml β€” Defines all general player stats that can appear on gear (e.g., Strength, Health).

πŸ“ lang/

  • messages_en.yml β€” English language file for all player-facing messages.
  • messages_cn.yml β€” Chinese language file for all player-facing messages.

πŸ“ profiles/

  • gui.profile.yml β€” Configure the layout and design of player-facing GUIs, like the profile screen.
  • gui.profiles.yml β€” Manages the different available GUI profiles a server can use.
  • gui.settings.yml β€” Defines the options available in the GUI settings menu.
  • settings.yml β€” Configure the default player-specific settings.