Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.borntocraftstudio.net/llms.txt

Use this file to discover all available pages before exploring further.

​
RPG Core Configuration

The RpgCoreConfigurationEntry is the central hub for configuring the entire RPG Core extension. Because of the interconnected nature of RPG systems (items need stats, professions need items, crafting needs both), everything is managed through this single, comprehensive manifest entry. Type: Manifest Entry Entry ID: btc_rpgcore_configuration

​
Sections

This configuration is divided into several major sections:

​
1. Items (items)

Manages the custom item catalog.
  • Categories: Define item categories (e.g., Weapons, Armor, Consumables).
  • Sets: Define equipment sets and their set bonuses.
  • Lore: Configure how item lore is generated (stats order, formatting).
  • Pagination: Advanced settings for multi-page tooltips, customizable keybinds (e.g., SWAP_OFFHAND, LEFT_CLICK), dynamic page indicators (<page>, <max_pages>), and specific category image mappings for tooltips.
  • Messages: Custom messages for item interactions, commands, and errors.
  • Browser: Configuration for the /rpgitem menu GUI.

​
2. Stats (stats)

Defines the player statistics system.
  • Definitions: Create custom stats (e.g., Strength, Wisdom, Critical Chance).
  • Defaults: Set base values for stats for new players.
  • Formatting: Control how stats are displayed in menus and lore.

​
3. Professions (professions)

Configures the profession system.
  • Definitions: Define professions (Mining, Herbalism, etc.) with:
    • Max levels.
    • Experience curves.
    • Level-up rewards.
  • Main Menu: Configure the /rpgprofession menu layout.
  • Artifact: Reference to the ProfessionDataArtifactEntry used for storage.

​
4. Inventory (inventory)

Configures custom inventory solutions.
  • Backpacks: Define multiple backpack layouts (rows, slots, whitelist).
  • Wardrobe: Configure the cosmetic equipment menu (armor slots, accessories).
  • Artifacts: Reference to BackpackStorageArtifactEntry and WardrobeStorageArtifactEntry.

​
5. Auction (auction)

Settings for the global Auction House.
  • Taxes: Listing fees and transaction taxes.
  • Durations: Available auction durations (e.g., 6h, 12h, 24h).
  • Menus: Layouts for the Auction Browser, My Listings, and Collection Bin.

​
6. Crafting (crafting)

The custom crafting engine.
  • Recipes: Define custom crafting recipes (Grid, Station-based).
  • Stations: Configure custom crafting stations.
  • Upgrading: Settings for item upgrading (gemstones, reforging).

​
7. Other Systems

  • Fishing (fishing): Custom loot tables for fishing in specific fluids/biomes.
  • Block Break (blockBreak): XP rewards for mining specific blocks.
  • Anvil (anvil): Custom repair rules (material costs per item type) and renames.
  • Enchantment (enchantment): Rewards (XP) for enchanting items and custom enchantment behaviors.
  • Boosts (boosts): Messages and settings for temporary XP/Stat boosts.

​
8. Ether Corruption (ether_corruption)

Environmental hazard system.
  • Zones: Define areas where players take damage and suffer effects (e.g. Blindness).
  • Safety Criteria: Define rules to protect players from corruption (e.g. wearing a “Gas Mask” item).
  • Effects: Configure potioneffects, sounds, and particles for each zone.

​
Usage

This entry should be created once in your TypeWriter project. It effectively acts as the “database” for your server’s RPG rules.
[!IMPORTANT] Because this entry controls the Item Catalog, do not delete it if you have items created in game. Doing so may invalidate existing items or cause them to lose their data.